Строка
  • Документация
  • API
Information
· Компании
    Справочник отраслейgetСправочник субъектов РФgetСубъект РФ по кодуgetСправочник населённых пунктовget
Компании
    Поиск компанийgetПоиск компаний (POST)postЭкспорт компанийpost
Schemas
Strokka API
Strokka API

Schemas


AppliedFilterMeta

field
​string · required
operator
​string · required
value
​string
Default:

ColumnMeta

Метаданные колонки для динамической таблицы клиента.
key
​string · required
label
​string · required
type
​string · enum
Enum values:
text
url
email
phone
keywords
social
json
number
Default: text
filterable
​boolean
Default: false
sortable
​boolean
Default: false
serverSortable
​boolean
Default: false
​

CompanySearchRequest

Аналог GET /companies, но параметры передаются в JSON-теле.
​

Текст для семантического / полнотекстового поиска. Если не задан — режим SQL.

skip
​integer · min: 0

Смещение пагинации.

Default: 0
limit
​integer · min: 1 · max: 1000

Размер страницы (максимум 1000).

Default: 100
​

Поле сортировки (только SQL): id, domain, name, sector, region, city, employees_range.

sortOrder
​string

Порядок: asc или desc.

Default: asc
​FilterRule[]

Массив правил фильтрации.

searchMode
​string · enum

Режим поиска: auto, vector, fts, hybrid, sql, entity.

Enum values:
auto
vector
fts
hybrid
sql
entity
Default: auto
​

Semantic предыдущего запроса (уточнение таблицы).

​

Колонки предыдущей таблицы при уточнении («добавь телеграм»).

​

Минимальный порог схожести в Qdrant (0–1). Выше — строже отбор, ниже — шире выдача. По умолчанию 0.8.

​

Явный список полей в ответе (name, email, phone, whatsapp, …). Если не задан — используются значения по умолчанию.

​

Дедупликация по контактным полям: email, phone. Пустые значения не участвуют; повтор по любому полю отсекается.

FilterRule

Одно правило фильтрации для POST /companies/search.
field
​string · required

Имя поля таблицы core.companies

operator
​string · required

Оператор сравнения: contains, not_contains, starts_with, ends_with, eq, neq, in, empty, not_empty, gt, gte, lt, lte, between

value
​string

Значение для сравнения. Для in и between — несколько значений через запятую. Для empty / not_empty — можно передать true.

Default:
logic
​string

Логическая связь с предыдущим правилом: and или or. Не учитывается для первого фильтра.

Default: and

HTTPValidationError

​ValidationError[]

SearchResponse

Ответ постраничного поиска или списка компаний.
​object[] · required

Запрошенная страница записей

totalCount
​integer · required

Общее число записей, попадающих под условие

skip
​integer · required

Текущее смещение

limit
​integer · required

Размер страницы

searchMode
​string · required

Режим: sql, vector, fts, hybrid, entity

​object · required

Время этапов обработки, сек.

​ColumnMeta[]

Метаданные колонок для UI (порядок и подписи).

​

Нормализованный текст поискового запроса (если был передан параметр search)

sortingMode
​string · enum

Где применяется sortBy: server (SQL), fixed (релевантность), client.

Enum values:
server
client
fixed
Default: server
cached
​boolean

Были ли использованы кэшированные данные

Default: false
​

Список модулей, запрошенных/выбранных для ответа в auto-режиме.

​

Поля JSON в ответе после compile (колонки таблицы).

​

Режим проекции колонок: explicit, inferred, minimal.

​

Интент: catalog (полный список по фильтрам), discovery (тема), entity.

​

Краткое объяснение, как система поняла запрос (auto-режим).

​AppliedFilterMeta[]

Фильтры, реально применённые к запросу (в т.ч. от LLM в auto).

​

Поля дедупликации, применённые к выдаче (email, phone).

ValidationError

​array · required
msg
​string · required
type
​string · required
On this page
  • AppliedFilterMeta
  • ColumnMeta
  • CompanySearchRequest
  • FilterRule
  • HTTPValidationError
  • SearchResponse
  • ValidationError