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/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/ai/openai/chat_types.ts#L325

Properties

choices

TypeScript
choices: object[];

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/ai/openai/chat_types.ts#L332

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/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/ai/openai/chat_types.ts#L328


error?

TypeScript
optional error: object;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/ai/openai/chat_types.ts#L356

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/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/ai/openai/chat_types.ts#L326


model

TypeScript
model: string;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/ai/openai/chat_types.ts#L329


object

TypeScript
object: "chat.completion";

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/ai/openai/chat_types.ts#L327


service_tier?

TypeScript
optional service_tier: string;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/ai/openai/chat_types.ts#L330


service_tier_used?

TypeScript
optional service_tier_used: string;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/ai/openai/chat_types.ts#L331


system_fingerprint

TypeScript
system_fingerprint: string;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/ai/openai/chat_types.ts#L362


usage?

TypeScript
optional usage: AxAIOpenAIUsage;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/ai/openai/chat_types.ts#L355

Docs