Skip to content

Commit 4d60d02

Browse files
committed
remove more code tags
1 parent 4ea4539 commit 4d60d02

File tree

2 files changed

+22
-22
lines changed

2 files changed

+22
-22
lines changed

docs-devsite/vertexai.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@ https://github.com/firebase/firebase-js-sdk
1919
| [getGenAI(app, options)](./vertexai.md#getgenai_65c48ee) | Returns the default [GenAI](./vertexai.genai.md#genai_interface) instance that is associated with the provided [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface)<!-- -->. If no instance exists, initializes a new instance with the default settings. |
2020
| [getVertexAI(app, options)](./vertexai.md#getvertexai_04094cf) | Returns a <code>[VertexAI](./vertexai.md#vertexai)</code> instance for the given app. |
2121
| <b>function()</b> |
22-
| [googleAIBackend()](./vertexai.md#googleaibackend) | Creates a <code>[Backend](./vertexai.md#backend)</code> instance configured to use Google AI. |
22+
| [googleAIBackend()](./vertexai.md#googleaibackend) | Creates a [Backend](./vertexai.md#backend) instance configured to use Google AI. |
2323
| <b>function(genAI, ...)</b> |
24-
| [getGenerativeModel(genAI, modelParams, requestOptions)](./vertexai.md#getgenerativemodel_e3ccf80) | Returns a <code>[GenerativeModel](./vertexai.generativemodel.md#generativemodel_class)</code> class with methods for inference and other functionality. |
24+
| [getGenerativeModel(genAI, modelParams, requestOptions)](./vertexai.md#getgenerativemodel_e3ccf80) | Returns a <code>[GenerativeModel](./vertexai.generativemodel.md#generativemodel_class) class with methods for inference and other functionality. |
2525
| [getImagenModel(genAI, modelParams, requestOptions)](./vertexai.md#getimagenmodel_bffbd6b) | <b><i>(Public Preview)</i></b> Returns an <code>[ImagenModel](./vertexai.imagenmodel.md#imagenmodel_class)</code> class with methods for using Imagen.<!-- -->Only Imagen 3 models (named <code>imagen-3.0-*</code>) are supported. |
2626
| <b>function(location, ...)</b> |
27-
| [vertexAIBackend(location)](./vertexai.md#vertexaibackend_d0a4534) | Creates a <code>[Backend](./vertexai.md#backend)</code> instance configured to use Vertex AI. |
27+
| [vertexAIBackend(location)](./vertexai.md#vertexaibackend_d0a4534) | Creates a [Backend](./vertexai.md#backend) instance configured to use Vertex AI. |
2828

2929
## Classes
3030

@@ -131,7 +131,7 @@ https://github.com/firebase/firebase-js-sdk
131131
| --- | --- |
132132
| [BackendType](./vertexai.md#backendtype) | An enum-like object containing constants that represent the supported backends for the Firebase GenAI SDK.<!-- -->These values are assigned to the <code>backendType</code> property within the specific backend configuration objects ([GoogleAIBackend](./vertexai.md#googleaibackend) or [VertexAIBackend](./vertexai.md#vertexaibackend)<!-- -->) to identify which service to target. |
133133
| [POSSIBLE\_ROLES](./vertexai.md#possible_roles) | Possible roles. |
134-
| [VertexAIError](./vertexai.md#vertexaierror) | Error class for the Vertex AI in Firebase SDK.<!-- -->For more information, refer to the documentation for the new <code>[GenAIError](./vertexai.genaierror.md#genaierror_class)</code>. |
134+
| [VertexAIError](./vertexai.md#vertexaierror) | Error class for the Vertex AI in Firebase SDK.<!-- -->For more information, refer to the documentation for the new [GenAIError](./vertexai.genaierror.md#genaierror_class)<!-- -->. |
135135
| [VertexAIModel](./vertexai.md#vertexaimodel) | Base class for Vertex AI in Firebase model APIs.<!-- -->For more information, refer to the documentation for the new [GenAIModel](./vertexai.genaimodel.md#genaimodel_class)<!-- -->. |
136136

137137
## Type Aliases
@@ -164,14 +164,14 @@ export declare function getGenAI(app?: FirebaseApp, options?: GenAIOptions): Gen
164164

165165
| Parameter | Type | Description |
166166
| --- | --- | --- |
167-
| app | [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) | The <code>[FirebaseApp](./app.firebaseapp.md#firebaseapp_interface)</code> to use. |
168-
| options | [GenAIOptions](./vertexai.genaioptions.md#genaioptions_interface) | <code>[GenAIOptions](./vertexai.genaioptions.md#genaioptions_interface)</code> that configure the GenAI instance. |
167+
| app | [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) | The [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) to use. |
168+
| options | [GenAIOptions](./vertexai.genaioptions.md#genaioptions_interface) | [GenAIOptions](./vertexai.genaioptions.md#genaioptions_interface) that configure the GenAI instance. |
169169

170170
<b>Returns:</b>
171171

172172
[GenAI](./vertexai.genai.md#genai_interface)
173173

174-
The default <code>[GenAI](./vertexai.genai.md#genai_interface)</code> instance for the given <code>[FirebaseApp](./app.firebaseapp.md#firebaseapp_interface)</code>.
174+
The default [GenAI](./vertexai.genai.md#genai_interface) instance for the given [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface)<!-- -->.
175175

176176
### Example 1
177177

@@ -224,7 +224,7 @@ export declare function getVertexAI(app?: FirebaseApp, options?: VertexAIOptions
224224

225225
### googleAIBackend() {:#googleaibackend}
226226

227-
Creates a <code>[Backend](./vertexai.md#backend)</code> instance configured to use Google AI.
227+
Creates a [Backend](./vertexai.md#backend) instance configured to use Google AI.
228228

229229
<b>Signature:</b>
230230

@@ -235,13 +235,13 @@ export declare function googleAIBackend(): GoogleAIBackend;
235235

236236
[GoogleAIBackend](./vertexai.md#googleaibackend)
237237

238-
A <code>[GoogleAIBackend](./vertexai.md#googleaibackend)</code> object.
238+
A [GoogleAIBackend](./vertexai.md#googleaibackend) object.
239239

240240
## function(genAI, ...)
241241

242242
### getGenerativeModel(genAI, modelParams, requestOptions) {:#getgenerativemodel_e3ccf80}
243243

244-
Returns a <code>[GenerativeModel](./vertexai.generativemodel.md#generativemodel_class)</code> class with methods for inference and other functionality.
244+
Returns a <code>[GenerativeModel](./vertexai.generativemodel.md#generativemodel_class) class with methods for inference and other functionality.
245245

246246
<b>Signature:</b>
247247

@@ -296,7 +296,7 @@ If the `apiKey` or `projectId` fields are missing in your Firebase config.
296296

297297
### vertexAIBackend(location) {:#vertexaibackend_d0a4534}
298298

299-
Creates a <code>[Backend](./vertexai.md#backend)</code> instance configured to use Vertex AI.
299+
Creates a [Backend](./vertexai.md#backend) instance configured to use Vertex AI.
300300

301301
<b>Signature:</b>
302302

@@ -314,7 +314,7 @@ export declare function vertexAIBackend(location?: string): VertexAIBackend;
314314

315315
[VertexAIBackend](./vertexai.md#vertexaibackend)
316316

317-
A <code>[VertexAIBackend](./vertexai.md#vertexaibackend)</code> object.
317+
A [VertexAIBackend](./vertexai.md#vertexaibackend) object.
318318

319319
## BackendType
320320

@@ -345,7 +345,7 @@ POSSIBLE_ROLES: readonly ["user", "model", "function", "system"]
345345

346346
Error class for the Vertex AI in Firebase SDK.
347347

348-
For more information, refer to the documentation for the new <code>[GenAIError](./vertexai.genaierror.md#genaierror_class)</code>.
348+
For more information, refer to the documentation for the new [GenAIError](./vertexai.genaierror.md#genaierror_class)<!-- -->.
349349

350350
<b>Signature:</b>
351351

packages/vertexai/src/api.ts

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ export const VertexAIModel = GenAIModel;
5858
/**
5959
* Error class for the Vertex AI in Firebase SDK.
6060
*
61-
* For more information, refer to the documentation for the new <code>{@link GenAIError}</code>.
61+
* For more information, refer to the documentation for the new {@link GenAIError}.
6262
*
6363
* @public
6464
*/
@@ -116,9 +116,9 @@ export function getVertexAI(
116116
* const genAI = getGenAI(app, { backend: vertexAIBackend() });
117117
* ```
118118
*
119-
* @param app - The <code>{@link @firebase/app#FirebaseApp}</code> to use.
120-
* @param options - <code>{@link GenAIOptions}</code> that configure the GenAI instance.
121-
* @returns The default <code>{@link GenAI}</code> instance for the given <code>{@link @firebase/app#FirebaseApp}</code>.
119+
* @param app - The {@link @firebase/app#FirebaseApp} to use.
120+
* @param options - {@link GenAIOptions} that configure the GenAI instance.
121+
* @returns The default {@link GenAI} instance for the given {@link @firebase/app#FirebaseApp}.
122122
*
123123
* @public
124124
*/
@@ -137,9 +137,9 @@ export function getGenAI(
137137
}
138138

139139
/**
140-
* Creates a <code>{@link Backend}</code> instance configured to use Google AI.
140+
* Creates a {@link Backend} instance configured to use Google AI.
141141
*
142-
* @returns A <code>{@link GoogleAIBackend}</code> object.
142+
* @returns A {@link GoogleAIBackend} object.
143143
*
144144
* @public
145145
*/
@@ -152,12 +152,12 @@ export function googleAIBackend(): GoogleAIBackend {
152152
}
153153

154154
/**
155-
* Creates a <code>{@link Backend}</code> instance configured to use Vertex AI.
155+
* Creates a {@link Backend} instance configured to use Vertex AI.
156156
*
157157
* @param location - The region identifier, defaulting to `us-central1`;
158158
* see {@link https://firebase.google.com/docs/vertex-ai/locations?platform=ios#available-locations | Vertex AI locations}
159159
* for a list of supported locations.
160-
* @returns A <code>{@link VertexAIBackend}</code> object.
160+
* @returns A {@link VertexAIBackend} object.
161161
*
162162
* @public
163163
*/
@@ -171,7 +171,7 @@ export function vertexAIBackend(location?: string): VertexAIBackend {
171171
}
172172

173173
/**
174-
* Returns a <code>{@link GenerativeModel}</code> class with methods for inference
174+
* Returns a <code>{@link GenerativeModel} class with methods for inference
175175
* and other functionality.
176176
*
177177
* @public

0 commit comments

Comments
 (0)