Class Agent

Readonlymodel

Readonlyname

Readonlyprovider

cloneWithSystem

• cloneWithSystem(system: string, name?: string): Agent

  Parameters

  • system: string
  • Optionalname: string

  Returns Agent

dispose

• dispose(): Promise<void>

  Returns Promise<void>

estimateCost

• estimateCost(
      params: Pick<
          AgentRunParams,
          "prompt"
          | "system"
          | "maxTokens"
          | "tools"
          | "budget",
      >,
  ): CostEstimate

  Parameters

  • params: Pick<AgentRunParams, "prompt" | "system" | "maxTokens" | "tools" | "budget">

  Returns CostEstimate

getAttachedAdapters

• getAttachedAdapters(): readonly AgentAdapter[]

  Returns readonly AgentAdapter[]

getCapabilities

• getCapabilities(): ModelCapabilities

  Returns ModelCapabilities

markAdaptersExternallyManaged

• markAdaptersExternallyManaged(adapters: readonly AgentAdapter[]): void

  Parameters

  • adapters: readonly AgentAdapter[]

  Returns void

mergeToolPolicy

• mergeToolPolicy(policy: ToolPolicy | undefined): void

  Parameters

  • policy: ToolPolicy | undefined

  Returns void

run

• run(params: AgentRunParams): Promise<AgentResponse>

  Parameters

  • params: AgentRunParams

  Returns Promise<AgentResponse>

setCache

• setCache(cache: AgentCacheController | undefined): void

  Parameters

  • cache: AgentCacheController | undefined

  Returns void

setEventEmitter

• setEventEmitter(events: AgentEventEmitter | undefined): void

  Parameters

  • events: AgentEventEmitter | undefined

  Returns void

setToolPolicy

• setToolPolicy(policy: ToolPolicy | undefined): void

  Parameters

  • policy: ToolPolicy | undefined

  Returns void

stream

• stream(params: AgentRunParams): AsyncGenerator<StreamChunk>

  Parameters

  • params: AgentRunParams

  Returns AsyncGenerator<StreamChunk>

use

• use(adapter: CreatorPack | AgentAdapter): this

  Parameters

  • adapter: CreatorPack | AgentAdapter

  Returns this

Staticcatalog

• catalog(filter?: CatalogFilter): ModelInfo[]

  Parameters

  • Optionalfilter: CatalogFilter

  Returns ModelInfo[]

Staticcreate

• create(config: AgentCreateConfig): Agent

  Parameters

  • config: AgentCreateConfig

  Returns Agent

StaticestimateCost

• estimateCost(
      model: string,
      params: Pick<
          AgentRunParams,
          "prompt"
          | "system"
          | "maxTokens"
          | "tools"
          | "budget",
      >,
  ): CostEstimate

  Parameters

  • model: string
  • params: Pick<AgentRunParams, "prompt" | "system" | "maxTokens" | "tools" | "budget">

  Returns CostEstimate

Staticinspect

• inspect(model: string): ModelInfo

  Parameters

  • model: string

  Returns ModelInfo

Staticsupports

• supports(
      model: string,
      capability:
          | "audio"
          | "tools"
          | "streaming"
          | "video"
          | "files"
          | "contextWindow"
          | "vision"
          | "maxOutput"
          | "jsonMode",
  ): boolean

  Parameters

  • model: string
  • capability:
        | "audio"
        | "tools"
        | "streaming"
        | "video"
        | "files"
        | "contextWindow"
        | "vision"
        | "maxOutput"
        | "jsonMode"

  Returns boolean