Skip to content

QueryGenerationTableDict

Dictionary Type

QueryGenerationTableDict

Bases: TypedDict

Dictionary form of QueryGenerationTable.

Attributes

columns instance-attribute

An array of objects, each of which defines information about a column in the table.

description instance-attribute
description: str | None

A description of the table that helps the query engine understand the contents of the table.

inclusion instance-attribute
inclusion: str | None

Specifies whether to include or exclude the table during query generation. If you specify EXCLUDE, the table will be ignored. If you specify INCLUDE, all other tables will be ignored.

name instance-attribute
name: Required[str]

The name of the table for which the other fields in this object apply.