QueryWorkbookDetails

pydantic model openapi_client.models.query_workbook_details.QueryWorkbookDetails

Full detail of a single workbook, returned by GET /workbooks/{workbook_id} when no action query parameter is given. ChatConfiguration and QueryConfiguration are present only if they were set; everything else is always returned.

Fields:

• access_type (str | None)

• auto_generate_title (bool | None)

• chat_configuration (openapi_client.models.query_workbook_chat_configuration.QueryWorkbookChatConfiguration | None)

• created_by (str | None)

• creation_time (str | None)

• expiration_time (int | None)

• expire_after (int | None)

• is_pinned (bool | None)

• is_title_updated (bool | None)

• last_modified_by (str | None)

• last_modified_time (str | None)

• query_configuration (openapi_client.models.query_workbook_execution_configuration.QueryWorkbookExecutionConfiguration | None)

• title (str | None)

• workbook_id (str | None)

field workbook_id: Optional[StrictStr] = None (alias 'WorkbookId')

Unique identifier for the workbook

field title: Optional[StrictStr] = None (alias 'Title')

Workbook title

field creation_time: Optional[StrictStr] = None (alias 'CreationTime')

Workbook creation timestamp

field created_by: Optional[StrictStr] = None (alias 'CreatedBy')

User who created the workbook

field last_modified_by: Optional[StrictStr] = None (alias 'LastModifiedBy')

User who last modified the workbook

field last_modified_time: Optional[StrictStr] = None (alias 'LastModifiedTime')

Last modification timestamp

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

Whether the title should be auto-generated from the conversation

field is_title_updated: Optional[StrictBool] = None (alias 'IsTitleUpdated')

Whether the workbook title has already been updated either manually or by auto-generation

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

Whether the workbook is pinned for the user

field expire_after: Optional[StrictInt] = None (alias 'ExpireAfter')

Number of days after which the workbook expires (computed from the stored ExpirationTime)

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

field query_configuration: Optional[QueryWorkbookExecutionConfiguration] = None (alias 'QueryConfiguration')

field expiration_time: Optional[StrictInt] = None (alias 'ExpirationTime')

Absolute expiry of the workbook as a Unix epoch timestamp in seconds. ExpireAfter is derived from this value.

field access_type: Optional[StrictStr] = None (alias 'AccessType')

The caller’s access level to the 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 QueryWorkbookDetails 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 QueryWorkbookDetails from a dict

Return type:

Optional[Self]