Renames for console logging (#14776)

Author: paulb777

FirebaseAI/Sources/VertexLog.swift renamed to FirebaseAI/Sources/AILog.swift

@@ -17,8 +17,8 @@ import os.log
 
 internal import FirebaseCoreExtension
 
-enum VertexLog {
-  /// Log message codes for the Vertex AI SDK
+enum AILog {
+  /// Log message codes for the Firebase AI SDK
   ///
   /// These codes should ideally not be re-used in order to facilitate matching error codes in
   /// support requests to lines in the SDK. These codes should range between 0 and 999999 to avoid
@@ -75,10 +75,10 @@ enum VertexLog {
   /// Subsystem that should be used for all Loggers.
   static let subsystem = "com.google.firebase"
 
-  /// Log identifier for the Vertex AI SDK.
+  /// Log identifier for the AI SDK.
   ///
   /// > Note: This corresponds to the `category` in `OSLog`.
-  static let service = "[FirebaseVertexAI]"
+  static let service = "[FirebaseAI]"
 
   /// The raw `OSLog` log object.
   ///
@@ -92,7 +92,7 @@ enum VertexLog {
     let messageCode = String(format: "I-VTX%06d", code.rawValue)
     FirebaseLogger.log(
       level: level,
-      service: VertexLog.service,
+      service: AILog.service,
       code: messageCode,
       message: message
     )

FirebaseAI/Sources/FirebaseAI.swift

@@ -73,7 +73,7 @@ public final class FirebaseAI: Sendable {
                               requestOptions: RequestOptions = RequestOptions())
     -> GenerativeModel {
     if !modelName.starts(with: GenerativeModel.geminiModelNamePrefix) {
-      VertexLog.warning(code: .unsupportedGeminiModel, """
+      AILog.warning(code: .unsupportedGeminiModel, """
       Unsupported Gemini model "\(modelName)"; see \
       https://firebase.google.com/docs/vertex-ai/models for a list supported Gemini model names.
       """)
@@ -113,7 +113,7 @@ public final class FirebaseAI: Sendable {
                           safetySettings: ImagenSafetySettings? = nil,
                           requestOptions: RequestOptions = RequestOptions()) -> ImagenModel {
     if !modelName.starts(with: ImagenModel.imagenModelNamePrefix) {
-      VertexLog.warning(code: .unsupportedImagenModel, """
+      AILog.warning(code: .unsupportedImagenModel, """
       Unsupported Imagen model "\(modelName)"; see \
       https://firebase.google.com/docs/vertex-ai/models for a list supported Imagen model names.
       """)

FirebaseAI/Sources/GenerateContentResponse.swift

@@ -49,7 +49,7 @@ public struct GenerateContentResponse: Sendable {
   /// The response's content as text, if it exists.
   public var text: String? {
     guard let candidate = candidates.first else {
-      VertexLog.error(
+      AILog.error(
         code: .generateContentResponseNoCandidates,
         "Could not get text from a response that had no candidates."
       )
@@ -64,7 +64,7 @@ public struct GenerateContentResponse: Sendable {
       }
     }
     guard textValues.count > 0 else {
-      VertexLog.error(
+      AILog.error(
         code: .generateContentResponseNoText,
         "Could not get a text part from the first candidate."
       )
@@ -91,7 +91,7 @@ public struct GenerateContentResponse: Sendable {
   /// Returns inline data parts found in any `Part`s of the first candidate of the response, if any.
   public var inlineDataParts: [InlineDataPart] {
     guard let candidate = candidates.first else {
-      VertexLog.error(code: .generateContentResponseNoCandidates, """
+      AILog.error(code: .generateContentResponseNoCandidates, """
       Could not get inline data parts because the response has no candidates. The accessor only \
       checks the first candidate.
       """)
@@ -219,7 +219,7 @@ public struct FinishReason: DecodableProtoEnum, Hashable, Sendable {
   public let rawValue: String
 
   static let unrecognizedValueMessageCode =
-    VertexLog.MessageCode.generateContentResponseUnrecognizedFinishReason
+    AILog.MessageCode.generateContentResponseUnrecognizedFinishReason
 }
 
 /// A metadata struct containing any feedback the model had on the prompt it was provided.
@@ -254,7 +254,7 @@ public struct PromptFeedback: Sendable {
     public let rawValue: String
 
     static let unrecognizedValueMessageCode =
-      VertexLog.MessageCode.generateContentResponseUnrecognizedBlockReason
+      AILog.MessageCode.generateContentResponseUnrecognizedBlockReason
   }
 
   /// The reason a prompt was blocked, if it was blocked.
@@ -428,7 +428,7 @@ extension Citation: Decodable {
     ) {
       publicationDate = publicationProtoDate.dateComponents
       if let publicationDate, !publicationDate.isValidDate {
-        VertexLog.warning(
+        AILog.warning(
           code: .decodedInvalidCitationPublicationDate,
           "Decoded an invalid citation publication date: \(publicationDate)"
         )

FirebaseAI/Sources/GenerativeAIService.swift

@@ -50,12 +50,12 @@ struct GenerativeAIService {
 
     // Verify the status code is 200
     guard response.statusCode == 200 else {
-      VertexLog.error(
+      AILog.error(
         code: .loadRequestResponseError,
         "The server responded with an error: \(response)"
       )
       if let responseString = String(data: data, encoding: .utf8) {
-        VertexLog.error(
+        AILog.error(
           code: .loadRequestResponseErrorPayload,
           "Response payload: \(responseString)"
         )
@@ -104,7 +104,7 @@ struct GenerativeAIService {
 
         // Verify the status code is 200
         guard response.statusCode == 200 else {
-          VertexLog.error(
+          AILog.error(
             code: .loadRequestStreamResponseError,
             "The server responded with an error: \(response)"
           )
@@ -113,7 +113,7 @@ struct GenerativeAIService {
             responseBody += line + "\n"
           }
 
-          VertexLog.error(
+          AILog.error(
             code: .loadRequestStreamResponseErrorPayload,
             "Response payload: \(responseBody)"
           )
@@ -128,7 +128,7 @@ struct GenerativeAIService {
         let decoder = JSONDecoder()
         decoder.keyDecodingStrategy = .convertFromSnakeCase
         for try await line in stream.lines {
-          VertexLog.debug(code: .loadRequestStreamResponseLine, "Stream response: \(line)")
+          AILog.debug(code: .loadRequestStreamResponseLine, "Stream response: \(line)")
 
           if line.hasPrefix("data:") {
             // We can assume 5 characters since it's utf-8 encoded, removing `data:`.
@@ -180,7 +180,7 @@ struct GenerativeAIService {
       let tokenResult = await appCheck.getToken(forcingRefresh: false)
       urlRequest.setValue(tokenResult.token, forHTTPHeaderField: "X-Firebase-AppCheck")
       if let error = tokenResult.error {
-        VertexLog.error(
+        AILog.error(
           code: .appCheckTokenFetchFailed,
           "Failed to fetch AppCheck token. Error: \(error)"
         )
@@ -212,7 +212,7 @@ struct GenerativeAIService {
     // response objects you get back from the URLSession, NSURLConnection, or NSURLDownload class
     // are instances of the HTTPURLResponse class."
     guard let response = urlResponse as? HTTPURLResponse else {
-      VertexLog.error(
+      AILog.error(
         code: .generativeAIServiceNonHTTPResponse,
         "Response wasn't an HTTP response, internal error \(urlResponse)"
       )
@@ -260,8 +260,8 @@ struct GenerativeAIService {
   private func logRPCError(_ error: BackendError) {
     let projectID = firebaseInfo.projectID
     if error.isVertexAIInFirebaseServiceDisabledError() {
-      VertexLog.error(code: .vertexAIInFirebaseAPIDisabled, """
-      The Vertex AI in Firebase SDK requires the Vertex AI in Firebase API \
+      AILog.error(code: .vertexAIInFirebaseAPIDisabled, """
+      The Firebase AI SDK requires the Firebase AI API \
       (`firebasevertexai.googleapis.com`) to be enabled in your Firebase project. Enable this API \
       by visiting the Firebase Console at
       https://console.firebase.google.com/project/\(projectID)/genai/ and clicking "Get started". \
@@ -276,9 +276,9 @@ struct GenerativeAIService {
       return try JSONDecoder().decode(type, from: data)
     } catch {
       if let json = String(data: data, encoding: .utf8) {
-        VertexLog.error(code: .loadRequestParseResponseFailedJSON, "JSON response: \(json)")
+        AILog.error(code: .loadRequestParseResponseFailedJSON, "JSON response: \(json)")
       }
-      VertexLog.error(
+      AILog.error(
         code: .loadRequestParseResponseFailedJSONError,
         "Error decoding server JSON: \(error)"
       )
@@ -307,12 +307,12 @@ struct GenerativeAIService {
     }
 
     private func printCURLCommand(from request: URLRequest) {
-      guard VertexLog.additionalLoggingEnabled() else {
+      guard AILog.additionalLoggingEnabled() else {
         return
       }
       let command = cURLCommand(from: request)
-      os_log(.debug, log: VertexLog.logObject, """
-      \(VertexLog.service) Creating request with the equivalent cURL command:
+      os_log(.debug, log: AILog.logObject, """
+      \(AILog.service) Creating request with the equivalent cURL command:
       ----- cURL command -----
       \(command, privacy: .private)
       ------------------------

FirebaseAI/Sources/GenerativeModel.swift

@@ -104,15 +104,15 @@ public final class GenerativeModel: Sendable {
     }
     self.requestOptions = requestOptions
 
-    if VertexLog.additionalLoggingEnabled() {
-      VertexLog.debug(code: .verboseLoggingEnabled, "Verbose logging enabled.")
+    if AILog.additionalLoggingEnabled() {
+      AILog.debug(code: .verboseLoggingEnabled, "Verbose logging enabled.")
     } else {
-      VertexLog.info(code: .verboseLoggingDisabled, """
+      AILog.info(code: .verboseLoggingDisabled, """
       [FirebaseVertexAI] To enable additional logging, add \
-      `\(VertexLog.enableArgumentKey)` as a launch argument in Xcode.
+      `\(AILog.enableArgumentKey)` as a launch argument in Xcode.
       """)
     }
-    VertexLog.debug(code: .generativeModelInitialized, "Model \(modelResourceName) initialized.")
+    AILog.debug(code: .generativeModelInitialized, "Model \(modelResourceName) initialized.")
   }
 
   /// Generates content from String and/or image inputs, given to the model as a prompt, that are

FirebaseAI/Sources/ModalityTokenCount.swift

@@ -54,7 +54,7 @@ public struct ContentModality: DecodableProtoEnum, Hashable, Sendable {
   public let rawValue: String
 
   static let unrecognizedValueMessageCode =
-    VertexLog.MessageCode.generateContentResponseUnrecognizedContentModality
+    AILog.MessageCode.generateContentResponseUnrecognizedContentModality
 }
 
 // MARK: Codable Conformances

FirebaseAI/Sources/Protocols/Internal/CodableProtoEnum.swift

@@ -46,8 +46,8 @@ protocol ProtoEnum: Sendable {
 /// Protobuf enums are represented as strings in JSON. A default `Decodable` implementation is
 /// provided when conforming to this type.
 protocol DecodableProtoEnum: ProtoEnum, Decodable {
-  /// Returns the ``VertexLog/MessageCode`` associated with unrecognized (unknown) enum values.
-  static var unrecognizedValueMessageCode: VertexLog.MessageCode { get }
+  /// Returns the ``AILog/MessageCode`` associated with unrecognized (unknown) enum values.
+  static var unrecognizedValueMessageCode: AILog.MessageCode { get }
 
   /// Creates a new instance by decoding from the given decoder.
   ///
@@ -90,7 +90,7 @@ extension DecodableProtoEnum {
     self = Self(rawValue: rawValue)
 
     if Kind(rawValue: rawValue) == nil {
-      VertexLog.error(
+      AILog.error(
         code: Self.unrecognizedValueMessageCode,
         """
         Unrecognized \(Self.self) with value "\(rawValue)":

FirebaseAI/Sources/Safety.swift

@@ -107,7 +107,7 @@ public struct SafetyRating: Equatable, Hashable, Sendable {
     public let rawValue: String
 
     static let unrecognizedValueMessageCode =
-      VertexLog.MessageCode.generateContentResponseUnrecognizedHarmProbability
+      AILog.MessageCode.generateContentResponseUnrecognizedHarmProbability
   }
 
   /// The magnitude of how harmful a model response might be for the respective ``HarmCategory``.
@@ -139,7 +139,7 @@ public struct SafetyRating: Equatable, Hashable, Sendable {
     public let rawValue: String
 
     static let unrecognizedValueMessageCode =
-      VertexLog.MessageCode.generateContentResponseUnrecognizedHarmSeverity
+      AILog.MessageCode.generateContentResponseUnrecognizedHarmSeverity
   }
 }
 
@@ -263,7 +263,7 @@ public struct HarmCategory: CodableProtoEnum, Hashable, Sendable {
   public let rawValue: String
 
   static let unrecognizedValueMessageCode =
-    VertexLog.MessageCode.generateContentResponseUnrecognizedHarmCategory
+    AILog.MessageCode.generateContentResponseUnrecognizedHarmCategory
 }
 
 // MARK: - Codable Conformances

FirebaseAI/Sources/Types/Internal/ProtoDate.swift

@@ -68,7 +68,7 @@ extension ProtoDate: Decodable {
     let container = try decoder.container(keyedBy: CodingKeys.self)
     if let year = try container.decodeIfPresent(Int.self, forKey: .year), year != 0 {
       if year < 0 || year > 9999 {
-        VertexLog.warning(
+        AILog.warning(
           code: .decodedInvalidProtoDateYear,
           """
           Invalid year: \(year); must be from 1 to 9999, or 0 for a date without a specified year.
@@ -82,7 +82,7 @@ extension ProtoDate: Decodable {
 
     if let month = try container.decodeIfPresent(Int.self, forKey: .month), month != 0 {
       if month < 0 || month > 12 {
-        VertexLog.warning(
+        AILog.warning(
           code: .decodedInvalidProtoDateMonth,
           """
           Invalid month: \(month); must be from 1 to 12, or 0 for a year date without a specified \
@@ -97,7 +97,7 @@ extension ProtoDate: Decodable {
 
     if let day = try container.decodeIfPresent(Int.self, forKey: .day), day != 0 {
       if day < 0 || day > 31 {
-        VertexLog.warning(
+        AILog.warning(
           code: .decodedInvalidProtoDateDay,
           "Invalid day: \(day); must be from 1 to 31, or 0 for a date without a specified day."
         )

FirebaseAI/Sources/Types/Public/Imagen/ImagenGenerationResponse.swift

@@ -61,7 +61,7 @@ extension ImagenGenerationResponse: Decodable where T: Decodable {
       } else if let filteredReason = try? predictionsContainer.decode(RAIFilteredReason.self) {
         filteredReasons.append(filteredReason.raiFilteredReason)
       } else if let unsupportedPrediction = try? predictionsContainer.decode(JSONObject.self) {
-        VertexLog.warning(
+        AILog.warning(
           code: .decodedUnsupportedImagenPredictionType,
           "Ignoring unsupported Imagen prediction: \(unsupportedPrediction)"
         )