Skip to content

function_definition

Classes:

Name Description
FunctionDefinition

FunctionDefinition

Attributes:

Name Type Description
description str

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

name Required[str]

The name of the function to be called.

parameters FunctionParameters

The parameters the functions accepts, described as a JSON Schema object.

description instance-attribute

description: str

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

name instance-attribute

name: Required[str]

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.

parameters instance-attribute

parameters: 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.