Merge branch 'firebase:main' into JesusRojass/#15802

Author: JesusRojass

Crashlytics/CHANGELOG.md

@@ -1,4 +1,4 @@
-# Unreleased
+# 12.11.0
 - [fixed] Fixed an issue where Crashlytics API calls were silently dropped if invoked immediately after Firebase initialization.
 
 # 12.10.0

FirebaseAI/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 12.11.0
+- [feature] **Public Preview**: Introduces `GenerativeModelSession` providing
+  APIs for generating structured data from Gemini via the same `@Generable` and
+  `@Guide` macros that are used with Foundation Models.
+
 # 12.9.0
 - [changed] The URL context tool APIs are now GA.
 - [feature] Added support for implicit caching (context caching) metadata in `GenerateContentResponse`.

FirebaseAI/Sources/AGENTS.md

@@ -24,6 +24,7 @@ This directory contains the source code for the FirebaseAI library.
 - **`GenerativeAIRequest.swift`**: Defines the `GenerativeAIRequest` protocol for requests sent to the generative AI backend. It also defines `RequestOptions`.
 - **`GenerativeAIService.swift`**: Defines the `GenerativeAIService` struct, which is responsible for making requests to the generative AI backend. It handles things like authentication, URL construction, and response parsing.
 - **`GenerativeModel.swift`**: Defines the `GenerativeModel` class, which represents a remote multimodal model. It provides methods for generating content, counting tokens, and starting a chat via `startChat(history:)`, which returns a `Chat` instance.
+- **`GenerativeModelSession.swift`**: Defines the `GenerativeModelSession` class, which provides a simplified interface for single-turn interactions with a generative model. It's particularly useful for generating typed objects from a model's response using the `@Generable` macro, without the conversational turn-based structure of a `Chat`.
 - **`History.swift`**: Defines the `History` class, a thread-safe class for managing the chat history, used by the `Chat` class.
 - **`JSONValue.swift`**: Defines the `JSONValue` enum and `JSONObject` typealias for representing JSON values.
 - **`ModalityTokenCount.swift`**: Defines the `ModalityTokenCount` and `ContentModality` structs for representing token counting information for a single modality.

FirebaseAI/Sources/Chat.swift

@@ -37,6 +37,8 @@ public final class Chat: Sendable {
     }
   }
 
+  var generationConfig: GenerationConfig? { model.generationConfig }
+
   /// Sends a message using the existing history of this chat as context. If successful, the message
   /// and response will be added to the history. If unsuccessful, history will remain unchanged.
   /// - Parameter parts: The new content to send as a single chat message.
