Documentation

Build LLM-powered agents
with production-ready TypeScript

DSPy for TypeScript. Working with LLMs is complex—they don't always do what you want. DSPy makes it easier to build amazing things with LLMs. Just define your inputs and outputs (signature) and an efficient prompt is auto-generated and used. Connect together various signatures to build complex systems and workflows using LLMs.

15+ LLM Providers
End-to-end Streaming
Auto Prompt Tuning

AxMemory

Defined in: https://github.com/ax-llm/ax/blob/a8847bd2906efff202fde10d776fddd20fd2ff57/src/ax/mem/memory.ts#L258

Implements

Constructors

Constructor

new AxMemory(): AxMemory;

Defined in: https://github.com/ax-llm/ax/blob/a8847bd2906efff202fde10d776fddd20fd2ff57/src/ax/mem/memory.ts#L262

Returns

AxMemory

Methods

addFunctionResults()

addFunctionResults(results: readonly AxFunctionResult[], sessionId?: string): void;

Defined in: https://github.com/ax-llm/ax/blob/a8847bd2906efff202fde10d776fddd20fd2ff57/src/ax/mem/memory.ts#L293

Parameters

ParameterType
resultsreadonly AxFunctionResult[]
sessionId?string

Returns

void

Implementation of

AxAIMemory.addFunctionResults


addRequest()

addRequest(value: (
  | {
  cache?: boolean;
  content: string;
  role: "system";
}
  | {
  cache?: boolean;
  content:   | string
     | (
     | {
     cache?: boolean;
     text: string;
     type: "text";
   }
     | {
     altText?: string;
     cache?: boolean;
     details?: "high" | "low" | "auto";
     image: string;
     mimeType: string;
     optimize?: "auto" | "quality" | "size";
     type: "image";
   }
     | {
     cache?: boolean;
     data: string;
     duration?: number;
     format?: "wav" | "mp3" | "ogg";
     transcription?: string;
     type: "audio";
   }
     | {
     cache?: boolean;
     data: string;
     extractedText?: string;
     filename?: string;
     mimeType: string;
     type: "file";
   }
     | {
     cache?: boolean;
     extractedText?: string;
     filename?: string;
     fileUri: string;
     mimeType: string;
     type: "file";
   }
     | {
     cache?: boolean;
     cachedContent?: string;
     description?: string;
     title?: string;
     type: "url";
     url: string;
   })[];
  name?: string;
  role: "user";
}
  | {
  cache?: boolean;
  content?: string;
  functionCalls?: object[];
  name?: string;
  role: "assistant";
  thought?: string;
  thoughtBlocks?: AxThoughtBlockItem[];
}
  | {
  cache?: boolean;
  functionId: string;
  isError?: boolean;
  result: string;
  role: "function";
})[], sessionId?: string): void;

Defined in: https://github.com/ax-llm/ax/blob/a8847bd2906efff202fde10d776fddd20fd2ff57/src/ax/mem/memory.ts#L278

Parameters

ParameterType
value( | { cache?: boolean; content: string; role: "system"; } | { cache?: boolean; content: | string | ( | { cache?: boolean; text: string; type: "text"; } | { altText?: string; cache?: boolean; details?: "high" | "low" | "auto"; image: string; mimeType: string; optimize?: "auto" | "quality" | "size"; type: "image"; } | { cache?: boolean; data: string; duration?: number; format?: "wav" | "mp3" | "ogg"; transcription?: string; type: "audio"; } | { cache?: boolean; data: string; extractedText?: string; filename?: string; mimeType: string; type: "file"; } | { cache?: boolean; extractedText?: string; filename?: string; fileUri: string; mimeType: string; type: "file"; } | { cache?: boolean; cachedContent?: string; description?: string; title?: string; type: "url"; url: string; })[]; name?: string; role: "user"; } | { cache?: boolean; content?: string; functionCalls?: object[]; name?: string; role: "assistant"; thought?: string; thoughtBlocks?: AxThoughtBlockItem[]; } | { cache?: boolean; functionId: string; isError?: boolean; result: string; role: "function"; })[]
sessionId?string

Returns

void

Implementation of

AxAIMemory.addRequest


addResponse()

addResponse(results: readonly AxChatResponseResult[], sessionId?: string): void;

Defined in: https://github.com/ax-llm/ax/blob/a8847bd2906efff202fde10d776fddd20fd2ff57/src/ax/mem/memory.ts#L285

