文档首页/ 应用平台 AppStage/ API参考/ API/ 模型调用/ 文本向量化
更新时间：2024-07-30 GMT+08:00
在线调试
CLI示例
查看PDF
分享

文本向量化

功能介绍

将用户输入的文本转化成数字向量，多用于从向量化知识库中查询相似的文本。

URI

POST /v1/embeddings

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

Authorization

是

String

AI原生应用引擎鉴权API Key。

1.以管理员身份登录AI原生应用引擎工作台，在左侧导航栏选择“配置中心 > 平台租户鉴权”。

2.在“平台租户鉴权”页面，选择“平台API Key”页签，单击“新增平台API Key”。

3.在“新增平台API Key”对话框中的输入框设置API Key名称，用以区分API Key。

4.在弹出的下载窗口中单击“立即下载”，将API Key下载到本地查看。
表2 请求Body参数

参数

是否必选

参数类型

描述

input

是

Array of strings

输入支持2种格式：

  • 纯文本（string），例如："你好" ；

  • 文本列表（array），例如：["你","好"] 。

数组长度：1 - 2048

model

是

String

对于平台预置模型服务，填入模型名称。

对于租户部署或接入的模型，填入对应模型服务的模型服务调用ID。

  • 例如：调用平台接入的Baichuan-Text-Embedding模型， 可填入Baichuan-Text-Embedding或者publisher:baichuan:Baichuan-Text-Embedding。

  • 例如：调用租户接入的模型mymodelservice， 仅可填入integrate:919008600000xxxxxxx:mymodelservice。

枚举值：

  • publisher:baichuan:Baichuan-Text-Embedding

  • publisher:zhipu:embedding-2

  • platform:bge-large-zh-v1.5

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

data

Array of Embedding objects

向量化结果。

model

String

实际转发后调用的模型名称，与请求体中model可能不同。

object

String

固定值‘list’。

usage

usage object

每次请求的用量统计。
表4 Embedding

参数

参数类型

描述

index

Integer

向量在向量列表中的排序。

embedding

Array of numbers

向量数组（Float类型）。

object

String

固定值‘embedding’。
表5 usage

参数

参数类型

描述

prompt_tokens

Integer

提问包含的token数。

total_tokens

Integer

提问包含的token数。

状态码： 500

表6 响应Body参数

参数

参数类型

描述

error

Error object

异常详情。

error_code

String

平台异常错误码。

error_msg

String

异常信息。
表7 Error

参数

参数类型

描述

code

String

异常码。

枚举值：

  • invalid_request_error

  • invalid_api_key

  • internal_error

  • invalid_third_response

  • invalid_third_authentication

  • ...

message

String

异常信息。

param

String

异常参数，暂未使用。

type

String

异常类型，同code。

请求示例

{
  "model" : "publisher:zhipu:embedding-2",
  "input" : "你好啊"
}

响应示例

状态码： 200

OK

{
    "data": [
        {
            "index": 0,
            "embedding": [
                0.02513289265334606,
                -0.017512470483779907,
                -0.029955564066767693,
                ...
            ],
    "object": "embedding"
            }
    ],
    "usage": {
        "prompt_tokens": 5,
        "total_tokens": 5
    },
    "model": "embedding-2",
    "object": "list"
}

状态码： 500

服务器内部错误或三方服务器内部错误。

{
  "error" : {
    "message" : "Internal server error, please try again later!",
    "type" : "internal_error",
    "param" : null,
    "code" : "internal_error"
  },
  "error_code" : "AIAE.31001001",
  "error_msg" : "Internal server error, please try again later!"
}

状态码

状态码

描述

200

OK

500

服务器内部错误或三方服务器内部错误。

错误码

请参见错误码。

父主题： 模型调用

相关文档