AgentsOperations
The agents.* operations.
Methods
Section titled “Methods”list()
Section titled “list()”list(input?, options?): Promise<AgentSummary[]>;List the agents.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
input? |
{ agents?: string[]; } |
- |
input.agents? |
string[] |
The agents to cover, by ID, given once for each. Each covers its conversations too. Every agent you may see unless set. |
options? |
CallOptions |
- |
Returns
Section titled “Returns”Promise<AgentSummary[]>
forget()
Section titled “forget()”forget(input?, options?): Promise<Forgotten>;Forget the agents.
Each agent goes as agent.forget takes it: stopped, with its conversation, definition and triggers deleted.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
input? |
{ agents?: string[]; } |
- |
input.agents? |
string[] |
The agents to cover, by ID, given once for each. Each covers its conversations too. Every agent you may see unless set. |
options? |
CallOptions |
- |
Returns
Section titled “Returns”Promise<Forgotten>
cancel()
Section titled “cancel()”cancel(input?, options?): Promise<string[]>;Stop what the agents are doing.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
input? |
{ agents?: string[]; } |
- |
input.agents? |
string[] |
The agents to cover, by ID, given once for each. Each covers its conversations too. Every agent you may see unless set. |
options? |
CallOptions |
- |
Returns
Section titled “Returns”Promise<string[]>