examples

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

Overview

Name	examples
Type	Resource
Id	databricks_workspace.supervisoragents.examples

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description
name	string	Full resource name: supervisor-agents/{supervisor_agent_id}/examples/{example_id}
example_id	string	The universally unique identifier (UUID) of the example.
guidelines	array	Guidelines for answering the question.
question	string	The example question.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	parent, deployment_name	page_size, page_token	Lists examples under a Supervisor Agent.
create	insert	parent, deployment_name, example		Creates an example for a Supervisor Agent.

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 (default: dbc-abcd0123-a1bc)
parent	string	Parent resource where this example will be created. Format: supervisor-agents/{supervisor_agent_id}
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

list

Lists examples under a Supervisor Agent.

SELECT
name,
example_id,
guidelines,
question
FROM databricks_workspace.supervisoragents.examples
WHERE parent = '{{ parent }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create

Creates an example for a Supervisor Agent.

INSERT INTO databricks_workspace.supervisoragents.examples (
example,
parent,
deployment_name
)
SELECT 
'{{ example }}' /* required */,
'{{ parent }}',
'{{ deployment_name }}'
RETURNING
name,
example_id,
guidelines,
question
;

Manifest

# Description fields are for documentation purposes
- name: examples
props:
  - name: parent
    value: "{{ parent }}"
    description: Required parameter for the examples resource.
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the examples resource.
  - name: example
    description: |
      The example to create under the parent Supervisor Agent.
    value:
      question: "{{ question }}"
      guidelines:
        - "{{ guidelines }}"
      example_id: "{{ example_id }}"
      name: "{{ name }}"