Share via


AgentsClient class

Constructors

AgentsClient(string, KeyCredential | TokenCredential, AgentsClientOptionalParams)

Properties

files

The operation groups for files

messages

The operation groups for messages

pipeline

The pipeline used by this client to make requests

runs

The operation groups for runs

runSteps

The operation groups for runSteps

threads

The operation groups for threads

vectorStoreFileBatches

The operation groups for vectorStoreFileBatches

vectorStoreFiles

The operation groups for vectorStoreFiles

vectorStores

The operation groups for vectorStores

Methods

createAgent(string, CreateAgentOptionalParams)

Creates a new agent.

deleteAgent(string, DeleteAgentOptionalParams)

Deletes an agent.

getAgent(string, GetAgentOptionalParams)

Retrieves an existing agent.

listAgents(ListAgentsOptionalParams)

Gets a list of agents that were previously created.

updateAgent(string, UpdateAgentOptionalParams)

Modifies an existing agent.

Constructor Details

AgentsClient(string, KeyCredential | TokenCredential, AgentsClientOptionalParams)

new AgentsClient(endpointParam: string, credential: KeyCredential | TokenCredential, options?: AgentsClientOptionalParams)

Parameters

endpointParam

string

Property Details

files

The operation groups for files

files: FilesOperations

Property Value

messages

The operation groups for messages

messages: MessagesOperations

Property Value

pipeline

The pipeline used by this client to make requests

pipeline: Pipeline

Property Value

runs

The operation groups for runs

runs: RunsOperations

Property Value

runSteps

The operation groups for runSteps

runSteps: RunStepsOperations

Property Value

threads

The operation groups for threads

threads: ThreadsOperations

Property Value

vectorStoreFileBatches

The operation groups for vectorStoreFileBatches

vectorStoreFileBatches: VectorStoreFileBatchesOperations

Property Value

vectorStoreFiles

The operation groups for vectorStoreFiles

vectorStoreFiles: VectorStoreFilesOperations

Property Value

vectorStores

The operation groups for vectorStores

vectorStores: VectorStoresOperations

Property Value

Method Details

createAgent(string, CreateAgentOptionalParams)

Creates a new agent.

function createAgent(model: string, options?: CreateAgentOptionalParams): Promise<Agent>

Parameters

model

string

Returns

Promise<Agent>

deleteAgent(string, DeleteAgentOptionalParams)

Deletes an agent.

function deleteAgent(assistantId: string, options?: DeleteAgentOptionalParams): Promise<AgentDeletionStatus>

Parameters

assistantId

string

Returns

getAgent(string, GetAgentOptionalParams)

Retrieves an existing agent.

function getAgent(assistantId: string, options?: GetAgentOptionalParams): Promise<Agent>

Parameters

assistantId

string

Returns

Promise<Agent>

listAgents(ListAgentsOptionalParams)

Gets a list of agents that were previously created.

function listAgents(options?: ListAgentsOptionalParams): PagedAsyncIterableIterator<Agent, Agent[], PageSettings>

Parameters

Returns

updateAgent(string, UpdateAgentOptionalParams)

Modifies an existing agent.

function updateAgent(assistantId: string, options?: UpdateAgentOptionalParams): Promise<Agent>

Parameters

assistantId

string

Returns

Promise<Agent>