Skip to content
Kortexya Kortexya Reasoning Layer SDK

Interface: DiscoverSchemaRequest

@kortexya/reasoninglayer

@kortexya/reasoninglayer / Sources / DiscoverSchemaRequest

Interface: DiscoverSchemaRequest

Defined in: src/types/sources.ts:340

Request to discover schema from a registered source.

Remarks

Wire format is snake_case (sample_size, include_sample_data, type_filter, exclude_types).

Properties

excludeTypes?

optional excludeTypes: string[] | null

Defined in: src/types/sources.ts:363

Exclude these types from discovery.

Conjoins with the source config’s exclude_tables; an exclusion always wins over an inclusion.

includeSampleData?

optional includeSampleData: boolean

Defined in: src/types/sources.ts:344

Whether to include sample data in response (default: true).

sampleSize?

optional sampleSize: number

Defined in: src/types/sources.ts:342

Sample size for schema inference (default: 100).

typeFilter?

optional typeFilter: string[] | null

Defined in: src/types/sources.ts:356

Discover only these types (default: all).

The request-scoped counterpart to the source config’s include_tables, and — like it — an explicit narrowing: naming the subset proceeds even when the source has more candidate types than the discovery cap allows. This is how a client discovers the subset a user picked out of ListTablesResponse without re-registering the source. It conjoins with the source config’s own include_tables: a request narrows within the registration, it cannot widen past it.