Retrieve - Alibaba Cloud Model Studio - Alibaba Cloud Documentation Center

Mengambil informasi dari basis pengetahuan yang ditentukan.

Deskripsi operasi

Metode pemanggilan: Kami merekomendasikan penggunaan Alibaba Cloud Model Studio SDK terbaru. SDK ini merangkum logika perhitungan tanda tangan yang kompleks untuk menyederhanakan proses pemanggilan Anda.
Persyaratan izin:
- Pengguna RAM (sub-akun): Anda harus terlebih dahulu memperoleh izin API untuk Alibaba Cloud Model Studio (Anda dapat menggunakan kebijakan AliyunBailianDataFullAccess, yang mencakup izin sfm:Retrieve yang dibutuhkan oleh API ini) dan bergabung dengan workspace sebelum memanggil API ini.
- Akun Alibaba Cloud (akun utama): Memiliki izin secara default dan dapat memanggil API secara langsung.
Latensi respons: Karena pemanggilan API melibatkan pengambilan dan pencocokan yang kompleks, waktu respons mungkin lama. Kami merekomendasikan agar Anda menetapkan kebijakan batas waktu permintaan dan percobaan ulang yang wajar.
Idempotensi: API ini bersifat idempoten.

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.

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
sfm:Retrieve	none	全部资源 ``	None	None

Action

Access level

Resource type

Condition key

Dependent action

sfm:Retrieve

none

*全部资源

*

None

Sintaks permintaan

POST /{WorkspaceId}/index/retrieve HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
WorkspaceId	string	Yes	ID workspace tempat basis pengetahuan berada. Untuk cara mendapatkannya, lihat Cara Menggunakan Workspace.	llm-3shx2gu255oqxxxx

Parameter permintaan

Parameter	Type	Required	Description	Example
Query	string	No	Teks masukan (prompt input asli). Tidak ada batasan panjang atau jumlah karakter untuk Query.	阿里云百炼平台介绍
DenseSimilarityTopK	integer	No	Top K pengambilan vektor. Sistem menghasilkan vektor dari teks masukan dan mengambil K potongan teks di basis pengetahuan yang representasi vektornya paling mirip. K berada dalam rentang [0-100]. Jumlah `DenseSimilarityTopK` dan `SparseSimilarityTopK` harus kurang dari atau sama dengan 200. Nilai default: 100.	100
EnableReranking	boolean	No	Menentukan apakah pemeringkatan ulang (reranking) diaktifkan. Untuk informasi selengkapnya, lihat Basis Pengetahuan. Nilai yang valid: true: Diaktifkan. false: Dinonaktifkan. Nilai default: true. Valid values: true : Diaktifkan false : Dinonaktifkan	true
EnableRewrite	boolean	No	Menentukan apakah Penulisan Ulang Percakapan Multi-giliran diaktifkan. Nilai yang valid: true: Diaktifkan. false: Dinonaktifkan. Nilai default: false. Valid values: true : Diaktifkan false : Dinonaktifkan	false
Rerank	array<object>	No	Konfigurasi pemeringkatan ulang.
	object	No	Objek konfigurasi pemeringkatan ulang.
