com.databricks.sdk.service.supervisoragents

Class SupervisorAgentsAPI

java.lang.Object

com.databricks.sdk.service.supervisoragents.SupervisorAgentsAPI

@Generated
public class SupervisorAgentsAPI
extends Object

Manage Supervisor Agents and related resources.

Constructor Summary

Constructors

Constructor and Description
SupervisorAgentsAPI(ApiClient apiClient) Regular-use constructor
SupervisorAgentsAPI(SupervisorAgentsService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
Example	createExample(CreateExampleRequest request) Creates an example for a Supervisor Agent.
SupervisorAgent	createSupervisorAgent(CreateSupervisorAgentRequest request) Creates a new Supervisor Agent.
Tool	createTool(CreateToolRequest request) Creates a Tool under a Supervisor Agent.
void	deleteExample(DeleteExampleRequest request) Deletes an example from a Supervisor Agent.
void	deleteExample(String name)
void	deleteSupervisorAgent(DeleteSupervisorAgentRequest request) Deletes a Supervisor Agent.
void	deleteSupervisorAgent(String name)
void	deleteTool(DeleteToolRequest request) Deletes a Tool.
void	deleteTool(String name)
Example	getExample(GetExampleRequest request) Gets an example from a Supervisor Agent.
Example	getExample(String name)
GetSupervisorAgentPermissionLevelsResponse	getPermissionLevels(GetSupervisorAgentPermissionLevelsRequest request) Gets the permission levels that a user can have on an object.
GetSupervisorAgentPermissionLevelsResponse	getPermissionLevels(String supervisorAgentId)
SupervisorAgentPermissions	getPermissions(GetSupervisorAgentPermissionsRequest request) Gets the permissions of a supervisor agent.
SupervisorAgentPermissions	getPermissions(String supervisorAgentId)
SupervisorAgent	getSupervisorAgent(GetSupervisorAgentRequest request) Gets a Supervisor Agent.
SupervisorAgent	getSupervisorAgent(String name)
Tool	getTool(GetToolRequest request) Gets a Tool.
Tool	getTool(String name)
SupervisorAgentsService	impl()
Iterable<Example>	listExamples(ListExamplesRequest request) Lists examples under a Supervisor Agent.
Iterable<Example>	listExamples(String parent)
Iterable<SupervisorAgent>	listSupervisorAgents(ListSupervisorAgentsRequest request) Lists Supervisor Agents.
Iterable<Tool>	listTools(ListToolsRequest request) Lists Tools under a Supervisor Agent.
Iterable<Tool>	listTools(String parent)
SupervisorAgentPermissions	setPermissions(SupervisorAgentPermissionsRequest request) Sets permissions on an object, replacing existing permissions if they exist.
Example	updateExample(UpdateExampleRequest request) Updates an example in a Supervisor Agent.
SupervisorAgentPermissions	updatePermissions(SupervisorAgentPermissionsRequest request) Updates the permissions on a supervisor agent.
SupervisorAgent	updateSupervisorAgent(UpdateSupervisorAgentRequest request) Updates a Supervisor Agent.
Tool	updateTool(UpdateToolRequest request) Updates a Tool.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SupervisorAgentsAPI

public SupervisorAgentsAPI(ApiClient apiClient)

Regular-use constructor

SupervisorAgentsAPI

public SupervisorAgentsAPI(SupervisorAgentsService mock)

Constructor for mocks

Method Detail

createExample

public Example createExample(CreateExampleRequest request)

Creates an example for a Supervisor Agent.

createSupervisorAgent

public SupervisorAgent createSupervisorAgent(CreateSupervisorAgentRequest request)

Creates a new Supervisor Agent.

createTool

public Tool createTool(CreateToolRequest request)

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

public void deleteExample(String name)

deleteExample

public void deleteExample(DeleteExampleRequest request)

Deletes an example from a Supervisor Agent.

deleteSupervisorAgent

public void deleteSupervisorAgent(String name)

deleteSupervisorAgent

public void deleteSupervisorAgent(DeleteSupervisorAgentRequest request)

Deletes a Supervisor Agent.

deleteTool

public void deleteTool(String name)

deleteTool

public void deleteTool(DeleteToolRequest request)

Deletes a Tool.

getExample

public Example getExample(String name)

getExample

public Example getExample(GetExampleRequest request)

Gets an example from a Supervisor Agent.

getPermissionLevels

public GetSupervisorAgentPermissionLevelsResponse getPermissionLevels(String supervisorAgentId)

getPermissionLevels

public GetSupervisorAgentPermissionLevelsResponse getPermissionLevels(GetSupervisorAgentPermissionLevelsRequest request)

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

getPermissions

public SupervisorAgentPermissions getPermissions(String supervisorAgentId)

getPermissions

public SupervisorAgentPermissions getPermissions(GetSupervisorAgentPermissionsRequest request)

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

getSupervisorAgent

public SupervisorAgent getSupervisorAgent(String name)

getSupervisorAgent

public SupervisorAgent getSupervisorAgent(GetSupervisorAgentRequest request)

Gets a Supervisor Agent.

getTool

public Tool getTool(String name)

getTool

public Tool getTool(GetToolRequest request)

Gets a Tool.

listExamples

public Iterable<Example> listExamples(String parent)

listExamples

public Iterable<Example> listExamples(ListExamplesRequest request)

Lists examples under a Supervisor Agent.

listSupervisorAgents

public Iterable<SupervisorAgent> listSupervisorAgents(ListSupervisorAgentsRequest request)

Lists Supervisor Agents.

listTools

public Iterable<Tool> listTools(String parent)

listTools

public Iterable<Tool> listTools(ListToolsRequest request)

Lists Tools under a Supervisor Agent.

setPermissions

public SupervisorAgentPermissions setPermissions(SupervisorAgentPermissionsRequest request)

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

public Example updateExample(UpdateExampleRequest request)

Updates an example in a Supervisor Agent.

updatePermissions

public SupervisorAgentPermissions updatePermissions(SupervisorAgentPermissionsRequest request)

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

updateSupervisorAgent

public SupervisorAgent updateSupervisorAgent(UpdateSupervisorAgentRequest request)

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

public Tool updateTool(UpdateToolRequest request)

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.

impl

public SupervisorAgentsService impl()