你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Get Embeddings - Get Embeddings

参考

服务:: AI Foundry

API 版本:: 2024-05-01-preview

返回给定文本提示的嵌入向量。该方法对给定终结点上的 /embeddings 路由进行 REST API 调用。

POST https:///embeddings?api-version=2024-05-01-preview

URI 参数

名称	在	必需	类型	说明
api-version	query	True	string minLength: 1	用于此作的 API 版本。

请求头

名称	必需	类型	说明
extra-parameters		ExtraParameters	控制在 JSON 请求有效负载中传递其他参数（由 REST API 未定义）会发生什么情况。这会 `extra-parameters`设置 HTTP 请求标头。

请求正文

名称	必需	类型	说明
input	True	string[]	要嵌入的输入文本，编码为字符串或标记数组。若要在单个请求中嵌入多个输入，请传递字符串数组或令牌数组数组。
dimensions		integer (int32)	自选。生成的输出嵌入应具有的维度数。传递 null 会导致模型使用其默认值。如果模型不支持值或参数，则返回 422 错误。
encoding_format		EmbeddingEncodingFormat	自选。返回的嵌入的所需格式。
input_type		EmbeddingInputType	自选。输入的类型。如果模型不支持值或参数，则返回 422 错误。
model		string	在终结点上提供多个模型时，要使用的特定 AI 模型的 ID。

响应

名称	类型	说明
200 OK	EmbeddingsResult	请求已成功。
Other Status Codes	Azure.Core.Foundations.ErrorResponse	意外的错误响应。标头 x-ms-error-code: string

名称

类型

说明

200 OK

EmbeddingsResult

请求已成功。

Other Status Codes

Azure.Core.Foundations.ErrorResponse

意外的错误响应。

标头

x-ms-error-code: string

安全性

api-key

类型: apiKey
在: header

OAuth2Auth

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

作用域

名称	说明
https://ml.azure.com/.default

示例

maximum set embeddings

minimum set embeddings

maximum set embeddings

示例请求

HTTP

POST https:///embeddings?api-version=2024-05-01-preview


{
  "input": [
    "This is a very good text"
  ],
  "dimensions": 1024,
  "encoding_format": "float",
  "input_type": "text",
  "model": "my-model-name"
}

示例响应

状态代码:: 200

{
  "id": "cknxthfa",
  "data": [
    {
      "index": 0,
      "object": "embedding",
      "embedding": [
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0
      ]
    }
  ],
  "object": "list",
  "model": "my-model-name",
  "usage": {
    "prompt_tokens": 15,
    "total_tokens": 15
  }
}

minimum set embeddings

示例请求

HTTP

POST https:///embeddings?api-version=2024-05-01-preview

{
  "input": [
    "This is a very good text"
  ]
}

示例响应

状态代码:: 200

{
  "id": "cknxthfa",
  "data": [
    {
      "index": 0,
      "object": "embedding",
      "embedding": [
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0
      ]
    }
  ],
  "object": "list",
  "model": "my-model-name",
  "usage": {
    "prompt_tokens": 15,
    "total_tokens": 15
  }
}

定义

名称	说明
Azure.Core.Foundations.Error	错误对象。
Azure.Core.Foundations.ErrorResponse	包含错误详细信息的响应。
Azure.Core.Foundations.InnerError	包含有关错误的更具体信息的对象。根据Microsoft一个 API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
EmbeddingEncodingFormat	指定要生成的嵌入类型。压缩的嵌入类型（如 `uint8`、`int8`、`ubinary` 和 `binary`）可能会降低存储成本，而不会牺牲数据的完整性。如果模型不支持值或参数，则返回 422 错误。阅读模型的文档，了解模型支持的值。
EmbeddingInputType	表示用于嵌入搜索的输入类型。
EmbeddingItem	单个嵌入相关性比较的表示形式。
EmbeddingsOptions	嵌入请求的配置信息。
EmbeddingsResult	嵌入请求中的响应数据的表示形式。嵌入可测量文本字符串的相关性，通常用于搜索、聚类分析、建议和其他类似方案。
EmbeddingsUsage	测量此请求和响应中使用的令牌量。
ExtraParameters	控制在 JSON 请求有效负载中传递其他参数（由 REST API 未定义）会发生什么情况。

Azure.Core.Foundations.Error

Object

错误对象。

