genie_messages

Creates, updates, deletes, gets or lists a genie_messages resource.

Overview

Name	genie_messages
Type	Resource
Id	databricks_workspace.dashboards.genie_messages

Fields

The following fields are returned by SELECT queries:

get_query_result_by_attachment

Name	Datatype	Description
statement_response	string

get

Name	Datatype	Description
id	string
conversation_id	string	Conversation ID
message_id	string	Message ID
space_id	string	Genie space ID
user_id	integer	ID of the user who created the message
▶attachments	array	AI-generated response to the message
content	string	User message content
created_timestamp	integer	Timestamp when the message was created
▶error	object	Error message if Genie failed to respond to the message
▶feedback	object	User feedback for the message if provided
last_updated_timestamp	integer	Timestamp when the message was last updated
▶query_result	object	The result of SQL query if the message includes a query attachment. Deprecated. Use `query_result_metadata` in `GenieQueryAttachment` instead.
status	string	MessageStatus. The possible values are: * `FETCHING_METADATA`: Fetching metadata from the data<br />sources. * `FILTERING_CONTEXT`: Running smart context step to determine relevant context. *<br />`ASKING_AI`: Waiting for the LLM to respond to the user's question. * `PENDING_WAREHOUSE`:<br />Waiting for warehouse before the SQL query can start executing. * `EXECUTING_QUERY`: Executing a<br />generated SQL query. Get the SQL query result by calling<br />[getMessageAttachmentQueryResult](:method:genie/getMessageAttachmentQueryResult) API. *<br />`FAILED`: The response generation or query execution failed. See `error` field. * `COMPLETED`:<br />Message processing is completed. Results are in the `attachments` field. Get the SQL query<br />result by calling<br />[getMessageAttachmentQueryResult](:method:genie/getMessageAttachmentQueryResult) API. *<br />`SUBMITTED`: Message has been submitted. * `QUERY_RESULT_EXPIRED`: SQL result is not available<br />anymore. The user needs to rerun the query. Rerun the SQL query result by calling<br />[executeMessageAttachmentQuery](:method:genie/executeMessageAttachmentQuery) API. * `CANCELLED`:<br />Message has been cancelled. (ASKING_AI, CANCELLED, COMPLETED, EXECUTING_QUERY, FAILED, FETCHING_METADATA, FILTERING_CONTEXT, PENDING_WAREHOUSE, QUERY_RESULT_EXPIRED, SUBMITTED)

list

Name	Datatype	Description
▶messages	array
next_page_token	string	The token to use for retrieving the next page of results.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_query_result_by_attachment	select	space_id, conversation_id, message_id, attachment_id, deployment_name		DEPRECATED: Use Get Message Attachment Query Result
get	select	space_id, conversation_id, message_id, deployment_name		Get message from conversation.
list	select	space_id, conversation_id, deployment_name	page_size, page_token	List messages in a conversation
create	insert	space_id, conversation_id, deployment_name, content		Create new message in a conversation. The AI response uses all
delete	delete	space_id, conversation_id, message_id, deployment_name		Delete a conversation message.
execute_query	exec	space_id, conversation_id, message_id, deployment_name		DEPRECATED: Use Execute Message Attachment Query
get_query_result_deprecated	exec	space_id, conversation_id, message_id, deployment_name		DEPRECATED: Use Get Message Attachment Query Result
send_feedback	exec	space_id, conversation_id, message_id, deployment_name, rating		Send feedback for a message.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
attachment_id	string	Attachment ID
conversation_id	string	The ID associated with the conversation.
deployment_name	string	The Databricks Workspace Deployment Name (default: dbc-abcd0123-a1bc)
message_id	string	The ID associated with the message to provide feedback for.
space_id	string	The ID associated with the Genie space where the message is located.
page_size	integer	Maximum number of messages to return per page
page_token	string	Token to get the next page of results

SELECT examples

get_query_result_by_attachment

DEPRECATED: Use Get Message Attachment Query Result

SELECT
statement_response
FROM databricks_workspace.dashboards.genie_messages
WHERE space_id = '{{ space_id }}' -- required
AND conversation_id = '{{ conversation_id }}' -- required
AND message_id = '{{ message_id }}' -- required
AND attachment_id = '{{ attachment_id }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
;

get

Get message from conversation.

SELECT
id,
conversation_id,
message_id,
space_id,
user_id,
attachments,
content,
created_timestamp,
error,
feedback,
last_updated_timestamp,
query_result,
status
FROM databricks_workspace.dashboards.genie_messages
WHERE space_id = '{{ space_id }}' -- required
AND conversation_id = '{{ conversation_id }}' -- required
AND message_id = '{{ message_id }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
;

list

List messages in a conversation

SELECT
messages,
next_page_token
FROM databricks_workspace.dashboards.genie_messages
WHERE space_id = '{{ space_id }}' -- required
AND conversation_id = '{{ conversation_id }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create

Create new message in a conversation. The AI response uses all

INSERT INTO databricks_workspace.dashboards.genie_messages (
content,
space_id,
conversation_id,
deployment_name
)
SELECT 
'{{ content }}' /* required */,
'{{ space_id }}',
'{{ conversation_id }}',
'{{ deployment_name }}'
RETURNING
id,
conversation_id,
message_id,
space_id,
user_id,
attachments,
content,
created_timestamp,
error,
feedback,
last_updated_timestamp,
query_result,
status
;

Manifest

# Description fields are for documentation purposes
- name: genie_messages
props:
  - name: space_id
    value: "{{ space_id }}"
    description: Required parameter for the genie_messages resource.
  - name: conversation_id
    value: "{{ conversation_id }}"
    description: Required parameter for the genie_messages resource.
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the genie_messages resource.
  - name: content
    value: "{{ content }}"
    description: |
      User message content.

DELETE examples

delete

Delete a conversation message.

DELETE FROM databricks_workspace.dashboards.genie_messages
WHERE space_id = '{{ space_id }}' --required
AND conversation_id = '{{ conversation_id }}' --required
AND message_id = '{{ message_id }}' --required
AND deployment_name = '{{ deployment_name }}' --required
;

Lifecycle Methods

execute_query

DEPRECATED: Use Execute Message Attachment Query

EXEC databricks_workspace.dashboards.genie_messages.execute_query 
@space_id='{{ space_id }}' --required, 
@conversation_id='{{ conversation_id }}' --required, 
@message_id='{{ message_id }}' --required, 
@deployment_name='{{ deployment_name }}' --required
;

get_query_result_deprecated

DEPRECATED: Use Get Message Attachment Query Result

EXEC databricks_workspace.dashboards.genie_messages.get_query_result_deprecated 
@space_id='{{ space_id }}' --required, 
@conversation_id='{{ conversation_id }}' --required, 
@message_id='{{ message_id }}' --required, 
@deployment_name='{{ deployment_name }}' --required
;

send_feedback

Send feedback for a message.

EXEC databricks_workspace.dashboards.genie_messages.send_feedback 
@space_id='{{ space_id }}' --required, 
@conversation_id='{{ conversation_id }}' --required, 
@message_id='{{ message_id }}' --required, 
@deployment_name='{{ deployment_name }}' --required 
@@json=
'{
"rating": "{{ rating }}"
}'
;