Class GenieClient

Creates a Genie space from a serialized payload.

Download a rendered image of a message visualization attachment. The response body is the raw PNG image, not a JSON payload. This is only available if the attachment is a visualization and the message status is COMPLETED.

Cancels an in-flight agent-mode response. response_id is the id returned in the response.created event from the agent-mode responses endpoint. The response stops at the next agent boundary and its terminal state is returned.

Sends a new message in a chat-mode conversation. The AI response uses all previously created messages in the conversation to respond.

Creates and runs chat-mode evaluations for multiple benchmark questions in a Genie space.

Create a comment on a conversation message.

Delete a conversation.

Delete a conversation message.

Execute the SQL for a message query attachment. Use this API when the query attachment has expired and needs to be re-executed.

DEPRECATED: Use Execute Message Attachment Query instead.

Initiates a new SQL execution and returns a download_id and download_id_signature that you can use to track the progress of the download. The query result is stored in an external link and can be retrieved using the Get Download Full Query Result API. Both download_id and download_id_signature must be provided when calling the Get endpoint.

Warning: Databricks strongly recommends that you protect the URLs that are returned by the EXTERNAL_LINKS disposition.

When you use the EXTERNAL_LINKS disposition, a short-lived cloud-storage URL is generated to download the results. The URL contains temporary access credentials, so protect it and do not set an Authorization header in the download request.

See Execute Statement for more details.

Gets a message from a chat-mode or agent-mode conversation. For a complete agent-mode transcript, use the List conversation items endpoint.

After Generating a Full Query Result Download and successfully receiving a download_id and download_id_signature, use this API to poll the download progress. Both download_id and download_id_signature are required to call this endpoint. When the download is complete, the API returns the result in the EXTERNAL_LINKS disposition, containing one or more external links to the query result files.

Warning: Databricks strongly recommends that you protect the URLs that are returned by the EXTERNAL_LINKS disposition.

When you use the EXTERNAL_LINKS disposition, a short-lived cloud-storage URL is generated to download the results. The URL contains temporary access credentials, so protect it and do not set an Authorization header in the download request.

See Execute Statement for more details.

Get details for evaluation results.

Get evaluation run details.

Get the result of SQL query if the message has a query attachment. This is only available if a message has a query attachment and the message status is EXECUTING_QUERY OR COMPLETED.

DEPRECATED: Use Get Message Attachment Query Result instead.

DEPRECATED: Use Get Message Attachment Query Result instead.

Get details of a Genie Space.

List all comments across all messages in a conversation.

Lists messages in a chat-mode or agent-mode conversation. Agent-mode messages are returned as GenieMessage projections. Use the List conversation items endpoint for the complete reasoning and tool-call history.

Get a list of conversations in a Genie Space.

List evaluation results for a specific evaluation run.

Lists all evaluation runs in a space.

List comments on a specific conversation message.

Get list of Genie Spaces.

Sends feedback for a message in a chat-mode or agent-mode conversation.

Starts a new chat-mode conversation and sends its first message.

Move a Genie Space to the trash.

Updates a Genie space with a serialized payload.