Вложения OpenAI

📝 Введение

Получите векторные представления заданного входного текста, которые можно легко использовать моделями и алгоритмами машинного обучения. Соответствующие рекомендации см. в Руководстве по встраиванию.

Следует отметить следующее:

• Некоторые модели могут иметь ограничения на общее количество входных жетонов.

• Вы можете использовать Пример кода Python для расчета количества токенов.

• Например: размерность выходного вектора модели text-embedding-ada-002 равна 1536.

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

Создать вставку текста ✅

curl https://88api.ai/v1/embeddings \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY" \
  -d '{
    "input": "The food was delicious and the waiter...",
    "model": "text-embedding-ada-002",
    "encoding_format": "float"
  }'

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

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

Создавайте пакетные вставки ✅

curl https://88api.ai/v1/embeddings \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY" \
  -d '{
    "input": ["The food was delicious", "The waiter was friendly"],
    "model": "text-embedding-ada-002",
    "encoding_format": "float"
  }'

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

{
  "object": "list",
  "data": [
    {
      "object": "embedding",
      "embedding": [
        0.0023064255
        // ... (1536 число с плавающей запятой)
      ],
      "index": 0
    },
    {
      "object": "embedding",
      "embedding": [
        -0.008815289
        // ... (1536 число с плавающей запятой)
      ],
      "index": 1
    }
  ],
  "model": "text-embedding-ada-002",
  "usage": {
    "prompt_tokens": 12,
    "total_tokens": 12
  }
}

📮 Запрос

Конечная точка

POST /v1/embeddings

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

Метод аутентификации

Включите в заголовок запроса для аутентификации ключа API следующее:

Authorization: Bearer $API_KEY

Где $OPENAI_API_KEY — ваш ключ API.

Параметры тела запроса

$OPENAI_API_KEY

• Тип: строка или массив.
• Требуется: Да

Введите текст для встраивания в виде строки или массива токенов. Чтобы внедрить несколько входных данных в один запрос, передайте массив строк или массив массивов токенов. Входные данные не должны превышать максимальное количество входных токенов модели (8192 токена для text-embedding-ada-002), не могут быть пустой строкой, а размерность любого массива должна быть меньше или равна 2048.

$OPENAI_API_KEY

• Тип: строка
• Требуется: Да

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

$OPENAI_API_KEY

• Тип: строка
• Требуется: Нет -Значение по умолчанию: плавающее

Возвращает внедренный формат. Может быть float или base64.

$OPENAI_API_KEY

• Тип: целое число
• Требуется: Нет

Количество измерений, которые должно иметь сгенерированное выходное внедрение. Поддерживается только в моделях text-embedding-3 и выше.

$OPENAI_API_KEY

• Тип: строка
• Требуется: Нет

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

📥 Ответ

Успешный ответ

Возвращает список внедренных объектов.

$OPENAI_API_KEY

• Тип: строка
• Описание: Тип объекта, значение — «список».

$OPENAI_API_KEY

• Тип: массив
• Описание: Массив, содержащий встроенные объекты.
• Свойства:
  • $OPENAI_API_KEY: тип объекта, значение — «встраивание».
  • $OPENAI_API_KEY: внедрить вектор, список чисел с плавающей запятой. Длина вектора зависит от модели
  • $OPENAI_API_KEY: индекс встроен в список.

$OPENAI_API_KEY

• Тип: строка
• Описание: используемое название модели.

$OPENAI_API_KEY

• Тип: Объект
• Описание: статистика использования токенов.
• Свойства:
  • $OPENAI_API_KEY: Подскажите количество используемых токенов.
  • $OPENAI_API_KEY: общее количество токенов

Встроить объект

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

{
  "object": "embedding",
  "embedding": [
    0.0023064255, -0.009327292,
    // ... (ada-002 общий 1536 число с плавающей запятой)
    -0.0028842222
  ],
  "index": 0
}

index

• Тип: целое число
• Описание: Индекс, встроенный в список.

index

• Тип: массив
• Описание: Встроить вектор, список чисел с плавающей запятой. Длина вектора зависит от модели, подробности см. в руководстве по встраиванию.

index

• Тип: строка
• Описание: Тип объекта, всегда «встраивание».

Ошибка ответа

При возникновении проблемы с запросом API вернет объект ответа об ошибке с кодом состояния HTTP в диапазоне 4XX-5XX.

Коды состояния распространенных ошибок

• index: ключ API недействителен или не предоставлен.
• index: параметр запроса недействителен, например, ввод пуст или превышает лимит токена.
• index: превышен лимит вызовов API.
• index: внутренняя ошибка сервера.

Пример ответа об ошибке:

{
  "error": {
    "message": "The input exceeds the maximum length. Please reduce the length of your input.",
    "type": "invalid_request_error",
    "param": "input",
    "code": "context_length_exceeded"
  }
}