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

AxChatLogEntry

TypeScript
type AxChatLogEntry = object;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/types.ts#L456

A single chat round-trip entry: the full prompt sent to the model and its response, with normalized roles and inline XML formatting.

Properties

messages

TypeScript
messages: AxChatLogMessage[];

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/types.ts#L460


model

TypeScript
model: string;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/types.ts#L459


modelUsage?

TypeScript
optional modelUsage: AxChatResponse["modelUsage"];

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/types.ts#L471


name?

TypeScript
optional name: string;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/types.ts#L458

Optional composite-program label for the program/node that produced this chat round trip.


providerMetadata?

TypeScript
optional providerMetadata: AxChatResponse["providerMetadata"];

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/types.ts#L470

Provider-specific metadata that should flow through adapters.


remoteId?

TypeScript
optional remoteId: AxChatResponse["remoteId"];

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/types.ts#L464

Provider response/message/completion identifier.


remoteRequestId?

TypeScript
optional remoteRequestId: AxChatResponse["remoteRequestId"];

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/types.ts#L466

Provider request identifier, usually from response headers.


remoteSessionId?

TypeScript
optional remoteSessionId: AxChatResponse["remoteSessionId"];

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/types.ts#L468

Provider conversation/session identifier when distinct from Ax’s local sessionId.


sessionId?

TypeScript
optional sessionId: AxChatResponse["sessionId"];

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/types.ts#L462

Ax-local session identifier used for conversation tracking and memory isolation.


stage?

TypeScript
optional stage: "ctx" | "task";

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/types.ts#L473

Set by the AxAgent coordinator when running a two-stage ctx+task flow.

Docs