FoundationModels · IOS API REFERENCE

Transcript.ToolDefinition

struct · iOS 26.0+ · SDK 27.1

struct ToolDefinition

A definition of a tool.

Members (7)

get · iOS 27.0+

TypeScript

get parameters(): GenerationSchema

Swift declaration

var parameters: GenerationSchema { get set }

A schema that specifies the parameters of the tool.

set · iOS 27.0+

TypeScript

set parameters(value: GenerationSchema)

Swift declaration

var parameters: GenerationSchema { get set }

A schema that specifies the parameters of the tool.

get · iOS 26.0+

TypeScript

get description(): string

Swift declaration

var description: String

A description of how and when to use the tool.

set · iOS 26.0+

TypeScript

set description(value: string)

Swift declaration

var description: String

A description of how and when to use the tool.

init · iOS 26.0+

TypeScript

static init(name: string, description: string, parameters: GenerationSchema): Transcript_ToolDefinition

Swift declaration

init(name: String, description: String, parameters: GenerationSchema)

get · iOS 26.0+

TypeScript

get name(): string

Swift declaration

var name: String

The tool's name.

set · iOS 26.0+

TypeScript

set name(value: string)

Swift declaration

var name: String

The tool's name.

1 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

Transcript.ToolDefinition.init(tool:)

This protocol needs associated types that cannot yet cross the bridge.