embedding

模型能力须知：该接口调用的是微软的embedding相关能力，请在调用时注意信息安全，目前仅支持ada，若有更高要求（如Babbage等）可以联系我们提出需求
调用申请：需申请开通「调用微软相关模型」权限，同时需要发起审批（Boss Hi工作台-流程中心-大模型资源申请）， 审批通过后才能进行模型调用。点击申请 (opens new window)
调用量限制：为了防止您的代码在异常情况多次调用，每个应用将默认获得50qpm和500万token/日的额度，如果您的业务调用量较大，请在发起审批时进行调整
基础数据安全策略：为了保证数据安全，我们做了如下基础策略限制，如果您想要进行更多策略限制，建议在您的服务端处理完成后再调用该接口

• （1）用户个人信息：身份证号、护照号、银行卡号、支付宝账户、GPS信息（正则匹配处理）
• （2）个人联系方式：手机号、邮箱等
• （3）公司业务信息：蓝领、牛炸、首善、达成、机构号、pv等
• （4）公司组织架构信息：产品*组，研发*组，算法*组
• （5）其他：如boss直聘+股票

请求

基本
HTTP URL	https://hi-gw.weizhipin.com/open-apis/ai/open/api/embeddings
HTTP Method	POST
支持的应用类型	自建应用
权限要求 开启任一权限即可	调用微软相关模型

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 值格式："Bearer access_token" 示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560"
Content-Type	string	是	固定值："application/json; charset=utf-8"

请求体

名称	类型	必填	描述
child_model	int	否	1、ada ；2、large-3 不填时默认选择ada
input	string	是	输入一段文本得到它的嵌入表示，编码成字符串形式。输入令牌的数量取决于您使用的子模型。除非您是对代码进行嵌入，否则我们建议将输入中的换行符（\n）替换为一个空格，因为我们观察到，当存在换行符时，嵌入结果可能较差。
user	number	否	一个唯一的标识符，代表您的最终用户。这将有助于微软检测和监视滥用行为。请不要传递PII标识符，而是使用伪匿名值，如GUID。

请求体示例

{
  "input": "The food was delicious and the waiter...",
  "child_model": 1
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	data	-

响应体示例

{
  "code": 0,
  "success": true,
  "data": {
    "usage": {
      "prompt_tokens": 8,
      "total_tokens": 8
    },
    "forbbiden": null,
    "object": "list",
    "data": [
      {
        "object": "embedding",
        "index": 0,
        "embedding": [
          0.0023064255
        ]
      }
    ],
    "model": "ada"
  },
  "msg": "操作成功",
  "traceId": "_Ao56wOI2Q6IGg2P"
}