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 new message in a [conversation](:method:genie/startconversation).
GenieMessageComment	createMessageComment(GenieCreateMessageCommentRequest request) Create a comment on a conversation message.
GenieSpace	createSpace(GenieCreateSpaceRequest request) Creates a Genie space from a serialized payload.
void	deleteConversation(GenieDeleteConversationRequest request) Delete a conversation.
void	deleteConversation(String spaceId, String conversationId)
void	deleteConversationMessage(GenieDeleteConversationMessageRequest request) Delete a conversation message.
void	deleteConversationMessage(String spaceId, String conversationId, String messageId)
GenieGetMessageQueryResultResponse	executeMessageAttachmentQuery(GenieExecuteMessageAttachmentQueryRequest request) Execute the SQL for a message query attachment.
GenieGetMessageQueryResultResponse	executeMessageQuery(GenieExecuteMessageQueryRequest request) DEPRECATED: Use [Execute Message Attachment Query](:method:genie/executemessageattachmentquery) instead.
GenieGenerateDownloadFullQueryResultResponse	generateDownloadFullQueryResult(GenieGenerateDownloadFullQueryResultRequest request) 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.
GenieEvalRunResponse	genieCreateEvalRun(GenieCreateEvalRunRequest request) Create and run evaluations for multiple benchmark questions in a Genie space.
GenieEvalResultDetails	genieGetEvalResultDetails(GenieGetEvalResultDetailsRequest request) Get details for evaluation results.
GenieEvalResultDetails	genieGetEvalResultDetails(String spaceId, String evalRunId, String resultId)
GenieEvalRunResponse	genieGetEvalRun(GenieGetEvalRunRequest request) Get evaluation run details.
GenieEvalRunResponse	genieGetEvalRun(String spaceId, String evalRunId)
GenieListEvalResultsResponse	genieListEvalResults(GenieListEvalResultsRequest request) List evaluation results for a specific evaluation run.
GenieListEvalResultsResponse	genieListEvalResults(String spaceId, String evalRunId)
GenieListEvalRunsResponse	genieListEvalRuns(GenieListEvalRunsRequest request) Lists all evaluation runs in a space.
GenieListEvalRunsResponse	genieListEvalRuns(String spaceId)
GenieGetDownloadFullQueryResultResponse	getDownloadFullQueryResult(GenieGetDownloadFullQueryResultRequest request) After [Generating a Full Query Result Download](:method:genie/generatedownloadfullqueryresult) and successfully receiving a `download_id` and `download_id_signature`, use this API to poll the download progress.
GenieGetDownloadFullQueryResultResponse	getDownloadFullQueryResult(String spaceId, String conversationId, String messageId, String attachmentId, String downloadId)
GenieMessage	getMessage(GenieGetConversationMessageRequest request) Get message from conversation.
GenieMessage	getMessage(String spaceId, String conversationId, String messageId)
GenieGetMessageQueryResultResponse	getMessageAttachmentQueryResult(GenieGetMessageAttachmentQueryResultRequest request) Get the result of SQL query if the message has a query attachment.
GenieGetMessageQueryResultResponse	getMessageAttachmentQueryResult(String spaceId, String conversationId, String messageId, String attachmentId)
GenieGetMessageQueryResultResponse	getMessageQueryResult(GenieGetMessageQueryResultRequest request) DEPRECATED: Use [Get Message Attachment Query Result](:method:genie/getmessageattachmentqueryresult) instead.
GenieGetMessageQueryResultResponse	getMessageQueryResult(String spaceId, String conversationId, String messageId)
GenieGetMessageQueryResultResponse	getMessageQueryResultByAttachment(GenieGetQueryResultByAttachmentRequest request) DEPRECATED: Use [Get Message Attachment Query Result](:method:genie/getmessageattachmentqueryresult) instead.
GenieGetMessageQueryResultResponse	getMessageQueryResultByAttachment(String spaceId, String conversationId, String messageId, String attachmentId)
GenieSpace	getSpace(GenieGetSpaceRequest request) Get details of a Genie Space.
GenieSpace	getSpace(String spaceId)
GenieService	impl()
GenieListConversationCommentsResponse	listConversationComments(GenieListConversationCommentsRequest request) List all comments across all messages in a conversation.
GenieListConversationCommentsResponse	listConversationComments(String spaceId, String conversationId)
GenieListConversationMessagesResponse	listConversationMessages(GenieListConversationMessagesRequest request) List messages in a conversation
GenieListConversationMessagesResponse	listConversationMessages(String spaceId, String conversationId)
GenieListConversationsResponse	listConversations(GenieListConversationsRequest request) Get a list of conversations in a Genie Space.
GenieListConversationsResponse	listConversations(String spaceId)
GenieListMessageCommentsResponse	listMessageComments(GenieListMessageCommentsRequest request) List comments on a specific conversation message.
GenieListMessageCommentsResponse	listMessageComments(String spaceId, String conversationId, String messageId)
GenieListSpacesResponse	listSpaces(GenieListSpacesRequest request) Get list of Genie Spaces.
void	sendMessageFeedback(GenieSendMessageFeedbackRequest request) Send feedback for a message.
Wait<GenieMessage,GenieStartConversationResponse>	startConversation(GenieStartConversationMessageRequest request) Start a new conversation.
void	trashSpace(GenieTrashSpaceRequest request) Move a Genie Space to the trash.
void	trashSpace(String spaceId)
GenieSpace	updateSpace(GenieUpdateSpaceRequest request) Updates a Genie space with a serialized payload.
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(GenieCreateConversationMessageRequest request)

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

createMessageComment

public GenieMessageComment createMessageComment(GenieCreateMessageCommentRequest request)

Create a comment on a conversation message.

createSpace

