Справочник. Внедрение | Azure AI Foundry

Статья
09/02/2024

Внимание

Элементы, обозначенные в этой статье как (предварительная версия), сейчас предлагаются в общедоступной предварительной версии. Эта предварительная версия предоставляется без соглашения об уровне обслуживания, и мы не рекомендуем ее для рабочих нагрузок. Некоторые функции могут не поддерживаться или их возможности могут быть ограничены. Дополнительные сведения см. в статье Дополнительные условия использования Предварительных версий Microsoft Azure.

Создает вектор внедрения, представляющий входной текст.

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

Параметры URI

Имя.	In	Обязательное поле	Type	Описание
`api-version`	query	Истина	строка	Версия API в формате YYYY-MM-DD или YYYY-MM-DD-preview.

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

имени	Обязательно	Type	Описание
дополнительные параметры		строка	Поведение API при указании дополнительных параметров в полезных данных. Использование `pass-through` API для передачи параметра базовой модели. Используйте это значение, если вы хотите передать параметры, которые вы знаете, базовая модель может поддерживать. Использование `drop` API для удаления любого неподдерживаемого параметра. Используйте это значение, если необходимо использовать одну полезные данные для разных моделей, но один из дополнительных параметров может привести к ошибке модели, если она не поддерживается. Использование `error` API для отклонения любого дополнительного параметра в полезных данных. Можно указать только параметры, указанные в этом API, или возвращается ошибка 400.
azureml-model-deployment		строка	Имя развертывания, в которое нужно направить запрос. Поддерживается для конечных точек, поддерживающих несколько развертываний.

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

имени	Обязательно	Type	Описание
модель		строка	Имя модели. Этот параметр игнорируется, если конечная точка обслуживает только одну модель.
input	Истина	string[]	Входной текст для внедрения, закодированный в виде строки или массива маркеров. Чтобы внедрить несколько входных данных в один запрос, передайте массив строк или массив массивов маркеров.
dimensions		integer	Число измерений, в которых должны быть внедренные выходные данные. Возвращает ошибку 422, если модель не поддерживает значение или параметр.
encoding_format		ВнедрениеEncodingFormat	Формат, в который возвращаются встраиваемые элементы. Base64, float, int8, uint8, binary или ubinary. Возвращает ошибку 422, если модель не поддерживает значение или параметр.
input_type		ВнедрениеInputType	Тип входных данных. `text`, `query` или `document`. Возвращает ошибку 422, если модель не поддерживает значение или параметр.

Отклики

Имя.	Тип	Описание
200 OK	CreateEmbeddingResponse	ОК
401 — не авторизовано	НесанкционированныйError	Маркер доступа отсутствует или недопустим Заголовки x-ms-error-code: string
404 Не найдено	NotFoundError	Модальность не поддерживается моделью. Проверьте документацию модели, чтобы узнать, какие маршруты доступны. Заголовки x-ms-error-code: string
422 Необработаемая сущность	UnprocessableContentError	Запрос содержит необработаемое содержимое Заголовки x-ms-error-code: string
429 — слишком много запросов	TooManyRequestsError	Вы достигли заданного ограничения скорости, и ваш запрос должен быть темпирован. Заголовки x-ms-error-code: string
Другие коды состояния	ContentFilterError	Недопустимый запрос Заголовки x-ms-error-code: string

Безопасность

Авторизация

Маркер с Bearer: prefixнапример. Bearer abcde12345

Тип: apiKey In: заголовок

AADToken

Проверка подлинности OAuth2 в Azure Active Directory

Тип: поток oauth2: URL-адрес маркера приложения:https://login.microsoftonline.com/common/oauth2/v2.0/token

Примеры

Создает вектор внедрения, представляющий входной текст

Пример запроса

POST /embeddings?api-version=2024-04-01-preview

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

Пример ответа

Код состояния: 200.

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

Определения

Имя	Описание
ContentFilterError	Вызов API завершается сбоем, когда запрос активирует фильтр содержимого, как настроено. Измените запрос и повторите попытку.
CreateEmbeddingRequest	Запрос на создание внедрения.
CreateEmbeddingResponse	Ответ от запроса внедрения.
Detail	Сведения об ошибках.
Векторное представление	Представляет созданный объект внедрения.
ВнедрениеEncodingFormat	Формат, в который возвращаются встраиваемые элементы. Base64, float, int8, uint8, binary или ubinary. Возвращает ошибку 422, если модель не поддерживает значение или параметр.
ВнедрениеInputType	Тип входных данных. `text`, `query` или `document`. Возвращает ошибку 422, если модель не поддерживает значение или параметр.
ВнедрениеObject	Тип объекта, который всегда является внедрением.
ListObject	Тип объекта, который всегда является "list".
NotFoundError	Маршрут недопустим для развернутой модели.
TooManyRequestsError	Вы достигли заданного ограничения скорости, и ваши запросы должны быть темпы.
НесанкционированныйError	Проверка подлинности отсутствует или недопустимая.
UnprocessableContentError	Запрос содержит необработаемое содержимое. Ошибка возвращается, когда указанная полезные данные допустимы в соответствии с этой спецификацией. Однако некоторые инструкции, указанные в полезных данных, не поддерживаются базовой моделью. `details` Используйте раздел, чтобы понять, что параметр обижает.
Использование	Сведения об использовании запроса.

