Platform AI Search Terbuka memungkinkan Anda memanggil layanan penilaian relevansi dokumen melalui API. Anda dapat mengintegrasikan layanan ini ke dalam alur kerja bisnis untuk meningkatkan kinerja pengambilan data.
Nama Layanan | ID Layanan | Deskripsi Layanan | Batas QPS pada pemanggilan API (Akun Alibaba Cloud dan Pengguna RAM) |
Model penyusunan ulang BGE | ops-bge-reranker-larger | Menyediakan layanan penilaian dokumen berdasarkan model BGE. Model ini dapat menyusun peringkat dokumen berdasarkan relevansi antara kueri dan konten dokumen, dari skor tertinggi hingga terendah, serta mengeluarkan hasil penilaian yang sesuai. Model ini mendukung bahasa Cina dan Inggris dengan panjang token input maksimum 512 (kueri + dokumen). | 20 Catatan Untuk mengajukan QPS lebih tinggi, ajukan tiket. |
Model penyusunan ulang teks OpenSearch-001 | ops-text-reranker-001 | Model penyusunan ulang yang dikembangkan oleh OpenSearch yang mengintegrasikan pelatihan dari berbagai dataset industri untuk memberikan layanan penyusunan ulang berkualitas tinggi. Model ini dapat menyusun peringkat dokumen berdasarkan relevansi semantik antara kueri dan dokumen, dari tertinggi hingga terendah. Model ini mendukung bahasa Cina dan Inggris dengan panjang token input maksimum 512 (kueri + dokumen). | |
Layanan peringkat Qwen3-0.6B | ops-qwen3-reranker-0.6b | Layanan penyusunan ulang dokumen seri Qwen3, mendukung lebih dari 100 bahasa, dengan panjang token input maksimum 32k (kueri + dokumen) dan 0.6B parameter. |
Persyaratan awal
Informasi otentikasi telah diperoleh.
Saat memanggil layanan Platform AI Search Terbuka menggunakan API, Anda perlu mengotentikasi identitas pemanggil.
Alamat akses layanan telah diperoleh.
Anda dapat memanggil layanan melalui Internet atau virtual private cloud (VPC). Untuk informasi lebih lanjut, lihat Dapatkan Alamat Pendaftaran Layanan.
Deskripsi permintaan
Deskripsi umum
Badan permintaan tidak boleh melebihi 8 MB.
Metode permintaan
POST
URL
{host}/v3/openapi/workspaces/{workspace_name}/ranker/{service_id} Deskripsi Parameter:
host: Titik akhir layanan. Anda dapat memanggil layanan API melalui Internet atau melalui VPC. Untuk informasi lebih lanjut, lihat Dapatkan Alamat Pendaftaran Layanan.
workspace_name: Nama ruang kerja, seperti default.
service_id: ID layanan bawaan, misalnya ops-bge-reranker-larger.
Parameter permintaan
Parameter header
Otentikasi API-KEY
Parameter | Tipe | Diperlukan | Deskripsi | Nilai contoh |
Content-Type | String | Ya | Jenis permintaan: application/json | application/json |
Authorization | String | Ya | API-Key | Bearer OS-d1**2a |
Parameter body
Parameter | Tipe | Diperlukan | Deskripsi | Nilai contoh |
kueri | String | Ya | Konten kueri. | Apa saja tempat menyenangkan di Shanghai? |
dokumen | List<String> | Ya | Konten dokumen (daftar). | ["Ada banyak tempat menyenangkan di Shanghai", "Ada banyak tempat menyenangkan di Beijing"] |
Parameter tanggapan
Parameter | Tipe | Deskripsi | Nilai contoh |
request_id | String | ID permintaan. | A5B25952-4406-45BF-99EC-E8020246**** |
latensi | Float/Int | Latensi permintaan. Satuan: ms. | 10 |
usage.doc_count | Int | Jumlah dokumen masukan dalam permintaan ini. | 2 |
result.scores | List<score> | Hasil peringkat dokumen berdasarkan skor dari tertinggi hingga terendah. | [ { "index":1, "score":0.99 }, { "index":2, "score":0.05 } ] |
result.scores[].index | Int | Nilai indeks posisi dokumen ini dalam array dokumen kandidat masukan. | 1 |
result.scores[].score | Float | Hasil penilaian. Nilai yang lebih tinggi menunjukkan relevansi yang lebih tinggi. | 0.99 |
Contoh permintaan Curl
curl -XPOST -H"Content-Type: application/json"
"http://****-hangzhou.opensearch.aliyuncs.com/v3/openapi/workspaces/default/ranker/ops-bge-reranker-larger"
-H "Authorization: Bearer your API-KEY"
-d "{
\"query\":\"opensearch documentation\",
\"docs\":[
\"what is opensearch\",
\"what is LLM-based conversational search edition\",
\"What is the advantage of LLM-based conversational search edition\"
]
}"Contoh tanggapan
Contoh tanggapan normal
{
"request_id":"24B004E0-ADEF-****-879B-F28359BFAD1D",
"latency":19,
"usage":{
"doc_count":3
},
"result":{
"scores":[
{
"index":0,"score":0.45026873385713345
},
{
"index":1,"score":1.1412238544346029E-4
},
{
"index":2,"score":8.029784284533197E-5
}
]
}
}Contoh tanggapan abnormal
Jika terjadi kesalahan selama permintaan akses, keluaran akan menentukan alasan kesalahan melalui kode dan pesan.
{
"request_id": "45C8C9E5-6BCB-****-80D3-E298F788512B",
"latency": 0,
"code": "InvalidParameter",
"message": "JSON parse error: Unexpected character ..."
}Kode status
Untuk informasi lebih lanjut, lihat Kode Status.