Package version:

Class AgentsClient

Index

Constructors

Properties

files messages pipeline runs runSteps threads vectorStoreFileBatches vectorStoreFiles vectorStores

Methods

createAgent deleteAgent getAgent listAgents updateAgent

Constructors

constructor

new AgentsClient(endpointParam, credential, options?): AgentsClient
Parameters
- endpointParam: string
- credential: any
- options: AgentsClientOptionalParams = {}
Returns AgentsClient
- Defined in agentsClient.ts:42

Properties

`Readonly`files

files: FilesOperations

The operation groups for files

`Readonly`messages

messages: MessagesOperations

The operation groups for messages

`Readonly`pipeline

pipeline: Pipeline

The pipeline used by this client to make requests

`Readonly`runs

runs: RunsOperations

The operation groups for runs

`Readonly`runSteps

runSteps: RunStepsOperations

The operation groups for runSteps

`Readonly`threads

threads: ThreadsOperations

The operation groups for threads

`Readonly`vectorStoreFileBatches

vectorStoreFileBatches: VectorStoreFileBatchesOperations

The operation groups for vectorStoreFileBatches

`Readonly`vectorStoreFiles

vectorStoreFiles: VectorStoreFilesOperations

The operation groups for vectorStoreFiles

`Readonly`vectorStores

vectorStores: VectorStoresOperations

The operation groups for vectorStores

Methods

createAgent

createAgent(model, options?): Promise<Agent>
Creates a new agent.
Parameters
- model: string
- options: CreateAgentOptionalParams = ...
Returns Promise<Agent>
- Defined in agentsClient.ts:115

deleteAgent

deleteAgent(assistantId, options?): Promise<AgentDeletionStatus>
Deletes an agent.
Parameters
- assistantId: string
- options: DeleteAgentOptionalParams = ...
Returns Promise<AgentDeletionStatus>
- Defined in agentsClient.ts:84

getAgent

getAgent(assistantId, options?): Promise<Agent>
Retrieves an existing agent.
Parameters
- assistantId: string
- options: GetAgentOptionalParams = ...
Returns Promise<Agent>
- Defined in agentsClient.ts:100

listAgents

listAgents(options?): PagedAsyncIterableIterator<Agent, {}, PageSettings>
Gets a list of agents that were previously created.
Parameters
- options: ListAgentsOptionalParams = ...
Returns PagedAsyncIterableIterator<Agent, {}, PageSettings>
- Defined in agentsClient.ts:108

updateAgent

updateAgent(assistantId, options?): Promise<Agent>
Modifies an existing agent.
Parameters
- assistantId: string
- options: UpdateAgentOptionalParams = ...
Returns Promise<Agent>
- Defined in agentsClient.ts:92