QueryWorkbookUpdate

pydantic model openapi_client.models.query_workbook_update.QueryWorkbookUpdate

Request body for PUT /workbooks/{workbook_id}. Every property is optional and an empty body is a valid no-op that still returns 200. Properties that are omitted keep their stored values, and unrecognised properties are ignored rather than rejected. Most properties are written only when the supplied value differs from the stored one; ExpireAfter is the exception and always rewrites the expiry from the current time.

Fields:

• auto_generate_title (bool | None)

• chat_configuration (openapi_client.models.query_workbook_update_chat_configuration.QueryWorkbookUpdateChatConfiguration | None)

• expire_after (int | None)

• is_pinned (bool | None)

• query_configuration (openapi_client.models.query_workbook_update_query_configuration.QueryWorkbookUpdateQueryConfiguration | None)

• title (str | None)

field title: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None (alias 'Title')

Updated title. Must be a non-empty string; whitespace is stripped. Setting this also sets IsTitleUpdated to true, which stops the auto-generated title from later overwriting it. The length limit is enforced by the API Gateway validator rather than by the backend.

field expire_after: Optional[Annotated[int, Field(le=1825, strict=True, ge=1)]] = None (alias 'ExpireAfter')

Number of days after which the workbook expires. Always applied, recomputing the absolute expiry from the current time.

field is_pinned: Optional[StrictBool] = None (alias 'IsPinned')

Whether to pin or unpin the workbook in listings.

field auto_generate_title: Optional[StrictBool] = None (alias 'AutoGenerateTitle')

Whether the title should be auto-generated from the conversation.

field chat_configuration: Optional[QueryWorkbookUpdateChatConfiguration] = None (alias 'ChatConfiguration')

field query_configuration: Optional[QueryWorkbookUpdateQueryConfiguration] = 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 QueryWorkbookUpdate 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 QueryWorkbookUpdate from a dict

Return type:

Optional[Self]