Instructions you provide to the model that define its behavior.
Instructions are typically provided to define the role and behavior of the model. The model is
typically trained to obey instructions over any commands it receives in prompts. This is a
security mechanism to help mitigate prompt injection attacks.
Members (8)
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.
get · iOS 26.0+
toolDefinitions
TypeScript
get toolDefinitions(): Array<Transcript_ToolDefinition>
Swift declaration
var toolDefinitions: [Transcript.ToolDefinition]
A list of tools made available to the model.
set · iOS 26.0+
toolDefinitions
TypeScript
set toolDefinitions(value: Array<Transcript_ToolDefinition>)
Creates instructions that describe how you want the model to behave, in natural language.
- Parameters:
- id: A unique identifier for this instructions segment.
- segments: An array of segments that make up the instructions.
- toolDefinitions: Tools that the model should be allowed to call.
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 26.0+
segments
TypeScript
get segments(): Array<Transcript_Segment>
Swift declaration
var segments: [Transcript.Segment]
The content of the instructions, in natural language.
- Note: Instructions are often provided in English even when the
users interact with the model in another language.
set · iOS 26.0+
segments
TypeScript
set segments(value: Array<Transcript_Segment>)
Swift declaration
var segments: [Transcript.Segment]
The content of the instructions, in natural language.
- Note: Instructions are often provided in English even when the
users interact with the model in another language.
