Skip to content

Commit 1e6e17f

Browse files
committed
Rename internal firebaseAI to createInstance to avoid confusion
1 parent f47fcde commit 1e6e17f

File tree

3 files changed

+14
-9
lines changed

3 files changed

+14
-9
lines changed

FirebaseAI/Sources/FirebaseAI.swift

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,11 @@ public final class FirebaseAI: Sendable {
3535
/// - Returns: A `FirebaseAI` instance, configured with the custom `FirebaseApp`.
3636
public static func firebaseAI(app: FirebaseApp? = nil,
3737
backend: Backend = .googleAI()) -> FirebaseAI {
38-
let instance = firebaseAI(app: app, location: backend.location, apiConfig: backend.apiConfig)
38+
let instance = createInstance(
39+
app: app,
40+
location: backend.location,
41+
apiConfig: backend.apiConfig
42+
)
3943
// Verify that the `FirebaseAI` instance is always configured with the production endpoint since
4044
// this is the public API surface for creating an instance.
4145
assert(instance.apiConfig.service.endpoint == .firebaseVertexAIProd)
@@ -159,7 +163,8 @@ public final class FirebaseAI: Sendable {
159163
version: .v1beta
160164
)
161165

162-
static func firebaseAI(app: FirebaseApp?, location: String?, apiConfig: APIConfig) -> FirebaseAI {
166+
static func createInstance(app: FirebaseApp?, location: String?,
167+
apiConfig: APIConfig) -> FirebaseAI {
163168
guard let app = app ?? FirebaseApp.app() else {
164169
fatalError("No instance of the default Firebase app was found.")
165170
}

FirebaseAI/Tests/TestApp/Tests/Utilities/InstanceConfig.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ extension FirebaseAI {
127127
switch instanceConfig.apiConfig.service {
128128
case .vertexAI:
129129
let location = instanceConfig.location ?? "us-central1"
130-
return FirebaseAI.firebaseAI(
130+
return FirebaseAI.createInstance(
131131
app: instanceConfig.app,
132132
location: location,
133133
apiConfig: instanceConfig.apiConfig
@@ -137,7 +137,7 @@ extension FirebaseAI {
137137
instanceConfig.location == nil,
138138
"The Developer API is global and does not support `location`."
139139
)
140-
return FirebaseAI.firebaseAI(
140+
return FirebaseAI.createInstance(
141141
app: instanceConfig.app,
142142
location: nil,
143143
apiConfig: instanceConfig.apiConfig

FirebaseAI/Tests/Unit/VertexComponentTests.swift

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -152,12 +152,12 @@ class VertexComponentTests: XCTestCase {
152152
}
153153

154154
func testSameAppAndDifferentAPI_newInstanceCreated() throws {
155-
let vertex1 = FirebaseAI.firebaseAI(
155+
let vertex1 = FirebaseAI.createInstance(
156156
app: VertexComponentTests.app,
157157
location: location,
158158
apiConfig: APIConfig(service: .vertexAI(endpoint: .firebaseVertexAIProd), version: .v1beta)
159159
)
160-
let vertex2 = FirebaseAI.firebaseAI(
160+
let vertex2 = FirebaseAI.createInstance(
161161
app: VertexComponentTests.app,
162162
location: location,
163163
apiConfig: APIConfig(service: .vertexAI(endpoint: .firebaseVertexAIProd), version: .v1)
@@ -208,7 +208,7 @@ class VertexComponentTests: XCTestCase {
208208
func testModelResourceName_developerAPI_generativeLanguage() throws {
209209
let app = try XCTUnwrap(VertexComponentTests.app)
210210
let apiConfig = APIConfig(service: .developer(endpoint: .generativeLanguage), version: .v1beta)
211-
let vertex = FirebaseAI.firebaseAI(app: app, location: nil, apiConfig: apiConfig)
211+
let vertex = FirebaseAI.createInstance(app: app, location: nil, apiConfig: apiConfig)
212212
let model = "test-model-name"
213213

214214
let modelResourceName = vertex.modelResourceName(modelName: model)
@@ -222,7 +222,7 @@ class VertexComponentTests: XCTestCase {
222222
service: .developer(endpoint: .firebaseVertexAIStaging),
223223
version: .v1beta
224224
)
225-
let vertex = FirebaseAI.firebaseAI(app: app, location: nil, apiConfig: apiConfig)
225+
let vertex = FirebaseAI.createInstance(app: app, location: nil, apiConfig: apiConfig)
226226
let model = "test-model-name"
227227
let projectID = vertex.firebaseInfo.projectID
228228

@@ -253,7 +253,7 @@ class VertexComponentTests: XCTestCase {
253253
service: .developer(endpoint: .firebaseVertexAIStaging),
254254
version: .v1beta
255255
)
256-
let vertex = FirebaseAI.firebaseAI(app: app, location: nil, apiConfig: apiConfig)
256+
let vertex = FirebaseAI.createInstance(app: app, location: nil, apiConfig: apiConfig)
257257
let modelResourceName = vertex.modelResourceName(modelName: modelName)
258258
let expectedSystemInstruction = ModelContent(role: nil, parts: systemInstruction.parts)
259259

0 commit comments

Comments
 (0)