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

AxChatResponseResult

TypeScript
type AxChatResponseResult = object;

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

Properties

audio?

TypeScript
optional audio: AxChatAudioOutput;

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


audioProcessedMs?

TypeScript
optional audioProcessedMs: number;

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

Latest provider-reported amount of realtime audio processed.


citations?

TypeScript
optional citations: AxCitation[];

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


content?

TypeScript
optional content: string;

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


decisionContext?

TypeScript
optional decisionContext: AxDecisionContext;

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

Trusted decision adapter evidence, never model-authored JSON.


finishReason?

TypeScript
optional finishReason: "stop" | "length" | "function_call" | "content_filter" | "error";

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


functionCalls?

TypeScript
optional functionCalls: object[];

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

function

TypeScript
{
  name: string;
  params?: string | object;
}

id

TypeScript
id: string;

type

TypeScript
type: "function";

id?

TypeScript
optional id: string;

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


images?

TypeScript
optional images: AxChatImageOutput[];

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


index

TypeScript
index: number;

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


logprobs?

TypeScript
optional logprobs: object;

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

content?

TypeScript
optional content: object[];

name?

TypeScript
optional name: string;

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


phase?

TypeScript
optional phase: "commentary" | "final_answer";

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

Responses-style output phase for commentary/final-answer ordering.


thought?

TypeScript
optional thought: string;

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


thoughtBlocks?

TypeScript
optional thoughtBlocks: AxThoughtBlockItem[];

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

Array of thinking blocks, each with its own signature


transcript?

TypeScript
optional transcript: object;

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

Replace the previous snapshot for this result id; content contains only finalized speech.

isFinal

TypeScript
isFinal: boolean;

text

TypeScript
text: string;
Docs