Class ProductionAgent

constructor

• new ProductionAgent(options: ProductionAgentOptions): ProductionAgent

  Parameters

  • options: ProductionAgentOptions

  Returns ProductionAgent

preview

activate

• activate(): Promise<void>

  Activates the agent.

  Returns Promise<void>

  void

deactivate

• deactivate(): Promise<void>

  Deactivates the agent.

  Returns Promise<void>

  void

getAgentIdForStorage

• getAgentIdForStorage(): string

  Get the agent ID to use for storage/transcript purposes

  Returns string

getBotMetadata

• getBotMetadata(): Promise<BotMetadata>

  Returns Promise<BotMetadata>

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>