Class AgentPreviewBase`Abstract`

Abstract base class for agent runners that provides common functionality for interacting with agents through the Einstein AI Agent API.

Hierarchy (View Summary)

AgentPreviewBase
- AgentPreview
- AgentSimulate

Implements

AgentInteractionBase

Index

Methods

end send setApexDebugMode start traces

Methods

`Abstract`end

end(sessionId: string, reason: EndReason): Promise<AgentPreviewEndResponse>
Ends an interactive session with the agent.
Parameters
- sessionId: string
  A session ID provided by first calling start().
- reason: EndReason
  A reason why the interactive session was ended.
Returns Promise<AgentPreviewEndResponse>
AgentPreviewEndResponse
Implementation of AgentInteractionBase.end
- Defined in agentPreviewBase.ts:93

`Abstract`send

send(sessionId: string, message: string): Promise<AgentPreviewSendResponse>
Send a message to the agent using the session ID obtained by calling start().
Parameters
- sessionId: string
  A session ID provided by first calling start().
- message: string
  A message to send to the agent.
Returns Promise<AgentPreviewSendResponse>
AgentPreviewSendResponse
Implementation of AgentInteractionBase.send
- Defined in agentPreviewBase.ts:84

setApexDebugMode

setApexDebugMode(enable: boolean): void
Enable or disable Apex Debug Mode, which will enable trace flags for the Bot user and create apex debug logs for use within VS Code's Apex Replay Debugger.
Parameters
- enable: boolean
  Whether to enable or disable Apex Debug Mode.
Returns void
Implementation of AgentInteractionBase.setApexDebugMode
- Defined in agentPreviewBase.ts:66

`Abstract`start

start(): Promise<AgentPreviewStartResponse>
Start an interactive session with the agent. This is implemented by child classes to provide their specific start logic.

Returns Promise<AgentPreviewStartResponse>
Implementation of AgentInteractionBase.start
- Defined in agentPreviewBase.ts:75

`Abstract`traces

traces(sessionId: string, messageIds: string[]): Promise<PlannerResponse[]>
Get the traces for a given session and message IDs.
Parameters
- sessionId: string
  A session ID provided by first calling start().
- messageIds: string[]
  An array of message IDs to get the traces for.
Returns Promise<PlannerResponse[]>
PlannerResponse[]
- Defined in agentPreviewBase.ts:102