Get Embeddings - Get Embeddings

Служба:: AI Foundry

Версия API:: 2024-05-01-preview

Возвращает векторы внедрения для заданных текстовых запросов. Метод выполняет вызов REST API к маршруту /embeddings на заданной конечной точке.

POST https://{resource}.services.ai.azure.com/models/embeddings?api-version=2024-05-01-preview

Параметры URI

Имя	В	Обязательно	Тип	Описание
resource	path	True	string	Имя ресурса служб искусственного интеллекта Azure, например "my-resource"
api-version	query	True	string minLength: 1	Версия API, используемая для этой операции.

Заголовок запроса

Имя	Обязательно	Тип	Описание
extra-parameters		ExtraParameters	Управляет тем, что происходит, если дополнительные параметры, неопределенные REST API, передаются в полезные данные запроса JSON. Это задает заголовок HTTP-запроса `extra-parameters`.

Текст запроса

Имя	Обязательно	Тип	Описание
input	True	string[]	Входной текст для внедрения, закодированный в виде строки или массива маркеров. Чтобы внедрить несколько входных данных в один запрос, передайте массив строк или массив массивов маркеров.
dimensions		integer (int32)	Необязательный. Число измерений, в которых должны быть внедренные выходные данные. Передача null приводит к тому, что модель будет использовать значение по умолчанию. Возвращает ошибку 422, если модель не поддерживает значение или параметр.
encoding_format		EmbeddingEncodingFormat	Необязательный. Требуемый формат возвращаемых внедрения.
input_type		EmbeddingInputType	Необязательный. Тип входных данных. Возвращает ошибку 422, если модель не поддерживает значение или параметр.
model		string	Идентификатор используемой модели ИИ, если на конечной точке доступно несколько моделей.

Ответы

Имя	Тип	Описание
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
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Области

Имя	Описание
https://cognitiveservices.azure.com/.default

Примеры

maximum set embeddings

minimum set embeddings

maximum set embeddings

Образец запроса

HTTP

POST https://{resource}.services.ai.azure.com/models/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://{resource}.services.ai.azure.com/models/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	Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по Azure REST API — https://aka.ms/AzureRestApiGuidelines#handling-errors.
EmbeddingEncodingFormat	Указывает типы внедрения, которые необходимо создать. Сжатые типы внедрения, такие как `uint8`, `int8`, `ubinary` и `binary`, могут снизить затраты на хранение без ущерба для целостности данных. Возвращает ошибку 422, если модель не поддерживает значение или параметр. Ознакомьтесь с документацией по модели, чтобы узнать значения, поддерживаемые вашей моделью.
EmbeddingInputType	Представляет типы входных данных, используемые для внедрения поиска.
EmbeddingItem	Представление сравнения связанности с одним внедрением.
EmbeddingsOptions	Сведения о конфигурации запроса внедрения.
EmbeddingsResult	Представление данных ответа из запроса внедрения. Внедрение измеряет связанность текстовых строк и часто используется для поиска, кластеризации, рекомендаций и других аналогичных сценариев.
EmbeddingsUsage	Измерение количества маркеров, используемых в этом запросе и ответе.
ExtraParameters	Управляет тем, что происходит, если дополнительные параметры, неопределенные REST API, передаются в полезные данные запроса JSON.

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

Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по Azure REST API — https://aka.ms/AzureRestApiGuidelines#handling-errors.

Имя	Тип	Описание
code	string	Один из определяемых сервером кодов ошибок.
innererror	Azure.Core.Foundations.InnerError	Внутренняя ошибка.

EmbeddingEncodingFormat

Перечисление

Указывает типы внедрения, которые необходимо создать. Сжатые типы внедрения, такие как uint8, int8, ubinary и binary, могут снизить затраты на хранение без ущерба для целостности данных. Возвращает ошибку 422, если модель не поддерживает значение или параметр. Ознакомьтесь с документацией по модели, чтобы узнать значения, поддерживаемые вашей моделью.

