Skip to content

Commit 0f4ba4f

Browse files
committed
Revert "feat(ai): Migrate to AI and add GoogleAI support (#8931)"
This reverts commit d5082f9.
1 parent ccb56b5 commit 0f4ba4f

File tree

76 files changed

+669
-2765
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

76 files changed

+669
-2765
lines changed

.changeset/tall-zoos-stare.md

Lines changed: 0 additions & 6 deletions
This file was deleted.

common/api-review/vertexai.api.md

Lines changed: 49 additions & 148 deletions
Original file line numberDiff line numberDiff line change
@@ -9,62 +9,6 @@ import { FirebaseApp } from '@firebase/app';
99
import { FirebaseAuthTokenData } from '@firebase/auth-interop-types';
1010
import { FirebaseError } from '@firebase/util';
1111

12-
// @public
13-
export interface AI {
14-
app: FirebaseApp;
15-
backend: Backend;
16-
// @deprecated
17-
location: string;
18-
}
19-
20-
// @public
21-
export class AIError extends FirebaseError {
22-
constructor(code: AIErrorCode, message: string, customErrorData?: CustomErrorData | undefined);
23-
// (undocumented)
24-
readonly code: AIErrorCode;
25-
// (undocumented)
26-
readonly customErrorData?: CustomErrorData | undefined;
27-
}
28-
29-
// @public
30-
const enum AIErrorCode {
31-
API_NOT_ENABLED = "api-not-enabled",
32-
ERROR = "error",
33-
FETCH_ERROR = "fetch-error",
34-
INVALID_CONTENT = "invalid-content",
35-
INVALID_SCHEMA = "invalid-schema",
36-
NO_API_KEY = "no-api-key",
37-
NO_APP_ID = "no-app-id",
38-
NO_MODEL = "no-model",
39-
NO_PROJECT_ID = "no-project-id",
40-
PARSE_FAILED = "parse-failed",
41-
REQUEST_ERROR = "request-error",
42-
RESPONSE_ERROR = "response-error",
43-
UNSUPPORTED = "unsupported"
44-
}
45-
46-
export { AIErrorCode }
47-
48-
export { AIErrorCode as VertexAIErrorCode }
49-
50-
// @public
51-
export abstract class AIModel {
52-
// @internal
53-
protected constructor(ai: AI, modelName: string);
54-
// Warning: (ae-forgotten-export) The symbol "ApiSettings" needs to be exported by the entry point index.d.ts
55-
//
56-
// @internal (undocumented)
57-
protected _apiSettings: ApiSettings;
58-
readonly model: string;
59-
// @internal
60-
static normalizeModelName(modelName: string, backendType: BackendType): string;
61-
}
62-
63-
// @public
64-
export interface AIOptions {
65-
backend: Backend;
66-
}
67-
6812
// @public
6913
export class ArraySchema extends Schema {
7014
constructor(schemaParams: SchemaParams, items: TypedSchema);
@@ -74,21 +18,6 @@ export class ArraySchema extends Schema {
7418
toJSON(): SchemaRequest;
7519
}
7620

77-
// @public
78-
export abstract class Backend {
79-
protected constructor(type: BackendType);
80-
readonly backendType: BackendType;
81-
}
82-
83-
// @public
84-
export const BackendType: {
85-
readonly VERTEX_AI: "VERTEX_AI";
86-
readonly GOOGLE_AI: "GOOGLE_AI";
87-
};
88-
89-
// @public
90-
export type BackendType = (typeof BackendType)[keyof typeof BackendType];
91-
9221
// @public
9322
export interface BaseParams {
9423
// (undocumented)
@@ -112,6 +41,7 @@ export class BooleanSchema extends Schema {
11241

11342
// @public
11443
export class ChatSession {
44+
// Warning: (ae-forgotten-export) The symbol "ApiSettings" needs to be exported by the entry point index.d.ts
11545
constructor(apiSettings: ApiSettings, model: string, params?: StartChatParams | undefined, requestOptions?: RequestOptions | undefined);
11646
getHistory(): Promise<Content[]>;
11747
// (undocumented)
@@ -130,9 +60,11 @@ export interface Citation {
13060
endIndex?: number;
13161
// (undocumented)
13262
license?: string;
63+
// (undocumented)
13364
publicationDate?: Date_2;
13465
// (undocumented)
13566
startIndex?: number;
67+
// (undocumented)
13668
title?: string;
13769
// (undocumented)
13870
uri?: string;
@@ -394,8 +326,8 @@ export interface GenerativeContentBlob {
394326
}
395327

396328
// @public
397-
export class GenerativeModel extends AIModel {
398-
constructor(ai: AI, modelParams: ModelParams, requestOptions?: RequestOptions);
329+
export class GenerativeModel extends VertexAIModel {
330+
constructor(vertexAI: VertexAI, modelParams: ModelParams, requestOptions?: RequestOptions);
399331
countTokens(request: CountTokensRequest | string | Array<string | Part>): Promise<CountTokensResponse>;
400332
generateContent(request: GenerateContentRequest | string | Array<string | Part>): Promise<GenerateContentResult>;
401333
generateContentStream(request: GenerateContentRequest | string | Array<string | Part>): Promise<GenerateContentStreamResult>;
@@ -415,76 +347,14 @@ export class GenerativeModel extends AIModel {
415347
}
416348

417349
// @public
418-
export function getAI(app?: FirebaseApp, options?: AIOptions): AI;
419-
420-
// @public
421-
export function getGenerativeModel(ai: AI, modelParams: ModelParams, requestOptions?: RequestOptions): GenerativeModel;
350+
export function getGenerativeModel(vertexAI: VertexAI, modelParams: ModelParams, requestOptions?: RequestOptions): GenerativeModel;
422351

423352
// @beta
424-
export function getImagenModel(ai: AI, modelParams: ImagenModelParams, requestOptions?: RequestOptions): ImagenModel;
353+
export function getImagenModel(vertexAI: VertexAI, modelParams: ImagenModelParams, requestOptions?: RequestOptions): ImagenModel;
425354

426355
// @public
427356
export function getVertexAI(app?: FirebaseApp, options?: VertexAIOptions): VertexAI;
428357

429-
// @public
430-
export class GoogleAIBackend extends Backend {
431-
constructor();
432-
}
433-
434-
// Warning: (ae-internal-missing-underscore) The name "GoogleAICitationMetadata" should be prefixed with an underscore because the declaration is marked as @internal
435-
//
436-
// @internal (undocumented)
437-
export interface GoogleAICitationMetadata {
438-
// (undocumented)
439-
citationSources: Citation[];
440-
}
441-
442-
// Warning: (ae-internal-missing-underscore) The name "GoogleAICountTokensRequest" should be prefixed with an underscore because the declaration is marked as @internal
443-
//
444-
// @internal (undocumented)
445-
export interface GoogleAICountTokensRequest {
446-
// (undocumented)
447-
generateContentRequest: {
448-
model: string;
449-
contents: Content[];
450-
systemInstruction?: string | Part | Content;
451-
tools?: Tool[];
452-
generationConfig?: GenerationConfig;
453-
};
454-
}
455-
456-
// Warning: (ae-internal-missing-underscore) The name "GoogleAIGenerateContentCandidate" should be prefixed with an underscore because the declaration is marked as @internal
457-
//
458-
// @internal (undocumented)
459-
export interface GoogleAIGenerateContentCandidate {
460-
// (undocumented)
461-
citationMetadata?: GoogleAICitationMetadata;
462-
// (undocumented)
463-
content: Content;
464-
// (undocumented)
465-
finishMessage?: string;
466-
// (undocumented)
467-
finishReason?: FinishReason;
468-
// (undocumented)
469-
groundingMetadata?: GroundingMetadata;
470-
// (undocumented)
471-
index: number;
472-
// (undocumented)
473-
safetyRatings?: SafetyRating[];
474-
}
475-
476-
// Warning: (ae-internal-missing-underscore) The name "GoogleAIGenerateContentResponse" should be prefixed with an underscore because the declaration is marked as @internal
477-
//
478-
// @internal (undocumented)
479-
export interface GoogleAIGenerateContentResponse {
480-
// (undocumented)
481-
candidates?: GoogleAIGenerateContentCandidate[];
482-
// (undocumented)
483-
promptFeedback?: PromptFeedback;
484-
// (undocumented)
485-
usageMetadata?: UsageMetadata;
486-
}
487-
488358
// @public @deprecated (undocumented)
489359
export interface GroundingAttribution {
490360
// (undocumented)
@@ -507,7 +377,7 @@ export interface GroundingMetadata {
507377
webSearchQueries?: string[];
508378
}
509379

510-
// @public
380+
// @public (undocumented)
511381
export enum HarmBlockMethod {
512382
PROBABILITY = "PROBABILITY",
513383
SEVERITY = "SEVERITY"
@@ -546,8 +416,7 @@ export enum HarmSeverity {
546416
HARM_SEVERITY_HIGH = "HARM_SEVERITY_HIGH",
547417
HARM_SEVERITY_LOW = "HARM_SEVERITY_LOW",
548418
HARM_SEVERITY_MEDIUM = "HARM_SEVERITY_MEDIUM",
549-
HARM_SEVERITY_NEGLIGIBLE = "HARM_SEVERITY_NEGLIGIBLE",
550-
HARM_SEVERITY_UNSUPPORTED = "HARM_SEVERITY_UNSUPPORTED"
419+
HARM_SEVERITY_NEGLIGIBLE = "HARM_SEVERITY_NEGLIGIBLE"
551420
}
552421

553422
// @beta
@@ -595,8 +464,8 @@ export interface ImagenInlineImage {
595464
}
596465

597466
// @beta
598-
export class ImagenModel extends AIModel {
599-
constructor(ai: AI, modelParams: ImagenModelParams, requestOptions?: RequestOptions | undefined);
467+
export class ImagenModel extends VertexAIModel {
468+
constructor(vertexAI: VertexAI, modelParams: ImagenModelParams, requestOptions?: RequestOptions | undefined);
600469
generateImages(prompt: string): Promise<ImagenGenerationResponse<ImagenInlineImage>>;
601470
// @internal
602471
generateImagesGCS(prompt: string, gcsURI: string): Promise<ImagenGenerationResponse<ImagenGCSImage>>;
@@ -718,6 +587,7 @@ export const POSSIBLE_ROLES: readonly ["user", "model", "function", "system"];
718587
export interface PromptFeedback {
719588
// (undocumented)
720589
blockReason?: BlockReason;
590+
// (undocumented)
721591
blockReasonMessage?: string;
722592
// (undocumented)
723593
safetyRatings: SafetyRating[];
@@ -757,15 +627,19 @@ export interface SafetyRating {
757627
category: HarmCategory;
758628
// (undocumented)
759629
probability: HarmProbability;
630+
// (undocumented)
760631
probabilityScore: number;
632+
// (undocumented)
761633
severity: HarmSeverity;
634+
// (undocumented)
762635
severityScore: number;
763636
}
764637

765638
// @public
766639
export interface SafetySetting {
767640
// (undocumented)
768641
category: HarmCategory;
642+
// (undocumented)
769643
method?: HarmBlockMethod;
770644
// (undocumented)
771645
threshold: HarmBlockThreshold;
@@ -917,19 +791,46 @@ export interface UsageMetadata {
917791
}
918792

919793
// @public
920-
export type VertexAI = AI;
794+
export interface VertexAI {
795+
app: FirebaseApp;
796+
// (undocumented)
797+
location: string;
798+
}
921799

922800
// @public
923-
export class VertexAIBackend extends Backend {
924-
constructor(location?: string);
925-
readonly location: string;
801+
export class VertexAIError extends FirebaseError {
802+
constructor(code: VertexAIErrorCode, message: string, customErrorData?: CustomErrorData | undefined);
803+
// (undocumented)
804+
readonly code: VertexAIErrorCode;
805+
// (undocumented)
806+
readonly customErrorData?: CustomErrorData | undefined;
926807
}
927808

928809
// @public
929-
export const VertexAIError: typeof AIError;
810+
export const enum VertexAIErrorCode {
811+
API_NOT_ENABLED = "api-not-enabled",
812+
ERROR = "error",
813+
FETCH_ERROR = "fetch-error",
814+
INVALID_CONTENT = "invalid-content",
815+
INVALID_SCHEMA = "invalid-schema",
816+
NO_API_KEY = "no-api-key",
817+
NO_APP_ID = "no-app-id",
818+
NO_MODEL = "no-model",
819+
NO_PROJECT_ID = "no-project-id",
820+
PARSE_FAILED = "parse-failed",
821+
REQUEST_ERROR = "request-error",
822+
RESPONSE_ERROR = "response-error"
823+
}
930824

931825
// @public
932-
export const VertexAIModel: typeof AIModel;
826+
export abstract class VertexAIModel {
827+
// @internal
828+
protected constructor(vertexAI: VertexAI, modelName: string);
829+
// @internal (undocumented)
830+
protected _apiSettings: ApiSettings;
831+
readonly model: string;
832+
static normalizeModelName(modelName: string): string;
833+
}
933834

934835
// @public
935836
export interface VertexAIOptions {

docs-devsite/_toc.yaml

Lines changed: 6 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -472,18 +472,8 @@ toc:
472472
- title: vertexai
473473
path: /docs/reference/js/vertexai.md
474474
section:
475-
- title: AI
476-
path: /docs/reference/js/vertexai.ai.md
477-
- title: AIError
478-
path: /docs/reference/js/vertexai.aierror.md
479-
- title: AIModel
480-
path: /docs/reference/js/vertexai.aimodel.md
481-
- title: AIOptions
482-
path: /docs/reference/js/vertexai.aioptions.md
483475
- title: ArraySchema
484476
path: /docs/reference/js/vertexai.arrayschema.md
485-
- title: Backend
486-
path: /docs/reference/js/vertexai.backend.md
487477
- title: BaseParams
488478
path: /docs/reference/js/vertexai.baseparams.md
489479
- title: BooleanSchema
@@ -542,8 +532,6 @@ toc:
542532
path: /docs/reference/js/vertexai.generativecontentblob.md
543533
- title: GenerativeModel
544534
path: /docs/reference/js/vertexai.generativemodel.md
545-
- title: GoogleAIBackend
546-
path: /docs/reference/js/vertexai.googleaibackend.md
547535
- title: GroundingAttribution
548536
path: /docs/reference/js/vertexai.groundingattribution.md
549537
- title: GroundingMetadata
@@ -610,8 +598,12 @@ toc:
610598
path: /docs/reference/js/vertexai.toolconfig.md
611599
- title: UsageMetadata
612600
path: /docs/reference/js/vertexai.usagemetadata.md
613-
- title: VertexAIBackend
614-
path: /docs/reference/js/vertexai.vertexaibackend.md
601+
- title: VertexAI
602+
path: /docs/reference/js/vertexai.vertexai.md
603+
- title: VertexAIError
604+
path: /docs/reference/js/vertexai.vertexaierror.md
605+
- title: VertexAIModel
606+
path: /docs/reference/js/vertexai.vertexaimodel.md
615607
- title: VertexAIOptions
616608
path: /docs/reference/js/vertexai.vertexaioptions.md
617609
- title: VideoMetadata

docs-devsite/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,5 +27,5 @@ https://github.com/firebase/firebase-js-sdk
2727
| [@firebase/performance](./performance.md#performance_package) | The Firebase Performance Monitoring Web SDK. This SDK does not work in a Node.js environment. |
2828
| [@firebase/remote-config](./remote-config.md#remote-config_package) | The Firebase Remote Config Web SDK. This SDK does not work in a Node.js environment. |
2929
| [@firebase/storage](./storage.md#storage_package) | Cloud Storage for Firebase |
30-
| [@firebase/vertexai](./vertexai.md#vertexai_package) | The Firebase AI Web SDK. |
30+
| [@firebase/vertexai](./vertexai.md#vertexai_package) | The Vertex AI in Firebase Web SDK. |
3131

0 commit comments

Comments
 (0)