Составить черновик типизатора по описанию или документу-образцу
Запрашивает у модели схему, название и инструкции; ничего не сохраняется (типизатор создаётся через POST /v1/typizers). Передайте description, file_id или оба. Каждый вызов расходует одну единицу дневной квоты ассистента (100 на организацию и 100 на пользователя, сутки по Москве) непосредственно перед обращением к модели; сверх квоты — 429 с Retry-After до полуночи по Москве. Конвертация образца: документ, который не удаётся сконвертировать, — 422 extraction_failed с param: "file_id" (не повторяйте; запоминается на 24 ч); занятый конвертер — 429 с Retry-After: 5; сверх 200 конвертаций на пользователя за сутки по Москве — 429 с Retry-After до полуночи по Москве; при исчерпанной квоте ассистента — 429 до любой конвертации; недоступный или слишком медленный конвертер или модель — 503 upstream_unavailable (повторите позже). Ответ модели, не являющийся корректной схемой, — 422 extraction_failed. Idempotency-Key принимается и игнорируется. Доступ: ключ API со скоупом typizers:write или сессия.
AuthorizationBearer <token>Ключ API (tz_live_…). Если операция требует скоупы, они нужны ключу; у сессии есть все скоупы.
Typizer-Organization?stringОрганизация, от имени которой выполняется запрос (org_…). По умолчанию сессия действует от имени своей активной организации; ключ API может указать только свою.
Idempotency-Key?stringПринимается для единообразия клиентов и в этой операции игнорируется: ничего не блокируется и не повторяется (некорректное значение всё же может получить 400).
^[\x20-\x7E]+$1 <= length <= 255application/json- body
description?stringЧто это за документы и какие данные извлекать
length <= 4000file_id?stringДокумент-образец: модели показываются его первые 10 страниц
length <= 64Черновик
application/json- response
object*"typizer_draft""typizer_draft"name*stringschema*Подмножество JSON Schema (draft 2020-12) с корнем object: не больше 200 полей и 10 уровней схемы (core), 131072 байт (128 КиБ) в компактном JSON в UTF-8, 64 уровней вложенности JSON (включая examples), и ни в одной строке нет NUL или непарного суррогата. Имена полей — буквы, десятичные цифры, _ и -, начинаются с буквы или _ (они становятся именами элементов XML). Порядок properties сохраняется: по нему идут столбцы результата, элементы XML и XSD.
instructions*stringcurl -X POST 'https://api.typizer.ru/v1/typizers/generate' \ -H 'Content-Type: application/json' \ -d '{}'{ "object": "typizer_draft", "name": "string", "schema": { "property1": null, "property2": null }, "instructions": "string"}