Вложения
Используйте встраивание ответов с запросом, совместимым с OpenAI.
Проверьте обработку запросов и ответов для рабочих процессов поиска, извлечения, кластеризации и рекомендаций с помощью возвращаемых векторов, сохраняя при этом видимость ключей на стороне сервера и их использования.
Последнее обновление: July 12, 2026. Examples использование safe placeholders и сделать не включить real API ключs, секреты, или customer данные.
Рекомендуется первое использование
Начните с небольшого пакета, сохраните векторы с исходными метаданными, затем добавьте очередь, повторные попытки и мониторинг ограничения скорости, прежде чем индексировать большой корпус.
Путь установки
Четыре шага от текста до возвращаемой векторной фигуры.
Step 1
Аутентификация на стороне сервера
Используйте ключ API с областью внедрения: запись из доверенного серверного кода.
Открыть разделStep 2
Отправить ввод текста
Отправьте одну строку или массив строк в конечную точку внедрения, совместимую с OpenAI.
Открыть разделStep 3
Чтение векторов с метаданными
Подтвердите возвращенную векторную форму с помощью идентификатора вашего документа, источника и любых поисковых фильтров, которые нужны вашему продукту.
Открыть разделStep 4
Мониторинг использования
Отслеживайте количество запросов, токены подсказок, состояние оценки и ответы 429 перед большими заданиями по индексированию.
Открыть разделКонечная точка
Отправьте текст в конечную точку внедрения.
Используйте OpenAI-совместимую конечную точку /v1 с серверным ключом с ограниченной областью действия. Не допускайте попадания необработанного содержимого в журналы, если это не разрешено вашей политикой данных.
| Товар | Значение | Примечания |
|---|---|---|
| Метод | POST | Отправьте JSON в конечную точку внедрения. |
| Конечная точка | https://unlimitedcodex.com/v1/embeddings | Используйте ту же самую базу /v1 URL для завершения чата и проверки запроса изображения. |
| Авторизация | Токен на предъявителя | Используйте ключ API с ограниченной областью действия с доступом на запись: внедрение. |
| Тип контента | приложение/json | Тело запроса должно быть действительным JSON. |
Запросить форму
Отправьте один вход или небольшую партию.
Наименьший полезный запрос включает в себя модель и входные данные. Используйте ввод массива, когда ваш клиент может сопоставить каждый возвращаемый индекс с исходной записью.
| Поле | Статус | Примечания |
|---|---|---|
| модель | Рекомендуется | Явно передайте значение модели внедрения. Используйте значение модели из предоставленных вами сведений о настройке. |
| ввод | Требуется | Отправьте одну непустую строку или массив непустых строк. |
| кодирующий_формат | Необязательно | Используйте число с плавающей запятой для числовых векторов или base64, если ваш уровень хранения предпочитает закодированную полезную нагрузку. |
const response = await fetch("https://unlimitedcodex.com/v1/embeddings", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.UCX_API_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({
model: "ucx-embedding-3-small",
input: [
"Release checklist for a safe API launch.",
"Rate states and usage review before rollout."
],
encoding_format: "float"
})
});
const body = await response.json();
if (!response.ok) {
throw new Error(body.error?.code ?? "embedding_request_failed");
}
const vectors = body.data.map((item) => item.embedding);Форма ответа
Сохраните вектор и исходный контекст вместе.
Ответ включает в себя один объект внедрения для каждого входа, а также поля использования для отчетности и проверки затрат.
| Поле | Значение | Примечания |
|---|---|---|
| объект | список | Идентифицирует ответ как список внедренных объектов. |
| данные[].встраивание | число[] или base64 | Соответствует запрошенному кодовому_формату. |
| данные[].index | позиция ввода | Используйте это, чтобы сопоставить входные данные массива с исходными записями. |
| использование.prompt_tokens | количество входных токенов | Подсчитывает объем текста, используемый для отчетов об использовании и проверки ограничений скорости. |
{
"object": "list",
"id": "embd_example",
"model": "ucx-embedding-3-small",
"data": [
{
"object": "embedding",
"index": 0,
"embedding": [0.1221, -0.7442, 0.0314]
}
],
"usage": {
"prompt_tokens": 18,
"total_tokens": 18
}
}{
"model": "ucx-embedding-3-small",
"input": "Short text to index.",
"encoding_format": "base64"
}Ограничения и ошибки
Относитесь к индексированию как к работе с учетом скорости.
Рабочие нагрузки по внедрению могут быстро расти при изменении корпуса. Включите отслеживание прогресса, повторных попыток и проверку скорости в свой конвейер индексирования.
Конечная точка возвращает OpenAI-совместимые векторы, поэтому команды могут подтвердить синтаксический анализ, отчеты об использовании и поведение хранилища перед более масштабными рабочими нагрузками по внедрению.
Запросы на внедрение учитываются как один запрос плюс токены подсказки.
Ввод массива полезен для небольших пакетов, но для больших заданий индексирования следует использовать собственную очередь и отсрочку.
Конечная точка возвращает ответ с полным списком; вложения не передаются в потоковом режиме.
Используйте обработку 429 из руководства по ограничению скорости перед индексированием большого корпуса.
Не отправляйте секретные данные, регулируемые данные или текстовые сообщения клиентов, если такое использование не разрешено вашим соглашением.
FAQ
Вопросы по вложениям.
Могу ли я отправить несколько текстов в одном запросе на встраивание?
Да. Поле ввода принимает одну непустую строку или массив непустых строк. Ответ включает индекс для каждого возвращенного внедрения.
Какая область действия требуется для ключа внедрения?
Используйте ключ API с областью внедрения:write. Сохраните ключ на стороне сервера и отправьте его как токен на предъявителя.
Есть ли потоковая передача вложений?
Нет. Конечная точка внедрения возвращает полный ответ в виде списка с полями данных и использования.
Как мне обрабатывать большие задания по индексированию?
Разбивайте работу на небольшие порции, сохраняйте прогресс в своей собственной системе, повторяйте временные сбои с отсрочкой и делайте паузу при повышении скорости до тех пор, пока мощность не изменится.
Бесплатные инструменты
Проверка и оценка рабочих нагрузок по внедрению
Проверяйте полезные данные, оценивайте токены, моделируйте давление квот и сравнивайте затраты перед индексацией производственных данных.
Запросить валидатор
Проверьте полезные данные чата, встраивания и изображений JSON на соответствие правилам, совместимым с unlimitedcodex OpenAI.
Оценщик токенов
Оцените объем токена по тексту подсказки или ответа перед планированием и запуском квоты.
Оценщик квот
Преобразуйте MAU и подсказывайте предположения в ежемесячные токены, запросы и предупреждения о пороговых значениях квоты.
Калькулятор стоимости
Оцените ежемесячные расходы OpenAI и сравните их с фиксированными unlimitedcodex еженедельными или ежемесячными пакетами.
Следующий шаг
Сочетайте встраивания с аутентификацией, ограничениями скорости и обработкой ошибок.
Прежде чем индексировать контент, ориентированный на клиента, подтвердите область действия ключа, правила обработки данных, поведение ограничения скорости и политику повторных попыток.