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	executeMessageQuery(ExecuteMessageQueryRequest executeMessageQueryRequest) Execute SQL query in a conversation message.
GenieMessage	getMessage(GenieGetConversationMessageRequest genieGetConversationMessageRequest) Get conversation message.
GenieGetMessageQueryResultResponse	getMessageQueryResult(GenieGetMessageQueryResultRequest genieGetMessageQueryResultRequest) Get conversation message SQL query result.
GenieStartConversationResponse	startConversation(GenieStartConversationMessageRequest genieStartConversationMessageRequest) Start conversation.

Method Detail

createMessage

GenieMessage createMessage(GenieCreateConversationMessageRequest genieCreateConversationMessageRequest)

Create conversation message.

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

executeMessageQuery

GenieGetMessageQueryResultResponse executeMessageQuery(ExecuteMessageQueryRequest executeMessageQueryRequest)

Execute SQL query in a conversation message.

Execute the SQL query in the message.

getMessage

GenieMessage getMessage(GenieGetConversationMessageRequest genieGetConversationMessageRequest)

Get conversation message.

Get message from conversation.

getMessageQueryResult

GenieGetMessageQueryResultResponse getMessageQueryResult(GenieGetMessageQueryResultRequest genieGetMessageQueryResultRequest)

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

startConversation

GenieStartConversationResponse startConversation(GenieStartConversationMessageRequest genieStartConversationMessageRequest)

Start conversation.

Start a new conversation.