Get Image Embeddings - Get Image Embeddings

Ссылка

Служба:: AI Foundry

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

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

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

Параметры URI

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

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

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

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

Имя	Обязательно	Тип	Описание
input	True	ImageEmbeddingInput[]	Входной образ для внедрения. Чтобы внедрить несколько входных данных в один запрос, передайте массив. Входные данные не должны превышать максимальные входные маркеры для модели.
dimensions		integer (int32)	Необязательный. Число измерений, в которых должны быть внедренные выходные данные. Передача null приводит к тому, что модель будет использовать значение по умолчанию. Возвращает ошибку 422, если модель не поддерживает значение или параметр.
encoding_format		EmbeddingEncodingFormat	Необязательный. Число измерений, в которых должны быть внедренные выходные данные. Передача null приводит к тому, что модель будет использовать значение по умолчанию. Возвращает ошибку 422, если модель не поддерживает значение или параметр.
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://ml.azure.com/.default

Примеры

maximum set image embeddings

minimum set image embeddings

maximum set image embeddings

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

HTTP

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


{
  "input": [
    {
      "image": "puqkvvlvgcjyzughesnkena",
      "text": "azrzyjsmnuefqpowpvfmyobeehqsni"
    }
  ],
  "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 image embeddings

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

HTTP

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

{
  "input": [
    {
      "image": "gvmojtfooxixxzayrditjlyymg"
    }
  ]
}

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

Код состояния:: 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	Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по API Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
EmbeddingEncodingFormat	Указывает типы внедрения, которые необходимо создать. Сжатые типы внедрения, такие как `uint8`, `int8`, `ubinary` и `binary`, могут снизить затраты на хранение без ущерба для целостности данных. Возвращает ошибку 422, если модель не поддерживает значение или параметр. Ознакомьтесь с документацией по модели, чтобы узнать значения, поддерживаемые вашей моделью.
EmbeddingInputType	Представляет типы входных данных, используемые для внедрения поиска.
EmbeddingItem	Представление сравнения связанности с одним внедрением.
EmbeddingsResult	Представление данных ответа из запроса внедрения. Внедрение измеряет связанность текстовых строк и часто используется для поиска, кластеризации, рекомендаций и других аналогичных сценариев.
EmbeddingsUsage	Измерение количества маркеров, используемых в этом запросе и ответе.
ExtraParameters	Управляет тем, что происходит, если дополнительные параметры, неопределенные REST API, передаются в полезные данные запроса JSON.
ImageEmbeddingInput	Представляет изображение с необязательным текстом.
ImageEmbeddingsOptions	Сведения о конфигурации запроса внедрения изображений.

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

Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по API Microsoft One — 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. Библиотека Python OpenAI извлекает внедрения из API в виде закодированных двоичных данных, а не с использованием промежуточных десятичных представлений, как это обычно делается.
binary	Возврат подписанных двоичных внедренных файлов
float	Возврат полной точности внедрения
int8	Возврат встраиваемого кода int8
ubinary	Возврат неподписанных двоичных внедренных файлов
uint8	Возврат неподписанных внедренных int8

EmbeddingInputType

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

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

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

EmbeddingItem

Object

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

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

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.

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

ImageEmbeddingInput

Object

Представляет изображение с необязательным текстом.

Имя	Тип	Описание
image	string	Входной образ, закодированный в строке base64 в виде URL-адреса данных. Пример: `data:image/{format};base64,{data}`.
text	string	Необязательный. Ввод текста для канала в модель (например, DINO, CLIP). Возвращает ошибку 422, если модель не поддерживает значение или параметр.

ImageEmbeddingsOptions

Object

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

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

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

Get Image Embeddings - Get Image Embeddings

Параметры URI

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

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

Ответы

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

api-key

OAuth2Auth

Области

Примеры

maximum set image embeddings

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

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

minimum set image embeddings

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

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

Определения

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

EmbeddingEncodingFormat

EmbeddingInputType

EmbeddingItem

EmbeddingsResult

EmbeddingsUsage

ExtraParameters

ImageEmbeddingInput

ImageEmbeddingsOptions

Дополнительные ресурсы