Class ProductionAgent

constructor

• new ProductionAgent(options: ProductionAgentOptions): ProductionAgent

  Parameters

  • options: ProductionAgentOptions

  Returns ProductionAgent

preview

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

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

getAgentIdForStorage

• getAgentIdForStorage(): string

  Get the agent ID to use for storage/transcript purposes

  Returns string

getBotMetadata

• getBotMetadata(): Promise<BotMetadata>

  Returns Promise<BotMetadata>

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>

getHistoryFromDisc

• getHistoryFromDisc(
      sessionId?: string,
  ): Promise<
      {
          metadata: PreviewMetadata
          | null;
          traces: PlannerResponse[];
          transcript: TranscriptEntry[];
      },
  >

  Parameters

  • OptionalsessionId: string

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

getId

• getId(): Promise<string>

  Returns the ID for this agent.

  Returns Promise<string>

  The ID of the agent (The Bot ID).

getLatestBotVersionMetadata

• getLatestBotVersionMetadata(): Promise<BotVersionMetadata>

  Returns the latest bot version metadata.

  Returns Promise<BotVersionMetadata>

  the latest bot version metadata

getTrace

• getTrace(planId: string): Promise<PlannerResponse | undefined>

  Parameters

  • planId: string

  Returns Promise<PlannerResponse | undefined>