创建嵌入请求

创建表示输入文本的嵌入向量

POST

https://api.openapi.cn/v1/embeddings

认证参数

Authorization

string

header

必填

使用以下格式进行身份验证：Bearer <YOUR API KEY>

请求体

application/json

model

string

必填

对应的模型名称。为了更好地提升服务质量，我们将对本服务提供的模型进行定期变更，包括但不限于模型上下线、模型服务能力调整等，在可行的情况下，我们将通过公告、消息推送等适当方式通知您相关变更。

input

string

必填

要嵌入的输入文本，编码为字符串或令牌数组。要在单个请求中嵌入多个输入，请传递字符串数组或令牌数组数组。输入不得超过模型的最大输入令牌数（所有模型为512个令牌，BAAI/bge-m3除外，为8192个），不能为空字符串。

encoding_format

string

可选

返回嵌入的格式。可以是float或base64。

响应体

object

string

对象类型，始终为"list"

model

string

用于生成嵌入的模型名称

data

array

模型生成的嵌入列表

usage

object

请求的使用信息

创建文本对话请求

Creates a model response for the given chat conversation.

创建重排序请求

创建模型重排序请求，对文档进行相关性排序

请求示例

curl -X POST "https://api.example.com/embeddings" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "BAAI/bge-large-zh-v1.5",
    "input": "OpenAPI flow embedding online: fast, affordable, and high-quality embedding services. come try it out!",
    "encoding_format": "float"
  }'

响应示例

{
  "object": "list",
  "model": "BAAI/bge-large-zh-v1.5",
  "data": [
    {
      "object": "embedding",
      "embedding": [0.0023064255, -0.009327292, ...],
      "index": 0
    }
  ],
  "usage": {
    "prompt_tokens": 16,
    "total_tokens": 16
  }
}