FoundationModels · IOS API REFERENCE

LanguageModelExecutorGenerationRequest

struct · iOS 27.0+ · SDK 27.1

struct LanguageModelExecutorGenerationRequest

A type that contains the details for a generation request. A generation request is the input payload that ``LanguageModelExecutor/respond(to:model:streamingInto:)`` handles. It bundles everything the executor needs to translate a framework call into a backend request, like the conversation so far, what tools are available, and so on.

Members (15)

get · iOS 27.0+

transcript

TypeScript

get transcript(): Transcript

Swift declaration

var transcript: Transcript

A transcript to generate the next entry for

set · iOS 27.0+

transcript

TypeScript

set transcript(value: Transcript)

Swift declaration

var transcript: Transcript

A transcript to generate the next entry for

get · iOS 27.0+

contextOptions

TypeScript

get contextOptions(): ContextOptions

Swift declaration

var contextOptions: ContextOptions

Settings that configure how the model is prompted

set · iOS 27.0+

contextOptions

TypeScript

set contextOptions(value: ContextOptions)

Swift declaration

var contextOptions: ContextOptions

Settings that configure how the model is prompted

get · iOS 27.0+

generationOptions

TypeScript

get generationOptions(): GenerationOptions

Swift declaration

var generationOptions: GenerationOptions

Generation options that control sampling behavior

set · iOS 27.0+

generationOptions

TypeScript

set generationOptions(value: GenerationOptions)

Swift declaration

var generationOptions: GenerationOptions

Generation options that control sampling behavior

get · iOS 27.0+

enabledToolDefinitions

TypeScript

get enabledToolDefinitions(): Array<Transcript_ToolDefinition>

Swift declaration

var enabledToolDefinitions: [Transcript.ToolDefinition]

The subset tool definitions that the model is allowed to call

set · iOS 27.0+

enabledToolDefinitions

TypeScript

set enabledToolDefinitions(value: Array<Transcript_ToolDefinition>)

Swift declaration

var enabledToolDefinitions: [Transcript.ToolDefinition]

The subset tool definitions that the model is allowed to call

get · iOS 27.0+

id

TypeScript

get id(): string

Swift declaration

var id: UUID

A request id for logging and tracing purposes

set · iOS 27.0+

id

TypeScript

set id(value: string)

Swift declaration

var id: UUID

A request id for logging and tracing purposes

init · iOS 27.0+

init

TypeScript

static init(id: string, transcript: Transcript, enabledTools: Array<Transcript_ToolDefinition>, schema: (GenerationSchema) | null, generationOptions: GenerationOptions, contextOptions: ContextOptions, metadata: Record<string, SDKHandle>): LanguageModelExecutorGenerationRequest

Swift declaration

init(id: UUID, transcript: Transcript, enabledTools: [Transcript.ToolDefinition], schema: GenerationSchema? = nil, generationOptions: GenerationOptions, contextOptions: ContextOptions, metadata: [String : any ConvertibleToGeneratedContent])

Creates a generation request. - Parameters: - id: The request identifier. - transcript: The transcript to generate the next entry for. - enabledTools: The subset tool definitions that the model can call. - schema: The schema dictating the required output format. - generationOptions: The generation options to use. - contextOptions: The settings that configure how the model is prompted. - metadata: The metadata to attach to the request.

get · iOS 27.0+

schema

TypeScript

get schema(): (GenerationSchema) | null

Swift declaration

var schema: GenerationSchema?

An optional schema dictating the required output format

set · iOS 27.0+

schema

TypeScript

set schema(value: (GenerationSchema) | null)

Swift declaration

var schema: GenerationSchema?

An optional schema dictating the required output format

get · iOS 27.0+

metadata

TypeScript

get metadata(): Record<string, GeneratedContent>

Swift declaration

var metadata: [String : GeneratedContent]

Metadata to attach to the request

set · iOS 27.0+

metadata

TypeScript

set metadata(value: Record<string, GeneratedContent>)

Swift declaration

var metadata: [String : GeneratedContent]

Metadata to attach to the request

Skipped declarations

No declarations were skipped in this snapshot.

All FoundationModels types →