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

100 lines
3.8 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 `GoogleSearch`.
///
/// ### Gemini Developer API
///
/// Type: `GoogleAiGenerativelanguageV1betaToolGoogleSearch`
///
/// GoogleSearch tool type.
/// Tool to support Google Search in Model. Powered by Google.
///
/// ### Gemini Enterprise Agent Platform
///
/// Type: `GoogleCloudAiplatformV1beta1ToolGoogleSearch`
///
/// GoogleSearch tool type.
/// Tool to support Google Search in Model. Powered by Google.
package struct GoogleSearch: Codable, Sendable, Equatable, Hashable {
/// Optional. Filter search results to a specific time range.
///
/// ### Gemini Developer API
///
/// Optional. Filter search results to a specific time range.
/// If customers set a start time, they must set an end time (and vice
/// versa).
///
/// ### Gemini Enterprise Agent Platform
///
/// > Important: This property is not supported in the Gemini Enterprise Agent Platform.
package let timeRangeFilter: Interval?
/// Optional. The set of search types to enable. If not set, web search is
/// enabled by default.
package let searchTypes: SearchTypes?
/// Optional. List of domains to be excluded from the search results.
///
/// ### Gemini Developer API
///
/// > Important: This property is not supported in the Gemini Developer API.
///
/// ### Gemini Enterprise Agent Platform
///
/// Optional. List of domains to be excluded from the search results.
/// The default limit is 2000 domains.
/// Example: ["amazon.com", "facebook.com"].
package let excludeDomains: [String]?
/// Optional. Sites with confidence level chosen & above this value will be blocked
///
/// ### Gemini Developer API
///
/// > Important: This property is not supported in the Gemini Developer API.
///
/// ### Gemini Enterprise Agent Platform
///
/// Optional. Sites with confidence level chosen & above this value will be blocked
/// from the search results.
package let blockingConfidence: BlockingConfidence?
/// Creates a new `GoogleSearch`.
///
/// - Parameters:
/// - timeRangeFilter: Optional. Filter search results to a specific time range. (Gemini Developer API only). For more details, see ``timeRangeFilter``.
/// - searchTypes: Optional. The set of search types to enable. If not set, web search is
/// - excludeDomains: Optional. List of domains to be excluded from the search results. (Gemini Enterprise Agent Platform only). For more details, see ``excludeDomains``.
/// - blockingConfidence: Optional. Sites with confidence level chosen & above this value will be blocked (Gemini Enterprise Agent Platform only). For more details, see ``blockingConfidence``.
package init(
timeRangeFilter: Interval? = nil,
searchTypes: SearchTypes? = nil,
excludeDomains: [String]? = nil,
blockingConfidence: BlockingConfidence? = nil
) {
self.timeRangeFilter = timeRangeFilter
self.searchTypes = searchTypes
self.excludeDomains = excludeDomains
self.blockingConfidence = blockingConfidence
}
enum CodingKeys: String, CodingKey {
case timeRangeFilter = "timeRangeFilter"
case searchTypes = "searchTypes"
case excludeDomains = "excludeDomains"
case blockingConfidence = "blockingConfidence"
}
}