Значение	Описание
base64	Верните двоичное представление внедренных значений, закодированных как строка Base64. Библиотека Python OpenAI извлекает внедрения из API в виде закодированных двоичных данных, а не с использованием промежуточных десятичных представлений, как это обычно делается.
binary	Возврат подписанных двоичных внедренных файлов
float	Возврат полной точности внедрения
int8	Возврат встраиваемого кода int8
ubinary	Возврат неподписанных двоичных внедренных файлов
uint8	Возврат неподписанных внедренных int8

EmbeddingInputType

Перечисление

Представляет типы входных данных, используемые для внедрения поиска.

Значение	Описание
text	Указывает, что входные данные являются общими текстовыми входными данными.
query	Указывает, что входные данные представляют поисковый запрос для поиска наиболее релевантных документов в векторной базе данных.
document	Указывает, что входные данные представляют документ, хранящийся в векторной базе данных.

EmbeddingItem

Object

Представление сравнения связанности с одним внедрением.

Имя	Тип	Описание
embedding	number[] (float)	Список входных значений внедрения. Они представляют измерение связанности на основе векторов предоставленных входных данных. Или строка в кодировке Base64 вектора внедрения.
index	integer (int32)	Индекс запроса, которому соответствует Внедренныйitem.
object	enum: embedding	Тип объекта этого элемента внедрения. Всегда будет `embedding`.

EmbeddingsOptions

Object

Сведения о конфигурации запроса внедрения.

Имя	Тип	Описание
dimensions	integer (int32)	Необязательный. Число измерений, в которых должны быть внедренные выходные данные. Передача null приводит к тому, что модель будет использовать значение по умолчанию. Возвращает ошибку 422, если модель не поддерживает значение или параметр.
encoding_format	EmbeddingEncodingFormat	Необязательный. Требуемый формат возвращаемых внедрения.
input	string[]	Входной текст для внедрения, закодированный в виде строки или массива маркеров. Чтобы внедрить несколько входных данных в один запрос, передайте массив строк или массив массивов маркеров.
input_type	EmbeddingInputType	Необязательный. Тип входных данных. Возвращает ошибку 422, если модель не поддерживает значение или параметр.
model	string	Идентификатор используемой модели ИИ, если на конечной точке доступно несколько моделей.

EmbeddingsResult

Object

Представление данных ответа из запроса внедрения. Внедрение измеряет связанность текстовых строк и часто используется для поиска, кластеризации, рекомендаций и других аналогичных сценариев.

Имя	Тип	Описание
data	EmbeddingItem[]	Внедрение значений для запросов, отправленных в запросе.
id	string	Уникальный идентификатор для результата внедрения.
model	string	Идентификатор модели, используемый для создания этого результата.
object	enum: list	Тип объекта результата внедрения. Всегда будет `list`.
usage	EmbeddingsUsage	Количество использования для входных данных маркеров с помощью API внедрения.

EmbeddingsUsage

Object

Измерение количества маркеров, используемых в этом запросе и ответе.

Имя	Тип	Описание
prompt_tokens	integer (int32)	Количество маркеров в запросе.
total_tokens	integer (int32)	Общее количество токенов, транзакций которых выполняется в этом запросе или ответе. Должно быть равно количеству маркеров в запросе.

ExtraParameters

Перечисление

Управляет тем, что происходит, если дополнительные параметры, неопределенные REST API, передаются в полезные данные запроса JSON.

Значение	Описание
error	Служба будет ошибаться, если она обнаружила дополнительные параметры в полезных данных запроса. Это служба по умолчанию.
drop	Служба будет игнорировать дополнительные параметры (удалить) в полезных данных запроса. Он передает только известные параметры в модель внутреннего ИИ.
pass-through	Служба передает дополнительные параметры в модель внутреннего ИИ.

Поделиться через

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