Class ProductionAgent

Abstract base class for agent preview functionality. Contains shared properties and methods between ScriptAgent and ProductionAgent.

Hierarchy (View Summary)

AgentBase
- ProductionAgent

Index

Constructors

constructor

new ProductionAgent(options: ProductionAgentOptions): ProductionAgent
Parameters
- options: ProductionAgentOptions
Returns ProductionAgent
Overrides AgentBase.constructor
- Defined in agents/productionAgent.ts:55

Properties

name

name: string | undefined

The display name of the agent (user-friendly name, not API name)

preview

preview: AgentPreviewInterface

Methods

activate

activate(version?: number): Promise<BotVersionMetadata>
Activates the agent.
Parameters
- Optionalversion: number
  The VersionNumber to activate (e.g., 0, 1, 2, 31), or undefined for latest
Returns Promise<BotVersionMetadata>
The activated bot version metadata
- Defined in agents/productionAgent.ts:176

deactivate

deactivate(): Promise<BotVersionMetadata>
Deactivates the currently active agent version. Only one version can be active at a time, so this automatically finds and deactivates it.

Returns Promise<BotVersionMetadata>
The deactivated bot version metadata
- Defined in agents/productionAgent.ts:186

getAgentIdForStorage

getAgentIdForStorage(): string
Get the agent ID to use for storage/transcript purposes

Returns string
Overrides AgentBase.getAgentIdForStorage
- Defined in agents/productionAgent.ts:197

getBotMetadata

getBotMetadata(): Promise<BotMetadata>
Returns Promise<BotMetadata>
- Defined in agents/productionAgent.ts:78

getBotVersionMetadata

getBotVersionMetadata(version?: number): Promise<BotVersionMetadata>
Gets a bot version by its version number, or latest if omitted. Searches for a version with matching VersionNumber property.
Parameters
- Optionalversion: number
  The VersionNumber to find (e.g., 0, 1, 2, 31), or undefined for latest
Returns Promise<BotVersionMetadata>
- Defined in agents/productionAgent.ts:120

getHistoryDir

getHistoryDir(): Promise<string>
Returns Promise<string>
Inherited from AgentBase.getHistoryDir
- Defined in agents/agentBase.ts:67

getHistoryFromDisc

getHistoryFromDisc(
    sessionId?: string,
): Promise<
    {
        metadata: PreviewMetadata
        | null;
        traces: PlannerResponse[];
        transcript: TranscriptEntry[];
    },
>
Parameters
- OptionalsessionId: string
Returns Promise<
    {
        metadata: PreviewMetadata
        | null;
        traces: PlannerResponse[];
        transcript: TranscriptEntry[];
    },
>
Overrides AgentBase.getHistoryFromDisc
- Defined in agents/productionAgent.ts:149

getId

getId(): Promise<string>
Returns the ID for this agent.

Returns Promise<string>
The ID of the agent (The Bot ID).
- Defined in agents/productionAgent.ts:164

getLatestBotVersionMetadata

getLatestBotVersionMetadata(): Promise<BotVersionMetadata>
Returns the latest bot version metadata.

Returns Promise<BotVersionMetadata>
the latest bot version metadata
- Defined in agents/productionAgent.ts:102

getTrace

getTrace(planId: string): Promise<PlannerResponse | undefined>
Parameters
- planId: string
Returns Promise<PlannerResponse | undefined>
Overrides AgentBase.getTrace
- Defined in agents/productionAgent.ts:145

restoreConnection

restoreConnection(): Promise<void>
Refreshes the access token on the standard connection.

Retained for backward compatibility. The caller's original Connection is never mutated by agent operations, so this only refreshes the internal standard connection owned by the ConnectionManager.

Returns Promise<void>
Inherited from AgentBase.restoreConnection
- Defined in agents/agentBase.ts:58

resumeSession

resumeSession(sessionId: string): Promise<void>
Resume an existing session by loading session state from disk
Parameters
- sessionId: string
  The session ID to resume
Returns Promise<void>
Inherited from AgentBase.resumeSession
- Defined in agents/agentBase.ts:79

setSessionId

setSessionId(sessionId: string): void
Parameters
- sessionId: string
Returns void
Inherited from AgentBase.setSessionId
- Defined in agents/agentBase.ts:63

Class ProductionAgent

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ProductionAgent

Properties

name

preview

Methods

activate

Parameters

Returns Promise<BotVersionMetadata>

deactivate

Returns Promise<BotVersionMetadata>

getAgentIdForStorage

Returns string

getBotMetadata

Returns Promise<BotMetadata>

getBotVersionMetadata

Parameters

Returns Promise<BotVersionMetadata>

getHistoryDir

Returns Promise<string>

getHistoryFromDisc

Parameters

Returns Promise< { metadata: PreviewMetadata | null; traces: PlannerResponse[]; transcript: TranscriptEntry[]; },>

getId

Returns Promise<string>

getLatestBotVersionMetadata

Returns Promise<BotVersionMetadata>

getTrace

Parameters

Returns Promise<PlannerResponse | undefined>

restoreConnection

Returns Promise<void>

resumeSession

Parameters

Returns Promise<void>

setSessionId

Parameters

Returns void

Settings

On This Page

Returns Promise<
{
metadata: PreviewMetadata
| null;
traces: PlannerResponse[];
transcript: TranscriptEntry[];
},
>