public GenieSpace createSpace(GenieCreateSpaceRequest request)

Creates a Genie space from a serialized payload.

deleteConversation

public void deleteConversation(String spaceId,
                               String conversationId)

deleteConversation

public void deleteConversation(GenieDeleteConversationRequest request)

Delete a conversation.

deleteConversationMessage

public void deleteConversationMessage(String spaceId,
                                      String conversationId,
                                      String messageId)

deleteConversationMessage

public void deleteConversationMessage(GenieDeleteConversationMessageRequest request)

Delete a conversation message.

executeMessageAttachmentQuery

public GenieGetMessageQueryResultResponse executeMessageAttachmentQuery(GenieExecuteMessageAttachmentQueryRequest request)

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(GenieExecuteMessageQueryRequest request)

DEPRECATED: Use [Execute Message Attachment Query](:method:genie/executemessageattachmentquery) instead.

generateDownloadFullQueryResult

public GenieGenerateDownloadFullQueryResultResponse generateDownloadFullQueryResult(GenieGenerateDownloadFullQueryResultRequest request)

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](:method:genie/getdownloadfullqueryresult) 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, URL is generated, which can be used to download the results directly from . As a short-lived is embedded in this URL, you should protect the URL.

Because URLs are already generated with embedded temporary s, you must not set an `Authorization` header in the download requests.

See [Execute Statement](:method:statementexecution/executestatement) for more details.

----

genieCreateEvalRun

public GenieEvalRunResponse genieCreateEvalRun(GenieCreateEvalRunRequest request)

Create and run evaluations for multiple benchmark questions in a Genie space.

genieGetEvalResultDetails

public GenieEvalResultDetails genieGetEvalResultDetails(String spaceId,
                                                        String evalRunId,
                                                        String resultId)

genieGetEvalResultDetails

public GenieEvalResultDetails genieGetEvalResultDetails(GenieGetEvalResultDetailsRequest request)

Get details for evaluation results.

genieGetEvalRun

public GenieEvalRunResponse genieGetEvalRun(String spaceId,
                                            String evalRunId)

genieGetEvalRun

public GenieEvalRunResponse genieGetEvalRun(GenieGetEvalRunRequest request)

Get evaluation run details.

genieListEvalResults

public GenieListEvalResultsResponse genieListEvalResults(String spaceId,
                                                         String evalRunId)

genieListEvalResults

public GenieListEvalResultsResponse genieListEvalResults(GenieListEvalResultsRequest request)

List evaluation results for a specific evaluation run.

genieListEvalRuns

public GenieListEvalRunsResponse genieListEvalRuns(String spaceId)

genieListEvalRuns

public GenieListEvalRunsResponse genieListEvalRuns(GenieListEvalRunsRequest request)

Lists all evaluation runs in a space.

getDownloadFullQueryResult

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

getDownloadFullQueryResult

public GenieGetDownloadFullQueryResultResponse getDownloadFullQueryResult(GenieGetDownloadFullQueryResultRequest request)

After [Generating a Full Query Result Download](:method:genie/generatedownloadfullqueryresult) 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, URL is generated, which can be used to download the results directly from . As a short-lived is embedded in this URL, you should protect the URL.

Because URLs are already generated with embedded temporary s, 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 message from conversation.

getMessageAttachmentQueryResult

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

getMessageAttachmentQueryResult

public GenieGetMessageQueryResultResponse getMessageAttachmentQueryResult(GenieGetMessageAttachmentQueryResultRequest request)

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: Use [Get Message Attachment Query Result](:method:genie/getmessageattachmentqueryresult) instead.

getMessageQueryResultByAttachment

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

getMessageQueryResultByAttachment

public GenieGetMessageQueryResultResponse getMessageQueryResultByAttachment(GenieGetQueryResultByAttachmentRequest request)

DEPRECATED: Use [Get Message Attachment Query Result](:method:genie/getmessageattachmentqueryresult) instead.

getSpace

public GenieSpace getSpace(String spaceId)

getSpace

public GenieSpace getSpace(GenieGetSpaceRequest request)

Get details of a Genie Space.

listConversationComments

public GenieListConversationCommentsResponse listConversationComments(String spaceId,
                                                                      String conversationId)

listConversationComments

public GenieListConversationCommentsResponse listConversationComments(GenieListConversationCommentsRequest request)

List all comments across all messages in a conversation.

listConversationMessages

public GenieListConversationMessagesResponse listConversationMessages(String spaceId,
                                                                      String conversationId)

listConversationMessages

public GenieListConversationMessagesResponse listConversationMessages(GenieListConversationMessagesRequest request)

List messages in a conversation

listConversations

public GenieListConversationsResponse listConversations(String spaceId)

listConversations

public GenieListConversationsResponse listConversations(GenieListConversationsRequest request)

Get a list of conversations in a Genie Space.

listMessageComments

public GenieListMessageCommentsResponse listMessageComments(String spaceId,
                                                            String conversationId,
                                                            String messageId)

listMessageComments

public GenieListMessageCommentsResponse listMessageComments(GenieListMessageCommentsRequest request)

List comments on a specific conversation message.

listSpaces

public GenieListSpacesResponse listSpaces(GenieListSpacesRequest request)

Get list of Genie Spaces.

sendMessageFeedback

public void sendMessageFeedback(GenieSendMessageFeedbackRequest request)

Send feedback for a message.

startConversation

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

Start a new conversation.

trashSpace

public void trashSpace(String spaceId)

trashSpace

public void trashSpace(GenieTrashSpaceRequest request)

Move a Genie Space to the trash.

updateSpace

public GenieSpace updateSpace(GenieUpdateSpaceRequest request)

Updates a Genie space with a serialized payload.

impl

public GenieService impl()