Files
firebase-ios-sdk/GeminiLanguageModel/Sources/GeminiAPIDataModels/GenerateContent/FileData.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

97 lines
3.1 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 `FileData`.
///
/// ### Gemini Developer API
///
/// Type: `FileData`
///
/// An element in the history the represents an external data file.
///
/// ### Gemini Enterprise Agent Platform
///
/// Type: `GoogleCloudAiplatformV1beta1FileData`
///
/// URI-based data.
///
/// A FileData message contains a URI
/// pointing to data of a specific media type. It is used to represent images,
/// audio, and video stored in Google Cloud Storage.
package struct FileData: Codable, Sendable, Equatable, Hashable {
/// Required. The IANA standard MIME type of the source data.
///
/// ### Gemini Developer API
///
/// Required. The IANA standard MIME type of the source data.
/// Examples:
/// - image/png
/// - image/jpeg
///
/// ### Gemini Enterprise Agent Platform
///
/// Required. The IANA standard MIME type of the source data.
package let mimeType: String
/// Required. URI.
///
/// ### Gemini Developer API
///
/// Required. URI.
///
/// ### Gemini Enterprise Agent Platform
///
/// Required. The URI of the file in Google Cloud Storage.
package let fileUri: String
/// Optional. The display name of the file. Used to provide a label or filename
///
/// ### Gemini Developer API
///
/// > Important: This property is not supported in the Gemini Developer API.
///
/// ### Gemini Enterprise Agent Platform
///
/// Optional. The display name of the file. Used to provide a label or filename
/// to distinguish files.
///
/// This field is only returned in `PromptMessage` for prompt management. It is
/// used in the Gemini calls only when server side tools (`code_execution`,
/// `google_search`, and `url_context`) are enabled.
package let displayName: String?
/// Creates a new `FileData`.
///
/// - Parameters:
/// - mimeType: Required. The IANA standard MIME type of the source data. (behavior varies by backend). For more details, see ``mimeType``.
/// - fileUri: Required. URI. (behavior varies by backend). For more details, see ``fileUri``.
/// - displayName: Optional. The display name of the file. Used to provide a label or filename (Gemini Enterprise Agent Platform only). For more details, see ``displayName``.
package init(
mimeType: String,
fileUri: String,
displayName: String? = nil
) {
self.mimeType = mimeType
self.fileUri = fileUri
self.displayName = displayName
}
enum CodingKeys: String, CodingKey {
case mimeType = "mimeType"
case fileUri = "fileUri"
case displayName = "displayName"
}
}