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

AxChatResponse

TypeScript
type AxChatResponse = object;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/types.ts#L378

Properties

modelUsage?

TypeScript
optional modelUsage: AxModelUsage;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/types.ts#L390


providerMetadata?

TypeScript
optional providerMetadata: AxProviderMetadata;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/types.ts#L388

Provider-specific metadata that should flow through adapters.


remoteId?

TypeScript
optional remoteId: string;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/types.ts#L382

Provider response/message/completion identifier.


remoteRequestId?

TypeScript
optional remoteRequestId: string;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/types.ts#L384

Provider request identifier, usually from response headers.


remoteSessionId?

TypeScript
optional remoteSessionId: string;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/types.ts#L386

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


results

TypeScript
results: readonly AxChatResponseResult[];

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/types.ts#L389


sessionId?

TypeScript
optional sessionId: string;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/types.ts#L380

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

Docs