自訂部署服務API參考 - OpenSearch

本文介紹如何通過API調用自訂部署服務。

公用說明

URI

從控制台上服務部署裡的管理頁面擷取訪問的網域名稱（公網或者私網網域名稱）。

Header

Content-Type: application/json
Authorization: Bearer ${工作空間的API Key}
Token: ${服務部署的Token}，參考上圖可以在服務部署>調用資訊中擷取。

多模態向量化模型

請求參數

欄位名

類型

描述

樣本

type

String

可選值：

text：文本。
image：圖片。

image

data

List[String]

每個元素代表一個需要向量化的文本或一張圖片。建議一次請求不要超過16個圖片。圖片支援png與jpeg，格式為data:image/{format};base64,{base64_image}

imgae類型：
["data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAoHCB..."]
text類型：
["a", "b", "c"]

請求樣本

curl -X POST \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 您的API Key" \
-H "Token: 替換為服務部署的Token" \
"http://xxxxxx.opensearch.aliyuncs.com/v3/openapi/xxxxxx" \
-d '{
  "type": "image",
  "data": ["data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAoHCB..."]
}'

說明

單個請求中不允許混合傳遞text與image。

響應樣本

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

文本向量化介面

請求參數

參數名	類型	是否必須	位置	描述	樣本
input	Array/String	是	body	支援多條文本輸入，每次請求最多 16 條；每一條的長度大小取決於選擇的模型。不支援空的字串。	["科學技術是第一生產力","opensearch產品文檔"]
input_type	String	否	body	指明input的資料類型，取值： query document 預設值為document	document
dimension	Int	否	body	輸出的維度。說明當部署的模型是定製的模型並開啟向量降維時才會生效，且不能大於基本模型的維度。	567

請求樣本

curl -X POST \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 您的API Key" \
-H "Token: 替換為服務部署的Token" \
"http://xxxxxx.opensearch.aliyuncs.com/v3/openapi/xxxxxx" \
-d '{
  "input":[
    "科學技術是第一生產力",
    "opensearch產品文檔"
  ],
  "input_type" : "document",
  "dimension": 567 # 當開啟向量降維訓練時，才會生效，且維度不能大於基本模型的維度
}'

返回參數

欄位	類型	描述	樣本
embeddings	List	本次請求的演算法輸出內容，是一個由結構組成的數組，每一個數組中包含一個對應的輸入 text 的演算法輸出內容。	`[ { "index": 0, "embedding": [0.003143,0.009750,省略,-0.017395] }, {} ]`
embeddings[].index	Int	對應請求文本在input中的序號。	0
embeddings[].embedding	List(Double)	向量化結果。	[0.003143,0.009750,省略,-0.017395]

響應樣本

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

reranker介面

請求參數

參數名	類型	是否必須	位置	描述
query	String[]	是	body	查詢內容。
docs	List<String>	是	body	多個文檔內容，不超過16個doc。

請求樣本

curl -X POST \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 您的API Key" \
-H "Token: 替換為服務部署的Token" \
"http://xxxxxx.opensearch.aliyuncs.com/v3/openapi/xxxxxx" \
-d '{
    "query": "opensearch產品文檔",
    "docs": [
        "opensearch產品文檔",
        "elasticsearch產品文檔"
    ]
}'

返回參數

參數名	參數類型	描述	樣本
scores	List<Double>	對應docs裡面每個doc分數	[0.9860338568687439,0.793461263179779]

響應樣本

{
    "scores":[
        0.9999276399612427,
        0.8209319710731506
    ]
}

狀態代碼說明

請參見AI搜尋開放平台狀態代碼說明。