OpenAIFnDef: {
    name: string;
    description?: undefined | string;
    parameters?: undefined | OpenAIClient.FunctionParameters;
}

Type declaration

  • 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?: undefined | string

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

  • Optionalparameters?: undefined | 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.