ModelName	string	No	Menentukan model pemeringkatan ulang yang akan digunakan. Nilai yang ditentukan di sini akan menggantikan model pemeringkatan ulang yang dipilih saat basis pengetahuan dibuat. Nilai yang valid: gte-rerank-hybrid: Pemeringkatan resmi. gte-rerank: Pemeringkatan gte-rerank. Nilai default kosong, yang berarti menggunakan model pemeringkatan ulang yang dipilih saat basis pengetahuan dibuat. Jika Anda hanya membutuhkan pemeringkatan semantik, gunakan `gte-rerank`. Jika Anda membutuhkan pemeringkatan semantik dan fitur pencocokan teks untuk memastikan relevansi, kami merekomendasikan penggunaan `gte-rerank-hybrid`. Valid values: gte-rerank-hybrid : Pemeringkatan gte-rerank (hybrid) gte-rerank : Pemeringkatan gte-rerank	gte-rerank-hybrid
RerankMode	string	No	Parameter ini belum tersedia. Jangan kirim parameter ini. Valid values: similar: 相似模式。 : similar: 相似模式。 custom: 自定义模式。 : custom: 自定义模式。 qa:（默认值）问答模式。 : qa:（默认值）问答模式。	qa
RerankInstruct	string	No	Parameter ini belum tersedia. Jangan kirim parameter ini.
RerankMinScore	number	No	Ambang batas kesamaan. Ambang batas ini menunjukkan skor kesamaan minimum yang diizinkan untuk potongan teks yang ditarik kembali. Parameter ini digunakan untuk memfilter potongan teks yang dikembalikan oleh model peringkat, yang berarti hanya potongan teks dengan skor melebihi nilai ini yang akan ditarik kembali. Rentang nilai: [0.01-1.00]. Parameter ini memiliki prioritas lebih tinggi daripada konfigurasi ambang batas kesamaan pada basis pengetahuan. Jika tidak ada nilai spesifik yang diberikan, ambang batas kesamaan yang dikonfigurasi untuk basis pengetahuan akan digunakan secara default.	0.20
RerankTopN	integer	No	Data Top N yang dikembalikan setelah pemeringkatan ulang. Rentang nilai: [1-20]. Nilai default: 5.	5
Rewrite	array<object>	No	Konfigurasi penulisan ulang percakapan multi-giliran.
	object	No	Objek konfigurasi penulisan ulang percakapan multi-giliran.
ModelName	string	No	Nama model penulisan ulang percakapan multi-giliran. Model ini secara otomatis menyesuaikan prompt input asli (pertanyaan pengguna) berdasarkan konteks percakapan untuk meningkatkan efektivitas pengambilan. Nilai yang valid: conv-rewrite-qwen-1.8b: Model conv-rewrite-qwen-1.8b (saat ini merupakan satu-satunya model yang didukung). Nilai default kosong, yang berarti menggunakan model conv-rewrite-qwen-1.8b. Valid values: conv-rewrite-qwen-1.8b : Model conv-rewrite-qwen-1.8b	conv-rewrite-qwen-1.8b
SparseSimilarityTopK	integer	No	Top K pengambilan kata kunci, yang menemukan potongan teks di basis pengetahuan yang sama persis dengan kata kunci dari teks masukan. Parameter ini membantu menyaring potongan teks yang tidak relevan dan memberikan hasil yang lebih akurat. Rentang nilai: [0-100]. Jumlah `DenseSimilarityTopK` dan `SparseSimilarityTopK` harus kurang dari atau sama dengan 200. Nilai default: 100.	100
IndexId	string	Yes	ID basis pengetahuan, yaitu `Data.Id` yang dikembalikan oleh API CreateIndex. Pastikan basis pengetahuan yang sesuai telah berhasil dibuat dan tidak dihapus.	5pwe0mxxxx
SaveRetrieverHistory	boolean	No	Menentukan apakah data pengujian penarikan kembali potongan teks historis akan disimpan. Nilai yang valid: true: Simpan. false: Jangan simpan. Nilai default: false.	false
SearchFilters	array<object>	No	Mendukung pengaturan kondisi pengambilan yang dipersonalisasi (seperti tag) melalui SearchFilter untuk memfilter hasil pengambilan semantik dan mengecualikan informasi yang tidak terkait dengan kueri. Atur parameter is_displayed_chunk_content ke true untuk mengaktifkan logika pemfilteran. Untuk detailnya, lihat SearchFilters Basis Pengetahuan.
	object	No	Objek kondisi pengambilan.
	string	No
Images	array	No	Mendukung pengiriman alamat URL gambar saat mengajukan pertanyaan.
	string	No	Saat melakukan pengambilan dari basis pengetahuan Tanya-Jawab gambar, Anda dapat mengirimkan alamat URL gambar. Jika basis pengetahuan memiliki indeks gambar, sistem mengonversi gambar masukan menjadi vektor dan mengambil rekaman yang relevan. Jika tidak ada indeks gambar, gambar masukan tidak akan digunakan untuk pengambilan. Bidang ini tidak mendukung basis pengetahuan pencarian dokumen atau kueri data (mengirimnya tidak akan berpengaruh). Pastikan tautan dapat diakses publik dan mengarah ke berkas gambar yang valid. Contoh format: https://example.com/downloads/pic.jpg	https://example.com/downloads/pic.jpg
