supervisor_agents

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

Overview

Name	supervisor_agents
Type	Resource
Id	databricks_workspace.supervisoragents.supervisor_agents

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description
id	string	Deprecated: Use supervisor_agent_id instead.
name	string	The resource name of the SupervisorAgent. Format: supervisor-agents/{supervisor_agent_id}
experiment_id	string	The MLflow experiment ID.
supervisor_agent_id	string	The universally unique identifier (UUID) of the Supervisor Agent.
display_name	string
endpoint_name	string	The name of the supervisor agent's serving endpoint.
create_time	string (date-time)	Creation timestamp.
creator	string	The creator of the Supervisor Agent.
description	string	Description of what this agent can do (user-facing).
instructions	string	Optional natural-language instructions for the supervisor agent.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	deployment_name	page_size, page_token	Lists Supervisor Agents.
create	insert	deployment_name, supervisor_agent		Creates a new 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)
page_size	integer	The maximum number of supervisor agents to return. If unspecified, at most 100 supervisor agents 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 ListSupervisorAgents call. Provide this to retrieve the subsequent page. If unspecified, the first page will be returned.

SELECT examples

list

Lists Supervisor Agents.

SELECT
id,
name,
experiment_id,
supervisor_agent_id,
display_name,
endpoint_name,
create_time,
creator,
description,
instructions
FROM databricks_workspace.supervisoragents.supervisor_agents
WHERE deployment_name = '{{ deployment_name }}' -- required
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create

Creates a new Supervisor Agent.

INSERT INTO databricks_workspace.supervisoragents.supervisor_agents (
supervisor_agent,
deployment_name
)
SELECT 
'{{ supervisor_agent }}' /* required */,
'{{ deployment_name }}'
RETURNING
id,
name,
experiment_id,
supervisor_agent_id,
display_name,
endpoint_name,
create_time,
creator,
description,
instructions
;

Manifest

# Description fields are for documentation purposes
- name: supervisor_agents
props:
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the supervisor_agents resource.
  - name: supervisor_agent
    description: |
      The Supervisor Agent to create.
    value:
      display_name: "{{ display_name }}"
      create_time: "{{ create_time }}"
      creator: "{{ creator }}"
      description: "{{ description }}"
      endpoint_name: "{{ endpoint_name }}"
      experiment_id: "{{ experiment_id }}"
      id: "{{ id }}"
      instructions: "{{ instructions }}"
      name: "{{ name }}"
      supervisor_agent_id: "{{ supervisor_agent_id }}"