OpenAI相容文本向量化 - OpenSearch

本文介紹OpenAI相容文本向量化服務的API參數配置。

URL

{host}/compatible-mode/v1/embeddings

host：調用服務的地址，支援通過公網和VPC兩種方式調用API服務，可參見擷取服務接入地址。

AI apikey截圖.png

請求參數

參數

類型

必填

描述

樣本值

model

String

是

指定的服務ID。

系統服務ID：（以ops-開頭）

支援的服務ID請參見支援的服務列表。

ops-text-embedding-001

input

Array/String

是

支援多條文本輸入，每次請求最多32 條；每條的長度大小取決於選擇的模型。不支援空的字串。

["科學技術是第一生產力"，"opensearch產品文檔"]

響應參數

參數	類型	描述	樣本值
data	List	返回資料資訊。	-
data.embedding	Array[float]	embedding的處理結果，返迴向量化的數組。	[ 0.003143, 0.009750, (1536 floats total ops-text-embedding-001), -0.017395 ]
data.index	Int	序號，對應請求input中的下標，從0開始。	0
data.object	String	固定值embedding。	embedding
object	String	回包類型，固定值list。	list
model	String	請求中指定的服務ID。	ops-text-embedding-001
usage	Object	本次模型調用的Token數量統計。	-
usage.prompt_tokens	Int	使用者請求大模型輸入的內容轉換後的Token數量。	5
usage.total_tokens	Int	總Token用量，usage.prompt_tokens與usage.completion_tokens的總和。	5

CURL樣本

curl http://xxxx-shanghai.opensearch.aliyuncs.com/compatible-mode/v1/chat/embeddings \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer 您的API-Key" \
  -d '{
    "model": "ops-text-embedding-001",
    "input": "搜尋開發平台"
  }'

響應樣本

{
  "id":"9085118afe14bee71d59c4a609fcf7c0",
  "object":"list",
  "data":
    [
        {
          "object":"embedding",
          "embedding":
              [
                  0.0021381378173828125,
                  0.12109375,
                  .......,
                  -0.0389404296875
               ],
             "index":0
            }
       ],
     "model":"ops-text-embedding-001",
     "usage":
         {
            "prompt_tokens":5,
            "total_tokens":5
          }
   }

狀態代碼說明

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