Rename template variables to template inputs

Author: paulb777

FirebaseAI/Sources/TemplateChatSession.swift

@@ -38,15 +38,15 @@ public final class TemplateChatSession: Sendable {
 
   /// Sends a message to the model and returns the response.
   public func sendMessage(_ message: any PartsRepresentable,
-                          variables: [String: Any],
+                          inputs: [String: Any],
                           options: RequestOptions = RequestOptions()) async throws
     -> GenerateContentResponse {
-    let templateVariables = try variables.mapValues { try TemplateVariable(value: $0) }
+    let templateInputs = try inputs.mapValues { try TemplateInput(value: $0) }
     let newContent = populateContentRole(ModelContent(parts: message.partsValue))
     let response = try await model.generateContentWithHistory(
       history: _history.history + [newContent],
       template: template,
-      variables: templateVariables,
+      inputs: templateInputs,
       options: options
     )
     _history.append(newContent)
@@ -57,15 +57,15 @@ public final class TemplateChatSession: Sendable {
   }
 
   public func sendMessageStream(_ message: any PartsRepresentable,
-                                variables: [String: Any],
+                                inputs: [String: Any],
                                 options: RequestOptions = RequestOptions()) throws
     -> AsyncThrowingStream<GenerateContentResponse, Error> {
-    let templateVariables = try variables.mapValues { try TemplateVariable(value: $0) }
+    let templateInputs = try inputs.mapValues { try TemplateInput(value: $0) }
     let newContent = populateContentRole(ModelContent(parts: message.partsValue))
     let stream = try model.generateContentStreamWithHistory(
       history: _history.history + [newContent],
       template: template,
-      variables: templateVariables,
+      inputs: templateInputs,
       options: options
     )
     return AsyncThrowingStream { continuation in

FirebaseAI/Sources/TemplateGenerateContentRequest.swift

@@ -17,7 +17,7 @@ import Foundation
 @available(iOS 15.0, macOS 12.0, macCatalyst 15.0, tvOS 15.0, watchOS 8.0, *)
 struct TemplateGenerateContentRequest: Sendable {
   let template: String
-  let variables: [String: TemplateVariable]
+  let inputs: [String: TemplateInput]
   let history: [ModelContent]
   let projectID: String
   let stream: Bool
@@ -28,13 +28,13 @@ struct TemplateGenerateContentRequest: Sendable {
 @available(iOS 15.0, macOS 12.0, macCatalyst 15.0, tvOS 15.0, watchOS 8.0, *)
 extension TemplateGenerateContentRequest: Encodable {
   enum CodingKeys: String, CodingKey {
-    case variables = "inputs"
+    case inputs
     case history
   }
 
   func encode(to encoder: any Encoder) throws {
     var container = encoder.container(keyedBy: CodingKeys.self)
-    try container.encode(variables, forKey: .variables)
+    try container.encode(inputs, forKey: .inputs)
     try container.encode(history, forKey: .history)
   }
 }

FirebaseAI/Sources/TemplateGenerateImagesRequest.swift

@@ -33,24 +33,24 @@ class TemplateGenerateImagesRequest: @unchecked Sendable, GenerativeAIRequest {
   let apiConfig: APIConfig
 
   let template: String
-  let variables: [String: TemplateVariable]
+  let inputs: [String: TemplateInput]
   let projectID: String
 
-  init(template: String, variables: [String: TemplateVariable], projectID: String,
+  init(template: String, inputs: [String: TemplateInput], projectID: String,
        apiConfig: APIConfig, options: RequestOptions) {
     self.apiConfig = apiConfig
     self.options = options
     self.template = template
-    self.variables = variables
+    self.inputs = inputs
     self.projectID = projectID
   }
 
   enum CodingKeys: String, CodingKey {
-    case variables = "inputs"
+    case inputs
   }
 
   func encode(to encoder: Encoder) throws {
     var container = encoder.container(keyedBy: CodingKeys.self)
-    try container.encode(variables, forKey: .variables)
+    try container.encode(inputs, forKey: .inputs)
   }
 }

FirebaseAI/Sources/TemplateGenerativeModel.swift

@@ -26,27 +26,27 @@ public final class TemplateGenerativeModel: Sendable {
     self.apiConfig = apiConfig
   }
 
-  /// Generates content from a prompt template and variables.
+  /// 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.
   /// - Returns: The content generated by the model.
   /// - Throws: A ``GenerateContentError`` if the request failed.
   public func generateContent(template: String,
-                              variables: [String: Any],
+                              inputs: [String: Any],
                               options: RequestOptions = RequestOptions()) async throws
     -> GenerateContentResponse {
-    let templateVariables = try variables.mapValues { try TemplateVariable(value: $0) }
+    let templateInputs = try inputs.mapValues { try TemplateInput(value: $0) }
     return try await generateContentWithHistory(
       history: [],
       template: template,
-      variables: templateVariables,
+      inputs: templateInputs,
       options: options
     )
   }
 
-  /// Generates content from a prompt template, variables, and history.
+  /// Generates content from a prompt template, inputs, and history.
   ///
   /// - Parameters:
   ///   - history: The conversation history to use.
@@ -55,12 +55,12 @@ public final class TemplateGenerativeModel: Sendable {
   /// - Returns: The content generated by the model.
   /// - Throws: A ``GenerateContentError`` if the request failed.
   func generateContentWithHistory(history: [ModelContent], template: String,
-                                  variables: [String: TemplateVariable],
+                                  inputs: [String: TemplateInput],
                                   options: RequestOptions = RequestOptions()) async throws
     -> GenerateContentResponse {
     let request = TemplateGenerateContentRequest(
       template: template,
-      variables: variables,
+      inputs: inputs,
       history: history,
       projectID: generativeAIService.firebaseInfo.projectID,
       stream: false,
@@ -73,13 +73,13 @@ public final class TemplateGenerativeModel: Sendable {
   }
 
   public func generateContentStream(template: String,
-                                    variables: [String: Any],
+                                    inputs: [String: Any],
                                     options: RequestOptions = RequestOptions()) throws
     -> AsyncThrowingStream<GenerateContentResponse, Error> {
-    let templateVariables = try variables.mapValues { try TemplateVariable(value: $0) }
+    let templateInputs = try inputs.mapValues { try TemplateInput(value: $0) }
     let request = TemplateGenerateContentRequest(
       template: template,
-      variables: templateVariables,
+      inputs: templateInputs,
       history: [],
       projectID: generativeAIService.firebaseInfo.projectID,
       stream: true,
@@ -90,12 +90,12 @@ public final class TemplateGenerativeModel: Sendable {
   }
 
   func generateContentStreamWithHistory(history: [ModelContent], template: String,
-                                        variables: [String: TemplateVariable],
+                                        inputs: [String: TemplateInput],
                                         options: RequestOptions = RequestOptions()) throws
     -> AsyncThrowingStream<GenerateContentResponse, Error> {
     let request = TemplateGenerateContentRequest(
       template: template,
-      variables: variables,
+      inputs: inputs,
       history: history,
       projectID: generativeAIService.firebaseInfo.projectID,
       stream: true,

FirebaseAI/Sources/TemplateImagenModel.swift

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

FirebaseAI/Sources/TemplateVariable.swift renamed to FirebaseAI/Sources/TemplateInput.swift

@@ -14,13 +14,13 @@
 
 import Foundation
 
-enum TemplateVariable: Encodable, Sendable {
+enum TemplateInput: Encodable, Sendable {
   case string(String)
   case int(Int)
   case double(Double)
   case bool(Bool)
-  case array([TemplateVariable])
-  case dictionary([String: TemplateVariable])
+  case array([TemplateInput])
+  case dictionary([String: TemplateInput])
 
   init(value: Any) throws {
     switch value {
@@ -35,9 +35,9 @@ enum TemplateVariable: Encodable, Sendable {
     case let value as Bool:
       self = .bool(value)
     case let value as [Any]:
-      self = try .array(value.map { try TemplateVariable(value: $0) })
+      self = try .array(value.map { try TemplateInput(value: $0) })
     case let value as [String: Any]:
-      self = try .dictionary(value.mapValues { try TemplateVariable(value: $0) })
+      self = try .dictionary(value.mapValues { try TemplateInput(value: $0) })
     default:
       throw EncodingError.invalidValue(
         value,

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

@@ -33,8 +33,8 @@ struct ServerPromptTemplateIntegrationTests {
     let model = FirebaseAI.componentInstance(config).templateGenerativeModel()
     let userName = "paul"
     let response = try await model.generateContent(
-      template: "greeting2",
-      variables: [
+      template: "greeting4",
+      inputs: [
         "name": userName,
         "language": "Spanish",
       ]
@@ -43,13 +43,16 @@ struct ServerPromptTemplateIntegrationTests {
     #expect(text.contains("Paul"))
   }
 
-  @Test(arguments: testConfigs)
+  @Test(arguments: [
+    // The "greeting2" template is only available in the `global` location.
+    InstanceConfig.vertexAI_v1beta_global,
+  ])
   func generateContentStream(_ config: InstanceConfig) async throws {
     let model = FirebaseAI.componentInstance(config).templateGenerativeModel()
     let userName = "paul"
     let stream = try model.generateContentStream(
-      template: "greeting.prompt",
-      variables: [
+      template: "greeting2",
+      inputs: [
         "name": userName,
         "language": "English",
       ]
@@ -93,8 +96,8 @@ struct ServerPromptTemplateIntegrationTests {
     let base64Image = imageBytes.base64EncodedString()
 
     let response = try await model.generateContent(
-      template: "media.prompt",
-      variables: [
+      template: "media",
+      inputs: [
         "imageData": [
           "isInline": true,
           "mimeType": "image/jpeg",
@@ -121,7 +124,7 @@ struct ServerPromptTemplateIntegrationTests {
 
     let stream = try model.generateContentStream(
       template: "media.prompt",
-      variables: [
+      inputs: [
         "imageData": [
           "isInline": true,
           "mimeType": "image/jpeg",
@@ -138,14 +141,17 @@ struct ServerPromptTemplateIntegrationTests {
     #expect(!resultText.isEmpty)
   }
 
-  @Test(arguments: testConfigs)
+  @Test(arguments: [
+    // The "greeting2" template is only available in the `global` location.
+    InstanceConfig.vertexAI_v1beta_global,
+  ])
   func chat(_ config: InstanceConfig) async throws {
     let model = FirebaseAI.componentInstance(config).templateGenerativeModel()
     let initialHistory = [
       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(template: "chat-history", history: initialHistory)
 
     let userMessage = "What's the weather like?"
 

FirebaseAI/Tests/Unit/TemplateChatSessionTests.swift

@@ -43,7 +43,7 @@ final class TemplateChatSessionTests: XCTestCase {
       isTemplateRequest: true
     )
     let chat = model.startChat(template: "test-template")
-    let response = try await chat.sendMessage("Hello", variables: ["name": "test"])
+    let response = try await chat.sendMessage("Hello", inputs: ["name": "test"])
     XCTAssertEqual(chat.history.count, 2)
     XCTAssertEqual(chat.history[0].role, "user")
     XCTAssertEqual((chat.history[0].parts.first as? TextPart)?.text, "Hello")
@@ -63,7 +63,7 @@ final class TemplateChatSessionTests: XCTestCase {
       isTemplateRequest: true
     )
     let chat = model.startChat(template: "test-template")
-    let stream = try chat.sendMessageStream("Hello", variables: ["name": "test"])
+    let stream = try chat.sendMessageStream("Hello", inputs: ["name": "test"])
 
     let content = try await GenerativeModelTestUtil.collectTextFromStream(stream)
 

FirebaseAI/Tests/Unit/TemplateGenerativeModelTests.swift

@@ -45,7 +45,7 @@ final class TemplateGenerativeModelTests: XCTestCase {
 
     let response = try await model.generateContent(
       template: "test-template",
-      variables: ["name": "test"]
+      inputs: ["name": "test"]
     )
     XCTAssertEqual(
       response.text,
@@ -63,7 +63,7 @@ final class TemplateGenerativeModelTests: XCTestCase {
 
     let stream = try model.generateContentStream(
       template: "test-template",
-      variables: ["name": "test"]
+      inputs: ["name": "test"]
     )
 
     let content = try await GenerativeModelTestUtil.collectTextFromStream(stream)

FirebaseAI/Tests/Unit/TemplateImagenModelTests.swift

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