Class Agent

Class for creating Agents and agent specs.

Index

Constructors

Methods

create createSpec list

Constructors

constructor

new Agent(connection: Connection, project: SfProject): Agent
Create an Agent instance
Parameters
- connection: Connection
- project: SfProject
Returns Agent
- Defined in agent.ts:53

Methods

create

create(config: AgentCreateConfig): Promise<AgentCreateResponse>
Creates an agent from a configuration, optionally saving the agent in an org.
Parameters
- config: AgentCreateConfig
  a configuration for creating or previewing an agent
Returns Promise<AgentCreateResponse>
the agent definition
- Defined in agent.ts:95

createSpec

createSpec(config: AgentJobSpecCreateConfig): Promise<AgentJobSpec>
Create an agent spec from provided data.
Parameters
- config: AgentJobSpecCreateConfig
  The configuration used to generate an agent spec.
Returns Promise<AgentJobSpec>
- Defined in agent.ts:173

`Static`list

list(project: SfProject): Promise<string[]>
List all agents in the current project.
Parameters
- project: SfProject
Returns Promise<string[]>
- Defined in agent.ts:62