Parameters

ParameterType
resultsreadonly AxChatResponseResult[]
sessionId?string

Returns

void

Implementation of

AxAIMemory.addResponse


addTag()

addTag(name: string, sessionId?: string): void;

Defined in: https://github.com/ax-llm/ax/blob/a8847bd2906efff202fde10d776fddd20fd2ff57/src/ax/mem/memory.ts#L307

Parameters

ParameterType
namestring
sessionId?string

Returns

void

Implementation of

AxAIMemory.addTag


getLast()

getLast(sessionId?: string): 
  | undefined
  | {
  chat: object[];
  role: "function" | "system" | "user" | "assistant";
  tags?: string[];
  updatable?: boolean;
};

Defined in: https://github.com/ax-llm/ax/blob/a8847bd2906efff202fde10d776fddd20fd2ff57/src/ax/mem/memory.ts#L323

Parameters

ParameterType
sessionId?string

Returns

| undefined | { chat: object[]; role: "function" | "system" | "user" | "assistant"; tags?: string[]; updatable?: boolean; }

Implementation of

AxAIMemory.getLast


history()

history(index: number, sessionId?: string): (
  | {
  cache?: boolean;
  content: string;
  role: "system";
}
  | {
  cache?: boolean;
  content:   | string
     | (
     | {
     cache?: boolean;
     text: string;
     type: "text";
   }
     | {
     altText?: string;
     cache?: boolean;
     details?: "high" | "low" | "auto";
     image: string;
     mimeType: string;
     optimize?: "auto" | "quality" | "size";
     type: "image";
   }
     | {
     cache?: boolean;
     data: string;
     duration?: number;
     format?: "wav" | "mp3" | "ogg";
     transcription?: string;
     type: "audio";
   }
     | {
     cache?: boolean;
     data: string;
     extractedText?: string;
     filename?: string;
     mimeType: string;
     type: "file";
   }
     | {
     cache?: boolean;
     extractedText?: string;
     filename?: string;
     fileUri: string;
     mimeType: string;
     type: "file";
   }
     | {
     cache?: boolean;
     cachedContent?: string;
     description?: string;
     title?: string;
     type: "url";
     url: string;
   })[];
  name?: string;
  role: "user";
}
  | {
  cache?: boolean;
  content?: string;
  functionCalls?: object[];
  name?: string;
  role: "assistant";
  thought?: string;
  thoughtBlocks?: AxThoughtBlockItem[];
}
  | {
  cache?: boolean;
  functionId: string;
  isError?: boolean;
  result: string;
  role: "function";
})[];

Defined in: https://github.com/ax-llm/ax/blob/a8847bd2906efff202fde10d776fddd20fd2ff57/src/ax/mem/memory.ts#L319

Parameters

ParameterType
indexnumber
sessionId?string

Returns

Implementation of

AxAIMemory.history


removeByTag()

removeByTag(name: string, sessionId?: string): AxMemoryData;

Defined in: https://github.com/ax-llm/ax/blob/a8847bd2906efff202fde10d776fddd20fd2ff57/src/ax/mem/memory.ts#L315

Parameters

ParameterType
namestring
sessionId?string

Returns

AxMemoryData

Implementation of

AxAIMemory.removeByTag


reset()

reset(sessionId?: string): void;

Defined in: https://github.com/ax-llm/ax/blob/a8847bd2906efff202fde10d776fddd20fd2ff57/src/ax/mem/memory.ts#L327

Parameters

ParameterType
sessionId?string

Returns

void

Implementation of

AxAIMemory.reset


rewindToTag()

rewindToTag(name: string, sessionId?: string): AxMemoryData;

Defined in: https://github.com/ax-llm/ax/blob/a8847bd2906efff202fde10d776fddd20fd2ff57/src/ax/mem/memory.ts#L311

Parameters

ParameterType
namestring
sessionId?string

Returns

AxMemoryData

Implementation of

AxAIMemory.rewindToTag


updateResult()

updateResult(result: Readonly<AxChatResponseResult & object>, sessionId?: string): void;

Defined in: https://github.com/ax-llm/ax/blob/a8847bd2906efff202fde10d776fddd20fd2ff57/src/ax/mem/memory.ts#L300

Parameters

ParameterType
resultReadonly<AxChatResponseResult & object>
sessionId?string

Returns

void

Implementation of

AxAIMemory.updateResult