Penyematan teks jarang - OpenSearch

Platform Pencarian Terbuka AI OpenSearch memungkinkan Anda menggunakan layanan penyematan teks jarang dengan memanggil API. Layanan ini dapat mengonversi data teks menjadi vektor jarang, yang menempati ruang penyimpanan lebih kecil dan biasanya digunakan untuk menyatakan informasi kata kunci serta frekuensi kata. Vektor jarang dapat digabungkan dengan vektor padat untuk pengambilan hibrida guna meningkatkan efektivitas pengambilan.

Layanan	ID	Deskripsi	Batas QPS untuk pemanggilan API (Akun Alibaba Cloud dan Pengguna RAM)
Penyematan teks jarang OpenSearch	ops-text-sparse-embedding-001	Bahasa yang didukung: lebih dari 100 bahasa Panjang maksimum teks input: 8.192 token	50 Catatan Untuk mengajukan QPS yang lebih tinggi, ajukan tiket.

Prasyarat

Informasi otentikasi telah diperoleh.
Saat memanggil layanan Platform Pencarian Terbuka AI 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.

Catatan penggunaan

Badan permintaan tidak boleh melebihi ukuran 8 MB.

Metode permintaan

POST

URL

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

Parameter URL

host: Titik akhir yang digunakan untuk memanggil Operasi API. Anda dapat memanggil Operasi API melalui Internet atau virtual private cloud (VPC). Untuk informasi lebih lanjut tentang cara mendapatkan titik akhir, lihat Kueri Titik Akhir Layanan.
workspace_name: Nama ruang kerja. Contoh: default.
service_id: ID layanan yang ingin digunakan. Contoh: ops-text-sparse-embedding-001.

Parameter permintaan

Parameter Header

Otentikasi Kunci API

Parameter	Tipe	Diperlukan	Deskripsi	Contoh
Content-Type	String	Ya	Jenis permintaan. Atur nilainya ke application/json.	application/json
Authorization	String	Ya	Kunci API.	Bearer OS-d1**2a

Parameter Body

Parameter	Tipe	Diperlukan	Deskripsi	Contoh
input	Array/String	Ya	Entri teks input. Setiap permintaan dapat berisi hingga 32 entri. Panjang entri ditentukan oleh model yang Anda pilih. String kosong tidak didukung.	["Ilmu pengetahuan dan teknologi adalah kekuatan produktif utama","Dokumentasi produk OpenSearch"]
input_type	String	Tidak	Tipe data dari input. Nilai valid: kueri dokumen Nilai default: dokumen.	dokumen
return_token	boolean	Tidak	Menentukan apakah akan mengembalikan penyematan. Nilai valid: true false Nilai default: false.	false

Parameter tanggapan

Parameter	Tipe	Deskripsi	Contoh
request_id	String	ID permintaan.	B4AB89C8-B135-****-A6F8-2BAB801A2CE4
latency	Float/Int	Waktu yang dikonsumsi untuk permintaan, dalam milidetik.	10
usage	Object	Informasi metering tentang panggilan saat ini.	"usage": { "token_count": 11 }
usage.token_count	Int	Jumlah token.	11
result.sparse_emebddings	List	Keluaran algoritma yang digunakan dalam permintaan. Nilainya adalah daftar array. Setiap array berisi keluaran algoritma untuk entri teks input.	[ { "index": 0, "embedding": [{ "tokenId": 6, "weight": 0.10137939453125 }] }, { "index": 1, "embedding": [{ "tokenId": 9803, "weight": 0.1951904296875 }] } ]
result.sparse_embeddings[].index	Int	Nomor urutan entri teks input dalam permintaan.	0
result.sparse_embeddings[].embedding	List	Hasil penyematan jarang.	[ { "token":"test", "token_id": 900, "weight":0.423 }]
result.sparse_embeddings[].embedding[].token	String	Token teks. Parameter ini dikembalikan jika return_token diatur ke true.	"xxx"
result.sparse_embeddings[].embedding[].token_id	Int	ID token.	123
result.sparse_embeddings[].embedding[].weight	Float	Bobot.	0.121

Permintaan Curl contoh

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\": [
          \"Ilmu pengetahuan dan teknologi adalah kekuatan produktif utama\", 
          "Dokumentasi produk OpenSearch"
    ], 
    \"input_type\": \"query\", 
    \"return_token\": false
}"

Tanggapan contoh

Tanggapan sukses contoh

{
	"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
					}
				]
			}
		]
	}
}

Tanggapan kesalahan contoh

Jika terjadi kesalahan dalam permintaan API, kode kesalahan dan pesan kesalahan yang sesuai dikembalikan melalui parameter code dan message.

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

Kode kesalahan

Untuk daftar kode kesalahan, lihat Kode Status.