com.databricks.sdk.service.dashboards

Class GenieAPI

java.lang.Object

com.databricks.sdk.service.dashboards.GenieAPI

@Generated
public class GenieAPI
extends Object

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.

Constructor Summary

Constructors

Constructor and Description
GenieAPI(ApiClient apiClient) Regular-use constructor
GenieAPI(GenieService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
Wait<GenieMessage,GenieMessage>	createMessage(GenieCreateConversationMessageRequest request) Create conversation message.
Wait<GenieMessage,GenieMessage>	createMessage(String spaceId, String conversationId, String content)
GenieGetMessageQueryResultResponse	executeMessageAttachmentQuery(GenieExecuteMessageAttachmentQueryRequest request) Execute message attachment SQL query.
GenieGetMessageQueryResultResponse	executeMessageAttachmentQuery(String spaceId, String conversationId, String messageId, String attachmentId)
GenieGetMessageQueryResultResponse	executeMessageQuery(GenieExecuteMessageQueryRequest request) [Deprecated] Execute SQL query in a conversation message.
GenieGetMessageQueryResultResponse	executeMessageQuery(String spaceId, String conversationId, String messageId)
GenieGenerateDownloadFullQueryResultResponse	generateDownloadFullQueryResult(GenieGenerateDownloadFullQueryResultRequest request) Generate full query result download.
GenieGenerateDownloadFullQueryResultResponse	generateDownloadFullQueryResult(String spaceId, String conversationId, String messageId, String attachmentId)
GenieGetDownloadFullQueryResultResponse	getDownloadFullQueryResult(GenieGetDownloadFullQueryResultRequest request) Get download full query result.
GenieGetDownloadFullQueryResultResponse	getDownloadFullQueryResult(String spaceId, String conversationId, String messageId, String attachmentId, String downloadId)
GenieMessage	getMessage(GenieGetConversationMessageRequest request) Get conversation message.
GenieMessage	getMessage(String spaceId, String conversationId, String messageId)
GenieGetMessageQueryResultResponse	getMessageAttachmentQueryResult(GenieGetMessageAttachmentQueryResultRequest request) Get message attachment SQL query result.
GenieGetMessageQueryResultResponse	getMessageAttachmentQueryResult(String spaceId, String conversationId, String messageId, String attachmentId)
GenieGetMessageQueryResultResponse	getMessageQueryResult(GenieGetMessageQueryResultRequest request) [Deprecated] Get conversation message SQL query result.
GenieGetMessageQueryResultResponse	getMessageQueryResult(String spaceId, String conversationId, String messageId)
GenieGetMessageQueryResultResponse	getMessageQueryResultByAttachment(GenieGetQueryResultByAttachmentRequest request) [Deprecated] Get conversation message SQL query result.
GenieGetMessageQueryResultResponse	getMessageQueryResultByAttachment(String spaceId, String conversationId, String messageId, String attachmentId)
GenieSpace	getSpace(GenieGetSpaceRequest request) Get Genie Space.
GenieSpace	getSpace(String spaceId)
GenieService	impl()
Wait<GenieMessage,GenieStartConversationResponse>	startConversation(GenieStartConversationMessageRequest request) Start conversation.
Wait<GenieMessage,GenieStartConversationResponse>	startConversation(String spaceId, String content)
GenieMessage	waitGetMessageGenieCompleted(String conversationId, String messageId, String spaceId)
GenieMessage	waitGetMessageGenieCompleted(String conversationId, String messageId, String spaceId, Duration timeout, Consumer<GenieMessage> callback)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GenieAPI

public GenieAPI(ApiClient apiClient)

Regular-use constructor

GenieAPI

public GenieAPI(GenieService mock)

Constructor for mocks

Method Detail

waitGetMessageGenieCompleted

public GenieMessage waitGetMessageGenieCompleted(String conversationId,
                                                 String messageId,
                                                 String spaceId)
                                          throws TimeoutException

Throws:

TimeoutException

waitGetMessageGenieCompleted

public GenieMessage waitGetMessageGenieCompleted(String conversationId,
                                                 String messageId,
                                                 String spaceId,
                                                 Duration timeout,
                                                 Consumer<GenieMessage> callback)
                                          throws TimeoutException

Throws:

TimeoutException

createMessage

public Wait<GenieMessage,GenieMessage> createMessage(String spaceId,
                                                     String conversationId,
                                                     String content)

createMessage

public Wait<GenieMessage,GenieMessage> createMessage(GenieCreateConversationMessageRequest request)

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

public GenieGetMessageQueryResultResponse executeMessageAttachmentQuery(String spaceId,
                                                                        String conversationId,
                                                                        String messageId,
                                                                        String attachmentId)

executeMessageAttachmentQuery

public GenieGetMessageQueryResultResponse executeMessageAttachmentQuery(GenieExecuteMessageAttachmentQueryRequest request)

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

public GenieGetMessageQueryResultResponse executeMessageQuery(String spaceId,
                                                              String conversationId,
                                                              String messageId)

executeMessageQuery

public GenieGetMessageQueryResultResponse executeMessageQuery(GenieExecuteMessageQueryRequest request)

[Deprecated] Execute SQL query in a conversation message.

Execute the SQL query in the message.

generateDownloadFullQueryResult

public GenieGenerateDownloadFullQueryResultResponse generateDownloadFullQueryResult(String spaceId,
                                                                                    String conversationId,
                                                                                    String messageId,
                                                                                    String attachmentId)

generateDownloadFullQueryResult

public GenieGenerateDownloadFullQueryResultResponse generateDownloadFullQueryResult(GenieGenerateDownloadFullQueryResultRequest request)

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

public GenieGetDownloadFullQueryResultResponse getDownloadFullQueryResult(String spaceId,
                                                                          String conversationId,
                                                                          String messageId,
                                                                          String attachmentId,
                                                                          String downloadId)

getDownloadFullQueryResult

public GenieGetDownloadFullQueryResultResponse getDownloadFullQueryResult(GenieGetDownloadFullQueryResultRequest request)

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

public GenieMessage getMessage(String spaceId,
                               String conversationId,
                               String messageId)

getMessage

public GenieMessage getMessage(GenieGetConversationMessageRequest request)

Get conversation message.

Get message from conversation.

getMessageAttachmentQueryResult

public GenieGetMessageQueryResultResponse getMessageAttachmentQueryResult(String spaceId,
                                                                          String conversationId,
                                                                          String messageId,
                                                                          String attachmentId)

getMessageAttachmentQueryResult

public GenieGetMessageQueryResultResponse getMessageAttachmentQueryResult(GenieGetMessageAttachmentQueryResultRequest request)

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

public GenieGetMessageQueryResultResponse getMessageQueryResult(String spaceId,
                                                                String conversationId,
                                                                String messageId)

getMessageQueryResult

public GenieGetMessageQueryResultResponse getMessageQueryResult(GenieGetMessageQueryResultRequest request)

[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

public GenieGetMessageQueryResultResponse getMessageQueryResultByAttachment(String spaceId,
                                                                            String conversationId,
                                                                            String messageId,
                                                                            String attachmentId)

getMessageQueryResultByAttachment

public GenieGetMessageQueryResultResponse getMessageQueryResultByAttachment(GenieGetQueryResultByAttachmentRequest request)

[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

public GenieSpace getSpace(String spaceId)

getSpace

public GenieSpace getSpace(GenieGetSpaceRequest request)

Get Genie Space.

Get details of a Genie Space.

startConversation

public Wait<GenieMessage,GenieStartConversationResponse> startConversation(String spaceId,
                                                                           String content)

startConversation

public Wait<GenieMessage,GenieStartConversationResponse> startConversation(GenieStartConversationMessageRequest request)

Start conversation.

Start a new conversation.

impl

public GenieService impl()