Class Intelligence

constructor

• new Intelligence(options: IntelligenceOptions): Intelligence

  Parameters

  • options: IntelligenceOptions

  Returns Intelligence

Optionalcheckpointer

maxSteps

Optionalmemory

model

OptionalonEvent

OptionalonRunEvent

OptionalonToolApproval

provider

system

tools

usage

ask

• ask(prompt: string | Message, options?: AskOptions): Promise<AskResult>

  Sends a prompt through the agent loop and returns the final result.

  Parameters

  • prompt: string | Message
  • options: AskOptions = {}

  Returns Promise<AskResult>

embed

• embed(input: string[]): Promise<number[][]>

  Generates embeddings for the given input strings, if the provider supports it.

  Parameters

  • input: string[]

  Returns Promise<number[][]>

image

• image(prompt: string): Promise<{ data?: string; url?: string }>

  Generates an image from a prompt, if the provider supports it.

  Parameters

  • prompt: string

  Returns Promise<{ data?: string; url?: string }>

object

• object<T>(schema: StandardSchemaV1<T, T>, prompt: string | Message): Promise<T>

  Forces a structured response via a synthetic tool call matching schema, returning its parsed input. Avoids per-provider JSON-mode plumbing.

  Type Parameters

  • T

  Parameters

  • schema: StandardSchemaV1<T, T>
  • prompt: string | Message

  Returns Promise<T>

stream

• stream(
      prompt: string | Message,
      options?: AskOptions,
  ): AsyncIterable<StreamEvent>

  Sends a prompt through the agent loop, streaming events as they occur.

  Parameters

  • prompt: string | Message
  • options: AskOptions = {}

  Returns AsyncIterable<StreamEvent>