com.databricks.sdk.service.supervisoragents

Interface SupervisorAgentsService

@Generated
public interface SupervisorAgentsService

Manage Supervisor Agents and related resources.

This is the high-level interface, that contains generated methods.

Evolving: this interface is under development. Method signatures may change.

Method Summary

Modifier and Type	Method and Description
Example	createExample(CreateExampleRequest createExampleRequest) Creates an example for a Supervisor Agent.
SupervisorAgent	createSupervisorAgent(CreateSupervisorAgentRequest createSupervisorAgentRequest) Creates a new Supervisor Agent.
Tool	createTool(CreateToolRequest createToolRequest) Creates a Tool under a Supervisor Agent.
void	deleteExample(DeleteExampleRequest deleteExampleRequest) Deletes an example from a Supervisor Agent.
void	deleteSupervisorAgent(DeleteSupervisorAgentRequest deleteSupervisorAgentRequest) Deletes a Supervisor Agent.
void	deleteTool(DeleteToolRequest deleteToolRequest) Deletes a Tool.
Example	getExample(GetExampleRequest getExampleRequest) Gets an example from a Supervisor Agent.
GetSupervisorAgentPermissionLevelsResponse	getPermissionLevels(GetSupervisorAgentPermissionLevelsRequest getSupervisorAgentPermissionLevelsRequest) Gets the permission levels that a user can have on an object.
SupervisorAgentPermissions	getPermissions(GetSupervisorAgentPermissionsRequest getSupervisorAgentPermissionsRequest) Gets the permissions of a supervisor agent.
SupervisorAgent	getSupervisorAgent(GetSupervisorAgentRequest getSupervisorAgentRequest) Gets a Supervisor Agent.
Tool	getTool(GetToolRequest getToolRequest) Gets a Tool.
ListExamplesResponse	listExamples(ListExamplesRequest listExamplesRequest) Lists examples under a Supervisor Agent.
ListSupervisorAgentsResponse	listSupervisorAgents(ListSupervisorAgentsRequest listSupervisorAgentsRequest) Lists Supervisor Agents.
ListToolsResponse	listTools(ListToolsRequest listToolsRequest) Lists Tools under a Supervisor Agent.
SupervisorAgentPermissions	setPermissions(SupervisorAgentPermissionsRequest supervisorAgentPermissionsRequest) Sets permissions on an object, replacing existing permissions if they exist.
Example	updateExample(UpdateExampleRequest updateExampleRequest) Updates an example in a Supervisor Agent.
SupervisorAgentPermissions	updatePermissions(SupervisorAgentPermissionsRequest supervisorAgentPermissionsRequest) Updates the permissions on a supervisor agent.
SupervisorAgent	updateSupervisorAgent(UpdateSupervisorAgentRequest updateSupervisorAgentRequest) Updates a Supervisor Agent.
Tool	updateTool(UpdateToolRequest updateToolRequest) Updates a Tool.

Method Detail

createExample

Example createExample(CreateExampleRequest createExampleRequest)

Creates an example for a Supervisor Agent.

createSupervisorAgent

SupervisorAgent createSupervisorAgent(CreateSupervisorAgentRequest createSupervisorAgentRequest)

Creates a new Supervisor Agent.

createTool

Tool createTool(CreateToolRequest createToolRequest)

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" in the request body. The legacy values "lakeview_dashboard" and "uc_table" are also accepted and remain equivalent to "dashboard" and "table" respectively.

deleteExample

void deleteExample(DeleteExampleRequest deleteExampleRequest)

Deletes an example from a Supervisor Agent.

deleteSupervisorAgent

void deleteSupervisorAgent(DeleteSupervisorAgentRequest deleteSupervisorAgentRequest)

Deletes a Supervisor Agent.

deleteTool

void deleteTool(DeleteToolRequest deleteToolRequest)

Deletes a Tool.

getExample

Example getExample(GetExampleRequest getExampleRequest)

Gets an example from a Supervisor Agent.

getPermissionLevels

GetSupervisorAgentPermissionLevelsResponse getPermissionLevels(GetSupervisorAgentPermissionLevelsRequest getSupervisorAgentPermissionLevelsRequest)

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

getPermissions

SupervisorAgentPermissions getPermissions(GetSupervisorAgentPermissionsRequest getSupervisorAgentPermissionsRequest)

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

getSupervisorAgent

SupervisorAgent getSupervisorAgent(GetSupervisorAgentRequest getSupervisorAgentRequest)

Gets a Supervisor Agent.

getTool

Tool getTool(GetToolRequest getToolRequest)

Gets a Tool.

listExamples

ListExamplesResponse listExamples(ListExamplesRequest listExamplesRequest)

Lists examples under a Supervisor Agent.

listSupervisorAgents

ListSupervisorAgentsResponse listSupervisorAgents(ListSupervisorAgentsRequest listSupervisorAgentsRequest)

Lists Supervisor Agents.

listTools

ListToolsResponse listTools(ListToolsRequest listToolsRequest)

Lists Tools under a Supervisor Agent.

setPermissions

SupervisorAgentPermissions setPermissions(SupervisorAgentPermissionsRequest supervisorAgentPermissionsRequest)

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.

updateExample

Example updateExample(UpdateExampleRequest updateExampleRequest)

Updates an example in a Supervisor Agent.

updatePermissions

SupervisorAgentPermissions updatePermissions(SupervisorAgentPermissionsRequest supervisorAgentPermissionsRequest)

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

updateSupervisorAgent

SupervisorAgent updateSupervisorAgent(UpdateSupervisorAgentRequest updateSupervisorAgentRequest)

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.

updateTool

Tool updateTool(UpdateToolRequest updateToolRequest)

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.