Embeddings

Получите векторное представление предоставленного входного текста, которое легко воспринимается моделями и алгоритмами машинного обучения.

Связанный справочник: Embeddings

Создание запроса

POST

https://api.openai.com/v1/embeddings

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

Тело запроса

Параметр	Тип	Обязателен	Описание
input	строка/массив	Да	Входной текст для встраивания, закодированный как строка или массив токенов. Чтобы встраивать несколько входных данных в одном запросе, передавайте массив строк или массив массивов токенов. Не должен превышать максимальную длину токенов (8192 токена).
model	строка	Да	Идентификатор модели, которую нужно использовать. Вы можете использовать API для списков моделей, чтобы увидеть все доступные вам модели, или ознакомиться с нашим описанием моделей.
encoding_format	строка	Нет	По умолчанию float. Формат для возвращаемых встраиваний может быть либо float, либо base64.
dimensions	целое число	Нет	Количество измерений, которые должны быть у встраиваний в результате. Поддерживается только в text-embedding-3 и более поздних моделях.
user	строка	Нет	Уникальный идентификатор, представляющий вашего конечного пользователя, который может помочь OpenAI для мониторинга и обнаружения злоупотреблений. Узнать больше.

Ответ

Возвращает: Список объектов встраивания.

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

bash

curl https://api.openai.com/v1/embeddings \
  -H "Authorization: Bearer $OPENAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "input": "Еда была очень вкусной, и официант...",
    "model": "text-embedding-ada-002",
    "encoding_format": "float"
  }'

python

from openai import OpenAI
client = OpenAI()

client.embeddings.create(
  model="text-embedding-ada-002",
  input="Еда была очень вкусной, и официант...",
  encoding_format="float"
)

javascript

import OpenAI from "openai";

const openai = new OpenAI();

async function main() {
  const embedding = await openai.embeddings.create({
    model: "text-embedding-ada-002",
    input: "Быстрая коричневая лиса прыгнула через ленивую собаку",
    encoding_format: "float",
  });

  console.log(embedding);
}

main();

Пример ответа объекта встраивания

{
  "object": "list",
  "data": [
    {
      "object": "embedding",
      "embedding": [
        0.0023064255,
        -0.009327292,
        .... (1536 float значений всего для ada-002)
        -0.0028842222,
      ],
      "index": 0
    }
  ],
  "model": "text-embedding-ada-002",
  "usage": {
    "prompt_tokens": 8,
    "total_tokens": 8
  }
}

Объект встраивания

Представляет вектор встраивания, возвращаемый конечной точкой встраивания.

Поле	Тип	Описание
index	целое число	Индекс встраивания в списке встраиваний.
embedding	массив	Вектор встраивания, который представляет собой список чисел с плавающей запятой. Длина вектора зависит от модели, как указано в руководстве по встраиванию.
object	строка	Тип объекта, который всегда равен "embedding".

{
  "object": "embedding",
  "embedding": [
    0.0023064255,
    -0.009327292,
    .... (1536 float значений всего для ada-002)
    -0.0028842222,
  ],
  "index": 0
}