QueryWorkbookChatConfiguration

pydantic model openapi_client.models.query_workbook_chat_configuration.QueryWorkbookChatConfiguration

Chat configuration for the workbook. Every member is individually optional, but the backend rejects any property not listed here with IPV-1004. One conditional rule is not expressible in the schema: TargetLocation is effectively required whenever QueryOn is supplied. Sending QueryOn without TargetLocation causes the request to fail with HTTP 500.

Fields:

• auto_run_query (str | None)

• model_id (str | None)

• query_on (openapi_client.models.query_workbook_chat_configuration_query_on.QueryWorkbookChatConfigurationQueryOn | None)

• role_id (str | None)

• row_limit (int | None)

• target_location (str | None)

field auto_run_query: Optional[StrictStr] = None (alias 'AutoRunQuery')

Whether AI-generated queries should be executed automatically.

field model_id: Optional[StrictStr] = None (alias 'ModelId')

Model id used to power the SQL AI conversation. Must be a model registered for the nl2sql component. Rejected with IPV-1004 when AI services are disabled for the environment.

field query_on: Optional[QueryWorkbookChatConfigurationQueryOn] = None (alias 'QueryOn')

field target_location: Optional[StrictStr] = None (alias 'TargetLocation')

Query backend for the chat. Required in practice whenever QueryOn is supplied, as noted in the schema description.

field role_id: Optional[StrictStr] = None (alias 'RoleId')

Amorphic role id to use when running queries from this workbook. Must be a role the caller is attached to, otherwise the request is rejected with AUTH-1010.

field row_limit: Optional[Annotated[int, Field(le=100000, strict=True, ge=1)]] = None (alias 'RowLimit')

Maximum number of rows the agent should request when generating queries for this workbook.

to_str()

Returns the string representation of the model using alias

Return type:

str

to_json()

Returns the JSON representation of the model using alias

Return type:

str

classmethod from_json(json_str)

Create an instance of QueryWorkbookChatConfiguration from a JSON string

Return type:

Optional[Self]

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

Return type:

Dict[str, Any]

classmethod from_dict(obj)

Create an instance of QueryWorkbookChatConfiguration from a dict

Return type:

Optional[Self]