ContentFilterError

Вызов API завершается сбоем, когда запрос активирует фильтр содержимого, как настроено. Измените запрос и повторите попытку.

Имя.	Тип	Описание
кодом	строка	Код ошибки.
error	строка	Описание ошибки.
message	строка	Сообщение об ошибке.
param	строка	Параметр, активировав фильтр содержимого.
статус	integer	Код состояния HTTP.

CreateEmbeddingRequest

Запрос на создание внедрения.

имени	Обязательно	Type	Описание
input	Истина	string[]	Входной текст для внедрения, закодированный в виде строки или массива маркеров. Чтобы внедрить несколько входных данных в один запрос, передайте массив строк или массив массивов маркеров.
dimensions		integer	Число измерений, в которых должны быть внедренные выходные данные. Возвращает ошибку 422, если модель не поддерживает значение или параметр.
encoding_format		ВнедрениеEncodingFormat	Формат, в который возвращаются встраиваемые элементы. Base64, float, int8, uint8, binary или ubinary. Возвращает ошибку 422, если модель не поддерживает значение или параметр.
input_type		ВнедрениеInputType	Тип входных данных. `text`, `query` или `document`. Возвращает ошибку 422, если модель не поддерживает значение или параметр.

CreateEmbeddingResponse

Ответ от запроса внедрения.

Имя.	Тип	Описание
.	Внедрение[]	Список внедрения, созданных моделью.
модель	строка	Имя модели, используемой для создания внедрения.
объект	ListObject	Тип объекта, который всегда является "list".
использование	Использование	Сведения об использовании запроса.

Подробный сведения

Сведения об ошибке UnprocessableContentError .

Имя.	Тип	Описание
loc	string[]	Параметр, вызывающий проблему
значение	строка	Значение, переданное параметру, вызывающее проблемы.

Векторное представление

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

Имя.	Тип	Описание
удостоверение	[]	Вектор внедрения. Длина вектора зависит от используемой модели, а тип зависит от используемого `encoding_format` .
index	integer	Индекс внедрения в список внедрения.
объект	ВнедрениеObject	Тип объекта, который всегда является внедрением.

ВнедрениеEncodingFormat

Формат, в который возвращаются встраиваемые элементы. Base64, float, int8, uint8, binary или ubinary. Возвращает ошибку 422, если модель не поддерживает значение или параметр.

Имя.	Тип	Описание
base64	строка
binary	строка
с плавающей запятой	строка
int8	строка
ubinary	строка
uint8	строка

ВнедрениеInputType

Тип входных данных. text, query или document. Возвращает ошибку 422, если модель не поддерживает значение или параметр.

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

ВнедрениеObject

Имя.	Тип	Описание
удостоверение	строка

ListObject

Тип объекта, который всегда является "list".

Имя.	Тип	Description
список	строка

NotFoundError

Имя.	Тип	Описание
error	строка	Описание ошибки.
message	строка	Сообщение об ошибке.
статус	integer	Код состояния HTTP.

TooManyRequestsError

Имя.	Тип	Описание
error	строка	Описание ошибки.
message	строка	Сообщение об ошибке.
статус	integer	Код состояния HTTP.

НесанкционированныйError

Имя.	Тип	Описание
error	строка	Описание ошибки.
message	строка	Сообщение об ошибке.
статус	integer	Код состояния HTTP.

UnprocessableContentError

Запрос содержит необработаемое содержимое. Ошибка возвращается, когда указанная полезные данные допустимы в соответствии с этой спецификацией. Однако некоторые инструкции, указанные в полезных данных, не поддерживаются базовой моделью. details Используйте раздел, чтобы понять, что параметр обижает.

Имя.	Тип	Описание
кодом	строка	Код ошибки.
detail	Detail
error	строка	Описание ошибки.
message	строка	Сообщение об ошибке.
статус	integer	Код состояния HTTP.

Использование

Сведения об использовании запроса.

Имя.	Тип	Описание
prompt_tokens	integer	Количество маркеров, используемых запросом.
total_tokens	integer	Общее количество маркеров, используемых запросом.

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