``w.supervisor_agents``: SupervisorAgents.v1 ============================================ .. currentmodule:: databricks.sdk.service.supervisoragents .. py:class:: SupervisorAgentsAPI Manage Supervisor Agents and related resources. .. py:method:: create_example(parent: str, example: Example) -> Example Creates an example for a Supervisor Agent. :param parent: str Parent resource where this example will be created. Format: supervisor-agents/{supervisor_agent_id} :param example: :class:`Example` The example to create under the parent Supervisor Agent. :returns: :class:`Example` .. py:method:: create_supervisor_agent(supervisor_agent: SupervisorAgent) -> SupervisorAgent Creates a new Supervisor Agent. :param supervisor_agent: :class:`SupervisorAgent` The Supervisor Agent to create. :returns: :class:`SupervisorAgent` .. py:method:: 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. :param parent: str Parent resource where this tool will be created. Format: supervisor-agents/{supervisor_agent_id} :param tool: :class:`Tool` :param tool_id: str The ID to use for the tool, which will become the final component of the tool's resource name. :returns: :class:`Tool` .. py:method:: delete_example(name: str) Deletes an example from a Supervisor Agent. :param name: str The resource name of the example to delete. Format: supervisor-agents/{supervisor_agent_id}/examples/{example_id} .. py:method:: delete_supervisor_agent(name: str) Deletes a Supervisor Agent. :param name: str The resource name of the Supervisor Agent. Format: supervisor-agents/{supervisor_agent_id} .. py:method:: delete_tool(name: str) Deletes a Tool. :param name: str The resource name of the Tool. Format: supervisor-agents/{supervisor_agent_id}/tools/{tool_id} .. py:method:: get_example(name: str) -> Example Gets an example from a Supervisor Agent. :param name: str The resource name of the example. Format: supervisor-agents/{supervisor_agent_id}/examples/{example_id} :returns: :class:`Example` .. py:method:: get_permission_levels(supervisor_agent_id: str) -> GetSupervisorAgentPermissionLevelsResponse Gets the permission levels that a user can have on an object. :param supervisor_agent_id: str The supervisor agent for which to get or manage permissions. :returns: :class:`GetSupervisorAgentPermissionLevelsResponse` .. py:method:: get_permissions(supervisor_agent_id: str) -> SupervisorAgentPermissions Gets the permissions of a supervisor agent. Supervisor agents can inherit permissions from their root object. :param supervisor_agent_id: str The supervisor agent for which to get or manage permissions. :returns: :class:`SupervisorAgentPermissions` .. py:method:: get_supervisor_agent(name: str) -> SupervisorAgent Gets a Supervisor Agent. :param name: str The resource name of the Supervisor Agent. Format: supervisor-agents/{supervisor_agent_id} :returns: :class:`SupervisorAgent` .. py:method:: get_tool(name: str) -> Tool Gets a Tool. :param name: str The resource name of the Tool. Format: supervisor-agents/{supervisor_agent_id}/tools/{tool_id} :returns: :class:`Tool` .. py:method:: list_examples(parent: str [, page_size: Optional[int], page_token: Optional[str]]) -> Iterator[Example] Lists examples under a Supervisor Agent. :param parent: str Parent resource to list from. Format: supervisor-agents/{supervisor_agent_id} :param 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. :param 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 :class:`Example` .. py:method:: list_supervisor_agents( [, page_size: Optional[int], page_token: Optional[str]]) -> Iterator[SupervisorAgent] Lists Supervisor Agents. :param 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. :param 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 :class:`SupervisorAgent` .. py:method:: list_tools(parent: str [, page_size: Optional[int], page_token: Optional[str]]) -> Iterator[Tool] Lists Tools under a Supervisor Agent. :param parent: str Parent resource to list from. Format: supervisor-agents/{supervisor_agent_id} :param page_size: int (optional) :param page_token: str (optional) :returns: Iterator over :class:`Tool` .. py:method:: 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. :param supervisor_agent_id: str The supervisor agent for which to get or manage permissions. :param access_control_list: List[:class:`SupervisorAgentAccessControlRequest`] (optional) :returns: :class:`SupervisorAgentPermissions` .. py:method:: update_example(name: str, example: Example, update_mask: FieldMask) -> Example Updates an example in a Supervisor Agent. :param name: str The resource name of the example to update. Format: supervisor-agents/{supervisor_agent_id}/examples/{example_id} :param example: :class:`Example` :param update_mask: FieldMask Comma-delimited list of fields to update on the example. Allowed values: `question`, `guidelines`. Examples: - `question` - `question,guidelines` :returns: :class:`Example` .. py:method:: 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. :param supervisor_agent_id: str The supervisor agent for which to get or manage permissions. :param access_control_list: List[:class:`SupervisorAgentAccessControlRequest`] (optional) :returns: :class:`SupervisorAgentPermissions` .. py:method:: 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. :param name: str The resource name of the SupervisorAgent. Format: supervisor-agents/{supervisor_agent_id} :param supervisor_agent: :class:`SupervisorAgent` The SupervisorAgent to update. :param update_mask: FieldMask Field mask for fields to be updated. :returns: :class:`SupervisorAgent` .. py:method:: 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. :param name: str Full resource name: supervisor-agents/{supervisor_agent_id}/tools/{tool_id} :param tool: :class:`Tool` The Tool to update. :param update_mask: FieldMask Field mask for fields to be updated. :returns: :class:`Tool`