Supervisor Agents

These dataclasses are used in the SDK to represent API requests and responses for services in the databricks.sdk.service.supervisoragents module.

class databricks.sdk.service.supervisoragents.App(name: str)

Databricks app. Supported app: custom mcp, custom agent.

name: str

App name

as_dict() → dict

Serializes the App into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the App into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → App

Deserializes the App from a dictionary.

class databricks.sdk.service.supervisoragents.Example(question: str, guidelines: List[str], example_id: str | None = None, name: str | None = None)

An example associated with a Supervisor Agent. Contains a question and guidelines for how the agent should respond.

question: str

The example question.

guidelines: List[str]

Guidelines for answering the question.

example_id: str | None = None

The universally unique identifier (UUID) of the example.

name: str | None = None

Full resource name: supervisor-agents/{supervisor_agent_id}/examples/{example_id}

as_dict() → dict

Serializes the Example into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the Example into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → Example

Deserializes the Example from a dictionary.

class databricks.sdk.service.supervisoragents.GenieSpace(id: 'str')

id: str

Deprecated: use space_id instead. Still REQUIRED for backward compatibility until a future API version removes it.

as_dict() → dict

Serializes the GenieSpace into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the GenieSpace into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → GenieSpace

Deserializes the GenieSpace from a dictionary.

class databricks.sdk.service.supervisoragents.GetSupervisorAgentPermissionLevelsResponse(permission_levels: 'Optional[List[SupervisorAgentPermissionsDescription]]' = None)

permission_levels: List[SupervisorAgentPermissionsDescription] | None = None

Specific permission levels

as_dict() → dict

Serializes the GetSupervisorAgentPermissionLevelsResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the GetSupervisorAgentPermissionLevelsResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → GetSupervisorAgentPermissionLevelsResponse

Deserializes the GetSupervisorAgentPermissionLevelsResponse from a dictionary.

class databricks.sdk.service.supervisoragents.KnowledgeAssistant(knowledge_assistant_id: 'str', serving_endpoint_name: 'Optional[str]' = None)

knowledge_assistant_id: str

The ID of the knowledge assistant.

serving_endpoint_name: str | None = None

Deprecated: use knowledge_assistant_id instead.

as_dict() → dict

Serializes the KnowledgeAssistant into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the KnowledgeAssistant into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → KnowledgeAssistant

Deserializes the KnowledgeAssistant from a dictionary.

class databricks.sdk.service.supervisoragents.ListExamplesResponse(examples: List[Example] | None = None, next_page_token: str | None = None)

A list of Supervisor Agent examples.

examples: List[Example] | None = None

next_page_token: str | None = None

as_dict() → dict

Serializes the ListExamplesResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the ListExamplesResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → ListExamplesResponse

Deserializes the ListExamplesResponse from a dictionary.

class databricks.sdk.service.supervisoragents.ListSupervisorAgentsResponse(next_page_token: 'Optional[str]' = None, supervisor_agents: 'Optional[List[SupervisorAgent]]' = None)

next_page_token: str | None = None

A token that can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

supervisor_agents: List[SupervisorAgent] | None = None

as_dict() → dict

Serializes the ListSupervisorAgentsResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the ListSupervisorAgentsResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → ListSupervisorAgentsResponse

Deserializes the ListSupervisorAgentsResponse from a dictionary.

class databricks.sdk.service.supervisoragents.ListToolsResponse(next_page_token: 'Optional[str]' = None, tools: 'Optional[List[Tool]]' = None)

next_page_token: str | None = None

tools: List[Tool] | None = None

as_dict() → dict

Serializes the ListToolsResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the ListToolsResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → ListToolsResponse

Deserializes the ListToolsResponse from a dictionary.

class databricks.sdk.service.supervisoragents.SupervisorAgent(display_name: 'str', create_time: 'Optional[Timestamp]' = None, creator: 'Optional[str]' = None, description: 'Optional[str]' = None, endpoint_name: 'Optional[str]' = None, experiment_id: 'Optional[str]' = None, id: 'Optional[str]' = None, instructions: 'Optional[str]' = None, name: 'Optional[str]' = None, supervisor_agent_id: 'Optional[str]' = None)

display_name: str

The display name of the Supervisor Agent, unique at workspace level.

create_time: Timestamp | None = None

Creation timestamp.

creator: str | None = None

The creator of the Supervisor Agent.

description: str | None = None

Description of what this agent can do (user-facing).

endpoint_name: str | None = None

The name of the supervisor agent’s serving endpoint.

experiment_id: str | None = None

The MLflow experiment ID.

id: str | None = None

Deprecated: Use supervisor_agent_id instead.

instructions: str | None = None

Optional natural-language instructions for the supervisor agent.

name: str | None = None

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

supervisor_agent_id: str | None = None

The universally unique identifier (UUID) of the Supervisor Agent.

as_dict() → dict

Serializes the SupervisorAgent into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the SupervisorAgent into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → SupervisorAgent

Deserializes the SupervisorAgent from a dictionary.

class databricks.sdk.service.supervisoragents.SupervisorAgentAccessControlRequest(group_name: 'Optional[str]' = None, permission_level: 'Optional[SupervisorAgentPermissionLevel]' = None, service_principal_name: 'Optional[str]' = None, user_name: 'Optional[str]' = None)

group_name: str | None = None

name of the group

permission_level: SupervisorAgentPermissionLevel | None = None

