w.supervisor_agents: SupervisorAgents.v1

class databricks.sdk.service.supervisoragents.SupervisorAgentsAPI

Manage Supervisor Agents and related resources.

create_example(parent: str, example: Example) → Example

Creates an example for a Supervisor Agent.

Parameters:

  • parent – str Parent resource where this example will be created. Format: supervisor-agents/{supervisor_agent_id}

  • example – Example The example to create under the parent Supervisor Agent.

Returns:

Example

create_supervisor_agent(supervisor_agent: SupervisorAgent) → SupervisorAgent

Creates a new Supervisor Agent.

Parameters:

supervisor_agent – SupervisorAgent The Supervisor Agent to create.

Returns:

SupervisorAgent

create_tool(parent: str, tool: Tool, tool_id: str) → Tool

Creates a Tool under a Supervisor Agent. Specify one of “genie_space”, “knowledge_assistant”, “uc_function”, “uc_connection”, “app”, “volume”, “dashboard”, “table”, “vector_search_index”, “catalog”, “schema”, “supervisor_agent”, “web_search”, “skill” in the request body. The legacy values “lakeview_dashboard” and “uc_table” are also accepted and remain equivalent to “dashboard” and “table” respectively.

Parameters:

  • parent – str Parent resource where this tool will be created. Format: supervisor-agents/{supervisor_agent_id}

  • tool – Tool

  • tool_id – str The ID to use for the tool, which will become the final component of the tool’s resource name.

Returns:

Tool

delete_example(name: str)

Deletes an example from a Supervisor Agent.

Parameters:

name – str The resource name of the example to delete. Format: supervisor-agents/{supervisor_agent_id}/examples/{example_id}

delete_supervisor_agent(name: str)

Deletes a Supervisor Agent.

Parameters:

name – str The resource name of the Supervisor Agent. Format: supervisor-agents/{supervisor_agent_id}

delete_tool(name: str)

Deletes a Tool.

Parameters:

name – str The resource name of the Tool. Format: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}

get_example(name: str) → Example

Gets an example from a Supervisor Agent.

Parameters:

name – str The resource name of the example. Format: supervisor-agents/{supervisor_agent_id}/examples/{example_id}

Returns:

Example

get_permission_levels(supervisor_agent_id: str) → GetSupervisorAgentPermissionLevelsResponse

Gets the permission levels that a user can have on an object.

Parameters:

supervisor_agent_id – str The supervisor agent for which to get or manage permissions.

Returns:

GetSupervisorAgentPermissionLevelsResponse

get_permissions(supervisor_agent_id: str) → SupervisorAgentPermissions

Gets the permissions of a supervisor agent. Supervisor agents can inherit permissions from their root object.

Parameters:

supervisor_agent_id – str The supervisor agent for which to get or manage permissions.

Returns:

SupervisorAgentPermissions

get_supervisor_agent(name: str) → SupervisorAgent

Gets a Supervisor Agent.

Parameters:

name – str The resource name of the Supervisor Agent. Format: supervisor-agents/{supervisor_agent_id}

Returns:

SupervisorAgent

get_tool(name: str) → Tool

Gets a Tool.

Parameters:

name – str The resource name of the Tool. Format: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}

Returns:

Tool

list_examples(parent: str [, page_size: Optional[int], page_token: Optional[str]]) → Iterator[Example]

Lists examples under a Supervisor Agent.

Parameters:

  • parent – str Parent resource to list from. Format: supervisor-agents/{supervisor_agent_id}

  • page_size – int (optional) 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 – str (optional) A page token, received from a previous ListExamples call. Provide this to retrieve the subsequent page. If unspecified, the first page will be returned.

Returns:

Iterator over Example

list_supervisor_agents([, page_size: Optional[int], page_token: Optional[str]]) → Iterator[SupervisorAgent]

Lists Supervisor Agents.

Parameters:

  • page_size – int (optional) 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 – str (optional) A page token, received from a previous ListSupervisorAgents call. Provide this to retrieve the subsequent page. If unspecified, the first page will be returned.

Returns:

Iterator over SupervisorAgent

list_tools(parent: str [, page_size: Optional[int], page_token: Optional[str]]) → Iterator[Tool]

Lists Tools under a Supervisor Agent.

Parameters:

  • parent – str Parent resource to list from. Format: supervisor-agents/{supervisor_agent_id}

  • page_size – int (optional)

  • page_token – str (optional)

Returns:

Iterator over Tool

set_permissions(supervisor_agent_id: str [, access_control_list: Optional[List[SupervisorAgentAccessControlRequest]]]) → SupervisorAgentPermissions

Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object.

Parameters:
Returns:

SupervisorAgentPermissions

update_example(name: str, example: Example, update_mask: FieldMask) → Example

Updates an example in a Supervisor Agent.

Parameters:

  • name – str The resource name of the example to update. Format: supervisor-agents/{supervisor_agent_id}/examples/{example_id}

  • example – Example

  • update_mask – FieldMask Comma-delimited list of fields to update on the example. Allowed values: question, guidelines. Examples: - question - question,guidelines

Returns:

Example

update_permissions(supervisor_agent_id: str [, access_control_list: Optional[List[SupervisorAgentAccessControlRequest]]]) → SupervisorAgentPermissions

Updates the permissions on a supervisor agent. Supervisor agents can inherit permissions from their root object.

Parameters:
Returns:

SupervisorAgentPermissions

update_supervisor_agent(name: str, supervisor_agent: SupervisorAgent, update_mask: FieldMask) → SupervisorAgent

Updates a Supervisor Agent. The fields that are required depend on the paths specified in update_mask. Only fields included in the mask will be updated.

Parameters:

  • name – str The resource name of the SupervisorAgent. Format: supervisor-agents/{supervisor_agent_id}

  • supervisor_agent – SupervisorAgent The SupervisorAgent to update.

  • update_mask – FieldMask Field mask for fields to be updated.

Returns:

SupervisorAgent

update_tool(name: str, tool: Tool, update_mask: FieldMask) → Tool

Updates a Tool. Only the description field can be updated. To change immutable fields such as tool type, spec, or tool ID, delete the tool and recreate it.

Parameters:

  • name – str Full resource name: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}

  • tool – Tool The Tool to update.

  • update_mask – FieldMask Field mask for fields to be updated.

Returns:

Tool