examples

Creates, updates, deletes, gets or lists an examples resource.

Overview

Name	examples
Type	Resource
Id	databricks_workspace.knowledgeassistants.examples

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Full resource name: knowledge-assistants/{knowledge_assistant_id}/examples/{example_id}
example_id	string	The universally unique identifier (UUID) of the example.
create_time	string (date-time)	Timestamp when this example was created.
guidelines	array	Guidelines for answering the question. Optional — examples may be created with just a question; the front-end form does not require guidelines.
question	string	The example question.
update_time	string (date-time)	Timestamp when this example was last updated.

list

Name	Datatype	Description
name	string	Full resource name: knowledge-assistants/{knowledge_assistant_id}/examples/{example_id}
example_id	string	The universally unique identifier (UUID) of the example.
create_time	string (date-time)	Timestamp when this example was created.
guidelines	array	Guidelines for answering the question. Optional — examples may be created with just a question; the front-end form does not require guidelines.
question	string	The example question.
update_time	string (date-time)	Timestamp when this example was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	knowledge_assistant_id, example_id, deployment_name, workspace_domain		Gets an example from a Knowledge Assistant.
list	select	knowledge_assistant_id, deployment_name, workspace_domain	page_size, page_token	Lists examples under a Knowledge Assistant.
create	insert	knowledge_assistant_id, deployment_name, workspace_domain, question		Creates an example for a Knowledge Assistant.
update	update	knowledge_assistant_id, example_id, update_mask, deployment_name, workspace_domain, question		Updates an example in a Knowledge Assistant.
delete	delete	knowledge_assistant_id, example_id, deployment_name, workspace_domain		Deletes an example from a Knowledge Assistant.

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
deployment_name	string	The Databricks workspace deployment name: the host prefix of the workspace URL (dbc-abcd0123-a1bc on AWS, adb-1234567890123456.7 on Azure, 1234567890123456.7 on GCP). Set DATABRICKS_DEPLOYMENT_NAME to default it for the session. (default: dbc-abcd0123-a1bc, x-stackQL-envVar: DATABRICKS_DEPLOYMENT_NAME)
example_id	string	The example_id segment of the name resource name (knowledge-assistants/{knowledge_assistant_id}/examples/{example_id}). The resource name of the example to delete. Format: knowledge-assistants/{knowledge_assistant_id}/examples/{example_id}
knowledge_assistant_id	string	The knowledge_assistant_id segment of the name resource name (knowledge-assistants/{knowledge_assistant_id}/examples/{example_id}). The resource name of the example to delete. Format: knowledge-assistants/{knowledge_assistant_id}/examples/{example_id}
update_mask	object	Comma-delimited list of fields to update on the example. Allowed values: question, guidelines. Examples: - question - question,guidelines
workspace_domain	string	The Databricks workspace domain suffix for the cloud. Selected by DATABRICKS_CLOUD (aws, azure or gcp; default aws). (default: cloud.databricks.com, x-stackQL-envVarSelector: {"envVar":"DATABRICKS_CLOUD","default":"aws","values":{"aws":"cloud.databricks.com","azure":"azuredatabricks.net","gcp":"gcp.databricks.com"}})
page_size	integer	The maximum number of examples to return. If unspecified, at most 100 examples will be returned. The maximum value is 100; values above 100 will be coerced to 100.
page_token	string	A page token, received from a previous ListExamples call. Provide this to retrieve the subsequent page. If unspecified, the first page will be returned.

SELECT examples

get

Gets an example from a Knowledge Assistant.

SELECT
name,
example_id,
create_time,
guidelines,
question,
update_time
FROM databricks_workspace.knowledgeassistants.examples
WHERE knowledge_assistant_id = '{{ knowledge_assistant_id }}' -- required
AND example_id = '{{ example_id }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND workspace_domain = '{{ workspace_domain }}' -- required
;

list

Lists examples under a Knowledge Assistant.

SELECT
name,
example_id,
create_time,
guidelines,
question,
update_time
FROM databricks_workspace.knowledgeassistants.examples
WHERE knowledge_assistant_id = '{{ knowledge_assistant_id }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND workspace_domain = '{{ workspace_domain }}' -- required
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create

Creates an example for a Knowledge Assistant.

INSERT INTO databricks_workspace.knowledgeassistants.examples (
question,
create_time,
example_id,
guidelines,
name,
update_time,
knowledge_assistant_id,
deployment_name,
workspace_domain
)
SELECT 
'{{ question }}' /* required */,
'{{ create_time }}',
'{{ example_id }}',
'{{ guidelines }}',
'{{ name }}',
'{{ update_time }}',
'{{ knowledge_assistant_id }}',
'{{ deployment_name }}',
'{{ workspace_domain }}'
RETURNING
name,
example_id,
create_time,
guidelines,
question,
update_time
;

Manifest

# Description fields are for documentation purposes
- name: examples
props:
  - name: knowledge_assistant_id
    value: "{{ knowledge_assistant_id }}"
    description: Required parameter for the examples resource.
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the examples resource.
  - name: workspace_domain
    value: "{{ workspace_domain }}"
    description: Required parameter for the examples resource.
  - name: question
    value: "{{ question }}"
    description: |
      The example question.
  - name: create_time
    value: "{{ create_time }}"
    description: |
      Timestamp when this example was created.
  - name: example_id
    value: "{{ example_id }}"
    description: |
      The universally unique identifier (UUID) of the example.
  - name: guidelines
    value:
      - "{{ guidelines }}"
    description: |
      Guidelines for answering the question. Optional — examples may be created with just a question; the front-end form does not require guidelines.
  - name: name
    value: "{{ name }}"
    description: |
      Full resource name: knowledge-assistants/{knowledge_assistant_id}/examples/{example_id}
  - name: update_time
    value: "{{ update_time }}"
    description: |
      Timestamp when this example was last updated.

UPDATE examples

update

Updates an example in a Knowledge Assistant.

UPDATE databricks_workspace.knowledgeassistants.examples
SET 
question = '{{ question }}',
create_time = '{{ create_time }}',
example_id = '{{ example_id }}',
guidelines = '{{ guidelines }}',
name = '{{ name }}',
update_time = '{{ update_time }}'
WHERE 
knowledge_assistant_id = '{{ knowledge_assistant_id }}' --required
AND example_id = '{{ example_id }}' --required
AND update_mask = '{{ update_mask }}' --required
AND deployment_name = '{{ deployment_name }}' --required
AND workspace_domain = '{{ workspace_domain }}' --required
AND question = '{{ question }}' --required
RETURNING
name,
example_id,
create_time,
guidelines,
question,
update_time;

DELETE examples

delete

Deletes an example from a Knowledge Assistant.

DELETE FROM databricks_workspace.knowledgeassistants.examples
WHERE knowledge_assistant_id = '{{ knowledge_assistant_id }}' --required
AND example_id = '{{ example_id }}' --required
AND deployment_name = '{{ deployment_name }}' --required
AND workspace_domain = '{{ workspace_domain }}' --required
;