Skip to content

Commit

Permalink
fix links
Browse files Browse the repository at this point in the history
  • Loading branch information
dlarocque committed Feb 13, 2025
1 parent ade589d commit 718c7e2
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
8 changes: 4 additions & 4 deletions docs-devsite/vertexai.imagengenerationconfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,11 @@ export interface ImagenGenerationConfig

| Property | Type | Description |
| --- | --- | --- |
| [addWatermark](./vertexai.imagengenerationconfig.md#imagengenerationconfigaddwatermark) | boolean | <b><i>(Public Preview)</i></b> 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. |
| [addWatermark](./vertexai.imagengenerationconfig.md#imagengenerationconfigaddwatermark) | boolean | <b><i>(Public Preview)</i></b> 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 <a href="https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/imagen-api#parameter_list"><code>addWatermark</code></a> documentation for more details. |
| [aspectRatio](./vertexai.imagengenerationconfig.md#imagengenerationconfigaspectratio) | [ImagenAspectRatio](./vertexai.md#imagenaspectratio) | <b><i>(Public Preview)</i></b> 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) | <b><i>(Public Preview)</i></b> 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 | <b><i>(Public Preview)</i></b> 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 | <b><i>(Public Preview)</i></b> 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. |
| [numberOfImages](./vertexai.imagengenerationconfig.md#imagengenerationconfignumberofimages) | number | <b><i>(Public Preview)</i></b> 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 <a href="https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/imagen-api#parameter_list"><code>sampleCount</code></a> documentation for more details. |

## ImagenGenerationConfig.addWatermark

Expand All @@ -42,7 +42,7 @@ 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 <a href="https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/imagen-api#parameter_list"><code>addWatermark</code></a> documentation for more details.

<b>Signature:</b>

Expand Down Expand Up @@ -102,7 +102,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 <a href="https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/imagen-api#parameter_list"><code>sampleCount</code></a> documentation for more details.

<b>Signature:</b>

Expand Down
4 changes: 2 additions & 2 deletions packages/vertexai/src/types/imagen/requests.ts
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ export interface ImagenGenerationConfig {
* 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 {@link https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/imagen-api#parameter_list | sampleCount}
* (typically up to 4); see the <a href="https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/imagen-api#parameter_list"><code>sampleCount</code></a>
* documentation for more details.
*/
numberOfImages?: number;
Expand All @@ -86,7 +86,7 @@ export interface ImagenGenerationConfig {
* 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 {@link https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/imagen-api#parameter_list | addWatermark }
* The default value depends on the Imagen model; see the <a href="https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/imagen-api#parameter_list"><code>addWatermark</code></a>
* documentation for more details.
*/
addWatermark?: boolean;
Expand Down

0 comments on commit 718c7e2

Please sign in to comment.