AgentsClient class
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 |
run |
The operation groups for runSteps |
threads | The operation groups for threads |
vector |
The operation groups for vectorStoreFileBatches |
vector |
The operation groups for vectorStoreFiles |
vector |
The operation groups for vectorStores |
Methods
create |
Creates a new agent. |
delete |
Deletes an agent. |
get |
Retrieves an existing agent. |
list |
Gets a list of agents that were previously created. |
update |
Modifies an existing agent. |
Constructor Details
AgentsClient(string, KeyCredential | TokenCredential, AgentsClientOptionalParams)
new AgentsClient(endpointParam: string, credential: KeyCredential | TokenCredential, options?: AgentsClientOptionalParams)
Parameters
- endpointParam
-
string
- credential
- options
- AgentsClientOptionalParams
Property Details
files
messages
pipeline
runs
runSteps
threads
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
- options
- CreateAgentOptionalParams
Returns
Promise<Agent>
deleteAgent(string, DeleteAgentOptionalParams)
Deletes an agent.
function deleteAgent(assistantId: string, options?: DeleteAgentOptionalParams): Promise<AgentDeletionStatus>
Parameters
- assistantId
-
string
- options
- DeleteAgentOptionalParams
Returns
Promise<AgentDeletionStatus>
getAgent(string, GetAgentOptionalParams)
Retrieves an existing agent.
function getAgent(assistantId: string, options?: GetAgentOptionalParams): Promise<Agent>
Parameters
- assistantId
-
string
- options
- GetAgentOptionalParams
Returns
Promise<Agent>
listAgents(ListAgentsOptionalParams)
Gets a list of agents that were previously created.
function listAgents(options?: ListAgentsOptionalParams): PagedAsyncIterableIterator<Agent, Agent[], PageSettings>
Parameters
- options
- ListAgentsOptionalParams
Returns
updateAgent(string, UpdateAgentOptionalParams)
Modifies an existing agent.
function updateAgent(assistantId: string, options?: UpdateAgentOptionalParams): Promise<Agent>
Parameters
- assistantId
-
string
- options
- UpdateAgentOptionalParams
Returns
Promise<Agent>