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	executeMessageQuery(ExecuteMessageQueryRequest request) Execute SQL query in a conversation message.
GenieGetMessageQueryResultResponse	executeMessageQuery(String spaceId, String conversationId, String messageId)
GenieMessage	getMessage(GenieGetConversationMessageRequest request) Get conversation message.
GenieMessage	getMessage(String spaceId, String conversationId, String messageId)
GenieGetMessageQueryResultResponse	getMessageQueryResult(GenieGetMessageQueryResultRequest request) Get conversation message SQL query result.
GenieGetMessageQueryResultResponse	getMessageQueryResult(String spaceId, String conversationId, String messageId)
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 [conversation](:method:genie/startconversation). The AI response uses all previously created messages in the conversation to respond.

executeMessageQuery

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

executeMessageQuery

public GenieGetMessageQueryResultResponse executeMessageQuery(ExecuteMessageQueryRequest request)

Execute SQL query in a conversation message.

Execute the SQL query in the message.

getMessage

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

getMessage

public GenieMessage getMessage(GenieGetConversationMessageRequest request)

Get conversation message.

Get message from conversation.

getMessageQueryResult

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

getMessageQueryResult

public GenieGetMessageQueryResultResponse getMessageQueryResult(GenieGetMessageQueryResultRequest request)

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

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