com.databricks.sdk.service.dashboards

Interface GenieService

@Generated
public interface GenieService

Genie provides a no-code experience for business users, powered by AI/BI. Analysts set up spaces that business users can use to ask questions using natural language. Genie uses data registered to Unity Catalog and requires at least CAN USE permission on a Pro or Serverless SQL warehouse. Also, Databricks Assistant must be enabled.

This is the high-level interface, that contains generated methods.

Evolving: this interface is under development. Method signatures may change.

Method Summary

Modifier and Type	Method and Description
GenieMessage	createMessage(GenieCreateConversationMessageRequest genieCreateConversationMessageRequest) Create conversation message.
GenieGetMessageQueryResultResponse	executeMessageAttachmentQuery(GenieExecuteMessageAttachmentQueryRequest genieExecuteMessageAttachmentQueryRequest) Execute message attachment SQL query.
GenieGetMessageQueryResultResponse	executeMessageQuery(GenieExecuteMessageQueryRequest genieExecuteMessageQueryRequest) [Deprecated] Execute SQL query in a conversation message.
GenieGenerateDownloadFullQueryResultResponse	generateDownloadFullQueryResult(GenieGenerateDownloadFullQueryResultRequest genieGenerateDownloadFullQueryResultRequest) Generate full query result download.
GenieGetDownloadFullQueryResultResponse	getDownloadFullQueryResult(GenieGetDownloadFullQueryResultRequest genieGetDownloadFullQueryResultRequest) Get download full query result.
GenieMessage	getMessage(GenieGetConversationMessageRequest genieGetConversationMessageRequest) Get conversation message.
GenieGetMessageQueryResultResponse	getMessageAttachmentQueryResult(GenieGetMessageAttachmentQueryResultRequest genieGetMessageAttachmentQueryResultRequest) Get message attachment SQL query result.
GenieGetMessageQueryResultResponse	getMessageQueryResult(GenieGetMessageQueryResultRequest genieGetMessageQueryResultRequest) [Deprecated] Get conversation message SQL query result.
GenieGetMessageQueryResultResponse	getMessageQueryResultByAttachment(GenieGetQueryResultByAttachmentRequest genieGetQueryResultByAttachmentRequest) [Deprecated] Get conversation message SQL query result.
GenieSpace	getSpace(GenieGetSpaceRequest genieGetSpaceRequest) Get Genie Space.
GenieStartConversationResponse	startConversation(GenieStartConversationMessageRequest genieStartConversationMessageRequest) Start conversation.

Method Detail

createMessage

GenieMessage createMessage(GenieCreateConversationMessageRequest genieCreateConversationMessageRequest)

Create conversation message.

Create new message in a [conversation](:method:genie/startconversation). The AI response uses all previously created messages in the conversation to respond.

executeMessageAttachmentQuery

GenieGetMessageQueryResultResponse executeMessageAttachmentQuery(GenieExecuteMessageAttachmentQueryRequest genieExecuteMessageAttachmentQueryRequest)

Execute message attachment SQL query.

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

executeMessageQuery

GenieGetMessageQueryResultResponse executeMessageQuery(GenieExecuteMessageQueryRequest genieExecuteMessageQueryRequest)

[Deprecated] Execute SQL query in a conversation message.

Execute the SQL query in the message.

generateDownloadFullQueryResult

GenieGenerateDownloadFullQueryResultResponse generateDownloadFullQueryResult(GenieGenerateDownloadFullQueryResultRequest genieGenerateDownloadFullQueryResultRequest)

Generate full query result download.

Initiate full SQL query result download and obtain a `download_id` to track the download progress. This call initiates a new SQL execution to generate the query result. The result is stored in an external link can be retrieved using the [Get Download Full Query Result](:method:genie/getdownloadfullqueryresult) API. Warning: Databricks strongly recommends that you protect the URLs that are returned by the `EXTERNAL_LINKS` disposition. See [Execute Statement](:method:statementexecution/executestatement) for more details.

getDownloadFullQueryResult

GenieGetDownloadFullQueryResultResponse getDownloadFullQueryResult(GenieGetDownloadFullQueryResultRequest genieGetDownloadFullQueryResultRequest)

Get download full query result.

After [Generating a Full Query Result Download](:method:genie/getdownloadfullqueryresult) and successfully receiving a `download_id`, use this API to Poll download progress and retrieve the SQL query result external link(s) upon completion. 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, presigned URL is generated, which can be used to download the results directly from Amazon S3. As a short-lived access credential is embedded in this presigned URL, you should protect the URL. Because presigned URLs are already generated with embedded temporary access credentials, you must not set an Authorization header in the download requests. See [Execute Statement](:method:statementexecution/executestatement) for more details.

getMessage

GenieMessage getMessage(GenieGetConversationMessageRequest genieGetConversationMessageRequest)

Get conversation message.

Get message from conversation.

getMessageAttachmentQueryResult

GenieGetMessageQueryResultResponse getMessageAttachmentQueryResult(GenieGetMessageAttachmentQueryResultRequest genieGetMessageAttachmentQueryResultRequest)

Get message attachment SQL query result.

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`.

getMessageQueryResult

GenieGetMessageQueryResultResponse getMessageQueryResult(GenieGetMessageQueryResultRequest genieGetMessageQueryResultRequest)

[Deprecated] Get conversation message SQL query result.

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`.

getMessageQueryResultByAttachment

GenieGetMessageQueryResultResponse getMessageQueryResultByAttachment(GenieGetQueryResultByAttachmentRequest genieGetQueryResultByAttachmentRequest)

[Deprecated] Get conversation message SQL query result.

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`.

getSpace

GenieSpace getSpace(GenieGetSpaceRequest genieGetSpaceRequest)

Get Genie Space.

Get details of a Genie Space.

startConversation

GenieStartConversationResponse startConversation(GenieStartConversationMessageRequest genieStartConversationMessageRequest)

Start conversation.

Start a new conversation.