TextEmbedding - 文本向量化_云原生数据仓库AnalyticDB(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	array<object>	向量结果列表。
Results	object	结果详情。
Embedding	array	向量值列表。
Embedding	double	向量值。	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
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。