genie_conversations

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

Overview

Name	genie_conversations
Type	Resource
Id	databricks_workspace.dashboards.genie_conversations

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description
▶conversations	array
next_page_token	string	Token to get the next page of results

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	space_id, deployment_name	include_all, page_size, page_token	Get a list of conversations in a Genie Space.
delete	delete	space_id, conversation_id, deployment_name		Delete a conversation.
start	exec	space_id, deployment_name, content		Start a new conversation.

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
conversation_id	string	The ID of the conversation to delete.
deployment_name	string	The Databricks Workspace Deployment Name (default: dbc-abcd0123-a1bc)
space_id	string	The ID associated with the Genie space where you want to start a conversation.
include_all	boolean	Include all conversations in the space across all users. Requires at least CAN MANAGE permission on the space.
page_size	integer	Maximum number of conversations to return per page
page_token	string	Token to get the next page of results

SELECT examples

list

Get a list of conversations in a Genie Space.

SELECT
conversations,
next_page_token
FROM databricks_workspace.dashboards.genie_conversations
WHERE space_id = '{{ space_id }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND include_all = '{{ include_all }}'
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

DELETE examples

delete

Delete a conversation.

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

Lifecycle Methods

start

Start a new conversation.

EXEC databricks_workspace.dashboards.genie_conversations.start 
@space_id='{{ space_id }}' --required, 
@deployment_name='{{ deployment_name }}' --required 
@@json=
'{
"content": "{{ content }}"
}'
;