template to templateID

Author: paulb777

FirebaseAI/Sources/TemplateChatSession.swift

@@ -18,12 +18,12 @@ import Foundation
 @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
-  private let template: String
+  private let templateID: String
   private let _history: History
 
-  init(model: TemplateGenerativeModel, template: String, history: [ModelContent]) {
+  init(model: TemplateGenerativeModel, templateID: String, history: [ModelContent]) {
     self.model = model
-    self.template = template
+    self.templateID = templateID
     _history = History(history: history)
   }
 
@@ -45,7 +45,7 @@ public final class TemplateChatSession: Sendable {
     let newContent = populateContentRole(ModelContent(parts: message.partsValue))
     let response = try await model.generateContentWithHistory(
       history: _history.history + [newContent],
-      template: template,
+      template: templateID,
       inputs: templateInputs,
       options: options
     )
@@ -64,7 +64,7 @@ public final class TemplateChatSession: Sendable {
     let newContent = populateContentRole(ModelContent(parts: message.partsValue))
     let stream = try model.generateContentStreamWithHistory(
       history: _history.history + [newContent],
-      template: template,
+      template: templateID,
       inputs: templateInputs,
       options: options
     )

FirebaseAI/Sources/TemplateGenerativeModel.swift

@@ -29,18 +29,18 @@ public final class TemplateGenerativeModel: Sendable {
   /// Generates content from a prompt template and inputs.
   ///
   /// - Parameters:
-  ///   - template: The prompt template to use.
-  ///   - variables: A dictionary of variables to substitute into the template.
+  ///   - templateID: The ID of the prompt template to use.
+  ///   - inputs: A dictionary of variables to substitute into the template.
   /// - Returns: The content generated by the model.
   /// - Throws: A ``GenerateContentError`` if the request failed.
-  public func generateContent(template: String,
+  public func generateContent(templateID: String,
                               inputs: [String: Any],
                               options: RequestOptions = RequestOptions()) async throws
     -> GenerateContentResponse {
     let templateInputs = try inputs.mapValues { try TemplateInput(value: $0) }
     return try await generateContentWithHistory(
       history: [],
-      template: template,
+      template: templateID,
       inputs: templateInputs,
       options: options
     )
@@ -51,7 +51,7 @@ public final class TemplateGenerativeModel: Sendable {
   /// - Parameters:
   ///   - history: The conversation history to use.
   ///   - template: The prompt template to use.
-  ///   - variables: A dictionary of variables to substitute into the template.
+  ///   - inputs: A dictionary of variables to substitute into the template.
   /// - Returns: The content generated by the model.
   /// - Throws: A ``GenerateContentError`` if the request failed.
   func generateContentWithHistory(history: [ModelContent], template: String,
@@ -72,13 +72,20 @@ public final class TemplateGenerativeModel: Sendable {
     return response
   }
 
-  public func generateContentStream(template: String,
+  /// Generates content from a prompt template and inputs, with streaming responses.
+  ///
+  /// - Parameters:
+  ///   - templateID: The ID of the prompt template to use.
+  ///   - inputs: A dictionary of variables to substitute into the template.
+  /// - Returns: An `AsyncThrowingStream` that yields `GenerateContentResponse` objects.
+  /// - Throws: A ``GenerateContentError`` if the request failed.
+  public func generateContentStream(templateID: String,
                                     inputs: [String: Any],
                                     options: RequestOptions = RequestOptions()) throws
     -> AsyncThrowingStream<GenerateContentResponse, Error> {
     let templateInputs = try inputs.mapValues { try TemplateInput(value: $0) }
     let request = TemplateGenerateContentRequest(
-      template: template,
+      template: templateID,
       inputs: templateInputs,
       history: [],
       projectID: generativeAIService.firebaseInfo.projectID,
@@ -108,14 +115,14 @@ public final class TemplateGenerativeModel: Sendable {
   /// Creates a new chat conversation using this model with the provided history and template.
   ///
   /// - Parameters:
-  ///   - template: The prompt template to use.
+  ///   - templateID: The ID of the prompt template to use.
   ///   - history: The conversation history to use.
   /// - Returns: A new ``TemplateChatSession`` instance.
-  public func startChat(template: String,
+  public func startChat(templateID: String,
                         history: [ModelContent] = []) -> TemplateChatSession {
     return TemplateChatSession(
       model: self,
-      template: template,
+      templateID: templateID,
       history: history
     )
   }

FirebaseAI/Sources/TemplateImagenModel.swift

@@ -34,14 +34,14 @@ public final class TemplateImagenModel: Sendable {
   ///   - variables: A dictionary of variables to substitute into the template.
   /// - Returns: The images generated by the model.
   /// - Throws: An error if the request failed.
-  public func generateImages(template: String,
+  public func generateImages(templateID: String,
                              inputs: [String: Any],
                              options: RequestOptions = RequestOptions()) async throws
     -> ImagenGenerationResponse<ImagenInlineImage> {
     let templateInputs = try inputs.mapValues { try TemplateInput(value: $0) }
     let projectID = generativeAIService.firebaseInfo.projectID
     let request = TemplateGenerateImagesRequest(
-      template: template,
+      template: templateID,
       inputs: templateInputs,
       projectID: projectID,
       apiConfig: apiConfig,

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

@@ -33,7 +33,7 @@ struct ServerPromptTemplateIntegrationTests {
     let model = FirebaseAI.componentInstance(config).templateGenerativeModel()
     let userName = "paul"
     let response = try await model.generateContent(
-      template: "greeting4",
+      templateID: "greeting4",
       inputs: [
         "name": userName,
         "language": "Spanish",
@@ -51,7 +51,7 @@ struct ServerPromptTemplateIntegrationTests {
     let model = FirebaseAI.componentInstance(config).templateGenerativeModel()
     let userName = "paul"
     let stream = try model.generateContentStream(
-      template: "greeting2",
+      templateID: "greeting2",
       inputs: [
         "name": userName,
         "language": "English",
@@ -74,7 +74,7 @@ struct ServerPromptTemplateIntegrationTests {
     let imagenModel = FirebaseAI.componentInstance(config).templateImagenModel()
     let imagenPrompt = "A cat picture"
     let response = try await imagenModel.generateImages(
-      template: "generate-images2",
+      templateID: "generate-images2",
       variables: [
         "prompt": imagenPrompt,
       ]
@@ -96,7 +96,7 @@ struct ServerPromptTemplateIntegrationTests {
     let base64Image = imageBytes.base64EncodedString()
 
     let response = try await model.generateContent(
-      template: "media",
+      templateID: "media",
       inputs: [
         "imageData": [
           "isInline": true,
@@ -123,7 +123,7 @@ struct ServerPromptTemplateIntegrationTests {
     let base64Image = imageBytes.base64EncodedString()
 
     let stream = try model.generateContentStream(
-      template: "media.prompt",
+      templateID: "media.prompt",
       inputs: [
         "imageData": [
           "isInline": true,
@@ -151,7 +151,7 @@ struct ServerPromptTemplateIntegrationTests {
       ModelContent(role: "user", parts: "Hello!"),
       ModelContent(role: "model", parts: "Hi there! How can I help?"),
     ]
-    let chatSession = model.startChat(template: "chat-history", history: initialHistory)
+    let chatSession = model.startChat(templateID: "chat-history", history: initialHistory)
 
     let userMessage = "What's the weather like?"
 
@@ -173,13 +173,13 @@ struct ServerPromptTemplateIntegrationTests {
       ModelContent(role: "user", parts: "Hello!"),
       ModelContent(role: "model", parts: "Hi there! How can I help?"),
     ]
-    let chatSession = model.startChat(template: "chat_history.prompt", history: initialHistory)
+    let chatSession = model.startChat(templateID: "chat_history.prompt", history: initialHistory)
 
     let userMessage = "What's the weather like?"
 
     let stream = try chatSession.sendMessageStream(
       userMessage,
-      variables: ["message": userMessage]
+      inputs: ["message": userMessage]
     )
     var resultText = ""
     for try await response in stream {

FirebaseAI/Tests/Unit/TemplateChatSessionTests.swift

@@ -42,7 +42,7 @@ final class TemplateChatSessionTests: XCTestCase {
       subdirectory: "mock-responses/googleai",
       isTemplateRequest: true
     )
-    let chat = model.startChat(template: "test-template")
+    let chat = model.startChat(templateID: "test-template")
     let response = try await chat.sendMessage("Hello", inputs: ["name": "test"])
     XCTAssertEqual(chat.history.count, 2)
     XCTAssertEqual(chat.history[0].role, "user")
@@ -62,7 +62,7 @@ final class TemplateChatSessionTests: XCTestCase {
       subdirectory: "mock-responses/googleai",
       isTemplateRequest: true
     )
-    let chat = model.startChat(template: "test-template")
+    let chat = model.startChat(templateID: "test-template")
     let stream = try chat.sendMessageStream("Hello", inputs: ["name": "test"])
 
     let content = try await GenerativeModelTestUtil.collectTextFromStream(stream)

FirebaseAI/Tests/Unit/TemplateGenerativeModelTests.swift

@@ -44,7 +44,7 @@ final class TemplateGenerativeModelTests: XCTestCase {
     )
 
     let response = try await model.generateContent(
-      template: "test-template",
+      templateID: "test-template",
       inputs: ["name": "test"]
     )
     XCTAssertEqual(
@@ -62,7 +62,7 @@ final class TemplateGenerativeModelTests: XCTestCase {
     )
 
     let stream = try model.generateContentStream(
-      template: "test-template",
+      templateID: "test-template",
       inputs: ["name": "test"]
     )
 

FirebaseAI/Tests/Unit/TemplateImagenModelTests.swift

@@ -43,7 +43,7 @@ final class TemplateImagenModelTests: XCTestCase {
     )
 
     let response = try await model.generateImages(
-      template: "test-template",
+      templateID: "test-template",
       inputs: ["prompt": "a cat picture"]
     )
     XCTAssertEqual(response.images.count, 4)