AxAgentContextMap

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/agent/contextMap.ts#L607

Constructors

Constructor

TypeScript

new AxAgentContextMap(input?: 
  | string
  | AxAgentContextMapSnapshot, options?: AxAgentContextMapOptions): AxAgentContextMap;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/agent/contextMap.ts#L615

Parameters

Parameter	Type
`input?`	\| `string` \| `AxAgentContextMapSnapshot`
`options?`	`AxAgentContextMapOptions`

Returns

AxAgentContextMap

Properties

Property	Modifier	Type
`text`	`public`	`string`

Methods

applyUpdatePayload()

TypeScript

applyUpdatePayload(payload: ContextMapUpdaterOutput): AxAgentContextMapUpdateResult;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/agent/contextMap.ts#L688

Parameters

Parameter	Type
`payload`	`ContextMapUpdaterOutput`

Returns

AxAgentContextMapUpdateResult

snapshot()

TypeScript

snapshot(): AxAgentContextMapSnapshot;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/agent/contextMap.ts#L650

Returns

AxAgentContextMapSnapshot

tag()

TypeScript

tag(itemId: string, tag: string): boolean;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/agent/contextMap.ts#L665

Parameters

Parameter	Type
`itemId`	`string`
`tag`	`string`

Returns

boolean

update()

TypeScript

update(ai: Readonly<AxAIService>, args: Readonly<{
  options?: Readonly<Omit<AxProgramForwardOptions<string>, "functions">>;
  task: string;
  trajectory: string;
}>): Promise<AxAgentContextMapUpdateResult>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/agent/contextMap.ts#L713

Parameters

Parameter	Type
`ai`	`Readonly`<`AxAIService`>
`args`	`Readonly`<{ `options?`: `Readonly`<`Omit`<`AxProgramForwardOptions`<`string`>, `"functions"`>>; `task`: `string`; `trajectory`: `string`; }>

Returns

Promise<AxAgentContextMapUpdateResult>

fromSnapshot()

TypeScript

static fromSnapshot(snapshot: AxAgentContextMapSnapshot, options?: AxAgentContextMapOptions): AxAgentContextMap;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/agent/contextMap.ts#L636

Parameters

Parameter	Type
`snapshot`	`AxAgentContextMapSnapshot`
`options?`	`AxAgentContextMapOptions`

Returns

AxAgentContextMap

fromText()

TypeScript

static fromText(text: string, options?: AxAgentContextMapOptions): AxAgentContextMap;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/agent/contextMap.ts#L643

Parameters

Parameter	Type
`text`	`string`
`options?`	`AxAgentContextMapOptions`

Returns

AxAgentContextMap