Files
firebase-ios-sdk/GeminiLanguageModel/Sources/GeminiAPIClient/GeminiAPIError.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
2.7 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
package import GeminiAPIDataModels
#if canImport(FoundationNetworking)
import FoundationNetworking
#endif
/// Errors thrown by `GeminiAPIClient`.
@available(macOS 15.0, iOS 18.0, tvOS 18.0, watchOS 11.0, visionOS 2.0, *)
package enum GeminiAPIError: Error, Sendable, Equatable {
/// An API error returned by the Google Gemini service conforming to AIP-0193.
case apiError(GoogleCloudAPIError)
/// An HTTP failure status code with a raw response body.
case httpError(statusCode: Int, body: String)
}
@available(macOS 15.0, iOS 18.0, tvOS 18.0, watchOS 11.0, visionOS 2.0, *)
extension GeminiAPIError {
/// The retry delay advice for this error, if available from headers or payload details.
package var retryAfter: Duration? {
switch self {
case .apiError(let error):
error.retryDelay
case .httpError:
nil
}
}
}
@available(macOS 15.0, iOS 18.0, tvOS 18.0, watchOS 11.0, visionOS 2.0, *)
extension GeminiAPIError: LocalizedError {
package static var errorDomain: String { "GeminiAPIClient.GeminiAPIError" }
package var errorDescription: String? {
switch self {
case .apiError(let error):
error.errorDescription
case .httpError(let statusCode, let body):
"HTTP \(statusCode): \(body)"
}
}
package var failureReason: String? {
switch self {
case .apiError(let error):
error.failureReason
case .httpError(let statusCode, _):
"HTTP status \(statusCode)"
}
}
package var helpAnchor: String? {
switch self {
case .apiError(let error):
error.helpAnchor
case .httpError:
nil
}
}
}
@available(macOS 15.0, iOS 18.0, tvOS 18.0, watchOS 11.0, visionOS 2.0, *)
extension GeminiAPIError: CustomNSError {
package var errorCode: Int {
switch self {
case .apiError(let error):
error.errorCode
case .httpError(let statusCode, _):
statusCode
}
}
package var errorUserInfo: [String: Any] {
switch self {
case .apiError(let error):
error.errorUserInfo
case .httpError(let statusCode, let body):
[
"statusCode": statusCode,
"body": body,
]
}
}
}