From 623e54609696f7679b4b3122304795a2d80d93a5 Mon Sep 17 00:00:00 2001
From: Andrew Heard <andrewheard@google.com>
Date: Wed, 8 May 2024 10:36:07 -0400
Subject: [PATCH] [Vertex AI] Make Constants file internal and fix typos

---
 .../Sources/{GenerativeAISwift.swift => Constants.swift}     | 4 ++--
 FirebaseVertexAI/Sources/CountTokensRequest.swift            | 2 +-
 FirebaseVertexAI/Sources/GenerateContentRequest.swift        | 2 +-
 FirebaseVertexAI/Sources/ModelContent.swift                  | 2 +-
 FirebaseVertexAI/Sources/Safety.swift                        | 5 ++---
 FirebaseVertexAI/Sources/VertexAI.swift                      | 2 +-
 6 files changed, 8 insertions(+), 9 deletions(-)
 rename FirebaseVertexAI/Sources/{GenerativeAISwift.swift => Constants.swift} (90%)

diff --git a/FirebaseVertexAI/Sources/GenerativeAISwift.swift b/FirebaseVertexAI/Sources/Constants.swift
similarity index 90%
rename from FirebaseVertexAI/Sources/GenerativeAISwift.swift
rename to FirebaseVertexAI/Sources/Constants.swift
index ddca2368fbb..d23744fee76 100644
--- a/FirebaseVertexAI/Sources/GenerativeAISwift.swift
+++ b/FirebaseVertexAI/Sources/Constants.swift
@@ -18,9 +18,9 @@ import Foundation
   #warning("Only iOS, macOS, and Catalyst targets are currently fully supported.")
 #endif
 
-/// Constants associated with the GenerativeAISwift SDK.
+/// Constants associated with the Vertex AI for Firebase SDK.
 @available(iOS 15.0, macOS 11.0, macCatalyst 15.0, *)
-public enum GenerativeAISwift {
+enum Constants {
   /// The Vertex AI backend endpoint URL.
   static let baseURL = "https://firebaseml.googleapis.com"
 }
diff --git a/FirebaseVertexAI/Sources/CountTokensRequest.swift b/FirebaseVertexAI/Sources/CountTokensRequest.swift
index 8af409329ad..e08566bede9 100644
--- a/FirebaseVertexAI/Sources/CountTokensRequest.swift
+++ b/FirebaseVertexAI/Sources/CountTokensRequest.swift
@@ -26,7 +26,7 @@ extension CountTokensRequest: GenerativeAIRequest {
   typealias Response = CountTokensResponse
 
   var url: URL {
-    URL(string: "\(GenerativeAISwift.baseURL)/\(options.apiVersion)/\(model):countTokens")!
+    URL(string: "\(Constants.baseURL)/\(options.apiVersion)/\(model):countTokens")!
   }
 }
 
diff --git a/FirebaseVertexAI/Sources/GenerateContentRequest.swift b/FirebaseVertexAI/Sources/GenerateContentRequest.swift
index 05abadf54e1..d26e957be1c 100644
--- a/FirebaseVertexAI/Sources/GenerateContentRequest.swift
+++ b/FirebaseVertexAI/Sources/GenerateContentRequest.swift
@@ -45,7 +45,7 @@ extension GenerateContentRequest: GenerativeAIRequest {
   typealias Response = GenerateContentResponse
 
   var url: URL {
-    let modelURL = "\(GenerativeAISwift.baseURL)/\(options.apiVersion)/\(model)"
+    let modelURL = "\(Constants.baseURL)/\(options.apiVersion)/\(model)"
     if isStreaming {
       return URL(string: "\(modelURL):streamGenerateContent?alt=sse")!
     } else {
diff --git a/FirebaseVertexAI/Sources/ModelContent.swift b/FirebaseVertexAI/Sources/ModelContent.swift
index e2980dcd6ea..47acc25c4b9 100644
--- a/FirebaseVertexAI/Sources/ModelContent.swift
+++ b/FirebaseVertexAI/Sources/ModelContent.swift
@@ -19,7 +19,7 @@ import Foundation
 /// may comprise multiple heterogeneous ``ModelContent/Part``s.
 @available(iOS 15.0, macOS 11.0, macCatalyst 15.0, *)
 public struct ModelContent: Equatable {
-  /// A discrete piece of data in a media format intepretable by an AI model. Within a single value
+  /// A discrete piece of data in a media format interpretable by an AI model. Within a single value
   /// of ``Part``, different data types may not mix.
   public enum Part: Equatable {
     /// Text value.
diff --git a/FirebaseVertexAI/Sources/Safety.swift b/FirebaseVertexAI/Sources/Safety.swift
index d2adc4a81e1..0541a609b93 100644
--- a/FirebaseVertexAI/Sources/Safety.swift
+++ b/FirebaseVertexAI/Sources/Safety.swift
@@ -24,9 +24,8 @@ public struct SafetyRating: Equatable, Hashable {
   public let category: SafetySetting.HarmCategory
 
   /// The model-generated probability that a given piece of content falls under the harm category
-  /// described in ``category``. This does not
-  /// indiciate the severity of harm for a piece of content. See ``HarmProbability`` for a list of
-  /// possible values.
+  /// described in ``SafetySetting/HarmCategory``. This does not indicate the severity of harm for a
+  /// piece of content. See ``HarmProbability`` for a list of possible values.
   public let probability: HarmProbability
 
   /// Initializes a new `SafetyRating` instance with the given category and probability.
diff --git a/FirebaseVertexAI/Sources/VertexAI.swift b/FirebaseVertexAI/Sources/VertexAI.swift
index 4198f140b29..2f9b069093b 100644
--- a/FirebaseVertexAI/Sources/VertexAI.swift
+++ b/FirebaseVertexAI/Sources/VertexAI.swift
@@ -20,7 +20,7 @@ import Foundation
 // Avoids exposing internal FirebaseCore APIs to Swift users.
 @_implementationOnly import FirebaseCoreExtension
 
-/// The Vertex AI service for Firebase.
+/// The Vertex AI for Firebase SDK provides access to Gemini models directly from your app.
 @available(iOS 15.0, macOS 11.0, macCatalyst 15.0, *)
 public class VertexAI: NSObject {
   // MARK: - Public APIs