Gunakan API Penyematan & Peringkat Ulang Kustom untuk OpenSearch - OpenSearch

Topik ini menjelaskan cara memanggil layanan penyebaran kustom melalui API.

Informasi Umum

URI

Buka Service Deployment > Manage untuk mendapatkan nama domain akses (Nama domain Internet atau jaringan pribadi).

Header

Content-Type: application/json
Authorization: Bearer ${workspace API key}
Token: ${service deployment Token}, seperti yang ditunjukkan pada gambar di atas, Anda bisa mendapatkannya dari Service Deployment > Call Information.

Model penyematan multimodal

Parameter permintaan

Nama bidang

Tipe

Deskripsi

Contoh

type

String

Nilai valid:

text: teks.
image: citra.

image

data

List[String]

Setiap elemen mewakili teks yang akan diubah menjadi vektor atau sebuah citra. Kami menyarankan agar tidak menyertakan lebih dari 16 citra dalam satu permintaan. Citra mendukung format png dan jpeg, dalam format data:image/{format};base64,{base64_image}

Jenis citra:
["data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAoHCB..."]
Jenis teks:
["a", "b", "c"]

Contoh permintaan

curl -X POST \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Your API Key" \
-H "Token: Replace with service deployment Token" \
"http://xxxxxx.opensearch.aliyuncs.com/v3/openapi/xxxxxx" \
-d '{
  "type": "image",
  "data": ["data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAoHCB..."]
}'

Catatan

Anda tidak dapat mencampur teks dan citra dalam satu permintaan.

Contoh respons

{
	"embeddings": [{
			"index": 0,
			"embedding": [0.02272411249577999, -0.0535903535783],
			"type": "image"
		}, {
			"index": 1,
			"embedding": [0.02272411249577999, -0.0535903535783],
			"type": "image"
		}
	]
}

API penyematan teks

Parameter permintaan

Nama parameter	Tipe	Diperlukan	Posisi	Deskripsi	Contoh
input	Array/String	Ya	body	Mendukung beberapa input teks, hingga 16 per permintaan. Panjang setiap teks bergantung pada model yang dipilih. String kosong tidak didukung.	["Ilmu pengetahuan dan teknologi adalah kekuatan produktif utama","dokumentasi produk opensearch"]
input_type	String	Tidak	body	Menentukan tipe data dari input, nilai valid: kueri dokumen Nilai default: dokumen	dokumen
dimension	Int	Tidak	body	Dimensi keluaran. Catatan Parameter ini berlaku hanya ketika model yang diterapkan adalah model kustom dengan pengurangan dimensionalitas vektor yang diaktifkan, dan nilainya tidak boleh lebih besar dari dimensi model dasar.	567

Contoh permintaan

curl -X POST \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Your API Key" \
-H "Token: Replace with service deployment Token" \
"http://xxxxxx.opensearch.aliyuncs.com/v3/openapi/xxxxxx" \
-d '{
  "input":[
    "Ilmu pengetahuan dan teknologi adalah kekuatan produktif utama",
    "dokumentasi produk opensearch"
  ],
  "input_type" : "document",
  "dimension": 567 # Ini berlaku hanya ketika pelatihan pengurangan dimensionalitas vektor diaktifkan, dan dimensinya tidak boleh lebih besar dari model dasar
}'

Parameter respons

Bidang	Tipe	Deskripsi	Contoh
embeddings	List	Keluaran dari permintaan. Parameter ini adalah array. Setiap elemen dari array sesuai dengan segmen teks masukan.	`[ { "index": 0, "embedding": [0.003143,0.009750,omitted,-0.017395] }, {} ]`
embeddings[].index	Int	Nomor urut teks permintaan yang sesuai dalam input.	0
embeddings[].embedding	List(Double)	Hasil vektorisasi.	[0.003143,0.009750,omitted,-0.017395]

Contoh respons

{
    "embeddings":[
        {
            "index":0,
            "embedding":[0.003143,0.009750,...,-0.017395]
        },
        {
            "index":1,
            "embedding":[]
        }
    ]
}

API Reranker

Parameter permintaan

Nama parameter	Tipe	Diperlukan	Posisi	Deskripsi
query	String[]	Ya	body	Konten kueri.
docs	List<String>	Ya	body	Beberapa konten dokumen, tidak melebihi 16 dokumen.

Contoh permintaan

curl -X POST \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Your API Key" \
-H "Token: Replace with service deployment Token" \
"http://xxxxxx.opensearch.aliyuncs.com/v3/openapi/xxxxxx" \
-d '{
    "query": "dokumentasi produk opensearch",
    "docs": [
        "dokumentasi produk opensearch",
        "dokumentasi produk elasticsearch"
    ]
}'

Parameter respons

Nama parameter	Tipe parameter	Deskripsi	Contoh
scores	List<Double>	Skor untuk setiap dokumen dalam docs	[0.9860338568687439,0.793461263179779]

Contoh respons

{
    "scores":[
        0.9999276399612427,
        0.8209319710731506
    ]
}

Kode status

Untuk informasi lebih lanjut, lihat kode status Platform Terbuka AI Search.