You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs-devsite/vertexai.imagenmodel.md
+1-3Lines changed: 1 addition & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -42,7 +42,7 @@ export declare class ImagenModel extends VertexAIModel
42
42
43
43
| Method | Modifiers | Description |
44
44
| --- | --- | --- |
45
-
| [generateImages(prompt)](./vertexai.imagenmodel.md#imagenmodelgenerateimages) | | <b><i>(Public Preview)</i></b> Generates images using the Imagen model and returns them as base64-encoded strings.<!-- -->For Vertex AI in Firebase, 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. |
45
+
| [generateImages(prompt)](./vertexai.imagenmodel.md#imagenmodelgenerateimages) | | <b><i>(Public Preview)</i></b> Generates images using the Imagen model and returns them as base64-encoded strings. |
Generates images using the Imagen model and returns them as base64-encoded strings.
115
115
116
-
For Vertex AI in Firebase, 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.
117
-
118
116
If the prompt was not blocked, but one or more of the generated images were filtered, the returned object will have a `filteredReason` property. If all images are filtered, the `images` array will be empty.
Settings for controlling the aggressiveness of filtering out sensitive content.
17
17
18
-
See the [Cloud documentation](https://cloud.google.com/vertex-ai/generative-ai/docs/image/responsible-ai-imagen#config-safety-filters) for more details.
18
+
See the [documentation](http://firebase.google.com/docs/vertex-ai/generate-images) for more details.
Copy file name to clipboardExpand all lines: docs-devsite/vertexai.md
+8-10Lines changed: 8 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ The Vertex AI in Firebase Web SDK.
20
20
|[getVertexAI(app, options)](./vertexai.md#getvertexai_04094cf)| Returns a <code>[VertexAI](./vertexai.vertexai.md#vertexai_interface)</code> instance for the given app. |
21
21
| <b>function(vertexAI, ...)</b> |
22
22
|[getGenerativeModel(vertexAI, modelParams, requestOptions)](./vertexai.md#getgenerativemodel_e3037c9)| Returns a <code>[GenerativeModel](./vertexai.generativemodel.md#generativemodel_class)</code> class with methods for inference and other functionality. |
23
-
|[getImagenModel(vertexAI, modelParams, requestOptions)](./vertexai.md#getimagenmodel_812c375)| <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.<!---->For Vertex AI in Firebase, 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.|
23
+
|[getImagenModel(vertexAI, modelParams, requestOptions)](./vertexai.md#getimagenmodel_812c375)| <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. |
24
24
25
25
## Classes
26
26
@@ -52,9 +52,9 @@ The Vertex AI in Firebase Web SDK.
52
52
|[HarmCategory](./vertexai.md#harmcategory)| Harm categories that would cause prompts or candidates to be blocked. |
53
53
|[HarmProbability](./vertexai.md#harmprobability)| Probability that a prompt or candidate matches a harm category. |
|[ImagenAspectRatio](./vertexai.md#imagenaspectratio)| <b><i>(Public Preview)</i></b> Aspect ratios for Imagen images.<!---->To specify an aspect ratio for generated images, set the <code>aspectRatio</code> property in your <code>[ImagenGenerationConfig](./vertexai.imagengenerationconfig.md#imagengenerationconfig_interface)</code>.<!---->See the the [Cloud documentation](https://cloud.google.com/vertex-ai/generative-ai/docs/image/generate-images#aspect-ratio) for more details and examples of the supported aspect ratios. |
56
-
|[ImagenPersonFilterLevel](./vertexai.md#imagenpersonfilterlevel)| <b><i>(Public Preview)</i></b> A filter level controlling whether generation of images containing people or faces is allowed.<!---->See the [\`personGeneration\`](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/imagen-api#parameter_list) documentation for more details. |
57
-
|[ImagenSafetyFilterLevel](./vertexai.md#imagensafetyfilterlevel)| <b><i>(Public Preview)</i></b> A filter level controlling how aggressively to filter sensitive content.<!---->Text prompts provided as inputs and images (generated or uploaded) through Imagen on Vertex AI are assessed against a list of safety filters, which include 'harmful categories' (for example, <code>violence</code>, <code>sexual</code>, <code>derogatory</code>, and <code>toxic</code>). This filter level controls how aggressively to filter out potentially harmful content from responses. See the [\`safetySetting\`](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/imagen-api#parameter_list) documentation and the [Responsible AI and usage guidelines](https://cloud.google.com/vertex-ai/generative-ai/docs/image/responsible-ai-imagen#safety-filters) for more details. |
55
+
|[ImagenAspectRatio](./vertexai.md#imagenaspectratio)| <b><i>(Public Preview)</i></b> Aspect ratios for Imagen images.<!---->To specify an aspect ratio for generated images, set the <code>aspectRatio</code> property in your <code>[ImagenGenerationConfig](./vertexai.imagengenerationconfig.md#imagengenerationconfig_interface)</code>.<!---->See the the [documentation](http://firebase.google.com/docs/vertex-ai/generate-images) for more details and examples of the supported aspect ratios. |
56
+
|[ImagenPersonFilterLevel](./vertexai.md#imagenpersonfilterlevel)| <b><i>(Public Preview)</i></b> A filter level controlling whether generation of images containing people or faces is allowed.<!---->See the <ahref="http://firebase.google.com/docs/vertex-ai/generate-images"><code>personGeneration</code></a> documentation for more details. |
57
+
|[ImagenSafetyFilterLevel](./vertexai.md#imagensafetyfilterlevel)| <b><i>(Public Preview)</i></b> A filter level controlling how aggressively to filter sensitive content.<!---->Text prompts provided as inputs and images (generated or uploaded) through Imagen on Vertex AI are assessed against a list of safety filters, which include 'harmful categories' (for example, <code>violence</code>, <code>sexual</code>, <code>derogatory</code>, and <code>toxic</code>). This filter level controls how aggressively to filter out potentially harmful content from responses. See the [documentation](http://firebase.google.com/docs/vertex-ai/generate-images) and the [Responsible AI and usage guidelines](https://cloud.google.com/vertex-ai/generative-ai/docs/image/responsible-ai-imagen#safety-filters) for more details. |
58
58
|[SchemaType](./vertexai.md#schematype)| Contains the list of OpenAPI data types as defined by the [OpenAPI specification](https://swagger.io/docs/specification/data-models/data-types/)|
59
59
|[VertexAIErrorCode](./vertexai.md#vertexaierrorcode)| Standardized error codes that <code>[VertexAIError](./vertexai.vertexaierror.md#vertexaierror_class)</code> can have. |
60
60
@@ -95,7 +95,7 @@ The Vertex AI in Firebase Web SDK.
95
95
|[ImagenGenerationResponse](./vertexai.imagengenerationresponse.md#imagengenerationresponse_interface)| <b><i>(Public Preview)</i></b> The response from a request to generate images with Imagen. |
96
96
|[ImagenInlineImage](./vertexai.imageninlineimage.md#imageninlineimage_interface)| <b><i>(Public Preview)</i></b> An image generated by Imagen, represented as inline data. |
97
97
|[ImagenModelParams](./vertexai.imagenmodelparams.md#imagenmodelparams_interface)| <b><i>(Public Preview)</i></b> Parameters for configuring an <code>[ImagenModel](./vertexai.imagenmodel.md#imagenmodel_class)</code>. |
98
-
|[ImagenSafetySettings](./vertexai.imagensafetysettings.md#imagensafetysettings_interface)| <b><i>(Public Preview)</i></b> Settings for controlling the aggressiveness of filtering out sensitive content.<!---->See the [Cloud documentation](https://cloud.google.com/vertex-ai/generative-ai/docs/image/responsible-ai-imagen#config-safety-filters) for more details. |
98
+
|[ImagenSafetySettings](./vertexai.imagensafetysettings.md#imagensafetysettings_interface)| <b><i>(Public Preview)</i></b> Settings for controlling the aggressiveness of filtering out sensitive content.<!---->See the [documentation](http://firebase.google.com/docs/vertex-ai/generate-images) for more details. |
99
99
|[InlineDataPart](./vertexai.inlinedatapart.md#inlinedatapart_interface)| Content part interface if the part represents an image. |
100
100
|[ModelParams](./vertexai.modelparams.md#modelparams_interface)| Params passed to <code>[getGenerativeModel()](./vertexai.md#getgenerativemodel_e3037c9)</code>. |
101
101
|[ObjectSchemaInterface](./vertexai.objectschemainterface.md#objectschemainterface_interface)| Interface for <code>[ObjectSchema](./vertexai.objectschema.md#objectschema_class)</code> class. |
@@ -189,8 +189,6 @@ Returns an <code>[ImagenModel](./vertexai.imagenmodel.md#imagenmodel_class)</cod
189
189
190
190
Only Imagen 3 models (named `imagen-3.0-*`<!---->) are supported.
191
191
192
-
For Vertex AI in Firebase, 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.
193
-
194
192
<b>Signature:</b>
195
193
196
194
```typescript
@@ -418,7 +416,7 @@ Aspect ratios for Imagen images.
418
416
419
417
To specify an aspect ratio for generated images, set the `aspectRatio` property in your <code>[ImagenGenerationConfig](./vertexai.imagengenerationconfig.md#imagengenerationconfig_interface)</code>.
420
418
421
-
See the the [Cloud documentation](https://cloud.google.com/vertex-ai/generative-ai/docs/image/generate-images#aspect-ratio) for more details and examples of the supported aspect ratios.
419
+
See the the [documentation](http://firebase.google.com/docs/vertex-ai/generate-images) for more details and examples of the supported aspect ratios.
A filter level controlling whether generation of images containing people or faces is allowed.
445
443
446
-
See the [\`personGeneration\`](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/imagen-api#parameter_list) documentation for more details.
444
+
See the <a href="http://firebase.google.com/docs/vertex-ai/generate-images"><code>personGeneration</code></a> documentation for more details.
A filter level controlling how aggressively to filter sensitive content.
468
466
469
-
Text prompts provided as inputs and images (generated or uploaded) through Imagen on Vertex AI are assessed against a list of safety filters, which include 'harmful categories' (for example, `violence`<!-- -->, `sexual`<!-- -->, `derogatory`<!-- -->, and `toxic`<!-- -->). This filter level controls how aggressively to filter out potentially harmful content from responses. See the [\`safetySetting\`](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/imagen-api#parameter_list) documentation and the [Responsible AI and usage guidelines](https://cloud.google.com/vertex-ai/generative-ai/docs/image/responsible-ai-imagen#safety-filters) for more details.
467
+
Text prompts provided as inputs and images (generated or uploaded) through Imagen on Vertex AI are assessed against a list of safety filters, which include 'harmful categories' (for example, `violence`<!-- -->, `sexual`<!-- -->, `derogatory`<!-- -->, and `toxic`<!-- -->). This filter level controls how aggressively to filter out potentially harmful content from responses. See the [documentation](http://firebase.google.com/docs/vertex-ai/generate-images) and the [Responsible AI and usage guidelines](https://cloud.google.com/vertex-ai/generative-ai/docs/image/responsible-ai-imagen#safety-filters) for more details.
0 commit comments