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

AxAIOpenAIChatResponse

TypeScript
type AxAIOpenAIChatResponse = object;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/openai/chat_types.ts#L256

Properties

choices

TypeScript
choices: object[];

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/openai/chat_types.ts#L261

finish_reason

TypeScript
finish_reason: "stop" | "length" | "content_filter" | "tool_calls";

index

TypeScript
index: number;

message

TypeScript
{
  annotations?: AxAIOpenAIAnnotation[];
  audio?:   | {
     data?: string;
     expires_at?: number;
     id: string;
     transcript?: string;
   }
     | null;
  content: string | null;
  reasoning_content?: string;
  refusal: string | null;
  role: string;
  tool_calls?: object[];
}

created

TypeScript
created: number;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/openai/chat_types.ts#L259


error?

TypeScript
optional error: object;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/openai/chat_types.ts#L285

code

TypeScript
code: number;

message

TypeScript
message: string;

param

TypeScript
param: string;

type

TypeScript
type: string;

id

TypeScript
id: string;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/openai/chat_types.ts#L257


model

TypeScript
model: string;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/openai/chat_types.ts#L260


object

TypeScript
object: "chat.completion";

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/openai/chat_types.ts#L258


system_fingerprint

TypeScript
system_fingerprint: string;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/openai/chat_types.ts#L291


usage?

TypeScript
optional usage: AxAIOpenAIUsage;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/openai/chat_types.ts#L284

Docs