Imagen

.changeset/twelve-toes-smash.md

@@ -0,0 +1,5 @@
+---
+"@google/generative-ai": minor
+---
+
+Add support for imagen model.

common/api-review/generative-ai.api.md

@@ -503,6 +503,7 @@ export class GoogleGenerativeAI {
     apiKey: string;
     getGenerativeModel(modelParams: ModelParams, requestOptions?: RequestOptions): GenerativeModel;
     getGenerativeModelFromCachedContent(cachedContent: CachedContent, modelParams?: Partial<ModelParams>, requestOptions?: RequestOptions): GenerativeModel;
+    getImageGenerationModel(modelParams: ModelParams, requestOptions?: RequestOptions): ImageGenerationModel;
 }
 
 // @public
@@ -619,6 +620,40 @@ export enum HarmProbability {
     NEGLIGIBLE = "NEGLIGIBLE"
 }
 
+// @public
+export class ImageGenerationModel {
+    constructor(apiKey: string, modelParams: ModelParams, _requestOptions?: RequestOptions);
+    // (undocumented)
+    apiKey: string;
+    generateImages(request: ImageGenerationRequest | string, requestOptions?: SingleRequestOptions): Promise<ImageGenerationResponse>;
+    // (undocumented)
+    model: string;
+}
+
+// @public
+export interface ImageGenerationRequest {
+    aspectRatio?: "1:1" | "9:16" | "16:9" | "4:3" | "3:4";
+    compressionQuality?: number;
+    guidanceScale?: number;
+    height?: number;
+    language?: string;
+    negativePrompt?: string;
+    numberOfImages?: number;
+    outputMimeType?: "image/png" | "image/jpeg";
+    personGeneration?: "dont_allow" | "allow_adult";
+    prompt: string;
+    safetyFilterLevel?: "block_low_and_above" | "block_medium_and_above" | "block_only_high";
+    width?: number;
+}
+
+// @public
+export interface ImageGenerationResponse {
+    // Warning: (ae-forgotten-export) The symbol "GeneratedImage" needs to be exported by the entry point index.d.ts
+    //
+    // (undocumented)
+    images: GeneratedImage[];
+}
+
 // @public
 export interface InlineDataPart {
     // (undocumented)

docs/reference/main/generative-ai.googlegenerativeai.getimagegenerationmodel.md

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [GoogleGenerativeAI](./generative-ai.googlegenerativeai.md) &gt; [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)
+

docs/reference/main/generative-ai.googlegenerativeai.md

@@ -30,4 +30,5 @@ export declare class GoogleGenerativeAI
 |  --- | --- | --- |
 |  [getGenerativeModel(modelParams, requestOptions)](./generative-ai.googlegenerativeai.getgenerativemodel.md) |  | Gets a [GenerativeModel](./generative-ai.generativemodel.md) instance for the provided model name. |
 |  [getGenerativeModelFromCachedContent(cachedContent, modelParams, requestOptions)](./generative-ai.googlegenerativeai.getgenerativemodelfromcachedcontent.md) |  | Creates a [GenerativeModel](./generative-ai.generativemodel.md) instance from provided content cache. |
+|  [getImageGenerationModel(modelParams, requestOptions)](./generative-ai.googlegenerativeai.getimagegenerationmodel.md) |  | Gets a [ImageGenerationModel](./generative-ai.imagegenerationmodel.md) instance for the provided model name. |
 

docs/reference/main/generative-ai.imagegenerationmodel._constructor_.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [ImageGenerationModel](./generative-ai.imagegenerationmodel.md) &gt; [(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)_ |
+

docs/reference/main/generative-ai.imagegenerationmodel.apikey.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [ImageGenerationModel](./generative-ai.imagegenerationmodel.md) &gt; [apiKey](./generative-ai.imagegenerationmodel.apikey.md)
+
+## ImageGenerationModel.apiKey property
+
+**Signature:**
+
+```typescript
+apiKey: string;
+```

docs/reference/main/generative-ai.imagegenerationmodel.generateimages.md

@@ -0,0 +1,29 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [ImageGenerationModel](./generative-ai.imagegenerationmodel.md) &gt; [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&lt;[ImageGenerationResponse](./generative-ai.imagegenerationresponse.md)<!-- -->&gt;
+

docs/reference/main/generative-ai.imagegenerationmodel.md

@@ -0,0 +1,33 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [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> |
+

docs/reference/main/generative-ai.imagegenerationmodel.model.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [ImageGenerationModel](./generative-ai.imagegenerationmodel.md) &gt; [model](./generative-ai.imagegenerationmodel.model.md)
+
+## ImageGenerationModel.model property
+
+**Signature:**
+
+```typescript
+model: string;
+```

docs/reference/main/generative-ai.imagegenerationrequest.aspectratio.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [ImageGenerationRequest](./generative-ai.imagegenerationrequest.md) &gt; [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";
+```

docs/reference/main/generative-ai.imagegenerationrequest.compressionquality.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [ImageGenerationRequest](./generative-ai.imagegenerationrequest.md) &gt; [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;
+```

docs/reference/main/generative-ai.imagegenerationrequest.guidancescale.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [ImageGenerationRequest](./generative-ai.imagegenerationrequest.md) &gt; [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;
+```

docs/reference/main/generative-ai.imagegenerationrequest.height.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [ImageGenerationRequest](./generative-ai.imagegenerationrequest.md) &gt; [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;
+```

docs/reference/main/generative-ai.imagegenerationrequest.language.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [ImageGenerationRequest](./generative-ai.imagegenerationrequest.md) &gt; [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;
+```

docs/reference/main/generative-ai.imagegenerationrequest.md

@@ -0,0 +1,31 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [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>&quot;en&quot;</code> for English, <code>&quot;hi&quot;</code> for Hindi, <code>&quot;ja&quot;</code> for Japanese, <code>&quot;ko&quot;</code> for Korean, and <code>&quot;auto&quot;</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..8. |
+|  [outputMimeType?](./generative-ai.imagegenerationrequest.outputmimetype.md) |  | "image/png" \| "image/jpeg" | _(Optional)_ hich 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. |
+

docs/reference/main/generative-ai.imagegenerationrequest.negativeprompt.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [ImageGenerationRequest](./generative-ai.imagegenerationrequest.md) &gt; [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;
+```

docs/reference/main/generative-ai.imagegenerationrequest.numberofimages.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [ImageGenerationRequest](./generative-ai.imagegenerationrequest.md) &gt; [numberOfImages](./generative-ai.imagegenerationrequest.numberofimages.md)
+
+## ImageGenerationRequest.numberOfImages property
+
+Number of images to generate. Range: 1..8.
+
+**Signature:**
+
+```typescript
+numberOfImages?: number;
+```

docs/reference/main/generative-ai.imagegenerationrequest.outputmimetype.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [ImageGenerationRequest](./generative-ai.imagegenerationrequest.md) &gt; [outputMimeType](./generative-ai.imagegenerationrequest.outputmimetype.md)
+
+## ImageGenerationRequest.outputMimeType property
+
+hich 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";
+```

docs/reference/main/generative-ai.imagegenerationrequest.persongeneration.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [ImageGenerationRequest](./generative-ai.imagegenerationrequest.md) &gt; [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";
+```

docs/reference/main/generative-ai.imagegenerationrequest.prompt.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [ImageGenerationRequest](./generative-ai.imagegenerationrequest.md) &gt; [prompt](./generative-ai.imagegenerationrequest.prompt.md)
+
+## ImageGenerationRequest.prompt property
+
+Text prompt for the image.
+
+**Signature:**
+
+```typescript
+prompt: string;
+```

docs/reference/main/generative-ai.imagegenerationrequest.safetyfilterlevel.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [ImageGenerationRequest](./generative-ai.imagegenerationrequest.md) &gt; [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";
+```

docs/reference/main/generative-ai.imagegenerationrequest.width.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [ImageGenerationRequest](./generative-ai.imagegenerationrequest.md) &gt; [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;
+```