嵌入式
获取给定输入的向量表示,该表示可以轻松地被机器学习模型和算法消费。
相关指南:嵌入式
创建嵌入式
创建表示输入文本的嵌入向量。
post https://api.openai.com/v1/embeddings请求正文
| 属性 | 类型 | 必需 | 描述 | 
|---|---|---|---|
| input | string or array | 是 | 要嵌入的输入文本,编码为字符串或令牌数组。要在单个请求中嵌入多个输入,请传递字符串数组或令牌数组数组。输入不得超过模型的最大输入令牌( text-embedding-ada-002的8192个令牌),不能为空字符串,并且数组的维度不得超过2048。示例Python代码用于计算令牌。 | 
| model | string | 是 | 要使用的模型的ID。您可以使用列出模型API查看所有可用的模型,或查看我们的模型概述了解它们的描述。 | 
| encoding_format | string | 否 | 返回嵌入的格式。可以是 float或base64。默认为浮点数。 | 
| dimensions | integer | 否 | 结果输出嵌入式应该具有的维度数。仅在 text-embedding-3和更新版本的模型中受支持。 | 
| user | string | 否 | 表示您的端用户的唯一标识符,可以帮助OpenAI监控和检测滥用。了解更多信息。 | 
返回
嵌入式对象的列表。
示例请求
curl https://api.openai.com/v1/embeddings \
  -H "Authorization: Bearer $OPENAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "input": "The food was delicious and the waiter...",
    "model": "text-embedding-ada-002",
    "encoding_format": "float"
  }'
响应
{
  "object": "list",
  "data": [
    {
      "object": "embedding",
      "embedding": [
        0.0023064255,
        -0.009327292,
        .... (1536 floats total for ada-002)
        -0.0028842222,
      ],
      "index": 0
    }
  ],
  "model": "text-embedding-ada-002",
  "usage": {
    "prompt_tokens": 8,
    "total_tokens": 8
  }
}
嵌入式对象
表示嵌入端点返回的嵌入向量。
| 属性 | 类型 | 描述 | 
|---|---|---|
| 索引 | 整数 | 嵌入的索引在嵌入列表中。 | 
| 嵌入 | 数组 | 嵌入向量,它是一个浮点数列表。向量的长度取决于模型,如嵌入指南中所列。 | 
| 对象 | 字符串 | 对象类型,始终为“嵌入”。 | 
{
  "object": "embedding",
  "embedding": [
    0.0023064255,
    -0.009327292,
    .... (1536 floats total for ada-002)
    -0.0028842222,
  ],
  "index": 0
}