Skip to content

function_definition

Classes:

Name Description
FunctionDefinition

FunctionDefinition

Attributes:

Name Type Description
description Optional[str]

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

name str

The name of the function to be called.

parameters Optional[FunctionParameters]

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

description class-attribute instance-attribute

description: Optional[str] = None

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

name instance-attribute

name: 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 class-attribute instance-attribute

parameters: Optional[FunctionParameters] = None

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.