Class Agent

constructor

• new Agent(config: AgentConfig): Agent

  Parameters

  • config: AgentConfig

  Returns Agent

Readonlyname

Readonlytools

asTool

• asTool(options?: { description?: string; name?: string }): Tool

  This agent as a tool for another agent: one input string in, the answer text out. A supervisor lists sub-agents here and the model picks.

  Parameters

  • options: { description?: string; name?: string } = {}

  Returns Tool

request

• request(input: AgentInput, overrides?: Partial<AIRequest>): AIRequest

  The request run sends: this agent's defaults, the input, then overrides.

  Parameters

  • input: AgentInput
  • overrides: Partial<AIRequest> = {}

  Returns AIRequest

run

• run(input: AgentInput, overrides?: Partial<AIRequest>): Promise<AgentResult>

  Parameters

  • input: AgentInput
  • overrides: Partial<AIRequest> = {}

  Returns Promise<AgentResult>

stream

• stream(
      input: AgentInput,
      overrides?: Partial<AIRequest>,
  ): AsyncGenerator<AIStreamChunk, void, void>

  Parameters

  • input: AgentInput
  • overrides: Partial<AIRequest> = {}

  Returns AsyncGenerator<AIStreamChunk, void, void>