RetrievalKnowledgeBase - PolarDB - Alibaba Cloud Documentation Center

Mengambil informasi dari basis pengetahuan.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

polardb:RetrievalKnowledgeBase

get

*All Resource

*

None

Sintaks permintaan

POST  HTTP/1.1

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah.	cn-beijing
KnowledgeBaseId	string	Yes	Pengenal unik basis pengetahuan. Anda dapat menentukan beberapa basis pengetahuan yang dipisahkan oleh koma. Maksimal 50 basis pengetahuan dapat ditentukan.	pkb-1xxxxx,pkb-2xxxxx
QueryText	string	Yes	Teks kueri.	Laporan keuangan
TopK	integer	No	Jumlah hasil yang dikembalikan.	5
ScoreThreshold	number	No	Ambang batas skor kemiripan.	0.7
RerankEnabled	boolean	No	Apakah akan mengaktifkan penyusunan ulang. Nilai default: true.	true

Elemen respons

Element	Type	Description	Example
	object	Skema respons.
QueryText	string	Teks kueri.	Laporan keuangan
RequestId	string	ID permintaan.	CD35F3-F3-44CA-AFFF-BAF869******
ResultCount	integer	Jumlah hasil.	5
Results	array<object>	Hasil pencarian.
	array<object>	Hasil pencarian.
Captions	array	Daftar keterangan gambar atau tabel yang terkait dengan chunk.
	string	Keterangan gambar atau tabel.	Diagram arsitektur sistem
DocItems	array	Daftar referensi elemen terstruktur dokumen sumber Docling yang terkait dengan chunk. Anda dapat menggunakan referensi ini untuk menemukan elemen secara tepat di dokumen asli.
	string	Referensi elemen terstruktur dokumen sumber Docling.	#/texts/2
FileId	string	Pengenal unik file.	91b97b71-xxxx-xxxx-xxxx-33c6a6341cdc
FileName	string	Nama file.	LaporanKeuangan2024.pdf
Headings	array	Rantai judul bagian tempat chunk berada.
	string	Judul.	Laporan keuangan
ImageResources	array<object>	Daftar sumber daya gambar yang direferensikan oleh chunk.
	object	Sumber daya gambar.
DocumentIndex	integer	Indeks dokumen sumber tempat gambar berada, dimulai dari 0.	0
Id	string	Pengenal unik sumber daya gambar.	document-0/pictures/1
ItemRef	string	Referensi elemen gambar dalam struktur dokumen sumber Docling.	#/pictures/1
MimeType	string	Tipe media sumber daya gambar.	image/png
Uri	string	URI OSS sumber daya gambar.	oss://my-bucket/results/my-space/doc-001/artifacts/image-1.png
Metadata	string	Metadata.	{}
PageNumbers	array	Daftar nomor halaman tempat chunk berada.
	integer	Nomor halaman tempat chunk berada.	1
ShardContent	string	Konten teks chunk.	Laporan keuangan
ShardIndex	integer	Indeks chunk.	1
SimilarityScore	number	Skor kemiripan.	0.8

Contoh

Respons sukses

JSONformat

{
  "QueryText": "Laporan keuangan",
  "RequestId": "CD35F3-F3-44CA-AFFF-BAF869******",
  "ResultCount": 5,
  "Results": [
    {
      "Captions": [
        "Diagram arsitektur sistem"
      ],
      "DocItems": [
        "#/texts/2"
      ],
      "FileId": "91b97b71-xxxx-xxxx-xxxx-33c6a6341cdc",
      "FileName": "2024FinancialReport.pdf",
      "Headings": [
        "Laporan keuangan"
      ],
      "ImageResources": [
        {
          "DocumentIndex": 0,
          "Id": "document-0/pictures/1",
          "ItemRef": "#/pictures/1",
          "MimeType": "image/png",
          "Uri": "oss://my-bucket/results/my-space/doc-001/artifacts/image-1.png"
        }
      ],
      "Metadata": "{}",
      "PageNumbers": [
        1
      ],
      "ShardContent": "Laporan keuangan",
      "ShardIndex": 1,
      "SimilarityScore": 0.8
    }
  ]
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.