使用TextEmbedding進行文本向量化-雲原生資料倉儲AnalyticDB-阿里雲

通過模型對文字文件進行向量化。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

gpdb:TextEmbedding

none

*DBInstance

acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}

無

請求參數

名稱	類型	必填	描述	樣本值
DBInstanceId	string	是	執行個體 ID。	gp-xxxxxxxxx
RegionId	string	是	執行個體所在的地區 ID。	cn-hangzhou
Model	string	否	向量模型，目前支援： text-embedding-v1：1536 維 text-embedding-v2：1536 維 text-embedding-v3（預設值）：1024 維、768 維、512 維 text2vec（不推薦）：1024 維 m3e-base（不推薦）：768 維 m3e-small（不推薦）：512 維	text-embedding-v3
Input	array	是	要向量化的常值內容列表，列表長度不能超過 100。
	string	否	要向量化的常值內容。長度不能超過 2048tokens。	ADBPG是什嗎？
Dimension	integer	否	向量維度。預設值是向量化演算法支援的維度。說明 text-embedding-v3 支援 1024 維、768 維、512 維，預設值為 1024。	1024

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	ABB39CC3-4488-4857-905D-2E4A051D0521
Message	string	資訊詳情。	Successful
Status	string	API 執行狀態，取值如下： success：執行成功。 fail：執行失敗。	success
TextTokens	integer	消耗的 tokens 總數。	1000
Results	object
Results	array<object>	向量結果清單。
	array<object>	結果詳情。
Embedding	object
Embedding	array	向量值列表。
	number	向量值。	0.1234
Index	integer	此向量在請求參數 Input 裡的序號，從 0 開始。	0

樣本

正常返回樣本

JSON格式

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Message": "Successful",
  "Status": "success",
  "TextTokens": 1000,
  "Results": {
    "Results": [
      {
        "Embedding": {
          "Embedding": [
            0.1234
          ]
        },
        "Index": 0
      }
    ]
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。