Method runAgent

packages/bot/src/thread.ts:287–313

(input?: {
    context?: ContextEntry[];
    tools?: BotTool[];
    /**
     * A user message to inject before running. Needed when the input isn't
     * already in the conversation history the adapter reconstructs — e.g. a
     * slash command, whose args are never posted to the channel. A
     * `AgentContentPart[]` carries multimodal content (e.g. inbound image/file
     * attachments) the model can read.
     */
    prompt?: string | AgentContentPart[];
    /**
     * Auto-bridge cross-platform transcripts for this run. When truthy AND the
     * thread has a resolved `userKey` AND a `Transcripts` instance, this:
     *   1. injects prior history (`transcripts.list`, default limit 20) as a
     *      context entry,
     *   2. appends the current user turn,
     *   3. runs the agent,
     *   4. captures the assistant reply and appends it.
     * This flag OWNS the bridge — callers using it should NOT also manually
     * append the same user/assistant turn via `bot.transcripts.append`.
     * No-ops with a one-time warning when identity/transcripts aren't configured.
     */
    transcript?: boolean | { limit?: number };
  })

  }

  async runAgent(input?: {
    context?: ContextEntry[];
    tools?: BotTool[];
    /**
     * A user message to inject before running. Needed when the input isn't
     * already in the conversation history the adapter reconstructs — e.g. a
     * slash command, whose args are never posted to the channel. A
     * `AgentContentPart[]` carries multimodal content (e.g. inbound image/file
     * attachments) the model can read.
     */
    prompt?: string | AgentContentPart[];
    /**
     * Auto-bridge cross-platform transcripts for this run. When truthy AND the
     * thread has a resolved `userKey` AND a `Transcripts` instance, this:
     *   1. injects prior history (`transcripts.list`, default limit 20) as a
     *      context entry,
     *   2. appends the current user turn,
     *   3. runs the agent,
     *   4. captures the assistant reply and appends it.
     * This flag OWNS the bridge — callers using it should NOT also manually
     * append the same user/assistant turn via `bot.transcripts.append`.
     * No-ops with a one-time warning when identity/transcripts aren't configured.
     */
    transcript?: boolean | { limit?: number };
  }): Promise<MessageRef | undefined> {
    return this.run(undefined, input);
  }

  async resume(value: unknown): Promise<MessageRef | undefined> {
    return this.run({ resume: value });