Class SupervisorAgentsClient

Index

Constructors

Methods

createExample createSupervisorAgent createTool deleteExample deleteSupervisorAgent deleteTool getExample getSupervisorAgent getTool listExamples listExamplesIter listSupervisorAgents listSupervisorAgentsIter listTools listToolsIter updateExample updateSupervisorAgent updateTool

Constructors

constructor

new SupervisorAgentsClient(options: ClientOptions): SupervisorAgentsClient
Parameters
- options: ClientOptions
Returns SupervisorAgentsClient
- Defined in client.ts:72

Methods

createExample

createExample(
req: CreateExampleRequest,
options?: CallOptions,
): Promise<Example>
Creates an example for a Supervisor Agent.
Parameters
- req: CreateExampleRequest
- Optionaloptions: CallOptions
Returns Promise<Example>
- Defined in client.ts:88

createSupervisorAgent

createSupervisorAgent(
req: CreateSupervisorAgentRequest,
options?: CallOptions,
): Promise<SupervisorAgent>
Creates a new Supervisor Agent.
Parameters
- req: CreateSupervisorAgentRequest
- Optionaloptions: CallOptions
Returns Promise<SupervisorAgent>
- Defined in client.ts:118

createTool

createTool(req: CreateToolRequest, options?: CallOptions): Promise<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
- req: CreateToolRequest
- Optionaloptions: CallOptions
Returns Promise<Tool>
- Defined in client.ts:151

deleteExample

deleteExample(req: DeleteExampleRequest, options?: CallOptions): Promise<void>
Deletes an example from a Supervisor Agent.
Parameters
- req: DeleteExampleRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:193

deleteSupervisorAgent

deleteSupervisorAgent(
req: DeleteSupervisorAgentRequest,
options?: CallOptions,
): Promise<void>
Deletes a Supervisor Agent.
Parameters
- req: DeleteSupervisorAgentRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:216

deleteTool

deleteTool(req: DeleteToolRequest, options?: CallOptions): Promise<void>
Deletes a Tool.
Parameters
- req: DeleteToolRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:239

getExample

getExample(req: GetExampleRequest, options?: CallOptions): Promise<Example>
Gets an example from a Supervisor Agent.
Parameters
- req: GetExampleRequest
- Optionaloptions: CallOptions
Returns Promise<Example>
- Defined in client.ts:262

getSupervisorAgent

getSupervisorAgent(
req: GetSupervisorAgentRequest,
options?: CallOptions,
): Promise<SupervisorAgent>
Gets a Supervisor Agent.
Parameters
- req: GetSupervisorAgentRequest
- Optionaloptions: CallOptions
Returns Promise<SupervisorAgent>
- Defined in client.ts:291

getTool

getTool(req: GetToolRequest, options?: CallOptions): Promise<Tool>
Gets a Tool.
Parameters
- req: GetToolRequest
- Optionaloptions: CallOptions
Returns Promise<Tool>
- Defined in client.ts:320

listExamples

listExamples(
req: ListExamplesRequest,
options?: CallOptions,
): Promise<ListExamplesResponse>
Lists examples under a Supervisor Agent.
Parameters
- req: ListExamplesRequest
- Optionaloptions: CallOptions
Returns Promise<ListExamplesResponse>
- Defined in client.ts:346

listExamplesIter

listExamplesIter(
req: ListExamplesRequest,
options?: CallOptions,
): AsyncGenerator<Example>
Parameters
- req: ListExamplesRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<Example>
- Defined in client.ts:383

listSupervisorAgents

listSupervisorAgents(
req: ListSupervisorAgentsRequest,
options?: CallOptions,
): Promise<ListSupervisorAgentsResponse>
Lists Supervisor Agents.
Parameters
- req: ListSupervisorAgentsRequest
- Optionaloptions: CallOptions
Returns Promise<ListSupervisorAgentsResponse>
- Defined in client.ts:401

listSupervisorAgentsIter

listSupervisorAgentsIter(
req: ListSupervisorAgentsRequest,
options?: CallOptions,
): AsyncGenerator<SupervisorAgent>
Parameters
- req: ListSupervisorAgentsRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<SupervisorAgent>
- Defined in client.ts:441

listTools

listTools(
req: ListToolsRequest,
options?: CallOptions,
): Promise<ListToolsResponse>
Lists Tools under a Supervisor Agent.
Parameters
- req: ListToolsRequest
- Optionaloptions: CallOptions
Returns Promise<ListToolsResponse>
- Defined in client.ts:459

listToolsIter

listToolsIter(
req: ListToolsRequest,
options?: CallOptions,
): AsyncGenerator<Tool>
Parameters
- req: ListToolsRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<Tool>
- Defined in client.ts:496

updateExample

updateExample(
req: UpdateExampleRequest,
options?: CallOptions,
): Promise<Example>
Updates an example in a Supervisor Agent.
Parameters
- req: UpdateExampleRequest
- Optionaloptions: CallOptions
Returns Promise<Example>
- Defined in client.ts:514

updateSupervisorAgent

updateSupervisorAgent(
req: UpdateSupervisorAgentRequest,
options?: CallOptions,
): Promise<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
- req: UpdateSupervisorAgentRequest
- Optionaloptions: CallOptions
Returns Promise<SupervisorAgent>
- Defined in client.ts:559

updateTool

updateTool(req: UpdateToolRequest, options?: CallOptions): Promise<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
- req: UpdateToolRequest
- Optionaloptions: CallOptions
Returns Promise<Tool>
- Defined in client.ts:607

Class SupervisorAgentsClient

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns SupervisorAgentsClient

Methods

createExample

Parameters

Returns Promise<Example>

createSupervisorAgent

Parameters

Returns Promise<SupervisorAgent>

createTool

Parameters

Returns Promise<Tool>

deleteExample

Parameters

Returns Promise<void>

deleteSupervisorAgent

Parameters

Returns Promise<void>

deleteTool

Parameters

Returns Promise<void>

getExample

Parameters

Returns Promise<Example>

getSupervisorAgent

Parameters

Returns Promise<SupervisorAgent>

getTool

Parameters

Returns Promise<Tool>

listExamples

Parameters

Returns Promise<ListExamplesResponse>

listExamplesIter

Parameters

Returns AsyncGenerator<Example>

listSupervisorAgents

Parameters

Returns Promise<ListSupervisorAgentsResponse>

listSupervisorAgentsIter

Parameters

Returns AsyncGenerator<SupervisorAgent>

listTools

Parameters

Returns Promise<ListToolsResponse>

listToolsIter

Parameters

Returns AsyncGenerator<Tool>

updateExample

Parameters

Returns Promise<Example>

updateSupervisorAgent

Parameters

Returns Promise<SupervisorAgent>

updateTool

Parameters

Returns Promise<Tool>

Settings

On This Page