Skip to main content
Module

x/openai/resources/chat/completions.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.47.3/resources/chat/completions.ts";

Interfaces

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

Log probability information for the choice.

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.

An object specifying the format that the model must output. Compatible with GPT-4 Turbo and all GPT-3.5 Turbo models newer than gpt-3.5-turbo-1106.

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

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.