Skip to content

metadata

FunctionToolDefinition

Bases: TypedDict

Represents a function tool definition for use in chat completions.

Attributes:

Name Type Description
name str

The name of the tool.

description str | None

A description of the tool, if any.

parameters dict[str, Any] | None

Additional parameters for the tool, if any.

strict bool | None

Whether the tool should be used strictly or not.

WebSearchUserLocation

Bases: NullableBaseModel

Represents the user's location for web search purposes.

WebSearchToolMCP

Bases: NullableBaseModel

Represents the metadata configuration for a web search tool.

WebSearchToolOptions

Bases: NullableBaseModel

Represents the options for a web search tool, passed to the request maker method.

Annotation

Bases: NullableBaseModel

Represents a reference/citation annotation, created from a citation entry found in the response text.