AxChatResponseResult

TypeScript

type AxChatResponseResult = object;

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

Properties

audio?

TypeScript

optional audio: AxChatAudioOutput;

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

audioProcessedMs?

TypeScript

optional audioProcessedMs: number;

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

Latest provider-reported amount of realtime audio processed.

citations?

TypeScript

optional citations: AxCitation[];

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

content?

TypeScript

optional content: string;

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

finishReason?

TypeScript

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

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

functionCalls?

TypeScript

optional functionCalls: object[];

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

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

images?

TypeScript

optional images: AxChatImageOutput[];

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

index

TypeScript

index: number;

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

logprobs?

TypeScript

optional logprobs: object;

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

content?

TypeScript

optional content: object[];

name?

TypeScript

optional name: string;

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

phase?

TypeScript

optional phase: "commentary" | "final_answer";

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

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

thought?

TypeScript

optional thought: string;

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

thoughtBlocks?

TypeScript

optional thoughtBlocks: AxThoughtBlockItem[];

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

Array of thinking blocks, each with its own signature

transcript?

TypeScript

optional transcript: object;

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

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

isFinal

TypeScript

isFinal: boolean;

text

TypeScript

text: string;