QueryHistory	array<object>	No	Penulisan Ulang Percakapan Multi-giliran mendukung pengiriman riwayat percakapan yang Anda kelola sendiri. Parameter ini hanya berlaku jika EnableRewrite=true (jika tidak, tidak akan berpengaruh meskipun dikirim).
	object	No
role	string	No	Peran. Nilai yang valid: user: Ketika peran ini dikirim, content mewakili teks yang Anda masukkan ke aplikasi Alibaba Cloud Model Studio. assistant: Ketika peran ini dikirim, content mewakili respons dari aplikasi Alibaba Cloud Model Studio.	user
content	string	No	Konten pertanyaan atau jawaban yang sesuai dengan peran.	代表一段文本。
Extra	object	No
uniqueId	string	No

Elemen respons

Element	Type	Description	Example
	object
Code	string	Kode status kesalahan.	Index.InvalidParameter
Data	object	Bidang data bisnis dari API.
Nodes	array<object>	Daftar potongan teks yang cocok.
	object	Objek potongan teks.
Metadata	any	A map of the text segment's metadata. In the metadata map for an unstructured knowledge base, the `file_path` field is meaningless. Do not use this field in your business code. When you retrieve data from an unstructured knowledge base, if a segment contains an image, the image URL is provided in the `image_url` field of the metadata map, along with an expiration time.	{ "parent": "", "file_path": "https://*", "image_url": [ "http://" ], "nid": "", "title": "阿里云百炼文档", "doc_id": "doc_", "content": "阿里云百炼是基于通义大模型、行业大模型以及三方大模型的一站式大模型开发平台。面向企业客户和个人开发者，提供完整的模型服务工具和全链路应用开发套件，预置丰富的能力插件，提供API及SDK等便捷的集成方式，高效完成大模型应用构建", "workspace_id": "ws_", "hier_title": "阿里云百炼文档", "doc_name": "阿里云百炼文档介绍.pdpf", "pipeline_id": "rhd", "_id": "ws_**" }
Score	number	The similarity score of the text segment. The value is in the range of [0, 1].	0.3
Text	string	The content of the text segment.	阿里云百炼是基于通义大模型、行业大模型以及三方大模型的一站式大模型开发平台。面向企业客户和个人开发者，提供完整的模型服务工具和全链路应用开发套件，预置丰富的能力插件，提供API及SDK等便捷的集成方式，高效完成大模型应用构建。
Message	string	Pesan kesalahan.	Required parameter(%s) missing or invalid, please check the request parameters.
RequestId	string	ID permintaan.	17204B98-7734-4F9A-8464-2446A84821CA
Status	string	Kode status yang dikembalikan oleh API.	200
Success	boolean	Menunjukkan apakah panggilan API berhasil. Nilai yang memungkinkan: true: Berhasil. false: Gagal.	true

Contoh

Respons sukses

JSONformat

{
  "Code": "Index.InvalidParameter",
  "Data": {
    "Nodes": [
      {
        "Metadata": "{\n  \"parent\": \"\",\n  \"file_path\": \"https://***\",\n  \"image_url\": [\n    \"http://***\"\n  ],\n  \"nid\": \"***\",\n  \"title\": \"阿里云百炼文档\",\n  \"doc_id\": \"doc_***\",\n  \"content\": \"阿里云百炼是基于通义大模型、行业大模型以及三方大模型的一站式大模型开发平台。面向企业客户和个人开发者，提供完整的模型服务工具和全链路应用开发套件，预置丰富的能力插件，提供API及SDK等便捷的集成方式，高效完成大模型应用构建\",\n  \"workspace_id\": \"ws_***\",\n  \"hier_title\": \"阿里云百炼文档\",\n  \"doc_name\": \"阿里云百炼文档介绍.pdpf\",\n  \"pipeline_id\": \"rhd***\",\n  \"_id\": \"ws_***\"\n}",
        "Score": 0.3,
        "Text": "阿里云百炼是基于通义大模型、行业大模型以及三方大模型的一站式大模型开发平台。面向企业客户和个人开发者，提供完整的模型服务工具和全链路应用开发套件，预置丰富的能力插件，提供API及SDK等便捷的集成方式，高效完成大模型应用构建。"
      }
    ]
  },
  "Message": "Required parameter(%s) missing or invalid, please check the request parameters.",
  "RequestId": "17204B98-7734-4F9A-8464-2446A84821CA",
  "Status": "200",
  "Success": true
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.