QueryWorkbookMessagesResponse

pydantic model openapi_client.models.query_workbook_messages_response.QueryWorkbookMessagesResponse

Paginated workbook messages, returned when action=retrieve_messages. In an environment where AI services are disabled this operation returns an empty object instead, so none of the properties below will be present. Treat a response with no messages key as “chat unavailable” rather than “no messages”.

Fields:

• count (int | None)

• messages (List[openapi_client.models.query_workbook_message.QueryWorkbookMessage] | None)

• next_available (str | None)

• total_count (int | None)

field messages: Optional[List[QueryWorkbookMessage]] = None

Messages on the current page, sorted by message time.

field count: Optional[StrictInt] = None

Number of messages returned on this page.

field total_count: Optional[StrictInt] = None

Total number of messages available across all pages.

field next_available: Optional[StrictStr] = None

Whether a further page exists. “yes” means more records remain, so request the next page by advancing offset by limit. “no” means this is the last page and the client must stop iterating.

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 QueryWorkbookMessagesResponse 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 QueryWorkbookMessagesResponse from a dict

Return type:

Optional[Self]