Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Vertex AI] Switch to firebasevertexai.googleapis.com API #13725

Merged
merged 2 commits into from
Oct 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions FirebaseVertexAI/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# 11.4.0
- [changed] **Breaking Change**: The SDK is now Generally Available (GA); both
new and existing users must perform the
[Build with Gemini](https://console.firebase.google.com/project/_/genai/)
onboarding flow in the Firebase Console to use the updated API. (#13725)
- [changed] **Breaking Change**: The `HarmCategory` enum is no longer nested
inside the `SafetySetting` struct and the `unspecified` case has been
removed. (#13686)
Expand Down
5 changes: 1 addition & 4 deletions FirebaseVertexAI/Sources/Constants.swift
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,5 @@ import Foundation
/// Constants associated with the Vertex AI for Firebase SDK.
enum Constants {
/// The Vertex AI backend endpoint URL.
///
/// TODO(andrewheard): Update to "https://firebasevertexai.googleapis.com" after the Vertex AI in
/// Firebase API launch.
static let baseURL = "https://firebaseml.googleapis.com"
static let baseURL = "https://firebasevertexai.googleapis.com"
}
16 changes: 0 additions & 16 deletions FirebaseVertexAI/Sources/Errors.swift
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,6 @@ struct RPCError: Error {
self.details = details
}

// TODO(andrewheard): Remove this method after the Vertex AI in Firebase API launch.
func isFirebaseMLServiceDisabledError() -> Bool {
return details.contains { $0.isFirebaseMLServiceDisabledErrorDetails() }
}

func isVertexAIInFirebaseServiceDisabledError() -> Bool {
return details.contains { $0.isVertexAIInFirebaseServiceDisabledErrorDetails() }
}
Expand Down Expand Up @@ -95,17 +90,6 @@ struct ErrorDetails {
return isErrorInfo() && reason == "SERVICE_DISABLED" && domain == "googleapis.com"
}

// TODO(andrewheard): Remove this method after the Vertex AI in Firebase API launch.
func isFirebaseMLServiceDisabledErrorDetails() -> Bool {
guard isServiceDisabledError() else {
return false
}
guard let metadata, metadata["service"] == "firebaseml.googleapis.com" else {
return false
}
return true
}

func isVertexAIInFirebaseServiceDisabledErrorDetails() -> Bool {
guard isServiceDisabledError() else {
return false
Expand Down
4 changes: 1 addition & 3 deletions FirebaseVertexAI/Sources/GenerativeAIRequest.swift
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,7 @@ public struct RequestOptions {
let timeout: TimeInterval

/// The API version to use in requests to the backend.
///
/// TODO(andrewheard): Update to "v1beta" after the Vertex AI in Firebase API launch.
let apiVersion = "v2beta"
let apiVersion = "v1beta"

/// Initializes a request options object.
///
Expand Down
11 changes: 0 additions & 11 deletions FirebaseVertexAI/Sources/GenerativeAIService.swift
Original file line number Diff line number Diff line change
Expand Up @@ -263,17 +263,6 @@ struct GenerativeAIService {
// Log specific RPC errors that cannot be mitigated or handled by user code.
// These errors do not produce specific GenerateContentError or CountTokensError cases.
private func logRPCError(_ error: RPCError) {
// TODO(andrewheard): Remove this check after the Vertex AI in Firebase API launch.
if error.isFirebaseMLServiceDisabledError() {
VertexLog.error(code: .vertexAIInFirebaseAPIDisabled, """
The Vertex AI in Firebase SDK requires the Firebase ML API (`firebaseml.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". \
If you enabled this API recently, wait a few minutes for the action to propagate to our \
systems and then retry.
""")
}

if error.isVertexAIInFirebaseServiceDisabledError() {
VertexLog.error(code: .vertexAIInFirebaseAPIDisabled, """
The Vertex AI in Firebase SDK requires the Vertex AI in Firebase API \
Expand Down
50 changes: 0 additions & 50 deletions FirebaseVertexAI/Tests/Unit/GenerativeModelTests.swift
Original file line number Diff line number Diff line change
Expand Up @@ -457,30 +457,6 @@ final class GenerativeModelTests: XCTestCase {
}
}

// TODO(andrewheard): Remove this test case after the Vertex AI in Firebase API launch.
func testGenerateContent_failure_firebaseMLAPINotEnabled() async throws {
let expectedStatusCode = 403
MockURLProtocol
.requestHandler = try httpRequestHandler(
forResource: "unary-failure-firebaseml-api-not-enabled",
withExtension: "json",
statusCode: expectedStatusCode
)

do {
_ = try await model.generateContent(testPrompt)
XCTFail("Should throw GenerateContentError.internalError; no error thrown.")
} catch let GenerateContentError.internalError(error as RPCError) {
XCTAssertEqual(error.httpResponseCode, expectedStatusCode)
XCTAssertEqual(error.status, .permissionDenied)
XCTAssertTrue(error.message.starts(with: "Firebase ML API has not been used in project"))
XCTAssertTrue(error.isFirebaseMLServiceDisabledError())
return
} catch {
XCTFail("Should throw GenerateContentError.internalError(RPCError); error thrown: \(error)")
}
}

func testGenerateContent_failure_firebaseVertexAIAPINotEnabled() async throws {
let expectedStatusCode = 403
MockURLProtocol
Expand Down Expand Up @@ -805,32 +781,6 @@ final class GenerativeModelTests: XCTestCase {
XCTFail("Should have caught an error.")
}

// TODO(andrewheard): Remove this test case after the Vertex AI in Firebase API launch.
func testGenerateContentStream_failure_firebaseMLAPINotEnabled() async throws {
let expectedStatusCode = 403
MockURLProtocol
.requestHandler = try httpRequestHandler(
forResource: "unary-failure-firebaseml-api-not-enabled",
withExtension: "json",
statusCode: expectedStatusCode
)

do {
let stream = try model.generateContentStream(testPrompt)
for try await _ in stream {
XCTFail("No content is there, this shouldn't happen.")
}
} catch let GenerateContentError.internalError(error as RPCError) {
XCTAssertEqual(error.httpResponseCode, expectedStatusCode)
XCTAssertEqual(error.status, .permissionDenied)
XCTAssertTrue(error.message.starts(with: "Firebase ML API has not been used in project"))
XCTAssertTrue(error.isFirebaseMLServiceDisabledError())
return
}

XCTFail("Should have caught an error.")
}

func testGenerateContentStream_failure_vertexAIInFirebaseAPINotEnabled() async throws {
let expectedStatusCode = 403
MockURLProtocol
Expand Down
Loading