FoundationModels · IOS API REFERENCE

LanguageModelSession.Usage

struct · iOS 27.0+ · SDK 27.1

struct Usage

Information about how many tokens were used by a response.

Members (8)

get · iOS 27.0+

totalTokenCount

TypeScript

get totalTokenCount(): number

Swift declaration

var totalTokenCount: Int { get }

The total number of tokens involved in this generation, combining input and output counts.

init · iOS 27.0+

init

TypeScript

static init(input: LanguageModelSession_Usage_Input, output: LanguageModelSession_Usage_Output, metadata?: Record<string, SDKHandle>): LanguageModelSession_Usage

Swift declaration

init(input: LanguageModelSession.Usage.Input, output: LanguageModelSession.Usage.Output, metadata: [String : any ConvertibleToGeneratedContent] = [:])

Creates a usage value with the given token counts. - Parameters: - input: Token counts for the transcript. - output: Token counts for the response. - metadata: Additional usage statistics from the language model.

get · iOS 27.0+

input

TypeScript

get input(): LanguageModelSession_Usage_Input

Swift declaration

var input: LanguageModelSession.Usage.Input

The input token counts from the transcript.

set · iOS 27.0+

input

TypeScript

set input(value: LanguageModelSession_Usage_Input)

Swift declaration

var input: LanguageModelSession.Usage.Input

The input token counts from the transcript.

get · iOS 27.0+

output

TypeScript

get output(): LanguageModelSession_Usage_Output

Swift declaration

var output: LanguageModelSession.Usage.Output

The output token counts from the response.

set · iOS 27.0+

output

TypeScript

set output(value: LanguageModelSession_Usage_Output)

Swift declaration

var output: LanguageModelSession.Usage.Output

The output token counts from the response.

get · iOS 27.0+

metadata

TypeScript

get metadata(): Record<string, GeneratedContent>

Swift declaration

var metadata: [String : GeneratedContent]

Language models that provide other kinds of usage statistics may encode them in metadata.

set · iOS 27.0+

metadata

TypeScript

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

Swift declaration

var metadata: [String : GeneratedContent]

Language models that provide other kinds of usage statistics may encode them in metadata.

Skipped declarations

No declarations were skipped in this snapshot.

All FoundationModels types →