One Logo Pool Ball
FoundationModels · IOS API REFERENCE

Transcript.ToolCall

struct · iOS 26.0+ · SDK 27.1

struct ToolCall

A tool call generated by the model containing the name of a tool and arguments to pass to it.

Members (11)

get · iOS 26.0+

description

TypeScript
get description(): string
Swift declaration
var description: String { get }

A textual representation of this instance. Calling this property directly is discouraged. Instead, convert an instance of any type to a string by using the `String(describing:)` initializer. This initializer works with any type, and uses the custom `description` property for types that conform to `CustomStringConvertible`: struct Point: CustomStringConvertible { let x: Int, y: Int var description: String { return "(\(x), \(y))" } } let p = Point(x: 21, y: 30) let s = String(describing: p) print(s) // Prints "(21, 30)" The conversion of `p` to a string in the assignment to `s` uses the `Point` type's `description` property.

init · iOS 27.0+

init

TypeScript
static initIdMetadataToolNameArguments(id: string, metadata: Record<string, SDKHandle>, toolName: string, arguments_: GeneratedContent): Transcript_ToolCall
Swift declaration
init(id: String, metadata: [String : any ConvertibleToGeneratedContent], toolName: String, arguments: GeneratedContent)
init · iOS 26.0+

init

TypeScript
static initIdToolNameArguments(id: string, toolName: string, arguments_: GeneratedContent): Transcript_ToolCall
Swift declaration
init(id: String, toolName: String, arguments: GeneratedContent)
get · iOS 26.0+

id

TypeScript
get id(): string
Swift declaration
var id: String

The stable identity of the entity associated with this instance.

set · iOS 26.0+

id

TypeScript
set id(value: string)
Swift declaration
var id: String

The stable identity of the entity associated with this instance.

get · iOS 27.0+

metadata

TypeScript
get metadata(): Record<string, GeneratedContent>
Swift declaration
var metadata: [String : GeneratedContent]

Metadata produced by the model while generating this tool call.

set · iOS 27.0+

metadata

TypeScript
set metadata(value: Record<string, GeneratedContent>)
Swift declaration
var metadata: [String : GeneratedContent]

Metadata produced by the model while generating this tool call.

get · iOS 26.0+

toolName

TypeScript
get toolName(): string
Swift declaration
var toolName: String

The name of the tool being invoked.

set · iOS 26.0+

toolName

TypeScript
set toolName(value: string)
Swift declaration
var toolName: String

The name of the tool being invoked.

get · iOS 26.0+

arguments

TypeScript
get arguments(): GeneratedContent
Swift declaration
var arguments: GeneratedContent { get set }

Arguments to pass to the invoked tool.

set · iOS 26.0+

arguments

TypeScript
set arguments(value: GeneratedContent)
Swift declaration
var arguments: GeneratedContent { get set }

Arguments to pass to the invoked tool.

Skipped declarations

No declarations were skipped in this snapshot.

All FoundationModels types →