QueryWorkbookMessage

pydantic model openapi_client.models.query_workbook_message.QueryWorkbookMessage

A single message in a workbook conversation. Individual properties may be absent when they were never stored.

Fields:
field message_id: Optional[StrictStr] = None (alias 'MessageId')

Message identifier.

field message_time: Optional[StrictStr] = None (alias 'MessageTime')

Timestamp at which the message was recorded.

field content: Optional[StrictStr] = None (alias 'Content')

Message body. Note this field carries two different kinds of value: normally the message text, but when ContentType is “chart” it is instead a presigned URL to a generated HTML chart, valid for eight hours. Check ContentType before rendering.

field content_type: Optional[StrictStr] = None (alias 'ContentType')

How to interpret Content. The value “chart” means Content is a presigned URL rather than text.

field type: Optional[StrictStr] = None (alias 'Type')

Whether the message came from the user or the assistant.

field reply_to: Optional[StrictStr] = None (alias 'ReplyTo')

Identifier of the message this one replies to.

field metadata: Optional[Dict[str, Any]] = None (alias 'Metadata')

Additional message metadata written by the SQL AI producer. Passed through without reshaping, so no structure is defined here.

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

Return type:

Optional[Self]