@@ -52,14 +54,40 @@ public final class Chat: Sendable {
   /// - Parameter content: The new content to send as a single chat message.
   /// - Returns: The model's response if no error occurred.
   /// - Throws: A ``GenerateContentError`` if an error occurred.
-  public func sendMessage(_ content: [ModelContent]) async throws
-    -> GenerateContentResponse {
+  public func sendMessage(_ content: [ModelContent]) async throws -> GenerateContentResponse {
+    return try await sendMessage(content, generationConfig: generationConfig)
+  }
+
+  /// Sends a message using the existing history of this chat as context. If successful, the message
+  /// and response will be added to the history. If unsuccessful, history will remain unchanged.
+  /// - Parameter parts: The new content to send as a single chat message.
+  /// - Returns: A stream containing the model's response or an error if an error occurred.
+  @available(macOS 12.0, *)
+  public func sendMessageStream(_ parts: any PartsRepresentable...) throws
+    -> AsyncThrowingStream<GenerateContentResponse, Error> {
+    return try sendMessageStream([ModelContent(parts: parts)])
+  }
+
+  /// Sends a message using the existing history of this chat as context. If successful, the message
+  /// and response will be added to the history. If unsuccessful, history will remain unchanged.
+  /// - Parameter content: The new content to send as a single chat message.
+  /// - Returns: A stream containing the model's response or an error if an error occurred.
+  @available(macOS 12.0, *)
+  public func sendMessageStream(_ content: [ModelContent]) throws
+    -> AsyncThrowingStream<GenerateContentResponse, Error> {
+    return try sendMessageStream(content, generationConfig: generationConfig)
+  }
+
+  // MARK: - Internal
+
+  func sendMessage(_ content: [ModelContent],
+                   generationConfig: GenerationConfig?) async throws -> GenerateContentResponse {
     // Ensure that the new content has the role set.
     let newContent = content.map(populateContentRole(_:))
 
     // Send the history alongside the new message as context.
     let request = history + newContent
-    let result = try await model.generateContent(request)
+    let result = try await model.generateContent(request, generationConfig: generationConfig)
     guard let reply = result.candidates.first?.content else {
       let error = NSError(domain: "com.google.generative-ai",
                           code: -1,
@@ -78,29 +106,14 @@ public final class Chat: Sendable {
     return result
   }
 
-  /// Sends a message using the existing history of this chat as context. If successful, the message
-  /// and response will be added to the history. If unsuccessful, history will remain unchanged.
-  /// - Parameter parts: The new content to send as a single chat message.
-  /// - Returns: A stream containing the model's response or an error if an error occurred.
-  @available(macOS 12.0, *)
-  public func sendMessageStream(_ parts: any PartsRepresentable...) throws
-    -> AsyncThrowingStream<GenerateContentResponse, Error> {
-    return try sendMessageStream([ModelContent(parts: parts)])
-  }
-
-  /// Sends a message using the existing history of this chat as context. If successful, the message
-  /// and response will be added to the history. If unsuccessful, history will remain unchanged.
-  /// - Parameter content: The new content to send as a single chat message.
-  /// - Returns: A stream containing the model's response or an error if an error occurred.
-  @available(macOS 12.0, *)
-  public func sendMessageStream(_ content: [ModelContent]) throws
+  func sendMessageStream(_ content: [ModelContent], generationConfig: GenerationConfig?) throws
     -> AsyncThrowingStream<GenerateContentResponse, Error> {
     // Ensure that the new content has the role set.
     let newContent: [ModelContent] = content.map(populateContentRole(_:))
 
     // Send the history alongside the new message as context.
     let request = history + newContent
-    let stream = try model.generateContentStream(request)
+    let stream = try model.generateContentStream(request, generationConfig: generationConfig)
     return AsyncThrowingStream { continuation in
       Task {
         var aggregatedContent: [ModelContent] = []

FirebaseAI/Sources/Extensions/Internal/AGENTS.md

@@ -0,0 +1,7 @@
+# Internal Extensions
+
+This directory contains internal extensions to data models and other types. These extensions provide functionality that is specific to the internal workings of the Firebase AI SDK and are not part of the public API.
+
+## Files
+
+-   **`GenerationSchema+Gemini.swift`**: This file extends `GenerationSchema` to provide a `toGeminiJSONSchema()` method. This method transforms the schema into a format that is compatible with the Gemini backend, including renaming properties like `x-order` to `propertyOrdering`. This file is conditionally compiled and is only available when `FoundationModels` can be imported.

FirebaseAI/Sources/Extensions/Internal/ConvertibleFromGeneratedContent+Firebase.swift

@@ -0,0 +1,33 @@
+// 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.
+
+#if compiler(>=6.2) && canImport(FoundationModels)
+  import FoundationModels
+
+  @available(iOS 26.0, macOS 26.0, *)
+  @available(tvOS, unavailable)
+  @available(watchOS, unavailable)
+  public extension FoundationModels.ConvertibleFromGeneratedContent {
+    /// Initializes an instance from `FirebaseAI.GeneratedContent`.
+    ///
+    /// **Public Preview**: This API is a public preview and may be subject to change.
+    ///
+    /// - Parameters:
+    ///   - content: The `FirebaseAI.GeneratedContent` from which to initialize.
+    /// - Throws: An error if initialization fails.
+    init(_ content: FirebaseAI.GeneratedContent) throws {
+      try self.init(content.generatedContent)
+    }
+  }
+#endif // compiler(>=6.2) && canImport(FoundationModels)

FirebaseAI/Sources/Extensions/Internal/GenerationSchema+Gemini.swift

@@ -0,0 +1,61 @@
+// 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
+
+@available(iOS 15.0, macOS 12.0, macCatalyst 15.0, tvOS 15.0, watchOS 8.0, *)
+extension FirebaseAI.GenerationSchema {
+  /// Returns a Gemini-compatible JSON Schema of this `GenerationSchema`.
+  func toGeminiJSONSchema() throws -> JSONObject {
+    let encoder = JSONEncoder()
+    encoder.keyEncodingStrategy = .custom { keys in
+      guard let lastKey = keys.last else {
+        assertionFailure("Unexpected empty coding path.")
+        return SchemaCodingKey(stringValue: "")
+      }
+      if lastKey.stringValue == "x-order" {
+        return SchemaCodingKey(stringValue: "propertyOrdering")
+      }
+      return lastKey
+    }
+
+    #if canImport(FoundationModels)
+      if #available(iOS 26.0, macOS 26.0, visionOS 26.0, *) {
+        let generationSchemaData = try encoder.encode(self)
+        let jsonSchema = try JSONDecoder().decode(JSONObject.self, from: generationSchemaData)
+
+        return jsonSchema
+      }
+    #endif // canImport(FoundationModels)
+
+    // TODO: Implement FirebaseAI.GenerationSchema encoding for iOS < 26.
+    throw EncodingError.invalidValue(self, .init(codingPath: [], debugDescription: """
+    \(Self.self).#\(#function): `GenerationSchema` encoding is not yet implemented for iOS < 26.
+    """))
+  }
+
+  private struct SchemaCodingKey: CodingKey {
+    let stringValue: String
+    let intValue: Int? = nil
+
+    init(stringValue: String) {
+      self.stringValue = stringValue
+    }
+
+    init?(intValue: Int) {
+      assertionFailure("Unexpected \(Self.self) with integer value: \(intValue)")
+      return nil
+    }
+  }
+}

FirebaseAI/Sources/FirebaseAI.swift

@@ -104,6 +104,28 @@ public final class FirebaseAI: Sendable {
     )
   }
 
+  // TODO: Remove the `#if compiler(>=6.2)` when Xcode 26 is the minimum supported version.
+  #if compiler(>=6.2)
+    /// Creates a new `GenerativeModelSession` with the given model.
+    ///
+    /// - Important: **Public Preview** - This API is a public preview and may be subject to change.
+    ///
+    /// - Parameters:
+    ///   - model: The name of the model to use; see [available model names
+    ///     ](https://firebase.google.com/docs/vertex-ai/gemini-models#available-model-names)
+    ///     for a list of supported model names.
+    ///   - instructions: System instructions that direct the model's behavior.
+    public func generativeModelSession(model: String,
+                                       instructions: String? = nil) -> GenerativeModelSession {
+      let model = generativeModel(
+        modelName: model,
+        systemInstruction: instructions.map { ModelContent(role: "system", parts: $0) }
+      )
+
+      return GenerativeModelSession(model: model)
+    }
+  #endif // compiler(>=6.2)
+
   /// Initializes an ``ImagenModel`` with the given parameters.
   ///
   /// - Note: Refer to [Imagen models](https://firebase.google.com/docs/vertex-ai/models) for

FirebaseAI/Sources/GenerateContentResponse.swift

@@ -71,6 +71,8 @@ public struct GenerateContentResponse: Sendable {
   /// Token usage metadata for processing the generate content request.
   public let usageMetadata: UsageMetadata?
 
+  let responseID: String?
+
   /// The response's content as text, if it exists.
   ///
   /// - Note: This does not include thought summaries; see ``thoughtSummary`` for more details.
@@ -123,6 +125,7 @@ public struct GenerateContentResponse: Sendable {
     self.candidates = candidates
     self.promptFeedback = promptFeedback
     self.usageMetadata = usageMetadata
+    responseID = nil
   }
 
   func text(isThought: Bool) -> String? {
@@ -453,10 +456,11 @@ public struct Segment: Sendable, Equatable, Hashable {
 
 @available(iOS 15.0, macOS 12.0, macCatalyst 15.0, tvOS 15.0, watchOS 8.0, *)
 extension GenerateContentResponse: Decodable {
-  enum CodingKeys: CodingKey {
+  enum CodingKeys: String, CodingKey {
     case candidates
     case promptFeedback
     case usageMetadata
+    case responseID = "responseId"
   }
 
   public init(from decoder: Decoder) throws {
@@ -482,6 +486,7 @@ extension GenerateContentResponse: Decodable {
     }
     promptFeedback = try container.decodeIfPresent(PromptFeedback.self, forKey: .promptFeedback)
     usageMetadata = try container.decodeIfPresent(UsageMetadata.self, forKey: .usageMetadata)
+    responseID = try container.decodeIfPresent(String.self, forKey: .responseID)
   }
 }
 

FirebaseAI/Sources/GenerationConfig.swift

@@ -19,45 +19,45 @@ import Foundation
 @available(iOS 15.0, macOS 12.0, macCatalyst 15.0, tvOS 15.0, watchOS 8.0, *)
 public struct GenerationConfig: Sendable {
   /// Controls the degree of randomness in token selection.
-  let temperature: Float?
+  var temperature: Float?
 
   /// Controls diversity of generated text.
-  let topP: Float?
+  var topP: Float?
 
   /// Limits the number of highest probability words considered.
-  let topK: Int?
+  var topK: Int?
 
   /// The number of response variations to return.
-  let candidateCount: Int?
+  var candidateCount: Int?
 
   /// Maximum number of tokens that can be generated in the response.
-  let maxOutputTokens: Int?
+  var maxOutputTokens: Int?
 
   /// Controls the likelihood of repeating the same words or phrases already generated in the text.
-  let presencePenalty: Float?
+  var presencePenalty: Float?
 
   /// Controls the likelihood of repeating words, with the penalty increasing for each repetition.
-  let frequencyPenalty: Float?
+  var frequencyPenalty: Float?
 
   /// A set of up to 5 `String`s that will stop output generation.
-  let stopSequences: [String]?
+  var stopSequences: [String]?
 
   /// Output response MIME type of the generated candidate text.
-  let responseMIMEType: String?
+  var responseMIMEType: String?
 
   /// Output schema of the generated candidate text.
-  let responseSchema: Schema?
+  var responseSchema: Schema?
 
   /// Output schema of the generated response in [JSON Schema](https://json-schema.org/) format.
   ///
   /// If set, `responseSchema` must be omitted and `responseMIMEType` is required.
-  let responseJSONSchema: JSONObject?
+  var responseJSONSchema: JSONObject?
 
   /// Supported modalities of the response.
-  let responseModalities: [ResponseModality]?
+  var responseModalities: [ResponseModality]?
 
   /// Configuration for controlling the "thinking" behavior of compatible Gemini models.
-  let thinkingConfig: ThinkingConfig?
+  var thinkingConfig: ThinkingConfig?
 
   /// Creates a new `GenerationConfig` value.
   ///
@@ -203,6 +203,54 @@ public struct GenerationConfig: Sendable {
     self.responseModalities = responseModalities
     self.thinkingConfig = thinkingConfig
   }
+
+  /// Merges two configurations, giving precedence to values found in the `overrides` parameter.
+  ///
+  /// - Parameters:
+  ///   - base: The foundational configuration (e.g., model-level defaults).
+  ///   - overrides: The configuration containing values that should supersede the base (e.g.,
+  /// request-level specific settings).
+  /// - Returns: A merged `GenerationConfig` prioritizing `overrides`, or `nil` if both inputs are
+  /// `nil`.
+  static func merge(_ base: GenerationConfig?,
+                    with overrides: GenerationConfig?) -> GenerationConfig? {
+    // 1. If the base config is missing, return the overrides (which might be nil).
+    guard let baseConfig = base else {
+      return overrides
+    }
+
+    // 2. If overrides are missing, strictly return the base.
+    guard let overrideConfig = overrides else {
+      return baseConfig
+    }
+
+    // 3. Start with a copy of the base config.
+    var config = baseConfig
+
+    // 4. Overwrite with any non-nil values found in the overrides.
+    config.temperature = overrideConfig.temperature ?? config.temperature
+    config.topP = overrideConfig.topP ?? config.topP
+    config.topK = overrideConfig.topK ?? config.topK
+    config.candidateCount = overrideConfig.candidateCount ?? config.candidateCount
+    config.maxOutputTokens = overrideConfig.maxOutputTokens ?? config.maxOutputTokens
+    config.presencePenalty = overrideConfig.presencePenalty ?? config.presencePenalty
+    config.frequencyPenalty = overrideConfig.frequencyPenalty ?? config.frequencyPenalty
+    config.stopSequences = overrideConfig.stopSequences ?? config.stopSequences
+    config.responseMIMEType = overrideConfig.responseMIMEType ?? config.responseMIMEType
+    config.responseModalities = overrideConfig.responseModalities ?? config.responseModalities
+    config.thinkingConfig = overrideConfig.thinkingConfig ?? config.thinkingConfig
+
+    // 5. Handle Schema mutual exclusivity with precedence for `responseJSONSchema`.
+    if let responseJSONSchema = overrideConfig.responseJSONSchema {
+      config.responseJSONSchema = responseJSONSchema
+      config.responseSchema = nil
+    } else if let responseSchema = overrideConfig.responseSchema {
+      config.responseSchema = responseSchema
+      config.responseJSONSchema = nil
+    }
+
+    return config
+  }
 }
 
 // MARK: - Codable Conformances