文档首页/ 应用平台 AppStage/ API参考/ API/ 模型调用/ 调用文本向量化模型服务
更新时间:2025-03-12 GMT+08:00
分享

调用文本向量化模型服务

功能介绍

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

调用方法

请参见如何调用API

URI

POST https://aiae.appstage.myhuaweicloud.com/v1/embeddings

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

Authorization

String

参数解释:

鉴权信息。获取平台API Key,并为API Key添加前缀Bearer,得到标准鉴权信息,例如Bearer sk-74e4157***。API Key获取方法请参见创建API Key

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表2 请求Body参数

参数

是否必选

参数类型

描述

input

Array of strings

参数解释:

输入支持2种格式:

纯文本(string),例如:"你好" ;

文本列表(array),例如:["你","好"] 。

约束限制:

输入长度小于25M,且列表元素数量小于1000。

取值范围:

不涉及。

默认取值:

不涉及。

model

String

参数解释:

模型服务调用唯一id字段。平台定义了3种模型服务:

1.平台预置模型服务

登录AI原生应用引擎,在左侧导航栏选择”资产中心“,选择“大模型”页签,单击模型卡片进入模型详情页面,查看模型服务调用ID。

2.租户部署模型服务

登录AI原生应用引擎,在左侧导航栏选择“模型中心 > 我的模型服务”,选择“我部署的”页签,在模型服务列表中复制模型服务调用ID。

3.租户接入模型服务

登录AI原生应用引擎,在左侧导航栏选择“模型中心 > 我的模型服务”,选择“我接入的”页签,在模型服务列表中复制模型服务调用ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码: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

参数解释:

异常码。

取值范围:

不涉及。

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

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

错误码

请参见错误码

相关文档