Interface Function

Deprecated

interface Function {
    name: string;
    description?: string;
    parameters?: OpenAIClient.FunctionParameters;
}

Properties

name description? parameters?

Properties

name

name: string

The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.

Optionaldescription

description?: string

A description of what the function does, used by the model to choose when and how to call the function.

Optionalparameters

parameters?: OpenAIClient.FunctionParameters

The parameters the functions accepts, described as a JSON Schema object. See the guide for examples, and the JSON Schema reference for documentation about the format.

Omitting parameters defines a function with an empty parameter list.

Settings

Member Visibility

On This Page

Properties