doc updates

Author: paulb777

FirebaseAI/Sources/TemplateChatSession.swift

@@ -15,6 +15,8 @@
 import Foundation
 
 /// A chat session that allows for conversation with a model.
+///
+/// **Public Preview**: This API is a public preview and may be subject to change.
 @available(iOS 15.0, macOS 12.0, macCatalyst 15.0, tvOS 15.0, watchOS 8.0, *)
 public final class TemplateChatSession: Sendable {
   private let model: TemplateGenerativeModel
@@ -37,6 +39,15 @@ public final class TemplateChatSession: Sendable {
   }
 
   /// Sends a message to the model and returns the response.
+  ///
+  /// **Public Preview**: This API is a public preview and may be subject to change.
+  ///
+  /// - Parameters:
+  ///   - message: The message to send to the model.
+  ///   - inputs: A dictionary of variables to substitute into the template.
+  ///   - options: The ``RequestOptions`` for the request, currently used to override default request timeout.
+  /// - Returns: The content generated by the model.
+  /// - Throws: A ``GenerateContentError`` if the request failed.
   public func sendMessage(_ message: any PartsRepresentable,
                           inputs: [String: Any],
                           options: RequestOptions = RequestOptions()) async throws
@@ -56,6 +67,16 @@ public final class TemplateChatSession: Sendable {
     return response
   }
 
+  /// Sends a message to the model and returns the response as a stream of `GenerateContentResponse`s.
+  ///
+  /// **Public Preview**: This API is a public preview and may be subject to change.
+  ///
+  /// - Parameters:
+  ///   - message: The message to send to the model.
+  ///   - inputs: A dictionary of variables to substitute into the template.
+  ///   - options: The ``RequestOptions`` for the request, currently used to override default request timeout.
+  /// - Returns: An `AsyncThrowingStream` that yields `GenerateContentResponse` objects.
+  /// - Throws: A ``GenerateContentError`` if the request failed.
   public func sendMessageStream(_ message: any PartsRepresentable,
                                 inputs: [String: Any],
                                 options: RequestOptions = RequestOptions()) throws

FirebaseAI/Sources/TemplateGenerativeModel.swift

@@ -16,6 +16,8 @@ import Foundation
 
 /// A type that represents a remote multimodal model (like Gemini), with the ability to generate
 /// content based on various input types.
+///
+/// **Public Preview**: This API is a public preview and may be subject to change.
 @available(iOS 15.0, macOS 12.0, macCatalyst 15.0, tvOS 15.0, watchOS 8.0, *)
 public final class TemplateGenerativeModel: Sendable {
   let generativeAIService: GenerativeAIService
@@ -28,9 +30,12 @@ public final class TemplateGenerativeModel: Sendable {
 
   /// Generates content from a prompt template and inputs.
   ///
+  /// **Public Preview**: This API is a public preview and may be subject to change.
+  ///
   /// - Parameters:
   ///   - templateID: The ID of the prompt template to use.
   ///   - inputs: A dictionary of variables to substitute into the template.
+  ///   - options: The ``RequestOptions`` for the request, currently used to override default request timeout.
   /// - Returns: The content generated by the model.
   /// - Throws: A ``GenerateContentError`` if the request failed.
   public func generateContent(templateID: String,
@@ -74,9 +79,12 @@ public final class TemplateGenerativeModel: Sendable {
 
   /// Generates content from a prompt template and inputs, with streaming responses.
   ///
+  /// **Public Preview**: This API is a public preview and may be subject to change.
+  ///
   /// - Parameters:
   ///   - templateID: The ID of the prompt template to use.
   ///   - inputs: A dictionary of variables to substitute into the template.
+  ///   - options: The ``RequestOptions`` for the request, currently used to override default request timeout.
   /// - Returns: An `AsyncThrowingStream` that yields `GenerateContentResponse` objects.
   /// - Throws: A ``GenerateContentError`` if the request failed.
   public func generateContentStream(templateID: String,

FirebaseAI/Sources/TemplateImagenModel.swift

@@ -17,6 +17,8 @@ import Foundation
 /// A type that represents a remote image generation model (like Imagen), with the ability to
 /// generate
 /// images based on various input types.
+///
+/// **Public Preview**: This API is a public preview and may be subject to change.
 @available(iOS 15.0, macOS 12.0, macCatalyst 15.0, tvOS 15.0, watchOS 8.0, *)
 public final class TemplateImagenModel: Sendable {
   let generativeAIService: GenerativeAIService
@@ -32,6 +34,7 @@ public final class TemplateImagenModel: Sendable {
   /// - Parameters:
   ///   - template: The prompt template to use.
   ///   - variables: A dictionary of variables to substitute into the template.
+  ///   - options: The ``RequestOptions`` for the request, currently used to override default request timeout.
   /// - Returns: The images generated by the model.
   /// - Throws: An error if the request failed.
   public func generateImages(templateID: String,

FirebaseAI/Tests/TestApp/Tests/Integration/ServerPromptTemplateIntegrationTests.swift

@@ -75,7 +75,7 @@ struct ServerPromptTemplateIntegrationTests {
     let imagenPrompt = "A cat picture"
     let response = try await imagenModel.generateImages(
       templateID: "generate-images2",
-      variables: [
+      inputs: [
         "prompt": imagenPrompt,
       ]
     )
@@ -157,7 +157,7 @@ struct ServerPromptTemplateIntegrationTests {
 
     let response = try await chatSession.sendMessage(
       userMessage,
-      variables: ["message": userMessage]
+      inputs: ["message": userMessage]
     )
     let text = try #require(response.text)
     #expect(!text.isEmpty)