Skip to main content

Type Alias: GatewayInferenceCreateChatCompletionStreamResponse

type GatewayInferenceCreateChatCompletionStreamResponse = {
[key: string]: unknown;
  id: string;
  choices: {
   [key: string]: unknown;
     delta: GatewayInferenceChatCompletionStreamResponseDelta;
     logprobs?:   | {
      [key: string]: unknown;
        content:   | GatewayInferenceChatCompletionTokenLogprob[]
           | null;
      }
        | null;
     finish_reason:   | "stop" | "length" | "tool_calls" | "content_filter" | "function_call"
        | null;
     index: number;
  }[];
  created: number;
  model: string;
  system_fingerprint?: string | null;
  object: "chat.completion.chunk";
  usage?:   | {
   [key: string]: unknown;
     completion_tokens: number;
     prompt_tokens: number;
     total_tokens: number;
   }
     | null;
};

Defined in: src/models/ai-gateway-inference.ts:1055

Portkey CreateChatCompletionStreamResponse; additive response fields are preserved.

Example​

`GatewayInferenceCreateChatCompletionStreamResponseSchema.parse(value);`

Indexable​

[key: string]: unknown

Properties​

id​

id: string;

Defined in: src/models/ai-gateway-inference.ts:1056

choices​

choices: {
[key: string]: unknown;
  delta: GatewayInferenceChatCompletionStreamResponseDelta;
  logprobs?:   | {
   [key: string]: unknown;
     content:   | GatewayInferenceChatCompletionTokenLogprob[]
        | null;
   }
     | null;
  finish_reason:   | "stop" | "length" | "tool_calls" | "content_filter" | "function_call"
     | null;
  index: number;
}[];

Defined in: src/models/ai-gateway-inference.ts:1057

Index Signature​

[key: string]: unknown

delta​

delta: GatewayInferenceChatCompletionStreamResponseDelta;

logprobs?​

optional logprobs?: 
  | {
[key: string]: unknown;
  content:   | GatewayInferenceChatCompletionTokenLogprob[]
     | null;
}
  | null;

finish_reason​

finish_reason: 
  | "stop" | "length" | "tool_calls" | "content_filter" | "function_call"
  | null;

index​

index: number;

created​

created: number;

Defined in: src/models/ai-gateway-inference.ts:1067

model​

model: string;

Defined in: src/models/ai-gateway-inference.ts:1068

system_fingerprint?​

optional system_fingerprint?: string | null;

Defined in: src/models/ai-gateway-inference.ts:1069

object​

object: "chat.completion.chunk";

Defined in: src/models/ai-gateway-inference.ts:1070

usage?​

optional usage?: 
  | {
[key: string]: unknown;
  completion_tokens: number;
  prompt_tokens: number;
  total_tokens: number;
}
  | null;

Defined in: src/models/ai-gateway-inference.ts:1071