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/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/types.ts#L533

Properties

modelUsage?

TypeScript
optional modelUsage: AxModelUsage;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/types.ts#L545


providerMetadata?

TypeScript
optional providerMetadata: AxProviderMetadata;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/types.ts#L543

Provider-specific metadata that should flow through adapters.


remoteId?

TypeScript
optional remoteId: string;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/types.ts#L537

Provider response/message/completion identifier.


remoteRequestId?

TypeScript
optional remoteRequestId: string;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/types.ts#L539

Provider request identifier, usually from response headers.


remoteSessionId?

TypeScript
optional remoteSessionId: string;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/types.ts#L541

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/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/types.ts#L544


sessionId?

TypeScript
optional sessionId: string;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/types.ts#L535

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

Docs