Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dlarocque committed Feb 7, 2025
1 parent 7b5a138 commit fc8da49
Show file tree
Hide file tree
Showing 10 changed files with 47 additions and 51 deletions.
14 changes: 7 additions & 7 deletions docs-devsite/vertexai.imagengenerationconfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ https://github.com/firebase/firebase-js-sdk
# ImagenGenerationConfig interface
Configuration options for generating images with Imagen.

See the \[Cloud documentation\](https://cloud.google.com/vertex-ai/generative-ai/docs/image/generate-images) for more details.
See the [Cloud documentation](https://cloud.google.com/vertex-ai/generative-ai/docs/image/generate-images) for more details.

<b>Signature:</b>

Expand All @@ -24,19 +24,19 @@ export interface ImagenGenerationConfig

| Property | Type | Description |
| --- | --- | --- |
| [addWatermark](./vertexai.imagengenerationconfig.md#imagengenerationconfigaddwatermark) | boolean | Whether to add an invisible watermark to generated images.<!-- -->If set to <code>true</code>, an invisible SynthID watermark is embedded in generated images to indicate that they are AI generated. If set to <code>false</code>, watermarking will be disabled.<!-- -->The default value depends on the Imagen model; see the \[<code>addWatermark</code>\](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/imagen-api\#parameter\_list) documentation for more details. |
| [addWatermark](./vertexai.imagengenerationconfig.md#imagengenerationconfigaddwatermark) | boolean | Whether to add an invisible watermark to generated images.<!-- -->If set to <code>true</code>, an invisible SynthID watermark is embedded in generated images to indicate that they are AI generated. If set to <code>false</code>, watermarking will be disabled.<!-- -->The default value depends on the Imagen model; see the [addWatermark](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/imagen-api#parameter_list) documentation for more details. |
| [aspectRatio](./vertexai.imagengenerationconfig.md#imagengenerationconfigaspectratio) | [ImagenAspectRatio](./vertexai.md#imagenaspectratio) | The aspect ratio of the generated images. The default value is square 1:1. Supported aspect ratios depend on the Imagen model, see <code>[ImagenAspectRatio](./vertexai.md#imagenaspectratio)</code> for more details. |
| [imageFormat](./vertexai.imagengenerationconfig.md#imagengenerationconfigimageformat) | [ImagenImageFormat](./vertexai.imagenimageformat.md#imagenimageformat_class) | The image format of the generated images. The default is PNG.<!-- -->See <code>[ImagenImageFormat](./vertexai.imagenimageformat.md#imagenimageformat_class)</code> for more details. |
| [negativePrompt](./vertexai.imagengenerationconfig.md#imagengenerationconfignegativeprompt) | string | A description of what should be omitted from the generated images.<!-- -->Support for negative prompts depends on the Imagen model.<!-- -->See the \[Cloud documentation\](https://cloud.google.com/vertex-ai/generative-ai/docs/image/generate-images\#negative-prompt) for more details. |
| [numberOfImages](./vertexai.imagengenerationconfig.md#imagengenerationconfignumberofimages) | number | The number of images to generate. The default value is 1.<!-- -->The number of sample images that may be generated in each request depends on the model (typically up to 4); see the \[<code>sampleCount</code>\](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/imagen-api\#parameter\_list) documentation for more details. |
| [negativePrompt](./vertexai.imagengenerationconfig.md#imagengenerationconfignegativeprompt) | string | A description of what should be omitted from the generated images.<!-- -->Support for negative prompts depends on the Imagen model.<!-- -->See the [Cloud documentation](https://cloud.google.com/vertex-ai/generative-ai/docs/image/generate-images#negative-prompt) for more details. |
| [numberOfImages](./vertexai.imagengenerationconfig.md#imagengenerationconfignumberofimages) | number | The number of images to generate. The default value is 1.<!-- -->The number of sample images that may be generated in each request depends on the model (typically up to 4); see the [sampleCount](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/imagen-api#parameter_list) documentation for more details. |

## ImagenGenerationConfig.addWatermark

Whether to add an invisible watermark to generated images.

If set to `true`<!-- -->, an invisible SynthID watermark is embedded in generated images to indicate that they are AI generated. If set to `false`<!-- -->, watermarking will be disabled.

The default value depends on the Imagen model; see the \[`addWatermark`<!-- -->\](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/imagen-api\#parameter\_list) documentation for more details.
The default value depends on the Imagen model; see the [addWatermark](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/imagen-api#parameter_list) documentation for more details.

<b>Signature:</b>

Expand Down Expand Up @@ -72,7 +72,7 @@ A description of what should be omitted from the generated images.

Support for negative prompts depends on the Imagen model.

See the \[Cloud documentation\](https://cloud.google.com/vertex-ai/generative-ai/docs/image/generate-images\#negative-prompt) for more details.
See the [Cloud documentation](https://cloud.google.com/vertex-ai/generative-ai/docs/image/generate-images#negative-prompt) for more details.

<b>Signature:</b>

Expand All @@ -84,7 +84,7 @@ negativePrompt?: string;

The number of images to generate. The default value is 1.

The number of sample images that may be generated in each request depends on the model (typically up to 4); see the \[`sampleCount`<!-- -->\](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/imagen-api\#parameter\_list) documentation for more details.
The number of sample images that may be generated in each request depends on the model (typically up to 4); see the [sampleCount](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/imagen-api#parameter_list) documentation for more details.

<b>Signature:</b>

Expand Down
4 changes: 2 additions & 2 deletions docs-devsite/vertexai.imagengenerationresponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ export interface ImagenGenerationResponse<T extends ImagenInlineImage | ImagenGC

| Property | Type | Description |
| --- | --- | --- |
| [filteredReason](./vertexai.imagengenerationresponse.md#imagengenerationresponsefilteredreason) | string | The reason that images were filtered out. This property will only be defined if one or more images were filtered.<!-- -->Images may be filtered out due to the <code>[ImagenSafetyFilterLevel](./vertexai.md#imagensafetyfilterlevel)</code>, <code>[ImagenPersonFilterLevel](./vertexai.md#imagenpersonfilterlevel)</code>, or filtering included in the model. The filter levels may be adjusted in your <code>[ImagenSafetySettings](./vertexai.imagensafetysettings.md#imagensafetysettings_interface)</code>.<!-- -->See the \[Responsible AI and usage guidelines for Imagen\](https://cloud.google.com/vertex-ai/generative-ai/docs/image/responsible-ai-imagen) for more details. |
| [filteredReason](./vertexai.imagengenerationresponse.md#imagengenerationresponsefilteredreason) | string | The reason that images were filtered out. This property will only be defined if one or more images were filtered.<!-- -->Images may be filtered out due to the <code>[ImagenSafetyFilterLevel](./vertexai.md#imagensafetyfilterlevel)</code>, <code>[ImagenPersonFilterLevel](./vertexai.md#imagenpersonfilterlevel)</code>, or filtering included in the model. The filter levels may be adjusted in your <code>[ImagenSafetySettings](./vertexai.imagensafetysettings.md#imagensafetysettings_interface)</code>.<!-- -->See the [Responsible AI and usage guidelines for Imagen](https://cloud.google.com/vertex-ai/generative-ai/docs/image/responsible-ai-imagen) for more details. |
| [images](./vertexai.imagengenerationresponse.md#imagengenerationresponseimages) | T\[\] | The images generated by Imagen.<!-- -->The number of images generated may be fewer than the number requested if one or more were filtered out; see <code>filteredReason</code>. |

## ImagenGenerationResponse.filteredReason
Expand All @@ -31,7 +31,7 @@ The reason that images were filtered out. This property will only be defined if

Images may be filtered out due to the <code>[ImagenSafetyFilterLevel](./vertexai.md#imagensafetyfilterlevel)</code>, <code>[ImagenPersonFilterLevel](./vertexai.md#imagenpersonfilterlevel)</code>, or filtering included in the model. The filter levels may be adjusted in your <code>[ImagenSafetySettings](./vertexai.imagensafetysettings.md#imagensafetysettings_interface)</code>.

See the \[Responsible AI and usage guidelines for Imagen\](https://cloud.google.com/vertex-ai/generative-ai/docs/image/responsible-ai-imagen) for more details.
See the [Responsible AI and usage guidelines for Imagen](https://cloud.google.com/vertex-ai/generative-ai/docs/image/responsible-ai-imagen) for more details.

<b>Signature:</b>

Expand Down
8 changes: 4 additions & 4 deletions docs-devsite/vertexai.imagenmodel.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ https://github.com/firebase/firebase-js-sdk
# ImagenModel class
Class for Imagen model APIs.

This class provides methods for generating images using the Imagen model. You can generate images inline as base64-encoded strings, or directly to Google Cloud Storage (GCS).
This class provides methods for generating images using the Imagen model.

<b>Signature:</b>

Expand All @@ -25,7 +25,7 @@ export declare class ImagenModel extends VertexAIModel
| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(vertexAI, modelParams, requestOptions)](./vertexai.imagenmodel.md#imagenmodelconstructor) | | Constructs a new instance of the [ImagenModel](./vertexai.imagenmodel.md#imagenmodel_class) class. |
| [(constructor)(vertexAI, modelParams, requestOptions)](./vertexai.imagenmodel.md#imagenmodelconstructor) | | Constructs a new instance of the <code>[ImagenModel](./vertexai.imagenmodel.md#imagenmodel_class)</code> class. |
## Properties
Expand All @@ -44,7 +44,7 @@ export declare class ImagenModel extends VertexAIModel
## ImagenModel.(constructor)
Constructs a new instance of the [ImagenModel](./vertexai.imagenmodel.md#imagenmodel_class) class.
Constructs a new instance of the <code>[ImagenModel](./vertexai.imagenmodel.md#imagenmodel_class)</code> class.
<b>Signature:</b>
Expand Down Expand Up @@ -153,7 +153,7 @@ generateImagesGCS(prompt: string, gcsURI: string): Promise<ImagenGenerationRespo
Promise&lt;[ImagenGenerationResponse](./vertexai.imagengenerationresponse.md#imagengenerationresponse_interface)<!-- -->&lt;[ImagenGCSImage](./vertexai.imagengcsimage.md#imagengcsimage_interface)<!-- -->&gt;&gt;
A promise that resolves to an [ImagenGenerationResponse](./vertexai.imagengenerationresponse.md#imagengenerationresponse_interface) object containing the URLs of the generated images.
A promise that resolves to an <code>[ImagenGenerationResponse](./vertexai.imagengenerationresponse.md#imagengenerationresponse_interface)</code> object containing the URLs of the generated images.
#### Exceptions
Expand Down
4 changes: 2 additions & 2 deletions docs-devsite/vertexai.imagenmodelparams.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ export interface ImagenModelParams
| Property | Type | Description |
| --- | --- | --- |
| [generationConfig](./vertexai.imagenmodelparams.md#imagenmodelparamsgenerationconfig) | [ImagenGenerationConfig](./vertexai.imagengenerationconfig.md#imagengenerationconfig_interface) | Configuration options for generating images with Imagen. |
| [model](./vertexai.imagenmodelparams.md#imagenmodelparamsmodel) | string | The Imagen model to use for generating images. For example: <code>imagen-3.0-generate-002</code>.<!-- -->Only Imagen 3 models (named <code>imagen-3.0-*</code>) are supported.<!-- -->See \[model versions\](https://cloud.google.com/vertex-ai/generative-ai/docs/image/model-versioning) for a full list of supported Imagen 3 models. |
| [model](./vertexai.imagenmodelparams.md#imagenmodelparamsmodel) | string | The Imagen model to use for generating images. For example: <code>imagen-3.0-generate-002</code>.<!-- -->Only Imagen 3 models (named <code>imagen-3.0-*</code>) are supported.<!-- -->See [model versions](https://cloud.google.com/vertex-ai/generative-ai/docs/image/model-versioning) for a full list of supported Imagen 3 models. |
| [safetySettings](./vertexai.imagenmodelparams.md#imagenmodelparamssafetysettings) | [ImagenSafetySettings](./vertexai.imagensafetysettings.md#imagensafetysettings_interface) | Safety settings for filtering potentially inappropriate content. |

## ImagenModelParams.generationConfig
Expand All @@ -42,7 +42,7 @@ The Imagen model to use for generating images. For example: `imagen-3.0-generate

Only Imagen 3 models (named `imagen-3.0-*`<!-- -->) are supported.

See \[model versions\](https://cloud.google.com/vertex-ai/generative-ai/docs/image/model-versioning) for a full list of supported Imagen 3 models.
See [model versions](https://cloud.google.com/vertex-ai/generative-ai/docs/image/model-versioning) for a full list of supported Imagen 3 models.

<b>Signature:</b>

Expand Down
2 changes: 1 addition & 1 deletion docs-devsite/vertexai.imagensafetysettings.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ https://github.com/firebase/firebase-js-sdk
# ImagenSafetySettings interface
Settings for controlling the aggressiveness of filtering out sensitive content.

See the \[Responsible AI and usage guidelines\](https://cloud.google.com/vertex-ai/generative-ai/docs/image/responsible-ai-imagen\#config-safety-filters) for more details.
See the [https://www.newyorker.com/magazine/2018/12/10/the-friendship-that-made-google-huge](https://cloud.google.com/vertex-ai/generative-ai/docs/image/responsible-ai-imagen#config-safety-filters) for more details.

<b>Signature:</b>

Expand Down
Loading

0 comments on commit fc8da49

Please sign in to comment.