QueryWorkbookCreate¶
- pydantic model openapi_client.models.query_workbook_create.QueryWorkbookCreate¶
Request body for POST /workbooks. Every property is optional and the body itself may be omitted entirely, in which case a workbook is created with default settings.
- Fields:
- field title: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None (alias 'Title')¶
Title for the new workbook. Defaults to “New Workbook” when omitted. Leading and trailing whitespace is stripped, and an empty or whitespace-only title is rejected with IPV-1002. Note the length limit is enforced by the API Gateway validator rather than by the backend.
- field auto_generate_title: Optional[StrictBool] = False (alias 'AutoGenerateTitle')¶
When true, the workbook title is generated from the conversation once enough messages exist.
- field expire_after: Optional[Annotated[int, Field(le=1825, strict=True, ge=1)]] = 365 (alias 'ExpireAfter')¶
Number of days after which the workbook expires, counted from now.
- field chat_configuration: Optional[QueryWorkbookChatConfiguration] = None (alias 'ChatConfiguration')¶
- field query_configuration: Optional[QueryWorkbookExecutionConfiguration] = None (alias 'QueryConfiguration')¶
- 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 QueryWorkbookCreate 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 QueryWorkbookCreate from a dict
- Return type:
Optional[Self]