OpenAI 创建嵌入接口

创建嵌入

post /embeddings

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

请求体参数

媒体类型为 application/json。

• input: string or array of string or array of number or array of array of number

要生成嵌入的输入文本，可编码为字符串或词元数组。若要在单次请求中嵌入多个输入，可传入字符串数组或词元数组的数组。输入不得超过模型的最大输入词元数（所有嵌入模型均为8192个词元），不能是空字符串，且任何数组的维数不得超过2048。计数词元的Python示例代码。除每个输入的词元限制外，所有嵌入模型还要求单次请求中所有输入的词元总数最多为300000。

• String = string

将转换为嵌入的字符串。

• Array = array of string（数组包含 1 至 2048 项）

将转换为嵌入的字符串数组。

• Array = array of number（数组包含 1 至 2048 项）

将转换为嵌入的整数数组。

• Array = array of array of number（数组包含 1 至 2048 项）

将转换为嵌入的整数数组的数组。

• model: string or EmbeddingModel

所用模型的ID。可以通过列出模型API查看所有可用模型，或在模型概览中查看模型说明。

• string

• EmbeddingModel = "text-embedding-ada-002" or "text-embedding-3-small" or "text-embedding-3-large"

• "text-embedding-ada-002"

• "text-embedding-3-small"

• "text-embedding-3-large"

• dimensions: optional integer（最小值为 1）

输出嵌入向量应具有的维数。仅text-embedding-3及后续模型支持。

• encoding_format: optional "float" or "base64"（默认 "float"）

返回嵌入的格式，可为float或base64。

• "float"

• "base64"

• user: optional string

表示终端用户的唯一标识符，可帮助OpenAI监控及检测滥用。了解更多。

返回值

• CreateEmbeddingResponse object { data, model, object, usage }

• data: array of Embedding

模型生成的嵌入列表。

• embedding: array of number or string

嵌入向量。encoding_format为默认值float时，以浮点数列表返回；为base64时，以Base64编码字符串返回。向量长度取决于所用模型，详见嵌入指南。

• array of number

• string

• index: integer

该嵌入在嵌入列表中的索引。

• object: "embedding"

对象类型，固定为"embedding"。

• "embedding"

• model: string

用于生成嵌入的模型名称。

• object: "list"

对象类型，固定为"list"。

• "list"

• usage: object { prompt_tokens, total_tokens }

请求的用量信息。

• prompt_tokens: integer

提示词使用的词元数。

• total_tokens: integer

请求使用的词元总数。

示例

代码内文字译释：

• 敏捷的棕色狐狸跳过了那只懒狗。

## [中文] 发送POST请求；将示例API凭证和输入文本替换为应用使用的值。
curl https://api.openai.com/v1/embeddings \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $OPENAI_API_KEY" \
    -d '{
          "input": "The quick brown fox jumped over the lazy dog",
          "model": "text-embedding-3-small",
          "encoding_format": "float",
          "user": "user-1234"
        }'

响应

中文说明：以下为原文配置、命令或事件示例，字段名、枚举、标识符及数值保留。

{
  "data": [
    {
      "embedding": [
        0
      ],
      "index": 0,
      "object": "embedding"
    }
  ],
  "model": "model",
  "object": "list",
  "usage": {
    "prompt_tokens": 0,
    "total_tokens": 0
  }
}

示例

代码内文字译释：

• 你好，世界。

## [中文] 发送POST请求；将示例API凭证和输入文本替换为应用使用的值。
curl https://api.openai.com/v1/embeddings \
  -H "Authorization: Bearer $OPENAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "input": "Hello world",
    "model": "text-embedding-3-small",
    "encoding_format": "float",
    "dimensions": 3
  }'

响应

中文说明：以下为原文配置、命令或事件示例，字段名、枚举、标识符及数值保留。

{
  "object": "list",
  "data": [
    {
      "object": "embedding",
      "embedding": [
        0.26726124,
        0.53452248,
        0.80178373
      ],
      "index": 0
    }
  ],
  "model": "text-embedding-3-small",
  "usage": {
    "prompt_tokens": 2,
    "total_tokens": 2
  }
}