AgentsOperations interface

Package:

@azure/ai-projects

Interface representing a Agents operations.

Properties

delete	Deletes an agent.
deleteVersion	Deletes a specific version of an agent.
get	Retrieves the agent.
getVersion	Retrieves a specific version of an agent.
list	Returns the list of all agents.
listVersions	Returns the list of versions of an agent.

Methods

create(string, AgentDefinitionUnion, AgentsCreateOptionalParams)	Creates the agent.
create(string, string, Record<string, any>, AgentsCreateAgentFromManifestOptionalParams)	Creates an agent from a manifest.
createVersion(string, AgentDefinitionUnion, AgentsCreateOptionalParams)	Create a new agent version.
createVersion(string, string, Record<string, any>, AgentsCreateAgentVersionFromManifestOptionalParams)	Create a new agent version from a manifest.
update(string, AgentDefinitionUnion, AgentsUpdateOptionalParams)	Updates the agent by adding a new version if there are any changes to the agent definition. If no changes, returns the existing agent version.
update(string, string, Record<string, any>, AgentsUpdateAgentFromManifestOptionalParams)	Updates the agent from a manifest by adding a new version if there are any changes to the agent definition. If no changes, returns the existing agent version.

Property Details

delete

Deletes an agent.

delete: (agentName: string, options?: AgentsDeleteOptionalParams) => Promise<DeleteAgentResponse>

Property Value

(agentName: string, options?: AgentsDeleteOptionalParams) => Promise<DeleteAgentResponse>

deleteVersion

Deletes a specific version of an agent.

deleteVersion: (agentName: string, agentVersion: string, options?: AgentsDeleteVersionOptionalParams) => Promise<DeleteAgentVersionResponse>

Property Value

(agentName: string, agentVersion: string, options?: AgentsDeleteVersionOptionalParams) => Promise<DeleteAgentVersionResponse>

get

Retrieves the agent.

get: (agentName: string, options?: AgentsGetOptionalParams) => Promise<Agent>

Property Value

(agentName: string, options?: AgentsGetOptionalParams) => Promise<Agent>

getVersion

Retrieves a specific version of an agent.

getVersion: (agentName: string, agentVersion: string, options?: AgentsGetVersionOptionalParams) => Promise<AgentVersion>

Property Value

(agentName: string, agentVersion: string, options?: AgentsGetVersionOptionalParams) => Promise<AgentVersion>

list

Returns the list of all agents.

list: (options?: AgentsListOptionalParams) => PagedAsyncIterableIterator<Agent, Agent[], PageSettings>

Property Value

(options?: AgentsListOptionalParams) => PagedAsyncIterableIterator<Agent, Agent[], PageSettings>

listVersions

Returns the list of versions of an agent.

listVersions: (agentName: string, options?: AgentsListVersionsOptionalParams) => PagedAsyncIterableIterator<AgentVersion, AgentVersion[], PageSettings>

Property Value

(agentName: string, options?: AgentsListVersionsOptionalParams) => PagedAsyncIterableIterator<AgentVersion, AgentVersion[], PageSettings>

Method Details

create(string, AgentDefinitionUnion, AgentsCreateOptionalParams)

Creates the agent.

function create(name: string, definition: AgentDefinitionUnion, options?: AgentsCreateOptionalParams): Promise<Agent>

Parameters

name

string

definition

AgentDefinitionUnion

options

AgentsCreateOptionalParams

Returns

Promise<Agent>

create(string, string, Record<string, any>, AgentsCreateAgentFromManifestOptionalParams)

Creates an agent from a manifest.

function create(name: string, manifestId: string, parameterValues: Record<string, any>, options?: AgentsCreateAgentFromManifestOptionalParams): Promise<Agent>

Parameters

name

string

manifestId

string

parameterValues

Record<string, any>

options

AgentsCreateAgentFromManifestOptionalParams

Returns

Promise<Agent>

createVersion(string, AgentDefinitionUnion, AgentsCreateOptionalParams)

Create a new agent version.

function createVersion(agentName: string, definition: AgentDefinitionUnion, options?: AgentsCreateOptionalParams): Promise<AgentVersion>

Parameters

agentName

string

definition

AgentDefinitionUnion

options

AgentsCreateOptionalParams

Returns

Promise<AgentVersion>

createVersion(string, string, Record<string, any>, AgentsCreateAgentVersionFromManifestOptionalParams)

Create a new agent version from a manifest.

function createVersion(agentName: string, manifestId: string, parameterValues: Record<string, any>, options?: AgentsCreateAgentVersionFromManifestOptionalParams): Promise<AgentVersion>

Parameters

agentName

string

manifestId

string

parameterValues

Record<string, any>

options

AgentsCreateAgentVersionFromManifestOptionalParams

Returns

Promise<AgentVersion>

update(string, AgentDefinitionUnion, AgentsUpdateOptionalParams)

Updates the agent by adding a new version if there are any changes to the agent definition. If no changes, returns the existing agent version.

function update(agentName: string, definition: AgentDefinitionUnion, options?: AgentsUpdateOptionalParams): Promise<Agent>

Parameters

agentName

string

definition

AgentDefinitionUnion

options

AgentsUpdateOptionalParams

Returns

Promise<Agent>

update(string, string, Record<string, any>, AgentsUpdateAgentFromManifestOptionalParams)

Updates the agent from a manifest by adding a new version if there are any changes to the agent definition. If no changes, returns the existing agent version.

function update(agentName: string, manifestId: string, parameterValues: Record<string, any>, options?: AgentsUpdateAgentFromManifestOptionalParams): Promise<Agent>

Parameters

agentName

string

manifestId

string

parameterValues

Record<string, any>

options

AgentsUpdateAgentFromManifestOptionalParams

Returns

Promise<Agent>