Referensi API layanan Penerapan kustom - OpenSearch - Alibaba Cloud Documentation Center

Topik ini menjelaskan cara memanggil layanan Penerapan kustom Anda.

Informasi umum

Titik akhir

Dapatkan titik akhir (internet atau jaringan pribadi) dari halaman Service Deployment di Konsol.

Pada kolom Tindakan untuk layanan target, klik Call Information. Kotak dialog yang muncul menampilkan internet endpoint, private network endpoint, dan access token yang sesuai.

Header

Content-Type: application/json
Authorization: Bearer ${your_workspace_api_key}
Token: ${your_service_deployment_token}. Dapatkan token ini dari Service Deployment > Call Information.

Model penyematan multimodal

Parameter permintaan

Parameter

Tipe

Deskripsi

Contoh

type

String

Nilai yang valid:

text: Menentukan bahwa input berupa teks.
image: Menentukan bahwa input berupa gambar.

image

data

List[String]

Setiap elemen berisi teks atau gambar yang akan dikonversi menjadi embedding. Kami merekomendasikan mengirimkan maksimal 16 gambar per permintaan. Format gambar yang didukung adalah PNG dan JPEG. Format yang diperlukan adalah data:image/{format};base64,{base64_image}.

Untuk gambar:

["data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAoHCB..."]
Untuk teks:

["a", "b", "c"]

Contoh permintaan

curl -X POST \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <your_workspace_api_key>" \
-H "Token: <your_service_deployment_token>" \
"http://xxxxxx.opensearch.aliyuncs.com/v3/openapi/xxxxxx" \
-d '{
  "type": "image",
  "data": ["data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAoHCB..."]
}'

Catatan

Satu permintaan tidak boleh berisi input teks dan gambar secara bersamaan.

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

Parameter	Tipe	Wajib	Lokasi	Deskripsi	Contoh
input	Array/String	Ya	body	Input teks yang akan dikonversi. Maksimal 16 input diperbolehkan per permintaan. Panjang maksimum setiap input tergantung pada model yang dipilih. String kosong tidak didukung.	["Science and technology are primary productive forces", "Open Search product documentation"]
input_type	String	Tidak	body	Menentukan tipe data dari `input`. Nilai yang valid: `query` `document` Nilai default adalah `document`.	document
dimension	Int	Tidak	body	Dimensi vektor output. Catatan Parameter ini hanya berlaku untuk model kustom yang telah mengaktifkan pengurangan dimensi vektor. Dimensi yang ditentukan tidak boleh melebihi dimensi model dasar.	567

Contoh permintaan

curl -X POST \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <your_workspace_api_key>" \
-H "Token: <your_service_deployment_token>" \
"http://xxxxxx.opensearch.aliyuncs.com/v3/openapi/xxxxxx" \
-d '{
  "input":[
    "Science and technology are primary productive forces",
    "Open Search product documentation"
  ],
  "input_type" : "document",
  "dimension": 567 # Parameter ini hanya berlaku jika pengurangan dimensi vektor diaktifkan pada model. Nilainya tidak boleh melebihi dimensi model dasar.
}'

Parameter respons

Parameter	Type	Deskripsi	Contoh
embeddings	List	Array objek, di mana setiap objek berisi embedding hasil untuk teks input yang sesuai.	`[ { "index": 0, "embedding": [0.003143,0.009750,...,-0.017395] }, {} ]`
embeddings[].index	Int	Indeks teks yang sesuai dalam array `input`.	0
embeddings[].embedding	List(Double)	Vektor embedding hasil.	[0.003143,0.009750,...,-0.017395]

Contoh respons

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

API Reranker

Parameter permintaan

Parameter	Tipe	Wajib	Lokasi	Deskripsi
query	String[]	Ya	body	Konten kueri.
docs	List<String>	Ya	body	Dokumen yang akan direrank berdasarkan kueri. Maksimal 16 dokumen diperbolehkan per permintaan.

Contoh permintaan

curl -X POST \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <your_workspace_api_key>" \
-H "Token: <your_service_deployment_token>" \
"http://xxxxxx.opensearch.aliyuncs.com/v3/openapi/xxxxxx" \
-d '{
    "query": "Open Search product documentation",
    "docs": [
        "Open Search product documentation",
        "Elasticsearch product documentation"
    ]
}'

Parameter respons

Parameter	Tipe	Deskripsi	Contoh
scores	List<Double>	Skor untuk setiap dokumen dalam array `docs`.	[0.9860338568687439,0.793461263179779]

Contoh respons

{
    "scores":[
        0.9999276399612427,
        0.8209319710731506
    ]
}

Kode status

Untuk informasi lebih lanjut, lihat kode status untuk Open Search.