AI搜尋開放平台支援通過API的方式調用文本向量服務,您可以使用下面服務將文本資料轉化為稠密向量形式表達,可用於資訊檢索、文本分類、相似性比較等情境。
服務名稱 | 服務ID | 服務描述 | API調用QPS限制(含主帳號與RAM子帳號) |
OpenSearch通用文本向量服務-001 | ops-text-embedding-001 |
| 50 說明 如需擴充QPS,請通過工單聯絡支援人員協助。 |
OpenSearch文本向量服務-中文-001 | ops-text-embedding-zh-001 |
| |
OpenSearch文本向量服務-英文-001 | ops-text-embedding-en-001 |
| |
OpenSearch通用文本向量服務-002 | ops-text-embedding-002 | 相比001模型支援更多語言,同時在Retrieval任務中表現更佳
| |
GTE文本向量-多語言-Base | ops-gte-sentence-embedding-multilingual-base |
| |
Qwen3文本向量-0.6B | ops-qwen3-embedding-0.6b | Qwen3系列多語言(100+)文本向量化服務。
|
前提條件
擷取身份鑒權資訊
通過API調用AI搜尋開放平台服務時,需要對調用者身份進行鑒權,如何擷取鑒權資訊請參見擷取API-KEY。
擷取服務調用地址
支援通過公網和VPC兩種方式調用服務,詳情請參見擷取服務接入地址。
請求說明
公用說明
請求body最大不能超過8MB。
請求方式
POST
URL
{host}/v3/openapi/workspaces/{workspace_name}/text-embedding/{service_id} host:調用服務的地址,支援通過公網和VPC兩種方式調用API服務,可參見擷取服務接入地址。
workspace_name:工作空間名稱,例如default。
service_id: 系統內建服務id,例如ops-text-embedding-001。
請求參數
Header參數
API-KEY認證
參數 | 類型 | 必填 | 描述 | 樣本值 |
Content-Type | String | 是 | 請求類型:application/json | application/json |
Authorization | String | 是 | API-Key | Bearer OS-d1**2a |
Body參數
參數 | 類型 | 必填 | 描述 | 樣本值 |
input | Array/String | 是 | 輸入內容,支援多條文本輸入,每次請求最多 32 條,每一條的長度取決於選擇的模型。不支援Null 字元串。 | ["科學技術是第一生產力","opensearch產品文檔"] |
input_type | String | 否 | input的資料類型
| document |
返回參數
參數 | 類型 | 描述 | 樣本值 |
request_id | String | 系統對一次API調用賦予的唯一標識。 | B4AB89C8-B135-****-A6F8-2BAB801A2CE4 |
latency | Float/Int | 請求耗時,單位ms。 | 10 |
usage | Object | 本次調用產生的計量資訊。 | "usage": { "token_count": 3072 } |
usage.token_count | Int | Token數量。 | 3072 |
result.embeddings | List | 輸出embedding內容,是一個由結果組成的數組。 | [{ "index": 0, "embedding": [0.003143,0.009750,...,-0.017395] }, {}] |
result.embeddings[].index | Int | 對應請求文本在input中的序號。 | 0 |
result.embeddings[].embedding | List(Float) | 向量化結果。 | [0.003143,0.009750,省略,-0.017395] |
Curl請求樣本
curl -XPOST -H"Content-Type: application/json"
"http://****-hangzhou.opensearch.aliyuncs.com/v3/openapi/workspaces/default/text-embedding/ops-text-embedding-001"
-H "Authorization: Bearer 您的API-KEY"
-d "{
\"input\": [
\"科學技術是第一生產力\",
\"opensearch產品文檔\"
],
\"input_type\": \"query\"
}"響應樣本
正常響應樣本
{
"request_id": "B4AB89C8-B135-****-A6F8-2BAB801A2CE4",
"latency": 38,
"usage": {
"token_count": 3072
},
"result": {
"embeddings": [
{
"index": 0,
"embedding": [
-0.02868066355586052,
0.022033605724573135,
-0.0417383536696434,
-0.044081952422857285,
0.02141784131526947,
-8.240503375418484E-4,
-0.01309406291693449,
-0.02169642224907875,
-0.03996409475803375,
0.008053945377469063,
...
-0.05131729692220688,
-0.016595875844359398
]
}
]
}
}異常響應樣本
在訪問請求出錯的情況下,輸出的結果中會通過code和message指明出錯原因。
{
"request_id": "651B3087-8A07-****-B931-9C4E7B60F52D",
"latency": 0,
"code": "InvalidParameter",
"message": "JSON parse error: Cannot deserialize value of type `InputType` from String \"xxx\""
}狀態代碼說明
請參見AI搜尋開放平台狀態代碼說明。