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

x/openai/resources/chat/mod.ts

Deno build of the official Typescript library for the OpenAI API.
Extremely Popular
Latest
import * as openai from "https://deno.land/x/openai@v4.69.0/resources/chat/mod.ts";

Interfaces

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

Log probability information for the choice.

Data about a previous audio response from the model. Learn more.

If the audio output modality is requested, this object contains data about the audio response from the model. Learn more.

Parameters for audio output. Required when audio output is requested with modalities: ["audio"]. Learn more.

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

A chat completion delta generated by streamed model responses.

Log probability information for the choice.

Learn about image inputs.

Learn about audio inputs.

Learn about text inputs.

Specifying a particular function via {"name": "my_function"} forces the model to call that function.

A chat completion message generated by the model.

The function that the model called.

Specifies a tool the model should use. Use to force the model to call a specific function.

Options for streaming response. Only set this when you set stream: true.

Type Aliases

Learn about text inputs.

The role of the author of a message

Controls which (if any) tool is called by the model. none means the model will not call any tool and instead generates a message. auto means the model can pick between generating a message or calling one or more tools. required means the model must call one or more tools. Specifying a particular tool via {"type": "function", "function": {"name": "my_function"}} forces the model to call that tool.