Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/openai/resources/chat/mod.ts>ChatCompletionChunk

Deno build of the official Typescript library for the OpenAI API.
openai/openai-deno-build
Extremely Popular
Latest
namespace ChatCompletionChunk
import { ChatCompletionChunk } from "https://deno.land/x/openai@v4.69.0/resources/chat/mod.ts";
interface ChatCompletionChunk
import { type ChatCompletionChunk } from "https://deno.land/x/openai@v4.69.0/resources/chat/mod.ts";

Represents a streamed chunk of a chat completion response returned by model, based on the provided input.

Properties

id: string

A unique identifier for the chat completion. Each chunk has the same ID.

choices: Array<ChatCompletionChunk.Choice>

A list of chat completion choices. Can contain more than one elements if n is greater than 1. Can also be empty for the last chunk if you set stream_options: {"include_usage": true}.

created: number

The Unix timestamp (in seconds) of when the chat completion was created. Each chunk has the same timestamp.

model: string

The model to generate the completion.

object: "chat.completion.chunk"

The object type, which is always chat.completion.chunk.

optional
service_tier: "scale" | "default" | null

The service tier used for processing the request. This field is only included if the service_tier parameter is specified in the request.

optional
system_fingerprint: string

This fingerprint represents the backend configuration that the model runs with. Can be used in conjunction with the seed request parameter to understand when backend changes have been made that might impact determinism.

optional
usage: CompletionsAPI.CompletionUsage | null

An optional field that will only be present when you set stream_options: {"include_usage": true} in your request. When present, it contains a null value except for the last chunk which contains the token usage statistics for the entire request.