Header menu logo Nao

ToolParameter Type

Describes a single parameter a tool accepts in its JSON input object.

Record fields

Record Field Description

Default

Full Usage: Default

Field type: string option

Default value applied when the parameter is omitted, if any

Field type: string option

Description

Full Usage: Description

Field type: string

Human-readable description of the parameter

Field type: string

Examples

Full Usage: Examples

Field type: string list

Example values for documentation / few-shot prompting

Field type: string list

Name

Full Usage: Name

Field type: string

Parameter name (the JSON object key)

Field type: string

Required

Full Usage: Required

Field type: bool

Whether this parameter is required

Field type: bool

Type

Full Usage: Type

Field type: string

Type hint (e.g. "string", "int", "object", "array")

Field type: string

Type something to start searching.