Перейти до основного вмісту
POST
/
v1
/
embeddings
from openai import OpenAI client = OpenAI( base_url="https://api.cometapi.com/v1", api_key="<COMETAPI_KEY>", ) response = client.embeddings.create( model="text-embedding-3-small", input="The food was delicious and the waiter was friendly.", ) print(response.data[0].embedding[:5]) # First 5 dimensions print(f"Dimensions: {len(response.data[0].embedding)}")
{
  "object": "list",
  "data": [
    {
      "object": "embedding",
      "index": 0,
      "embedding": [
        -0.0021,
        -0.0491,
        0.0209,
        0.0314,
        -0.0453
      ]
    }
  ],
  "model": "text-embedding-3-small",
  "usage": {
    "prompt_tokens": 2,
    "total_tokens": 2
  }
}

Огляд

API Embeddings генерує векторні представлення тексту, які відображають семантичне значення. Ці вектори можна використовувати для семантичного пошуку, кластеризації, класифікації, виявлення аномалій і retrieval-augmented generation (RAG). CometAPI підтримує embedding-моделі від кількох провайдерів. Передайте один або кілька текстових рядків і отримайте назад числові вектори, які можна зберігати у векторній базі даних або безпосередньо використовувати для обчислення подібності.

Доступні моделі

ModelDimensionsMax TokensBest For
text-embedding-3-large3,072 (змінюється)8,191Найвища якість embeddings
text-embedding-3-small1,536 (змінюється)8,191Економно, швидко
text-embedding-ada-0021,536 (фіксовано)8,191Сумісність зі спадщиною
Перегляньте список моделей, щоб побачити всі доступні embedding-моделі та ціни.

Важливі примітки

Зменшення розмірності — Моделі text-embedding-3-* підтримують параметр dimensions, що дає змогу скорочувати embedding-вектор без значної втрати точності. Це може зменшити витрати на зберігання до 75%, зберігаючи більшість семантичної інформації.
Пакетний input — Ви можете створювати embeddings для кількох текстів в одному запиті, передаючи масив рядків у параметр input. Це значно ефективніше, ніж робити окремі запити для кожного тексту.

Авторизації

Authorization
string
header
обов'язково

Bearer token authentication. Use your CometAPI key.

Тіло

application/json
model
string
обов'язково

The embedding model to use. See the Models page for current embedding model IDs.

Приклад:

"text-embedding-3-small"

input
обов'язково

The text to embed. Can be a single string, an array of strings, or an array of token arrays. Each input must not exceed the model's maximum token limit (8,191 tokens for text-embedding-3-* models).

encoding_format
enum<string>
за замовчуванням:float

The format of the returned embedding vectors. float returns an array of floating-point numbers. base64 returns a base64-encoded string representation, which can reduce response size for large batches.

Доступні опції:
float,
base64
dimensions
integer

The number of dimensions for the output embedding vector. Only supported by text-embedding-3-* models. Reducing dimensions can lower storage costs while maintaining most of the embedding's utility.

Необхідний діапазон: x >= 1
user
string

A unique identifier for your end-user, which can help monitor and detect abuse.

Відповідь

200 - application/json

A list of embedding vectors for the input text(s).

object
enum<string>

The object type, always list.

Доступні опції:
list
Приклад:

"list"

data
object[]

An array of embedding objects, one per input text. When multiple inputs are provided, results are returned in the same order as the input.

model
string

The model used to generate the embeddings.

Приклад:

"text-embedding-3-small"

usage
object

Token usage statistics for this request.