OpenSearch:Penyematan teks sparse

Nama layanan	ID Layanan	Deskripsi	Batas QPS
OpenSearch sparse text embedding service-001	ops-text-sparse-embedding-001	Bahasa yang didukung: 100+ Panjang input maksimum: 8.192 token	50 Catatan Untuk meminta batas QPS API yang lebih tinggi, kirimkan tiket ke dukungan teknis.

Prasyarat

• Dapatkan kredensial otentikasi

  Platform terbuka AI Search memerlukan Kunci API untuk otentikasi. Untuk petunjuknya, lihat Dapatkan Kunci API.

• Dapatkan Titik Akhir layanan

  Anda dapat memanggil layanan melalui jaringan publik atau VPC. Untuk detailnya, lihat Dapatkan Titik Akhir layanan.

Catatan penggunaan

• Ukuran badan permintaan tidak boleh melebihi 8 MB.

Metode permintaan

POST

URL

{host}/v3/openapi/workspaces/{workspace_name}/text-sparse-embedding/{service_id} 

Parameter URL

• host: Titik Akhir layanan. Anda dapat memanggil layanan API melalui internet atau melalui VPC. Untuk informasi selengkapnya, lihat Dapatkan Titik Akhir layanan.

  Di halaman API Keys pada Konsol, Anda dapat melihat domain API internet dan VPC di bagian Access Domain Name. Format nama domain adalah http://<instance_id>.opensearch.aliyuncs.com (HTTPS juga didukung). Domain API VPC berlaku untuk lingkungan VPC di wilayah China (Shanghai), China (Hangzhou), China (Shenzhen), China (Beijing), China (Zhangjiakou), dan China (Qingdao).

• workspace_name: Nama ruang kerja. Contoh: default.

• service_id: ID layanan bawaan. Contoh: ops-text-sparse-embedding-001.

Parameter permintaan

Parameter header

Otentikasi menggunakan Kunci API

Parameter	Tipe	Wajib	Deskripsi	Contoh
Content-Type	String	Ya	Jenis media permintaan. Atur nilai ini ke application/json.	application/json
Authorization	String	Ya	Kunci API untuk otentikasi. Formatnya adalah Bearer <your_api_key>.	Bearer OS-d1**2a

Parameter badan

Parameter	Tipe	Wajib	Deskripsi	Contoh
input	Array/String	Ya	Teks input untuk disematkan, disediakan sebagai string atau array string. Satu permintaan dapat berisi hingga 32 entri. Panjang maksimum setiap entri bergantung pada model. String kosong tidak didukung.	["Science and technology are the primary productive forces", "OpenSearch product documentation"]
input_type	String	Tidak	Tipe input. Nilai yang valid: query document Nilai default adalah document.	document
return_token	boolean	Tidak	Menentukan apakah teks yang telah ditokenisasi dikembalikan. Nilai yang valid: true: Teks yang telah ditokenisasi dikembalikan. false: Teks yang telah ditokenisasi tidak dikembalikan. Nilai default adalah false.	false

Parameter respons

Parameter	Tipe	Deskripsi	Contoh
request_id	String	ID unik untuk panggilan API.	B4AB89C8-B135-****-A6F8-2BAB801A2CE4
latency	Float/Int	Latensi permintaan dalam milidetik (ms).	10
usage	Object	Informasi penggunaan untuk panggilan tersebut.	"usage": { "token_count": 11 }
usage.token_count	Int	Jumlah token.	11
result.sparse_embeddings	List	Hasil penyematan. Ini adalah array objek, dengan setiap objek sesuai dengan item dalam array input.	[ { "index": 0, "embedding": [{ "tokenId": 6, "weight": 0.10137939453125 }] }, { "index": 1, "embedding": [{ "tokenId": 9803, "weight": 0.1951904296875 }] } ]
result.sparse_embeddings[].index	Int	Indeks teks yang sesuai dalam array input.	0
result.sparse_embeddings[].embedding	List	Hasil penyematan sparse.	[ { "token":"test", "token_id": 900, "weight":0.423 }]
result.sparse_embeddings[].embedding[].token	String	Token teks. Bidang ini hanya dikembalikan ketika return_token diatur ke true dalam permintaan.	"xxx"
result.sparse_embeddings[].embedding[].token_id	Int	ID token.	123
result.sparse_embeddings[].embedding[].weight	Float	Bobot.	0.121

Contoh cURL

curl -XPOST -H "Content-Type: application/json" \
"http://****-hangzhou.opensearch.aliyuncs.com/v3/openapi/workspaces/default/text-sparse-embedding/ops-text-sparse-embedding-001" \
-H "Authorization: Bearer <your_api_key>" \
-d '{
    "input": [
          "Science and technology are the primary productive forces", 
          "OpenSearch product documentation"
    ], 
    "input_type": "query", 
    "return_token": false
}'</your_api_key>

Contoh respons

Respons berhasil

{
	"request_id": "75C50B5B-E79E-4930-****-F48DBB392231",
	"latency": 22,
	"usage": {
		"token_count": 11
	},
	"result": {
		"sparse_embeddings": [
			{
				"index": 0,
				"embedding": [
					{
						"tokenId": 6,
						"weight": 0.10137939453125
					},
					{
						"tokenId": 163040,
						"weight": 0.2841796875
					},
					{
						"tokenId": 354,
						"weight": 0.1431884765625
					},
					{
						"tokenId": 5998,
						"weight": 0.161376953125
					},
					{
						"tokenId": 8550,
						"weight": 0.2388916015625
					},
					{
						"tokenId": 2017,
						"weight": 0.1614990234375
					}
				]
			},
			{
				"index": 1,
				"embedding": [
					{
						"tokenId": 9803,
						"weight": 0.1951904296875
					},
					{
						"tokenId": 86250,
						"weight": 0.317138671875
					},
					{
						"tokenId": 5889,
						"weight": 0.17529296875
					},
					{
						"tokenId": 2564,
						"weight": 0.11614990234375
					},
					{
						"tokenId": 59529,
						"weight": 0.1666259765625
					}
				]
			}
		]
	}
}

Respons error

Jika terjadi error, respons berisi bidang code dan message yang menjelaskan error tersebut.

{
    "request_id": "45C8C9E5-6BCB-****-80D3-E298F788512B",
    "latency": 0,
    "code": "InvalidParameter",
    "message": "JSON parse error: Unexpected character ..."
}

Kode status

Untuk informasi selengkapnya, lihat Kode status di AI Search Open Platform.