名称	类型	说明
code	string	服务器定义的错误代码集之一。
details	Azure.Core.Foundations.Error[]	导致此报告错误的特定错误的详细信息数组。
innererror	Azure.Core.Foundations.InnerError	包含与当前对象有关错误的更具体信息的对象。
message	string	错误的人工可读表示形式。
target	string	错误的目标。

Azure.Core.Foundations.ErrorResponse

Object

包含错误详细信息的响应。

名称	类型	说明
error	Azure.Core.Foundations.Error	错误对象。

Azure.Core.Foundations.InnerError

Object

包含有关错误的更具体信息的对象。根据Microsoft一个 API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。

名称	类型	说明
code	string	服务器定义的错误代码集之一。
innererror	Azure.Core.Foundations.InnerError	内部错误。

EmbeddingEncodingFormat

枚举

指定要生成的嵌入类型。压缩的嵌入类型（如 uint8、int8、ubinary 和 binary）可能会降低存储成本，而不会牺牲数据的完整性。如果模型不支持值或参数，则返回 422 错误。阅读模型的文档，了解模型支持的值。

值	说明
base64	获取编码为 Base64 字符串的嵌入的二进制表示形式。 OpenAI Python 库将 API 中的嵌入检索为编码的二进制数据，而不是像通常那样使用中间小数表示形式。
binary	获取已签名的二进制嵌入
float	恢复完全精度嵌入
int8	返回已登录的 int8 嵌入内容
ubinary	获取未签名的二进制嵌入
uint8	获取未签名的 int8 嵌入内容

EmbeddingInputType

枚举

表示用于嵌入搜索的输入类型。

值	说明
document	指示输入表示存储在向量数据库中的文档。
query	指示输入表示搜索查询，以查找矢量数据库中最相关的文档。
text	指示输入是常规文本输入。

EmbeddingItem

Object

单个嵌入相关性比较的表示形式。

名称	类型	说明
embedding	number[] (float)	输入提示的嵌入值列表。这些表示所提供输入的基于向量的相关性的度量。或嵌入矢量的 base64 编码字符串。
index	integer (int32)	EmbeddingItem 对应的提示的索引。
object	enum: embedding	此嵌入项的对象类型。将始终 `embedding`。

EmbeddingsOptions

Object

嵌入请求的配置信息。

名称	类型	说明
dimensions	integer (int32)	自选。生成的输出嵌入应具有的维度数。传递 null 会导致模型使用其默认值。如果模型不支持值或参数，则返回 422 错误。
encoding_format	EmbeddingEncodingFormat	自选。返回的嵌入的所需格式。
input	string[]	要嵌入的输入文本，编码为字符串或标记数组。若要在单个请求中嵌入多个输入，请传递字符串数组或令牌数组数组。
input_type	EmbeddingInputType	自选。输入的类型。如果模型不支持值或参数，则返回 422 错误。
model	string	在终结点上提供多个模型时，要使用的特定 AI 模型的 ID。

EmbeddingsResult

Object

嵌入请求中的响应数据的表示形式。嵌入可测量文本字符串的相关性，通常用于搜索、聚类分析、建议和其他类似方案。

名称	类型	说明
data	EmbeddingItem[]	为请求中提交的提示嵌入值。
id	string	嵌入结果的唯一标识符。
model	string	用于生成此结果的模型 ID。
object	enum: list	嵌入结果的对象类型。将始终 `list`。
usage	EmbeddingsUsage	使用嵌入 API 输入令牌的使用情况计数。

EmbeddingsUsage

Object

测量此请求和响应中使用的令牌量。

名称	类型	说明
prompt_tokens	integer (int32)	请求中的令牌数。
total_tokens	integer (int32)	在此请求/响应中事务的令牌总数。应等于请求中的令牌数。

ExtraParameters

枚举

控制在 JSON 请求有效负载中传递其他参数（由 REST API 未定义）会发生什么情况。

值	说明
drop	服务将忽略请求有效负载中的额外参数（删除）。它只会将已知参数传递给后端 AI 模型。
error	如果服务检测到请求有效负载中的额外参数，服务将出错。这是服务默认值。
pass-through	该服务会将额外的参数传递给后端 AI 模型。

通过

Get Embeddings - Get Embeddings

URI 参数

请求头

请求正文

响应

安全性

api-key

OAuth2Auth

作用域

示例

maximum set embeddings

示例请求

示例响应

minimum set embeddings

示例请求

示例响应

定义

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

EmbeddingEncodingFormat

EmbeddingInputType

EmbeddingItem

EmbeddingsOptions

EmbeddingsResult

EmbeddingsUsage

ExtraParameters

其他资源