-
Notifications
You must be signed in to change notification settings - Fork 154
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
24 changed files
with
358 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
"@google/generative-ai": minor | ||
--- | ||
|
||
Add imagen feature. |
25 changes: 25 additions & 0 deletions
25
docs/reference/main/generative-ai.googlegenerativeai.getimagegenerationmodel.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GoogleGenerativeAI](./generative-ai.googlegenerativeai.md) > [getImageGenerationModel](./generative-ai.googlegenerativeai.getimagegenerationmodel.md) | ||
|
||
## GoogleGenerativeAI.getImageGenerationModel() method | ||
|
||
Gets a [ImageGenerationModel](./generative-ai.imagegenerationmodel.md) instance for the provided model name. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
getImageGenerationModel(modelParams: ModelParams, requestOptions?: RequestOptions): ImageGenerationModel; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| modelParams | [ModelParams](./generative-ai.modelparams.md) | | | ||
| requestOptions | [RequestOptions](./generative-ai.requestoptions.md) | _(Optional)_ | | ||
|
||
**Returns:** | ||
|
||
[ImageGenerationModel](./generative-ai.imagegenerationmodel.md) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
22 changes: 22 additions & 0 deletions
22
docs/reference/main/generative-ai.imagegenerationmodel._constructor_.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ImageGenerationModel](./generative-ai.imagegenerationmodel.md) > [(constructor)](./generative-ai.imagegenerationmodel._constructor_.md) | ||
|
||
## ImageGenerationModel.(constructor) | ||
|
||
Constructs a new instance of the `ImageGenerationModel` class | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
constructor(apiKey: string, modelParams: ModelParams, _requestOptions?: RequestOptions); | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| apiKey | string | | | ||
| modelParams | [ModelParams](./generative-ai.modelparams.md) | | | ||
| \_requestOptions | [RequestOptions](./generative-ai.requestoptions.md) | _(Optional)_ | | ||
|
11 changes: 11 additions & 0 deletions
11
docs/reference/main/generative-ai.imagegenerationmodel.apikey.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ImageGenerationModel](./generative-ai.imagegenerationmodel.md) > [apiKey](./generative-ai.imagegenerationmodel.apikey.md) | ||
|
||
## ImageGenerationModel.apiKey property | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
apiKey: string; | ||
``` |
29 changes: 29 additions & 0 deletions
29
docs/reference/main/generative-ai.imagegenerationmodel.generateimages.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ImageGenerationModel](./generative-ai.imagegenerationmodel.md) > [generateImages](./generative-ai.imagegenerationmodel.generateimages.md) | ||
|
||
## ImageGenerationModel.generateImages() method | ||
|
||
Makes a single non-streaming call to the model and returns an object containing a single [ImageGenerationResponse](./generative-ai.imagegenerationresponse.md)<!-- -->. | ||
|
||
Inside the response there will be generated pictures specified by numberOfImages in [ImageGenerationRequest](./generative-ai.imagegenerationrequest.md) | ||
|
||
Fields set in the optional [SingleRequestOptions](./generative-ai.singlerequestoptions.md) parameter will take precedence over the [RequestOptions](./generative-ai.requestoptions.md) values provided to [GoogleGenerativeAI.getImageGenerationModel()](./generative-ai.googlegenerativeai.getimagegenerationmodel.md)<!-- -->. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
generateImages(request: ImageGenerationRequest | string, requestOptions?: SingleRequestOptions): Promise<ImageGenerationResponse>; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| request | [ImageGenerationRequest](./generative-ai.imagegenerationrequest.md) \| string | | | ||
| requestOptions | [SingleRequestOptions](./generative-ai.singlerequestoptions.md) | _(Optional)_ | | ||
|
||
**Returns:** | ||
|
||
Promise<[ImageGenerationResponse](./generative-ai.imagegenerationresponse.md)<!-- -->> | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ImageGenerationModel](./generative-ai.imagegenerationmodel.md) | ||
|
||
## ImageGenerationModel class | ||
|
||
Class for generative model APIs. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
export declare class ImageGenerationModel | ||
``` | ||
|
||
## Constructors | ||
|
||
| Constructor | Modifiers | Description | | ||
| --- | --- | --- | | ||
| [(constructor)(apiKey, modelParams, \_requestOptions)](./generative-ai.imagegenerationmodel._constructor_.md) | | Constructs a new instance of the <code>ImageGenerationModel</code> class | | ||
|
||
## Properties | ||
|
||
| Property | Modifiers | Type | Description | | ||
| --- | --- | --- | --- | | ||
| [apiKey](./generative-ai.imagegenerationmodel.apikey.md) | | string | | | ||
| [model](./generative-ai.imagegenerationmodel.model.md) | | string | | | ||
|
||
## Methods | ||
|
||
| Method | Modifiers | Description | | ||
| --- | --- | --- | | ||
| [generateImages(request, requestOptions)](./generative-ai.imagegenerationmodel.generateimages.md) | | <p>Makes a single non-streaming call to the model and returns an object containing a single [ImageGenerationResponse](./generative-ai.imagegenerationresponse.md)<!-- -->.</p><p>Inside the response there will be generated pictures specified by numberOfImages in [ImageGenerationRequest](./generative-ai.imagegenerationrequest.md)</p><p>Fields set in the optional [SingleRequestOptions](./generative-ai.singlerequestoptions.md) parameter will take precedence over the [RequestOptions](./generative-ai.requestoptions.md) values provided to [GoogleGenerativeAI.getImageGenerationModel()](./generative-ai.googlegenerativeai.getimagegenerationmodel.md)<!-- -->.</p> | | ||
|
11 changes: 11 additions & 0 deletions
11
docs/reference/main/generative-ai.imagegenerationmodel.model.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ImageGenerationModel](./generative-ai.imagegenerationmodel.md) > [model](./generative-ai.imagegenerationmodel.model.md) | ||
|
||
## ImageGenerationModel.model property | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
model: string; | ||
``` |
13 changes: 13 additions & 0 deletions
13
docs/reference/main/generative-ai.imagegenerationrequest.aspectratio.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ImageGenerationRequest](./generative-ai.imagegenerationrequest.md) > [aspectRatio](./generative-ai.imagegenerationrequest.aspectratio.md) | ||
|
||
## ImageGenerationRequest.aspectRatio property | ||
|
||
Changes the aspect ratio of the generated image. Supported values are: \* "1:1" : 1:1 aspect ratio \* "9:16" : 9:16 aspect ratio \* "16:9" : 16:9 aspect ratio \* "4:3" : 4:3 aspect ratio \* "3:4" : 3:4 aspect\_ratio | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
aspectRatio?: "1:1" | "9:16" | "16:9" | "4:3" | "3:4"; | ||
``` |
13 changes: 13 additions & 0 deletions
13
docs/reference/main/generative-ai.imagegenerationrequest.compressionquality.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ImageGenerationRequest](./generative-ai.imagegenerationrequest.md) > [compressionQuality](./generative-ai.imagegenerationrequest.compressionquality.md) | ||
|
||
## ImageGenerationRequest.compressionQuality property | ||
|
||
Level of compression if the output mime type is selected to be image/jpeg. Float between 0 to 100 | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
compressionQuality?: number; | ||
``` |
13 changes: 13 additions & 0 deletions
13
docs/reference/main/generative-ai.imagegenerationrequest.guidancescale.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ImageGenerationRequest](./generative-ai.imagegenerationrequest.md) > [guidanceScale](./generative-ai.imagegenerationrequest.guidancescale.md) | ||
|
||
## ImageGenerationRequest.guidanceScale property | ||
|
||
Controls the strength of the prompt. Suggested values are: \* 0-9 (low strength) \* 10-20 (medium strength) \* 21+ (high strength) | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
guidanceScale?: number; | ||
``` |
13 changes: 13 additions & 0 deletions
13
docs/reference/main/generative-ai.imagegenerationrequest.height.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ImageGenerationRequest](./generative-ai.imagegenerationrequest.md) > [height](./generative-ai.imagegenerationrequest.height.md) | ||
|
||
## ImageGenerationRequest.height property | ||
|
||
Height of the image. One of the Width/Height sizes must be 256 or 1024. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
height?: number; | ||
``` |
13 changes: 13 additions & 0 deletions
13
docs/reference/main/generative-ai.imagegenerationrequest.language.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ImageGenerationRequest](./generative-ai.imagegenerationrequest.md) > [language](./generative-ai.imagegenerationrequest.language.md) | ||
|
||
## ImageGenerationRequest.language property | ||
|
||
Language of the text prompt for the image. Default: None. Supported values are `"en"` for English, `"hi"` for Hindi, `"ja"` for Japanese, `"ko"` for Korean, and `"auto"` for automatic language detection. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
language?: string; | ||
``` |
31 changes: 31 additions & 0 deletions
31
docs/reference/main/generative-ai.imagegenerationrequest.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ImageGenerationRequest](./generative-ai.imagegenerationrequest.md) | ||
|
||
## ImageGenerationRequest interface | ||
|
||
Request message for generating image. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
export interface ImageGenerationRequest | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Modifiers | Type | Description | | ||
| --- | --- | --- | --- | | ||
| [aspectRatio?](./generative-ai.imagegenerationrequest.aspectratio.md) | | "1:1" \| "9:16" \| "16:9" \| "4:3" \| "3:4" | _(Optional)_ Changes the aspect ratio of the generated image. Supported values are: \* "1:1" : 1:1 aspect ratio \* "9:16" : 9:16 aspect ratio \* "16:9" : 16:9 aspect ratio \* "4:3" : 4:3 aspect ratio \* "3:4" : 3:4 aspect\_ratio | | ||
| [compressionQuality?](./generative-ai.imagegenerationrequest.compressionquality.md) | | number | _(Optional)_ Level of compression if the output mime type is selected to be image/jpeg. Float between 0 to 100 | | ||
| [guidanceScale?](./generative-ai.imagegenerationrequest.guidancescale.md) | | number | _(Optional)_ Controls the strength of the prompt. Suggested values are: \* 0-9 (low strength) \* 10-20 (medium strength) \* 21+ (high strength) | | ||
| [height?](./generative-ai.imagegenerationrequest.height.md) | | number | _(Optional)_ Height of the image. One of the Width/Height sizes must be 256 or 1024. | | ||
| [language?](./generative-ai.imagegenerationrequest.language.md) | | string | _(Optional)_ Language of the text prompt for the image. Default: None. Supported values are <code>"en"</code> for English, <code>"hi"</code> for Hindi, <code>"ja"</code> for Japanese, <code>"ko"</code> for Korean, and <code>"auto"</code> for automatic language detection. | | ||
| [negativePrompt?](./generative-ai.imagegenerationrequest.negativeprompt.md) | | string | _(Optional)_ A description of what you want to omit in the generated images. | | ||
| [numberOfImages?](./generative-ai.imagegenerationrequest.numberofimages.md) | | number | _(Optional)_ Number of images to generate. Range: 1..4. | | ||
| [outputMimeType?](./generative-ai.imagegenerationrequest.outputmimetype.md) | | "image/png" \| "image/jpeg" | _(Optional)_ Which image format should the output be saved as. Supported values: \* image/png: Save as a PNG image \* image/jpeg: Save as a JPEG image | | ||
| [personGeneration?](./generative-ai.imagegenerationrequest.persongeneration.md) | | "dont\_allow" \| "allow\_adult" | _(Optional)_ Allow generation of people by the model Supported values are: \* "dont\_allow" : Block generation of people \* "allow\_adult" : Generate adults, but not children | | ||
| [prompt](./generative-ai.imagegenerationrequest.prompt.md) | | string | Text prompt for the image. | | ||
| [safetyFilterLevel?](./generative-ai.imagegenerationrequest.safetyfilterlevel.md) | | "block\_low\_and\_above" \| "block\_medium\_and\_above" \| "block\_only\_high" | _(Optional)_ Adds a filter level to Safety filtering. Supported values are: \* "block\_most" : Strongest filtering level, most strict blocking \* "block\_some" : Block some problematic prompts and responses \* "block\_few" : Block fewer problematic prompts and responses | | ||
| [width?](./generative-ai.imagegenerationrequest.width.md) | | number | _(Optional)_ Width of the image. One of the Width/Height sizes must be 256 or 1024. | | ||
|
13 changes: 13 additions & 0 deletions
13
docs/reference/main/generative-ai.imagegenerationrequest.negativeprompt.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ImageGenerationRequest](./generative-ai.imagegenerationrequest.md) > [negativePrompt](./generative-ai.imagegenerationrequest.negativeprompt.md) | ||
|
||
## ImageGenerationRequest.negativePrompt property | ||
|
||
A description of what you want to omit in the generated images. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
negativePrompt?: string; | ||
``` |
13 changes: 13 additions & 0 deletions
13
docs/reference/main/generative-ai.imagegenerationrequest.numberofimages.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ImageGenerationRequest](./generative-ai.imagegenerationrequest.md) > [numberOfImages](./generative-ai.imagegenerationrequest.numberofimages.md) | ||
|
||
## ImageGenerationRequest.numberOfImages property | ||
|
||
Number of images to generate. Range: 1..4. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
numberOfImages?: number; | ||
``` |
13 changes: 13 additions & 0 deletions
13
docs/reference/main/generative-ai.imagegenerationrequest.outputmimetype.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ImageGenerationRequest](./generative-ai.imagegenerationrequest.md) > [outputMimeType](./generative-ai.imagegenerationrequest.outputmimetype.md) | ||
|
||
## ImageGenerationRequest.outputMimeType property | ||
|
||
Which image format should the output be saved as. Supported values: \* image/png: Save as a PNG image \* image/jpeg: Save as a JPEG image | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
outputMimeType?: "image/png" | "image/jpeg"; | ||
``` |
13 changes: 13 additions & 0 deletions
13
docs/reference/main/generative-ai.imagegenerationrequest.persongeneration.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ImageGenerationRequest](./generative-ai.imagegenerationrequest.md) > [personGeneration](./generative-ai.imagegenerationrequest.persongeneration.md) | ||
|
||
## ImageGenerationRequest.personGeneration property | ||
|
||
Allow generation of people by the model Supported values are: \* "dont\_allow" : Block generation of people \* "allow\_adult" : Generate adults, but not children | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
personGeneration?: "dont_allow" | "allow_adult"; | ||
``` |
13 changes: 13 additions & 0 deletions
13
docs/reference/main/generative-ai.imagegenerationrequest.prompt.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ImageGenerationRequest](./generative-ai.imagegenerationrequest.md) > [prompt](./generative-ai.imagegenerationrequest.prompt.md) | ||
|
||
## ImageGenerationRequest.prompt property | ||
|
||
Text prompt for the image. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
prompt: string; | ||
``` |
13 changes: 13 additions & 0 deletions
13
docs/reference/main/generative-ai.imagegenerationrequest.safetyfilterlevel.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ImageGenerationRequest](./generative-ai.imagegenerationrequest.md) > [safetyFilterLevel](./generative-ai.imagegenerationrequest.safetyfilterlevel.md) | ||
|
||
## ImageGenerationRequest.safetyFilterLevel property | ||
|
||
Adds a filter level to Safety filtering. Supported values are: \* "block\_most" : Strongest filtering level, most strict blocking \* "block\_some" : Block some problematic prompts and responses \* "block\_few" : Block fewer problematic prompts and responses | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
safetyFilterLevel?: "block_low_and_above" | "block_medium_and_above" | "block_only_high"; | ||
``` |
13 changes: 13 additions & 0 deletions
13
docs/reference/main/generative-ai.imagegenerationrequest.width.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ImageGenerationRequest](./generative-ai.imagegenerationrequest.md) > [width](./generative-ai.imagegenerationrequest.width.md) | ||
|
||
## ImageGenerationRequest.width property | ||
|
||
Width of the image. One of the Width/Height sizes must be 256 or 1024. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
width?: number; | ||
``` |
11 changes: 11 additions & 0 deletions
11
docs/reference/main/generative-ai.imagegenerationresponse.images.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ImageGenerationResponse](./generative-ai.imagegenerationresponse.md) > [images](./generative-ai.imagegenerationresponse.images.md) | ||
|
||
## ImageGenerationResponse.images property | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
images: GeneratedImage[]; | ||
``` |
20 changes: 20 additions & 0 deletions
20
docs/reference/main/generative-ai.imagegenerationresponse.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ImageGenerationResponse](./generative-ai.imagegenerationresponse.md) | ||
|
||
## ImageGenerationResponse interface | ||
|
||
Response message for generating image. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
export interface ImageGenerationResponse | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Modifiers | Type | Description | | ||
| --- | --- | --- | --- | | ||
| [images](./generative-ai.imagegenerationresponse.images.md) | | GeneratedImage\[\] | | | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters