Files
firebase-ios-sdk/GeminiLanguageModel/Sources/GeminiAPIDataModels/GenerateContent/ModalityTokenCount.swift
T
Andrew Heard 3796a55fdf feat(ai): add GeminiLanguageModel (#16601)
Implemented `GeminiLanguageModel`, providing an adapter for Google's
Gemini models conforming to Apple's `FoundationModels.LanguageModel`
protocol. This PR includes text to text generation capabilities; other
modalities and Gemini features will be handled in follow-up PRs.

**Note:** The `GeminiLanguageModel` implementation is guarded by the
environment variable `GEMINI_LANGUAGE_MODEL`. By default none of the
`GeminiLanguageModel` implementation is included.

Key additions:
- `GeminiLanguageModel`: Implements `LanguageModel` protocol with
  reasoning capabilities, configuring execution via `ModelResource`
  and `EndpointConfiguration`.
- `GeminiLanguageModelExecutor`: Converts prompt instructions and
  history into Gemini streaming requests, yielding responses as
  `LanguageModelSession.ResponseStream`.
- `GeminiTranscriptTranslator`: Translates Apple `Transcript` entries
  and segments into Gemini `Content` structures while preserving thought
  signatures and validating supported transcript features.
- `GeminiLanguageModel.Error` and `GeminiErrorMapper`: Translates Gemini
  API, HTTP, and network errors into standard `LanguageModelError` cases
  (`rateLimited`, `timeout`, `guardrailViolation`, `refusal`, and
  `unsupportedLanguageOrLocale`) or `GeminiLanguageModel.Error` cases
  (`serviceUnavailable`, `networkFailure`, `modelNotFound`, `apiError`).
  The `APIError` payload is designed for seamless forward compatibility
  with both GenerateContent and the upcoming Interactions API.
- Testing infrastructure: Adds `ConditionTrait.requireFoundationModels`
  to conditionally run Foundation Models tests only on supported
  platforms (macOS 27+, iOS 27+, watchOS 27+, visionOS 27+), along with
  shared test constants, mock fixtures, and comprehensive unit and
  integration test suites.
2026-09-04 18:05:45 -04:00

79 lines
2.5 KiB
Swift

// Copyright 2026 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
import Foundation
/// An internal data model for `ModalityTokenCount`.
///
/// ### Gemini Developer API
///
/// Type: `GoogleAiGenerativelanguageV1betaModalityTokenCount`
///
/// Represents token counting info for a single modality.
///
/// ### Gemini Enterprise Agent Platform
///
/// Type: `GoogleCloudAiplatformV1beta1ModalityTokenCount`
///
/// Represents a breakdown of token usage by modality.
///
/// This message is used in
/// CountTokensResponse
/// and
/// GenerateContentResponse.UsageMetadata
/// to provide a detailed view of how
/// many tokens are used by each modality (e.g., text, image, video) in a
/// request. This is particularly useful for multimodal models, allowing you to
/// track and manage token consumption for billing and quota purposes.
package struct ModalityTokenCount: Codable, Sendable, Equatable, Hashable {
/// The modality associated with this token count.
///
/// ### Gemini Developer API
///
/// The modality associated with this token count.
///
/// ### Gemini Enterprise Agent Platform
///
/// The modality that this token count applies to.
package let modality: Modality?
/// Number of tokens.
///
/// ### Gemini Developer API
///
/// Number of tokens.
///
/// ### Gemini Enterprise Agent Platform
///
/// The number of tokens counted for this modality.
package let tokenCount: Int?
/// Creates a new `ModalityTokenCount`.
///
/// - Parameters:
/// - modality: The modality associated with this token count. (behavior varies by backend). For more details, see ``modality``.
/// - tokenCount: Number of tokens. (behavior varies by backend). For more details, see ``tokenCount``.
package init(
modality: Modality? = nil,
tokenCount: Int? = nil
) {
self.modality = modality
self.tokenCount = tokenCount
}
enum CodingKeys: String, CodingKey {
case modality = "modality"
case tokenCount = "tokenCount"
}
}