Skip to content

Commit 7955002

Browse files
committed
Run formatter
1 parent 05c8294 commit 7955002

File tree

3 files changed

+34
-35
lines changed

3 files changed

+34
-35
lines changed

packages/vertexai/src/api.ts

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -48,24 +48,24 @@ export { GenAIErrorCode as VertexAIErrorCode };
4848

4949
/**
5050
* Base class for Vertex AI in Firebase model APIs.
51-
*
52-
* This is an alias that exists to maintain backwards-compatibility. This will be removed in
51+
*
52+
* This is an alias that exists to maintain backwards-compatibility. This will be removed in
5353
* version 12 of the Firebase JS SDK.
54-
*
54+
*
5555
* For more information, refer to the documentation for the new <code>{@link GenAIModel}</code>.
56-
*
56+
*
5757
* @public
5858
*/
5959
export const VertexAIModel = GenAIModel;
6060

6161
/**
6262
* Error class for the Vertex AI in Firebase SDK.
63-
*
64-
* This is an alias that exists to maintain backwards-compatibility. This will be removed in
63+
*
64+
* This is an alias that exists to maintain backwards-compatibility. This will be removed in
6565
* version 12 of the Firebase JS SDK.
66-
*
66+
*
6767
* For more information, refer to the documentation for the new <code>{@link GenAIError}</code>.
68-
*
68+
*
6969
* @public
7070
*/
7171
export const VertexAIError = GenAIError;
@@ -104,28 +104,28 @@ export function getVertexAI(
104104
* Returns the default {@link GenAI} instance that is associated with the provided
105105
* {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new instance with the
106106
* default settings.
107-
*
107+
*
108108
* @example
109109
* ```javascript
110110
* const genAI = getGenAI(app);
111111
* ```
112-
*
112+
*
113113
* @example
114114
* ```javascript
115115
* // Get a GenAI instance configured to use Vertex AI.
116-
* const genAI = getGenAI(app, { backend: vertexAIBackend() });
116+
* const genAI = getGenAI(app, { backend: vertexAIBackend() });
117117
* ```
118-
*
118+
*
119119
* @example
120120
* ```javascript
121121
* // Get a GenAI instance configured to use Google AI.
122-
* const genAI = getGenAI(app, { backend: vertexAIBackend() });
122+
* const genAI = getGenAI(app, { backend: vertexAIBackend() });
123123
* ```
124124
*
125125
* @param app - The <code>{@link @firebase/app#FirebaseApp}</code> to use.
126126
* @param options - <code>{@link GenAIOptions}</code> that configure the GenAI instance.
127127
* @returns The default <code>{@link GenAI}</code> instance for the given <code>{@link @firebase/app#FirebaseApp}</code>.
128-
*
128+
*
129129
* @public
130130
*/
131131
export function getGenAI(
@@ -143,10 +143,10 @@ export function getGenAI(
143143
}
144144

145145
/**
146-
* Creates a <code>{@link Backend}</code> instance configured to use Google AI.
147-
*
146+
* Creates a <code>{@link Backend}</code> instance configured to use Google AI.
147+
*
148148
* @returns A <code>{@link GoogleAIBackend}</code> object.
149-
*
149+
*
150150
* @public
151151
*/
152152
export function googleAIBackend(): GoogleAIBackend {
@@ -159,12 +159,12 @@ export function googleAIBackend(): GoogleAIBackend {
159159

160160
/**
161161
* Creates a <code>{@link Backend}</code> instance configured to use Vertex AI.
162-
*
162+
*
163163
* @param location - The region identifier, defaulting to `us-central1`;
164164
* see {@link https://firebase.google.com/docs/vertex-ai/locations?platform=ios#available-locations | Vertex AI locations}
165165
* for a list of supported locations.
166166
* @returns A <code>{@link VertexAIBackend}</code> object.
167-
*
167+
*
168168
* @public
169169
*/
170170
export function vertexAIBackend(location?: string): VertexAIBackend {

packages/vertexai/src/public-types.ts

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@ export interface VertexAIOptions {
3131

3232
/**
3333
* An instance of the Firebase GenAI SDK.
34-
*
34+
*
3535
* Do not create this instance directly. Instead, use <code>{@link getGenAI | getGenAI()}</code>.
36-
*
36+
*
3737
* @public
3838
*/
3939
export interface GenAI {
@@ -47,30 +47,30 @@ export interface GenAI {
4747
backend: Backend;
4848
/**
4949
* The location configured for this GenAI service instance, relevant for Vertex AI backends.
50-
*
50+
*
5151
* @deprecated This is here to maintain backwards-compatibility. Use `GenAI.backend.location` instead.
5252
*/
5353
location: string;
5454
}
5555

5656
/**
5757
* Union type representing the backend configuration for the GenAI service.
58-
* This can be either a <code>{@link GoogleAIBackend}</code> or a
58+
* This can be either a <code>{@link GoogleAIBackend}</code> or a
5959
* <code>{@link VertexAIBackend}</code> configuration object.
60-
*
61-
* Create instances using <code>{@link googleAIBackend}</code> or
60+
*
61+
* Create instances using <code>{@link googleAIBackend}</code> or
6262
* <code>{@link vertexAIBackend}</code>.
63-
*
63+
*
6464
* @public
6565
*/
6666
export type Backend = GoogleAIBackend | VertexAIBackend;
6767

6868
/**
6969
* Represents the configuration object for the Google AI backend.
70-
* Use this with <code>{@link GenAIOptions}</code> when initializing the service with
70+
* Use this with <code>{@link GenAIOptions}</code> when initializing the service with
7171
* <code>{@link getGenAI | getGenAI()}</code>.
7272
* Create an instance using <code>{@link googleAIBackend | googleAIBackend()}</code>.
73-
*
73+
*
7474
* @public
7575
*/
7676
export type GoogleAIBackend = {
@@ -80,22 +80,21 @@ export type GoogleAIBackend = {
8080
backendType: typeof BackendType.GOOGLE_AI;
8181
};
8282

83-
8483
/**
8584
* Represents the configuration object for the Vertex AI backend.
8685
* Use this with <code>{@link GenAIOptions}</code> when initializing the server with
8786
* <code>{@link getGenAI}</code>.
8887
* Create an instance using the <code>{@link vertexAIBackend}</code> function.
89-
*
88+
*
9089
* @public
9190
*/
9291
export type VertexAIBackend = {
9392
/**
9493
* Specifies the backend type as Vertex AI.
9594
*/
9695
backendType: typeof BackendType.VERTEX_AI;
97-
/**
98-
* The region identifier, defaulting to `us-central1`; see {@link https://firebase.google.com/docs/vertex-ai/locations?platform=ios#available-locations | Vertex AI locations}
96+
/**
97+
* The region identifier, defaulting to `us-central1`; see {@link https://firebase.google.com/docs/vertex-ai/locations?platform=ios#available-locations | Vertex AI locations}
9998
* for a list of supported locations.
10099
*/
101100
location: string;
@@ -146,8 +145,8 @@ export type BackendType = (typeof BackendType)[keyof typeof BackendType];
146145
export interface GenAIOptions {
147146
/**
148147
* The backend configuration to use for the GenAI service instance.
149-
* Use <code>{@link googleAIBackend | googleAIBackend()}</code> or
148+
* Use <code>{@link googleAIBackend | googleAIBackend()}</code> or
150149
* <code>{@link vertexAIBackend | vertexAIBackend() }</code> to create this configuration.
151150
*/
152151
backend: Backend;
153-
}
152+
}

packages/vertexai/src/types/internal.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,4 +35,4 @@ export interface ApiSettings {
3535
getAppCheckToken?: () => Promise<AppCheckTokenResult>;
3636
}
3737

38-
export type InstanceIdentifier = Backend;
38+
export type InstanceIdentifier = Backend;

0 commit comments

Comments
 (0)