OpenAI Embeddings

Создавайте текстовые векторы в совместимом с OpenAI формате.

Интерфейс OpenAI Embeddings преобразует один входной элемент или пакет элементов в векторное представление для семантического поиска, кластеризации, рекомендаций и векторного поиска. Ограничения ввода, размерность вывода и действие необязательных параметров зависят от выбранной модели Embedding.

POST/v1/embeddings

Создайте векторное представление заданного ввода для семантического поиска, кластеризации, рекомендаций и других задач векторного поиска. Интерфейс поддерживает один текст, пакет текстов, массив Tokens и пакет массивов Tokens.

Ограничения ввода и размерность вывода зависят от выбранной модели. Например, text-embedding-ada-002 возвращает вектор размерности 1536 и принимает не более 8192 Tokens; ограничения других моделей могут отличаться.

Аутентификация

bearerAuth

АутентификацияBearer <token>

Используйте Bearer your-api-key в Header Authorization.

Расположение: header

Тело запроса

Выберите структуру текста по числу входных элементов; оба режима используют один Endpoint Embeddings.

application/json

Один текст

Преобразуйте одну непустую строку в вектор эмбеддинга для проверки одного элемента или запроса в реальном времени.

model: ID модели Embedding, видимой текущему ключу API.
input: Одна непустая строка для преобразования в вектор.
encoding_format: Формат кодирования вектора; по умолчанию float.

application/json

{
  "model": "MODEL_ID",
  "input": "Еда в этом ресторане очень вкусная, а официанты дружелюбные.",
  "encoding_format": "float"
}

model*string

ID используемой модели. Укажите ID модели Embedding, доступной текущему аккаунту.

Длина1 <= length

input*|array<>|array<integer>|array<array<integer>>

Входные данные для преобразования в векторы. Можно передать один текст, массив текстов, целочисленный массив Tokens или пакет массивов Tokens. Ввод не должен быть пустым; размер пакета, общее число Tokens и предел для одного элемента зависят от выбранной модели.

encoding_format?string

Формат кодирования возвращаемых векторов эмбеддингов.

По умолчанию"float"

Допустимые значения

"float"
"base64"

dimensions?integer

Желаемая размерность выходного вектора. Этот параметр поддерживают лишь некоторые более новые модели Embedding.

Диапазон1 <= value

user?string

Уникальный идентификатор конечного пользователя для мониторинга и выявления злоупотреблений.

Длина1 <= length

Массивы Tokens и пакеты массивов Tokens доступны в полном справочнике полей; число входных элементов, длина и размерность векторов определяются ограничениями выбранной модели.

Тело ответа

`application/json`

curl -X POST "https://example.com/v1/embeddings" \  -H "Content-Type: application/json" \  -d '{    "model": "MODEL_ID",    "input": "Еда была вкусной, а официант — приветливым.",    "encoding_format": "float"  }'

{
  "object": "list",
  "data": [
    {
      "object": "embedding",
      "embedding": [
        0.0023064255,
        -0.009327292,
        -0.0028842222
      ],
      "index": 0
    }
  ],
  "model": "MODEL_ID",
  "usage": {
    "prompt_tokens": 8,
    "total_tokens": 8
  }
}

Аутентификация

Тело запроса

Тело ответа

200application/json

400application/json

401application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`