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 new message in a [conversation](:method:genie/startconversation).
void	deleteConversation(GenieDeleteConversationRequest genieDeleteConversationRequest) Delete a conversation.
GenieGetMessageQueryResultResponse	executeMessageAttachmentQuery(GenieExecuteMessageAttachmentQueryRequest genieExecuteMessageAttachmentQueryRequest) Execute the SQL for a message query attachment.
GenieGetMessageQueryResultResponse	executeMessageQuery(GenieExecuteMessageQueryRequest genieExecuteMessageQueryRequest) Execute the SQL query in the message.
GenieMessage	getMessage(GenieGetConversationMessageRequest genieGetConversationMessageRequest) Get message from conversation.
GenieGetMessageQueryResultResponse	getMessageAttachmentQueryResult(GenieGetMessageAttachmentQueryResultRequest genieGetMessageAttachmentQueryResultRequest) Get the result of SQL query if the message has a query attachment.
GenieGetMessageQueryResultResponse	getMessageQueryResult(GenieGetMessageQueryResultRequest genieGetMessageQueryResultRequest) Get the result of SQL query if the message has a query attachment.
GenieGetMessageQueryResultResponse	getMessageQueryResultByAttachment(GenieGetQueryResultByAttachmentRequest genieGetQueryResultByAttachmentRequest) Get the result of SQL query if the message has a query attachment.
GenieSpace	getSpace(GenieGetSpaceRequest genieGetSpaceRequest) Get details of a Genie Space.
GenieListConversationsResponse	listConversations(GenieListConversationsRequest genieListConversationsRequest) Get a list of conversations in a Genie Space.
GenieListSpacesResponse	listSpaces(GenieListSpacesRequest genieListSpacesRequest) Get list of Genie Spaces.
GenieStartConversationResponse	startConversation(GenieStartConversationMessageRequest genieStartConversationMessageRequest) Start a new conversation.
void	trashSpace(GenieTrashSpaceRequest genieTrashSpaceRequest) Move a Genie Space to the trash.

Method Detail

createMessage

GenieMessage createMessage(GenieCreateConversationMessageRequest genieCreateConversationMessageRequest)

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

deleteConversation

void deleteConversation(GenieDeleteConversationRequest genieDeleteConversationRequest)

Delete a conversation.

executeMessageAttachmentQuery

GenieGetMessageQueryResultResponse executeMessageAttachmentQuery(GenieExecuteMessageAttachmentQueryRequest genieExecuteMessageAttachmentQueryRequest)

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)

Execute the SQL query in the message.

getMessage

GenieMessage getMessage(GenieGetConversationMessageRequest genieGetConversationMessageRequest)

Get message from conversation.

getMessageAttachmentQueryResult

GenieGetMessageQueryResultResponse getMessageAttachmentQueryResult(GenieGetMessageAttachmentQueryResultRequest genieGetMessageAttachmentQueryResultRequest)

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)

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)

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 details of a Genie Space.

listConversations

GenieListConversationsResponse listConversations(GenieListConversationsRequest genieListConversationsRequest)

Get a list of conversations in a Genie Space.

listSpaces

GenieListSpacesResponse listSpaces(GenieListSpacesRequest genieListSpacesRequest)

Get list of Genie Spaces.

startConversation

GenieStartConversationResponse startConversation(GenieStartConversationMessageRequest genieStartConversationMessageRequest)

Start a new conversation.

trashSpace

void trashSpace(GenieTrashSpaceRequest genieTrashSpaceRequest)

Move a Genie Space to the trash.