AxResolvedCitations Generated TypeScript API reference. typescript api api/reference build/apidocs/TypeAlias.AxResolvedCitations.md type AxResolvedCitations

AxResolvedCitations

TypeScript
type AxResolvedCitations = object;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/agent/config.ts#L261

Properties

enabled

TypeScript
enabled: boolean;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/agent/config.ts#L262


field

TypeScript
field: string;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/agent/config.ts#L263


includeMemoryIds

TypeScript
includeMemoryIds: boolean;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/agent/config.ts#L265


onCitations()?

TypeScript
optional onCitations: (citations: readonly string[]) => void | Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/agent/config.ts#L266

Parameters

ParameterType
citationsreadonly string[]

Returns

void | Promise<void>


surface

TypeScript
surface: "output" | "hidden";

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/agent/config.ts#L264

Docs