mirror of
https://github.com/firebase/firebase-ios-sdk
synced 2026-11-11 22:55:59 +05:45
254 lines
10 KiB
Swift
254 lines
10 KiB
Swift
// Copyright 2024 Google LLC
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
import FirebaseAppCheckInterop
|
|
import FirebaseAuthInterop
|
|
import FirebaseCore
|
|
import Foundation
|
|
|
|
// Avoids exposing internal FirebaseCore APIs to Swift users.
|
|
internal import FirebaseCoreExtension
|
|
|
|
/// The Firebase AI SDK provides access to Gemini models directly from your app.
|
|
@available(iOS 15.0, macOS 12.0, macCatalyst 15.0, tvOS 15.0, watchOS 8.0, *)
|
|
public final class FirebaseAI: Sendable {
|
|
// MARK: - Public APIs
|
|
|
|
/// Creates an instance of `FirebaseAI`.
|
|
///
|
|
/// - Parameters:
|
|
/// - app: A custom `FirebaseApp` used for initialization; if not specified, uses the default
|
|
/// ``FirebaseApp``.
|
|
/// - backend: The backend API for the Firebase AI SDK; if not specified, uses the default
|
|
/// ``Backend/googleAI()`` (Gemini Developer API).
|
|
/// - Returns: A `FirebaseAI` instance, configured with the custom `FirebaseApp`.
|
|
public static func firebaseAI(app: FirebaseApp? = nil,
|
|
backend: Backend = .googleAI()) -> FirebaseAI {
|
|
let instance = createInstance(
|
|
app: app,
|
|
location: backend.location,
|
|
apiConfig: backend.apiConfig
|
|
)
|
|
// Verify that the `FirebaseAI` instance is always configured with the production endpoint since
|
|
// this is the public API surface for creating an instance.
|
|
assert(instance.apiConfig.service.endpoint == .firebaseProxyProd)
|
|
assert(instance.apiConfig.version == .v1beta)
|
|
return instance
|
|
}
|
|
|
|
/// Initializes a generative model with the given parameters.
|
|
///
|
|
/// - Note: Refer to [Gemini models](https://firebase.google.com/docs/vertex-ai/gemini-models) for
|
|
/// guidance on choosing an appropriate model for your use case.
|
|
///
|
|
/// - Parameters:
|
|
/// - modelName: The name of the model to use, for example `"gemini-1.5-flash"`; see
|
|
/// [available model names
|
|
/// ](https://firebase.google.com/docs/vertex-ai/gemini-models#available-model-names) for a
|
|
/// list of supported model names.
|
|
/// - generationConfig: The content generation parameters your model should use.
|
|
/// - safetySettings: A value describing what types of harmful content your model should allow.
|
|
/// - tools: A list of ``Tool`` objects that the model may use to generate the next response.
|
|
/// - toolConfig: Tool configuration for any `Tool` specified in the request.
|
|
/// - systemInstruction: Instructions that direct the model to behave a certain way; currently
|
|
/// only text content is supported.
|
|
/// - requestOptions: Configuration parameters for sending requests to the backend.
|
|
public func generativeModel(modelName: String,
|
|
generationConfig: GenerationConfig? = nil,
|
|
safetySettings: [SafetySetting]? = nil,
|
|
tools: [Tool]? = nil,
|
|
toolConfig: ToolConfig? = nil,
|
|
systemInstruction: ModelContent? = nil,
|
|
requestOptions: RequestOptions = RequestOptions())
|
|
-> GenerativeModel {
|
|
if !modelName.starts(with: GenerativeModel.geminiModelNamePrefix)
|
|
&& !modelName.starts(with: GenerativeModel.gemmaModelNamePrefix) {
|
|
AILog.warning(code: .unsupportedGeminiModel, """
|
|
Unsupported Gemini model "\(modelName)"; see \
|
|
https://firebase.google.com/docs/vertex-ai/models for a list supported Gemini model names.
|
|
""")
|
|
}
|
|
|
|
return GenerativeModel(
|
|
modelName: modelName,
|
|
modelResourceName: modelResourceName(modelName: modelName),
|
|
firebaseInfo: firebaseInfo,
|
|
apiConfig: apiConfig,
|
|
generationConfig: generationConfig,
|
|
safetySettings: safetySettings,
|
|
tools: tools,
|
|
toolConfig: toolConfig,
|
|
systemInstruction: systemInstruction,
|
|
requestOptions: requestOptions
|
|
)
|
|
}
|
|
|
|
/// **[Public Preview]** Initializes an ``ImagenModel`` with the given parameters.
|
|
///
|
|
/// > Warning: For Firebase AI SDK, image generation using Imagen 3 models is in Public
|
|
/// Preview, which means that the feature is not subject to any SLA or deprecation policy and
|
|
/// could change in backwards-incompatible ways.
|
|
///
|
|
/// > Important: Only Imagen 3 models (named `imagen-3.0-*`) are supported.
|
|
///
|
|
/// - Parameters:
|
|
/// - modelName: The name of the Imagen 3 model to use, for example `"imagen-3.0-generate-002"`;
|
|
/// see [model versions](https://firebase.google.com/docs/vertex-ai/models) for a list of
|
|
/// supported Imagen 3 models.
|
|
/// - generationConfig: Configuration options for generating images with Imagen.
|
|
/// - safetySettings: Settings describing what types of potentially harmful content your model
|
|
/// should allow.
|
|
/// - requestOptions: Configuration parameters for sending requests to the backend.
|
|
public func imagenModel(modelName: String, generationConfig: ImagenGenerationConfig? = nil,
|
|
safetySettings: ImagenSafetySettings? = nil,
|
|
requestOptions: RequestOptions = RequestOptions()) -> ImagenModel {
|
|
if !modelName.starts(with: ImagenModel.imagenModelNamePrefix) {
|
|
AILog.warning(code: .unsupportedImagenModel, """
|
|
Unsupported Imagen model "\(modelName)"; see \
|
|
https://firebase.google.com/docs/vertex-ai/models for a list supported Imagen model names.
|
|
""")
|
|
}
|
|
|
|
return ImagenModel(
|
|
modelResourceName: modelResourceName(modelName: modelName),
|
|
firebaseInfo: firebaseInfo,
|
|
apiConfig: apiConfig,
|
|
generationConfig: generationConfig,
|
|
safetySettings: safetySettings,
|
|
requestOptions: requestOptions
|
|
)
|
|
}
|
|
|
|
/// Class to enable FirebaseAI to register via the Objective-C based Firebase component system
|
|
/// to include FirebaseAI in the userAgent.
|
|
@objc(FIRVertexAIComponent) class FirebaseVertexAIComponent: NSObject {}
|
|
|
|
// MARK: - Private
|
|
|
|
/// Firebase data relevant to Firebase AI.
|
|
let firebaseInfo: FirebaseInfo
|
|
|
|
let apiConfig: APIConfig
|
|
|
|
/// A map of active `FirebaseAI` instances keyed by the `FirebaseApp` name and the `location`,
|
|
/// in the format `appName:location`.
|
|
private nonisolated(unsafe) static var instances: [InstanceKey: FirebaseAI] = [:]
|
|
|
|
/// Lock to manage access to the `instances` array to avoid race conditions.
|
|
private nonisolated(unsafe) static var instancesLock: os_unfair_lock = .init()
|
|
|
|
let location: String?
|
|
|
|
static let defaultVertexAIAPIConfig = APIConfig(
|
|
service: .vertexAI(endpoint: .firebaseProxyProd),
|
|
version: .v1beta
|
|
)
|
|
|
|
static func createInstance(app: FirebaseApp?, location: String?,
|
|
apiConfig: APIConfig) -> FirebaseAI {
|
|
guard let app = app ?? FirebaseApp.app() else {
|
|
fatalError("No instance of the default Firebase app was found.")
|
|
}
|
|
|
|
os_unfair_lock_lock(&instancesLock)
|
|
|
|
// Unlock before the function returns.
|
|
defer { os_unfair_lock_unlock(&instancesLock) }
|
|
|
|
let instanceKey = InstanceKey(appName: app.name, location: location, apiConfig: apiConfig)
|
|
if let instance = instances[instanceKey] {
|
|
return instance
|
|
}
|
|
let newInstance = FirebaseAI(app: app, location: location, apiConfig: apiConfig)
|
|
instances[instanceKey] = newInstance
|
|
return newInstance
|
|
}
|
|
|
|
init(app: FirebaseApp, location: String?, apiConfig: APIConfig) {
|
|
guard let projectID = app.options.projectID else {
|
|
fatalError("The Firebase app named \"\(app.name)\" has no project ID in its configuration.")
|
|
}
|
|
guard let apiKey = app.options.apiKey else {
|
|
fatalError("The Firebase app named \"\(app.name)\" has no API key in its configuration.")
|
|
}
|
|
firebaseInfo = FirebaseInfo(
|
|
appCheck: ComponentType<AppCheckInterop>.instance(
|
|
for: AppCheckInterop.self,
|
|
in: app.container
|
|
),
|
|
auth: ComponentType<AuthInterop>.instance(for: AuthInterop.self, in: app.container),
|
|
projectID: projectID,
|
|
apiKey: apiKey,
|
|
firebaseAppID: app.options.googleAppID,
|
|
firebaseApp: app
|
|
)
|
|
self.apiConfig = apiConfig
|
|
self.location = location
|
|
}
|
|
|
|
func modelResourceName(modelName: String) -> String {
|
|
guard !modelName.isEmpty && modelName
|
|
.allSatisfy({ !$0.isWhitespace && !$0.isNewline && $0 != "/" }) else {
|
|
fatalError("""
|
|
Invalid model name "\(modelName)" specified; see \
|
|
https://firebase.google.com/docs/vertex-ai/gemini-model#available-models for a list of \
|
|
available models.
|
|
""")
|
|
}
|
|
|
|
switch apiConfig.service {
|
|
case .vertexAI:
|
|
return vertexAIModelResourceName(modelName: modelName)
|
|
case .googleAI:
|
|
return developerModelResourceName(modelName: modelName)
|
|
}
|
|
}
|
|
|
|
private func vertexAIModelResourceName(modelName: String) -> String {
|
|
guard let location else {
|
|
fatalError("Location must be specified for the Firebase AI service.")
|
|
}
|
|
guard !location.isEmpty && location
|
|
.allSatisfy({ !$0.isWhitespace && !$0.isNewline && $0 != "/" }) else {
|
|
fatalError("""
|
|
Invalid location "\(location)" specified; see \
|
|
https://firebase.google.com/docs/vertex-ai/locations?platform=ios#available-locations \
|
|
for a list of available locations.
|
|
""")
|
|
}
|
|
|
|
let projectID = firebaseInfo.projectID
|
|
return "projects/\(projectID)/locations/\(location)/publishers/google/models/\(modelName)"
|
|
}
|
|
|
|
private func developerModelResourceName(modelName: String) -> String {
|
|
switch apiConfig.service.endpoint {
|
|
case .firebaseProxyStaging, .firebaseProxyProd:
|
|
let projectID = firebaseInfo.projectID
|
|
return "projects/\(projectID)/models/\(modelName)"
|
|
case .googleAIBypassProxy:
|
|
return "models/\(modelName)"
|
|
}
|
|
}
|
|
|
|
/// Identifier for a unique instance of ``FirebaseAI``.
|
|
///
|
|
/// This type is `Hashable` so that it can be used as a key in the `instances` dictionary.
|
|
private struct InstanceKey: Sendable, Hashable {
|
|
let appName: String
|
|
let location: String?
|
|
let apiConfig: APIConfig
|
|
}
|
|
}
|