FoundationModels · IOS API REFERENCE

PrivateCloudComputeLanguageModel.QuotaUsage

struct · iOS 27.0+ · SDK 27.1

struct QuotaUsage

The usage quota state for a Private Cloud Compute language model. A quota describes the model's per-user request budget and where the caller currently sits relative to it. Quotas are orthogonal to a model's availability — a model can be available even after its usage limit has been reached.

Members (7)

get · iOS 27.0+

isLimitReached

TypeScript

get isLimitReached(): boolean

Swift declaration

var isLimitReached: Bool { get }

A Boolean value that indicates whether the usage limit has been reached.

get · iOS 27.0+

limitIncreaseSuggestion

TypeScript

get limitIncreaseSuggestion(): (PrivateCloudComputeLanguageModel_QuotaUsage_LimitIncreaseSuggestion) | null

Swift declaration

var limitIncreaseSuggestion: PrivateCloudComputeLanguageModel.QuotaUsage.LimitIncreaseSuggestion?

A suggestion the user can act on to increase their quota. A `nil` value indicates that the model provider does not surface an upgrade path through this API.

set · iOS 27.0+

limitIncreaseSuggestion

TypeScript

set limitIncreaseSuggestion(value: (PrivateCloudComputeLanguageModel_QuotaUsage_LimitIncreaseSuggestion) | null)

Swift declaration

var limitIncreaseSuggestion: PrivateCloudComputeLanguageModel.QuotaUsage.LimitIncreaseSuggestion?

A suggestion the user can act on to increase their quota. A `nil` value indicates that the model provider does not surface an upgrade path through this API.

get · iOS 27.0+

status

TypeScript

get status(): PrivateCloudComputeLanguageModel_QuotaUsage_Status

Swift declaration

var status: PrivateCloudComputeLanguageModel.QuotaUsage.Status

The current quota status.

set · iOS 27.0+

status

TypeScript

set status(value: PrivateCloudComputeLanguageModel_QuotaUsage_Status)

Swift declaration

var status: PrivateCloudComputeLanguageModel.QuotaUsage.Status

The current quota status.

get · iOS 27.0+

resetDate

TypeScript

get resetDate(): (globalThis.Date) | null

Swift declaration

var resetDate: Date?

The date at which the quota refreshes. A `nil` value indicates that the model provider has not reported a reset time. This may be because the provider's limit does not refresh on a fixed schedule, or because the provider does not expose this information.

set · iOS 27.0+

resetDate

TypeScript

set resetDate(value: (globalThis.Date) | null)

Swift declaration

var resetDate: Date?

Skipped declarations

No declarations were skipped in this snapshot.

All FoundationModels types →