service_principal_name: str | None = None

application ID of a service principal

user_name: str | None = None

name of the user

as_dict() → dict

Serializes the SupervisorAgentAccessControlRequest into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the SupervisorAgentAccessControlRequest into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → SupervisorAgentAccessControlRequest

Deserializes the SupervisorAgentAccessControlRequest from a dictionary.

class databricks.sdk.service.supervisoragents.SupervisorAgentAccessControlResponse(all_permissions: 'Optional[List[SupervisorAgentPermission]]' = None, display_name: 'Optional[str]' = None, group_name: 'Optional[str]' = None, service_principal_name: 'Optional[str]' = None, user_name: 'Optional[str]' = None)

all_permissions: List[SupervisorAgentPermission] | None = None

All permissions.

display_name: str | None = None

Display name of the user or service principal.

group_name: str | None = None

name of the group

service_principal_name: str | None = None

Name of the service principal.

user_name: str | None = None

name of the user

as_dict() → dict

Serializes the SupervisorAgentAccessControlResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the SupervisorAgentAccessControlResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → SupervisorAgentAccessControlResponse

Deserializes the SupervisorAgentAccessControlResponse from a dictionary.

class databricks.sdk.service.supervisoragents.SupervisorAgentPermission(inherited: 'Optional[bool]' = None, inherited_from_object: 'Optional[List[str]]' = None, permission_level: 'Optional[SupervisorAgentPermissionLevel]' = None)

inherited: bool | None = None

inherited_from_object: List[str] | None = None

permission_level: SupervisorAgentPermissionLevel | None = None

as_dict() → dict

Serializes the SupervisorAgentPermission into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the SupervisorAgentPermission into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → SupervisorAgentPermission

Deserializes the SupervisorAgentPermission from a dictionary.

class databricks.sdk.service.supervisoragents.SupervisorAgentPermissionLevel

Permission level

CAN_MANAGE = "CAN_MANAGE"

CAN_QUERY = "CAN_QUERY"

class databricks.sdk.service.supervisoragents.SupervisorAgentPermissions(access_control_list: 'Optional[List[SupervisorAgentAccessControlResponse]]' = None, object_id: 'Optional[str]' = None, object_type: 'Optional[str]' = None)

access_control_list: List[SupervisorAgentAccessControlResponse] | None = None

object_id: str | None = None

object_type: str | None = None

as_dict() → dict

Serializes the SupervisorAgentPermissions into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the SupervisorAgentPermissions into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → SupervisorAgentPermissions

Deserializes the SupervisorAgentPermissions from a dictionary.

class databricks.sdk.service.supervisoragents.SupervisorAgentPermissionsDescription(description: 'Optional[str]' = None, permission_level: 'Optional[SupervisorAgentPermissionLevel]' = None)

description: str | None = None

permission_level: SupervisorAgentPermissionLevel | None = None

as_dict() → dict

Serializes the SupervisorAgentPermissionsDescription into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the SupervisorAgentPermissionsDescription into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → SupervisorAgentPermissionsDescription

Deserializes the SupervisorAgentPermissionsDescription from a dictionary.

class databricks.sdk.service.supervisoragents.Tool(tool_type: 'str', app: 'Optional[App]' = None, description: 'Optional[str]' = None, genie_space: 'Optional[GenieSpace]' = None, id: 'Optional[str]' = None, knowledge_assistant: 'Optional[KnowledgeAssistant]' = None, name: 'Optional[str]' = None, tool_id: 'Optional[str]' = None, uc_connection: 'Optional[UcConnection]' = None, uc_function: 'Optional[UcFunction]' = None, volume: 'Optional[Volume]' = None)

tool_type: str

Tool type. Must be one of: “genie_space”, “knowledge_assistant”, “uc_function”, “uc_connection”, “uc_mcp”, “app”, “volume”, “dashboard”, “serving_endpoint”, “table”, “vector_search_index”, “catalog”, “schema”, “supervisor_agent”, “web_search”, “skill”. The legacy values “lakeview_dashboard” and “uc_table” are also accepted and remain equivalent to “dashboard” and “table” respectively.

app: App | None = None

description: str | None = None

Description of what this tool does (user-facing).

genie_space: GenieSpace | None = None

id: str | None = None

Deprecated: Use tool_id instead.

knowledge_assistant: KnowledgeAssistant | None = None

name: str | None = None

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

tool_id: str | None = None

User specified id of the Tool.

uc_connection: UcConnection | None = None

uc_function: UcFunction | None = None

volume: Volume | None = None

as_dict() → dict

Serializes the Tool into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the Tool into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → Tool

Deserializes the Tool from a dictionary.

class databricks.sdk.service.supervisoragents.UcConnection(name: str)

Databricks UC connection. Supported connection: external mcp server.

name: str

as_dict() → dict

Serializes the UcConnection into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the UcConnection into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → UcConnection

Deserializes the UcConnection from a dictionary.

class databricks.sdk.service.supervisoragents.UcFunction(name: 'str')

name: str

Full uc function name

as_dict() → dict

Serializes the UcFunction into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the UcFunction into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → UcFunction

Deserializes the UcFunction from a dictionary.

class databricks.sdk.service.supervisoragents.Volume(name: 'str')

name: str

Full uc volume name

as_dict() → dict

Serializes the Volume into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the Volume into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → Volume

Deserializes the Volume from a dictionary.