Необходимые cookie-файлы нужны для работы сайта. Аналитические cookie (Яндекс Метрика) — только с вашего согласия. Политика cookie-файлов

Тема оформления
СправочникСправочник APIТипизаторы

Получить типизатор с текущей версией

Доступ: ключ API со скоупом typizers:read или сессия.

GET/v1/typizers/{id}Песочница

Авторизация

Проверяем сессию Кабинета…

Параметры

обязательный
string
Проверяем сессию Кабинета…

Authorization

headerAuthorizationBearer <token>

Ключ API (tz_live_…). Если операция требует скоупы, они нужны ключу; у сессии есть все скоупы.

Path Parameters

id*string

Header Parameters

Typizer-Organization?string

Организация, от имени которой выполняется запрос (org_…). По умолчанию сессия действует от имени своей активной организации; ключ API может указать только свою.

Response Body

Типизатор

application/json
  1. response
id*string
object*"typizer"
Value in"typizer"
name*string
description*string|null
version*integer

Текущая версия

schema*

Схема текущей версии

instructions*string
default_format*string

Формат выгрузки прогона, если формат не указан

Value in"json""xml""csv""xlsx"
mode*string

precise перепроверяет извлечение (оплачивается больше страниц)

Value in"standard""precise"
created_at*string
Formatdate-time
updated_at*string
Formatdate-time
curl -X GET 'https://api.typizer.ru/v1/typizers/string'
Example Response
{  "id": "string",  "object": "typizer",  "name": "string",  "description": "string",  "version": 0,  "schema": {    "property1": null,    "property2": null  },  "instructions": "string",  "default_format": "json",  "mode": "standard",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}

Составить черновик типизатора по описанию или документу-образцу

Запрашивает у модели схему, название и инструкции; ничего не сохраняется (типизатор создаётся через 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 или сессия.

Получить версию типизатора

Доступ: ключ API со скоупом typizers:read или сессия.