> For the complete documentation index, see [llms.txt](https://docs.mashagpt.ru/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.mashagpt.ru/api/embeddings.md).

# Эмбеддинги

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

## Объект `embedding`

**index**  integer\
Индекс эмбеддинга в списке

***

**embedding** array\
Эмбеддинг, который представляет собой список чисел с плавающей запятой. Длина вектора зависит от модели. Для модели `text-embedding-ada-002` длинна вектора составляет 1536.

***

**object**  string\
Тип объекта, который всегда `"embedding"`

***

{% code title="Объект "embedding"" lineNumbers="true" %}

```json
{
  "object": "embedding",
  "embedding": [
    0.0023064255,
    -0.009327292,
    .... (1536 floats total for ada-002)
    -0.0028842222,
  ],
  "index": 0
}
```

{% endcode %}

***

## Создание эмбеддинга

<mark style="color:green;">`POST`</mark> `https://api.mashagpt.ru/v1/embeddings`

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

#### Request Body

| Name                                    | Type            | Description                                                                                                                                                                                                                                                                                                                                |
| --------------------------------------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| input<mark style="color:red;">\*</mark> | String \| Array | Текст для генерации эмбеддинга в виде строки или массива токенов. Чтобы сгенерировать несколько эмбеддингов в одном запросе, передайте массив строк или массив массивов токенов. Входные данные не должны превышать максимальное количество токенов для модели (8192 токенов для `text-embedding-ada-002`) и не могут быть пустой строкой. |
| model<mark style="color:red;">\*</mark> | String          | Id модели которую использовать. На данный момент поддерживается только `text-embedding-ada-002`.                                                                                                                                                                                                                                           |
| encoding\_format                        | String          | Формат возврата эмбеддингов. Может быть `float` или `base64`.                                                                                                                                                                                                                                                                              |
| user                                    | String          | Уникальный идентификатор, представляющий вашего конечного пользователя.                                                                                                                                                                                                                                                                    |

{% tabs %}
{% tab title="200: OK Список эмбеддингов" %}
Список `data` [эмбеддингов](#obekt-embedding).
{% endtab %}
{% endtabs %}

{% code title="Пример запроса" lineNumbers="true" %}

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

{% endcode %}

{% code title="Пример ответа" lineNumbers="true" %}

```json
{
  "object": "list",
  "data": [
    {
      "object": "embedding",
      "embedding": [
        0.0023064255,
        -0.009327292,
        .... (1536 floats total for ada-002)
        -0.0028842222,
      ],
      "index": 0
    }
  ],
  "model": "text-embedding-ada-002",
  "usage": {
    "prompt_tokens": 8,
    "total_tokens": 8,
    "prompt_energy": 8,
    "total_energy": 8
  }
}
```

{% endcode %}
