Add Image Generation support using Imagen #8683

dlarocque · 2024-12-17T17:07:59Z

WIP

changeset-bot · 2024-12-17T17:08:03Z

⚠️ No Changeset found

Latest commit: 80021f9

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

hsubox76

Looks pretty good, just some nits (mostly about doc formatting) and small questions.

common/api-review/vertexai.api.md

packages/vertexai/src/api.test.ts

packages/vertexai/src/models/imagen-model.ts

packages/vertexai/src/models/imagen-model.test.ts

packages/vertexai/src/requests/request-helpers.ts

packages/vertexai/src/requests/response-helpers.ts

hsubox76 · 2024-12-17T18:30:52Z

packages/vertexai/src/types/imagen/requests.ts

+    addWatermark?: boolean;
+    safetyFilterLevel?: string;
+    personGeneration?: string;
+    includeRaiReason: boolean;


We put the word "rai" in the parameter going up but we remove it in the response? I can see reasons for including or not including but it should be consistent I think?

This property is not user-facing.

Users define configurations in ImagenGenerationConfig and ImagenModelParams, and these interfaces do not define a parameter related to the RAI reason- users cannot disable this. These configurations get mapped to this PredictRequestBody interface which is internal. Here, we set includeRaiReason to always be true, since users cannot define it in the config.

The flow looks like:
User --> ImagenGenerationConfig & ImagenModelParams --> PredictRequestBody (includeRaiReason: true)--> HTTP request --> HTTP response --> ImagenResponseInternal (raiFilteredReason: ...) --> ImagenImageResponse (filteredReason: ...) --> User

… other comments

…se-js-sdk into dl/vertex-imagen

google-oss-bot · 2025-01-03T18:17:49Z

Size Report ¹

Affected Products

@firebase/vertexai
Type Base (32bf021) Merge (1abe201) Diff
browser 28.8 kB 33.0 kB +4.21 kB (+14.6%)
main 29.6 kB 34.0 kB +4.32 kB (+14.6%)
module 28.8 kB 33.0 kB +4.21 kB (+14.6%)
firebase
Type Base (32bf021) Merge (1abe201) Diff
firebase-vertexai.js 23.8 kB 27.0 kB +3.15 kB (+13.2%)

Test Logs

https://storage.googleapis.com/firebase-sdk-metric-reports/L7e7jgt8A8.html

google-oss-bot · 2025-01-03T18:31:58Z

Size Analysis Report ¹

Affected Products

`@firebase/vertexai`

`ArraySchema`

Size

Type	Base (`32bf021`)	Merge (`1abe201`)	Diff
size	4.61 kB	5.10 kB	+493 B (+10.7%)
size-with-ext-deps	22.4 kB	22.9 kB	+502 B (+2.2%)

Dependency

Type Base (32bf021) Merge (1abe201) Diff

variables

14 dependencies

BlockReason
DEFAULT_LOCATION
FinishReason
FunctionCallingMode
HarmBlockMethod
HarmBlockThreshold
HarmCategory
HarmProbability
HarmSeverity
SchemaType
Task
VERTEX_TYPE
name
version

17 dependencies

BlockReason
DEFAULT_LOCATION
FinishReason
FunctionCallingMode
HarmBlockMethod
HarmBlockThreshold
HarmCategory
HarmProbability
HarmSeverity
ImagenAspectRatio
ImagenPersonFilterLevel
ImagenSafetyFilterLevel
SchemaType
Task
VERTEX_TYPE
name
version

+ ImagenAspectRatio
+ ImagenPersonFilterLevel
+ ImagenSafetyFilterLevel

`BlockReason`

Size

Type	Base (`32bf021`)	Merge (`1abe201`)	Diff
size	2.52 kB	3.01 kB	+493 B (+19.6%)
size-with-ext-deps	20.3 kB	20.8 kB	+502 B (+2.5%)

Dependency

Type Base (32bf021) Merge (1abe201) Diff

variables

14 dependencies

BlockReason
DEFAULT_LOCATION
FinishReason
FunctionCallingMode
HarmBlockMethod
HarmBlockThreshold
HarmCategory
HarmProbability
HarmSeverity
SchemaType
Task
VERTEX_TYPE
name
version

17 dependencies

BlockReason
DEFAULT_LOCATION
FinishReason
FunctionCallingMode
HarmBlockMethod
HarmBlockThreshold
HarmCategory
HarmProbability
HarmSeverity
ImagenAspectRatio
ImagenPersonFilterLevel
ImagenSafetyFilterLevel
SchemaType
Task
VERTEX_TYPE
name
version

+ ImagenAspectRatio
+ ImagenPersonFilterLevel
+ ImagenSafetyFilterLevel

`BooleanSchema`

Size

Type	Base (`32bf021`)	Merge (`1abe201`)	Diff
size	4.61 kB	5.11 kB	+493 B (+10.7%)
size-with-ext-deps	22.4 kB	22.9 kB	+502 B (+2.2%)

Dependency

Type Base (32bf021) Merge (1abe201) Diff

variables

14 dependencies

BlockReason
DEFAULT_LOCATION
FinishReason
FunctionCallingMode
HarmBlockMethod
HarmBlockThreshold
HarmCategory
HarmProbability
HarmSeverity
SchemaType
Task
VERTEX_TYPE
name
version

17 dependencies

BlockReason
DEFAULT_LOCATION
FinishReason
FunctionCallingMode
HarmBlockMethod
HarmBlockThreshold
HarmCategory
HarmProbability
HarmSeverity
ImagenAspectRatio
ImagenPersonFilterLevel
ImagenSafetyFilterLevel
SchemaType
Task
VERTEX_TYPE
name
version

+ ImagenAspectRatio
+ ImagenPersonFilterLevel
+ ImagenSafetyFilterLevel

`ChatSession`

Size

Type	Base (`32bf021`)	Merge (`1abe201`)	Diff
size	14.6 kB	15.1 kB	+500 B (+3.4%)
size-with-ext-deps	33.1 kB	33.6 kB	+502 B (+1.5%)

Dependency

Type Base (32bf021) Merge (1abe201) Diff

variables

27 dependencies

BlockReason
DEFAULT_API_VERSION
DEFAULT_BASE_URL
DEFAULT_FETCH_TIMEOUT_MS
DEFAULT_LOCATION
FinishReason
FunctionCallingMode
HarmBlockMethod
HarmBlockThreshold
HarmCategory
HarmProbability
HarmSeverity
LANGUAGE_TAG
PACKAGE_VERSION
POSSIBLE_ROLES
SILENT_ERROR
SchemaType
Task
VALID_PARTS_PER_ROLE
VALID_PART_FIELDS
VALID_PREVIOUS_CONTENT_ROLES
VERTEX_TYPE
badFinishReasons
logger
name
responseLineRE
version

30 dependencies

BlockReason
DEFAULT_API_VERSION
DEFAULT_BASE_URL
DEFAULT_FETCH_TIMEOUT_MS
DEFAULT_LOCATION
FinishReason
FunctionCallingMode
HarmBlockMethod
HarmBlockThreshold
HarmCategory
HarmProbability
HarmSeverity
ImagenAspectRatio
ImagenPersonFilterLevel
ImagenSafetyFilterLevel
LANGUAGE_TAG
PACKAGE_VERSION
POSSIBLE_ROLES
SILENT_ERROR
SchemaType
Task
VALID_PARTS_PER_ROLE
VALID_PART_FIELDS
VALID_PREVIOUS_CONTENT_ROLES
VERTEX_TYPE
badFinishReasons
logger
name
responseLineRE
version

+ ImagenAspectRatio
+ ImagenPersonFilterLevel
+ ImagenSafetyFilterLevel

`FinishReason`

Size

Type	Base (`32bf021`)	Merge (`1abe201`)	Diff
size	2.52 kB	3.01 kB	+493 B (+19.6%)
size-with-ext-deps	20.3 kB	20.8 kB	+502 B (+2.5%)

Dependency

Type Base (32bf021) Merge (1abe201) Diff

variables

14 dependencies

BlockReason
DEFAULT_LOCATION
FinishReason
FunctionCallingMode
HarmBlockMethod
HarmBlockThreshold
HarmCategory
HarmProbability
HarmSeverity
SchemaType
Task
VERTEX_TYPE
name
version

17 dependencies

BlockReason
DEFAULT_LOCATION
FinishReason
FunctionCallingMode
HarmBlockMethod
HarmBlockThreshold
HarmCategory
HarmProbability
HarmSeverity
ImagenAspectRatio
ImagenPersonFilterLevel
ImagenSafetyFilterLevel
SchemaType
Task
VERTEX_TYPE
name
version

+ ImagenAspectRatio
+ ImagenPersonFilterLevel
+ ImagenSafetyFilterLevel

`FunctionCallingMode`

Size

Type	Base (`32bf021`)	Merge (`1abe201`)	Diff
size	2.53 kB	3.02 kB	+493 B (+19.5%)
size-with-ext-deps	20.3 kB	20.8 kB	+502 B (+2.5%)

Dependency

Type Base (32bf021) Merge (1abe201) Diff

variables

14 dependencies

BlockReason
DEFAULT_LOCATION
FinishReason
FunctionCallingMode
HarmBlockMethod
HarmBlockThreshold
HarmCategory
HarmProbability
HarmSeverity
SchemaType
Task
VERTEX_TYPE
name
version

17 dependencies

BlockReason
DEFAULT_LOCATION
FinishReason
FunctionCallingMode
HarmBlockMethod
HarmBlockThreshold
HarmCategory
HarmProbability
HarmSeverity
ImagenAspectRatio
ImagenPersonFilterLevel
ImagenSafetyFilterLevel
SchemaType
Task
VERTEX_TYPE
name
version

+ ImagenAspectRatio
+ ImagenPersonFilterLevel
+ ImagenSafetyFilterLevel

`GenerativeModel`

Size

Type	Base (`32bf021`)	Merge (`1abe201`)	Diff
size	17.1 kB	17.7 kB	+582 B (+3.4%)
size-with-ext-deps	35.6 kB	36.2 kB	+581 B (+1.6%)

Dependency

Type Base (32bf021) Merge (1abe201) Diff

classes

ChatSession
GenerativeModel
RequestUrl
VertexAIError
VertexAIService

ChatSession
GenerativeModel
RequestUrl
VertexAIError
VertexAIModel
VertexAIService

+ VertexAIModel

variables

27 dependencies

BlockReason
DEFAULT_API_VERSION
DEFAULT_BASE_URL
DEFAULT_FETCH_TIMEOUT_MS
DEFAULT_LOCATION
FinishReason
FunctionCallingMode
HarmBlockMethod
HarmBlockThreshold
HarmCategory
HarmProbability
HarmSeverity
LANGUAGE_TAG
PACKAGE_VERSION
POSSIBLE_ROLES
SILENT_ERROR
SchemaType
Task
VALID_PARTS_PER_ROLE
VALID_PART_FIELDS
VALID_PREVIOUS_CONTENT_ROLES
VERTEX_TYPE
badFinishReasons
logger
name
responseLineRE
version

30 dependencies

BlockReason
DEFAULT_API_VERSION
DEFAULT_BASE_URL
DEFAULT_FETCH_TIMEOUT_MS
DEFAULT_LOCATION
FinishReason
FunctionCallingMode
HarmBlockMethod
HarmBlockThreshold
HarmCategory
HarmProbability
HarmSeverity
ImagenAspectRatio
ImagenPersonFilterLevel
ImagenSafetyFilterLevel
LANGUAGE_TAG
PACKAGE_VERSION
POSSIBLE_ROLES
SILENT_ERROR
SchemaType
Task
VALID_PARTS_PER_ROLE
VALID_PART_FIELDS
VALID_PREVIOUS_CONTENT_ROLES
VERTEX_TYPE
badFinishReasons
logger
name
responseLineRE
version

+ ImagenAspectRatio
+ ImagenPersonFilterLevel
+ ImagenSafetyFilterLevel

`HarmBlockMethod`

Size

Type	Base (`32bf021`)	Merge (`1abe201`)	Diff
size	2.52 kB	3.02 kB	+493 B (+19.5%)
size-with-ext-deps	20.3 kB	20.8 kB	+502 B (+2.5%)

Dependency

Type Base (32bf021) Merge (1abe201) Diff

variables

14 dependencies

BlockReason
DEFAULT_LOCATION
FinishReason
FunctionCallingMode
HarmBlockMethod
HarmBlockThreshold
HarmCategory
HarmProbability
HarmSeverity
SchemaType
Task
VERTEX_TYPE
name
version

17 dependencies

BlockReason
DEFAULT_LOCATION
FinishReason
FunctionCallingMode
HarmBlockMethod
HarmBlockThreshold
HarmCategory
HarmProbability
HarmSeverity
ImagenAspectRatio
ImagenPersonFilterLevel
ImagenSafetyFilterLevel
SchemaType
Task
VERTEX_TYPE
name
version

+ ImagenAspectRatio
+ ImagenPersonFilterLevel
+ ImagenSafetyFilterLevel

`HarmBlockThreshold`

Size

Type	Base (`32bf021`)	Merge (`1abe201`)	Diff
size	2.53 kB	3.02 kB	+493 B (+19.5%)
size-with-ext-deps	20.3 kB	20.8 kB	+502 B (+2.5%)

Dependency

Type Base (32bf021) Merge (1abe201) Diff

variables

14 dependencies

BlockReason
DEFAULT_LOCATION
FinishReason
FunctionCallingMode
HarmBlockMethod
HarmBlockThreshold
HarmCategory
HarmProbability
HarmSeverity
SchemaType
Task
VERTEX_TYPE
name
version

17 dependencies

BlockReason
DEFAULT_LOCATION
FinishReason
FunctionCallingMode
HarmBlockMethod
HarmBlockThreshold
HarmCategory
HarmProbability
HarmSeverity
ImagenAspectRatio
ImagenPersonFilterLevel
ImagenSafetyFilterLevel
SchemaType
Task
VERTEX_TYPE
name
version

+ ImagenAspectRatio
+ ImagenPersonFilterLevel
+ ImagenSafetyFilterLevel

`HarmCategory`

Size

Type	Base (`32bf021`)	Merge (`1abe201`)	Diff
size	2.52 kB	3.01 kB	+493 B (+19.6%)
size-with-ext-deps	20.3 kB	20.8 kB	+502 B (+2.5%)

Dependency

Type Base (32bf021) Merge (1abe201) Diff

variables

14 dependencies

BlockReason
DEFAULT_LOCATION
FinishReason
FunctionCallingMode
HarmBlockMethod
HarmBlockThreshold
HarmCategory
HarmProbability
HarmSeverity
SchemaType
Task
VERTEX_TYPE
name
version

17 dependencies

BlockReason
DEFAULT_LOCATION
FinishReason
FunctionCallingMode
HarmBlockMethod
HarmBlockThreshold
HarmCategory
HarmProbability
HarmSeverity
ImagenAspectRatio
ImagenPersonFilterLevel
ImagenSafetyFilterLevel
SchemaType
Task
VERTEX_TYPE
name
version

+ ImagenAspectRatio
+ ImagenPersonFilterLevel
+ ImagenSafetyFilterLevel

`HarmProbability`

Size

Type	Base (`32bf021`)	Merge (`1abe201`)	Diff
size	2.52 kB	3.02 kB	+493 B (+19.5%)
size-with-ext-deps	20.3 kB	20.8 kB	+502 B (+2.5%)

Dependency

Type Base (32bf021) Merge (1abe201) Diff

variables

14 dependencies

BlockReason
DEFAULT_LOCATION
FinishReason
FunctionCallingMode
HarmBlockMethod
HarmBlockThreshold
HarmCategory
HarmProbability
HarmSeverity
SchemaType
Task
VERTEX_TYPE
name
version

17 dependencies

BlockReason
DEFAULT_LOCATION
FinishReason
FunctionCallingMode
HarmBlockMethod
HarmBlockThreshold
HarmCategory
HarmProbability
HarmSeverity
ImagenAspectRatio
ImagenPersonFilterLevel
ImagenSafetyFilterLevel
SchemaType
Task
VERTEX_TYPE
name
version

+ ImagenAspectRatio
+ ImagenPersonFilterLevel
+ ImagenSafetyFilterLevel

`HarmSeverity`

Size

Type	Base (`32bf021`)	Merge (`1abe201`)	Diff
size	2.52 kB	3.01 kB	+493 B (+19.6%)
size-with-ext-deps	20.3 kB	20.8 kB	+502 B (+2.5%)

Dependency

Type Base (32bf021) Merge (1abe201) Diff

variables

14 dependencies

BlockReason
DEFAULT_LOCATION
FinishReason
FunctionCallingMode
HarmBlockMethod
HarmBlockThreshold
HarmCategory
HarmProbability
HarmSeverity
SchemaType
Task
VERTEX_TYPE
name
version

17 dependencies

BlockReason
DEFAULT_LOCATION
FinishReason
FunctionCallingMode
HarmBlockMethod
HarmBlockThreshold
HarmCategory
HarmProbability
HarmSeverity
ImagenAspectRatio
ImagenPersonFilterLevel
ImagenSafetyFilterLevel
SchemaType
Task
VERTEX_TYPE
name
version

+ ImagenAspectRatio
+ ImagenPersonFilterLevel
+ ImagenSafetyFilterLevel

`ImagenAspectRatio`

Size

Type	Base (`32bf021`)	Merge (`1abe201`)	Diff
size	?	3.02 kB	? (?)
size-with-ext-deps	?	20.8 kB	? (?)

Dependency

Type	Base (`32bf021`)	Merge (`1abe201`)	Diff
functions	?	registerVertex	?
classes	?	VertexAIService	?
variables	?	17 dependencies BlockReason DEFAULT_LOCATION FinishReason FunctionCallingMode HarmBlockMethod HarmBlockThreshold HarmCategory HarmProbability HarmSeverity ImagenAspectRatio ImagenPersonFilterLevel ImagenSafetyFilterLevel SchemaType Task VERTEX_TYPE name version	?
enums	?		?

External Dependency

Module	Base (`32bf021`)	Merge (`1abe201`)	Diff
`@firebase/app`	?	_registerComponent registerVersion	?
`@firebase/component`	?	Component	?
`@firebase/logger`	?	Logger	?

`ImagenImageFormat`

Size

Type	Base (`32bf021`)	Merge (`1abe201`)	Diff
size	?	3.18 kB	? (?)
size-with-ext-deps	?	21.0 kB	? (?)

Dependency

Type	Base (`32bf021`)	Merge (`1abe201`)	Diff
functions	?	registerVertex	?
classes	?	ImagenImageFormat VertexAIService	?
variables	?	17 dependencies BlockReason DEFAULT_LOCATION FinishReason FunctionCallingMode HarmBlockMethod HarmBlockThreshold HarmCategory HarmProbability HarmSeverity ImagenAspectRatio ImagenPersonFilterLevel ImagenSafetyFilterLevel SchemaType Task VERTEX_TYPE name version	?
enums	?		?

External Dependency

Module	Base (`32bf021`)	Merge (`1abe201`)	Diff
`@firebase/app`	?	_registerComponent registerVersion	?
`@firebase/component`	?	Component	?
`@firebase/logger`	?	Logger	?

`ImagenModel`

Size

Type	Base (`32bf021`)	Merge (`1abe201`)	Diff
size	?	9.09 kB	? (?)
size-with-ext-deps	?	27.2 kB	? (?)

Dependency

Type	Base (`32bf021`)	Merge (`1abe201`)	Diff
functions	?	constructRequest createPredictRequestBody getClientHeaders getHeaders handlePredictResponse makeRequest registerVertex	?
classes	?	ImagenImageFormat ImagenModel RequestUrl VertexAIError VertexAIModel VertexAIService	?
variables	?	23 dependencies BlockReason DEFAULT_API_VERSION DEFAULT_BASE_URL DEFAULT_FETCH_TIMEOUT_MS DEFAULT_LOCATION FinishReason FunctionCallingMode HarmBlockMethod HarmBlockThreshold HarmCategory HarmProbability HarmSeverity ImagenAspectRatio ImagenPersonFilterLevel ImagenSafetyFilterLevel LANGUAGE_TAG PACKAGE_VERSION SchemaType Task VERTEX_TYPE logger name version	?
enums	?		?

External Dependency

Module	Base (`32bf021`)	Merge (`1abe201`)	Diff
`@firebase/app`	?	_registerComponent registerVersion	?
`@firebase/component`	?	Component	?
`@firebase/logger`	?	Logger	?
`@firebase/util`	?	FirebaseError	?
`tslib`	?	__rest	?

`ImagenPersonFilterLevel`

Size

Type	Base (`32bf021`)	Merge (`1abe201`)	Diff
size	?	3.03 kB	? (?)
size-with-ext-deps	?	20.8 kB	? (?)

Dependency

Type	Base (`32bf021`)	Merge (`1abe201`)	Diff
functions	?	registerVertex	?
classes	?	VertexAIService	?
variables	?	17 dependencies BlockReason DEFAULT_LOCATION FinishReason FunctionCallingMode HarmBlockMethod HarmBlockThreshold HarmCategory HarmProbability HarmSeverity ImagenAspectRatio ImagenPersonFilterLevel ImagenSafetyFilterLevel SchemaType Task VERTEX_TYPE name version	?
enums	?		?

External Dependency

Module	Base (`32bf021`)	Merge (`1abe201`)	Diff
`@firebase/app`	?	_registerComponent registerVersion	?
`@firebase/component`	?	Component	?
`@firebase/logger`	?	Logger	?

`ImagenSafetyFilterLevel`

Size

Type	Base (`32bf021`)	Merge (`1abe201`)	Diff
size	?	3.03 kB	? (?)
size-with-ext-deps	?	20.8 kB	? (?)

Dependency

Type	Base (`32bf021`)	Merge (`1abe201`)	Diff
functions	?	registerVertex	?
classes	?	VertexAIService	?
variables	?	17 dependencies BlockReason DEFAULT_LOCATION FinishReason FunctionCallingMode HarmBlockMethod HarmBlockThreshold HarmCategory HarmProbability HarmSeverity ImagenAspectRatio ImagenPersonFilterLevel ImagenSafetyFilterLevel SchemaType Task VERTEX_TYPE name version	?
enums	?		?

External Dependency

Module	Base (`32bf021`)	Merge (`1abe201`)	Diff
`@firebase/app`	?	_registerComponent registerVersion	?
`@firebase/component`	?	Component	?
`@firebase/logger`	?	Logger	?

`IntegerSchema`

Size

Type	Base (`32bf021`)	Merge (`1abe201`)	Diff
size	4.61 kB	5.11 kB	+493 B (+10.7%)
size-with-ext-deps	22.4 kB	22.9 kB	+502 B (+2.2%)

Dependency

Type Base (32bf021) Merge (1abe201) Diff

variables

14 dependencies

BlockReason
DEFAULT_LOCATION
FinishReason
FunctionCallingMode
HarmBlockMethod
HarmBlockThreshold
HarmCategory
HarmProbability
HarmSeverity
SchemaType
Task
VERTEX_TYPE
name
version

17 dependencies

BlockReason
DEFAULT_LOCATION
FinishReason
FunctionCallingMode
HarmBlockMethod
HarmBlockThreshold
HarmCategory
HarmProbability
HarmSeverity
ImagenAspectRatio
ImagenPersonFilterLevel
ImagenSafetyFilterLevel
SchemaType
Task
VERTEX_TYPE
name
version

+ ImagenAspectRatio
+ ImagenPersonFilterLevel
+ ImagenSafetyFilterLevel

`NumberSchema`

Size

Type	Base (`32bf021`)	Merge (`1abe201`)	Diff
size	4.61 kB	5.10 kB	+493 B (+10.7%)
size-with-ext-deps	22.4 kB	22.9 kB	+502 B (+2.2%)

Dependency

Type Base (32bf021) Merge (1abe201) Diff

variables

14 dependencies

BlockReason
DEFAULT_LOCATION
FinishReason
FunctionCallingMode
HarmBlockMethod
HarmBlockThreshold
HarmCategory
HarmProbability
HarmSeverity
SchemaType
Task
VERTEX_TYPE
name
version

17 dependencies

BlockReason
DEFAULT_LOCATION
FinishReason
FunctionCallingMode
HarmBlockMethod
HarmBlockThreshold
HarmCategory
HarmProbability
HarmSeverity
ImagenAspectRatio
ImagenPersonFilterLevel
ImagenSafetyFilterLevel
SchemaType
Task
VERTEX_TYPE
name
version

+ ImagenAspectRatio
+ ImagenPersonFilterLevel
+ ImagenSafetyFilterLevel

`ObjectSchema`

Size

Type	Base (`32bf021`)	Merge (`1abe201`)	Diff
size	4.61 kB	5.10 kB	+493 B (+10.7%)
size-with-ext-deps	22.4 kB	22.9 kB	+502 B (+2.2%)

Dependency

Type Base (32bf021) Merge (1abe201) Diff

variables

14 dependencies

BlockReason
DEFAULT_LOCATION
FinishReason
FunctionCallingMode
HarmBlockMethod
HarmBlockThreshold
HarmCategory
HarmProbability
HarmSeverity
SchemaType
Task
VERTEX_TYPE
name
version

17 dependencies

BlockReason
DEFAULT_LOCATION
FinishReason
FunctionCallingMode
HarmBlockMethod
HarmBlockThreshold
HarmCategory
HarmProbability
HarmSeverity
ImagenAspectRatio
ImagenPersonFilterLevel
ImagenSafetyFilterLevel
SchemaType
Task
VERTEX_TYPE
name
version

+ ImagenAspectRatio
+ ImagenPersonFilterLevel
+ ImagenSafetyFilterLevel

`POSSIBLE_ROLES`

Size

Type	Base (`32bf021`)	Merge (`1abe201`)	Diff
size	2.57 kB	3.06 kB	+493 B (+19.2%)
size-with-ext-deps	20.4 kB	20.9 kB	+502 B (+2.5%)

Dependency

Type Base (32bf021) Merge (1abe201) Diff

variables

15 dependencies

BlockReason
DEFAULT_LOCATION
FinishReason
FunctionCallingMode
HarmBlockMethod
HarmBlockThreshold
HarmCategory
HarmProbability
HarmSeverity
POSSIBLE_ROLES
SchemaType
Task
VERTEX_TYPE
name
version

18 dependencies

BlockReason
DEFAULT_LOCATION
FinishReason
FunctionCallingMode
HarmBlockMethod
HarmBlockThreshold
HarmCategory
HarmProbability
HarmSeverity
ImagenAspectRatio
ImagenPersonFilterLevel
ImagenSafetyFilterLevel
POSSIBLE_ROLES
SchemaType
Task
VERTEX_TYPE
name
version

+ ImagenAspectRatio
+ ImagenPersonFilterLevel
+ ImagenSafetyFilterLevel

`Schema`

Size

Type	Base (`32bf021`)	Merge (`1abe201`)	Diff
size	4.61 kB	5.10 kB	+493 B (+10.7%)
size-with-ext-deps	22.4 kB	22.9 kB	+502 B (+2.2%)

Dependency

Type Base (32bf021) Merge (1abe201) Diff

variables

14 dependencies

BlockReason
DEFAULT_LOCATION
FinishReason
FunctionCallingMode
HarmBlockMethod
HarmBlockThreshold
HarmCategory
HarmProbability
HarmSeverity
SchemaType
Task
VERTEX_TYPE
name
version

17 dependencies

BlockReason
DEFAULT_LOCATION
FinishReason
FunctionCallingMode
HarmBlockMethod
HarmBlockThreshold
HarmCategory
HarmProbability
HarmSeverity
ImagenAspectRatio
ImagenPersonFilterLevel
ImagenSafetyFilterLevel
SchemaType
Task
VERTEX_TYPE
name
version

+ ImagenAspectRatio
+ ImagenPersonFilterLevel
+ ImagenSafetyFilterLevel

`SchemaType`

Size

Type	Base (`32bf021`)	Merge (`1abe201`)	Diff
size	2.52 kB	3.01 kB	+493 B (+19.6%)
size-with-ext-deps	20.3 kB	20.8 kB	+502 B (+2.5%)

Dependency

Type Base (32bf021) Merge (1abe201) Diff

variables

14 dependencies

BlockReason
DEFAULT_LOCATION
FinishReason
FunctionCallingMode
HarmBlockMethod
HarmBlockThreshold
HarmCategory
HarmProbability
HarmSeverity
SchemaType
Task
VERTEX_TYPE
name
version

17 dependencies

BlockReason
DEFAULT_LOCATION
FinishReason
FunctionCallingMode
HarmBlockMethod
HarmBlockThreshold
HarmCategory
HarmProbability
HarmSeverity
ImagenAspectRatio
ImagenPersonFilterLevel
ImagenSafetyFilterLevel
SchemaType
Task
VERTEX_TYPE
name
version

+ ImagenAspectRatio
+ ImagenPersonFilterLevel
+ ImagenSafetyFilterLevel

`StringSchema`

Size

Type	Base (`32bf021`)	Merge (`1abe201`)	Diff
size	4.61 kB	5.10 kB	+493 B (+10.7%)
size-with-ext-deps	22.4 kB	22.9 kB	+502 B (+2.2%)

Dependency

Type Base (32bf021) Merge (1abe201) Diff

variables

14 dependencies

BlockReason
DEFAULT_LOCATION
FinishReason
FunctionCallingMode
HarmBlockMethod
HarmBlockThreshold
HarmCategory
HarmProbability
HarmSeverity
SchemaType
Task
VERTEX_TYPE
name
version

17 dependencies

BlockReason
DEFAULT_LOCATION
FinishReason
FunctionCallingMode
HarmBlockMethod
HarmBlockThreshold
HarmCategory
HarmProbability
HarmSeverity
ImagenAspectRatio
ImagenPersonFilterLevel
ImagenSafetyFilterLevel
SchemaType
Task
VERTEX_TYPE
name
version

+ ImagenAspectRatio
+ ImagenPersonFilterLevel
+ ImagenSafetyFilterLevel

`VertexAIError`

Size

Type	Base (`32bf021`)	Merge (`1abe201`)	Diff
size	2.83 kB	3.32 kB	+493 B (+17.4%)
size-with-ext-deps	20.6 kB	21.1 kB	+502 B (+2.4%)

Dependency

Type Base (32bf021) Merge (1abe201) Diff

variables

14 dependencies

BlockReason
DEFAULT_LOCATION
FinishReason
FunctionCallingMode
HarmBlockMethod
HarmBlockThreshold
HarmCategory
HarmProbability
HarmSeverity
SchemaType
Task
VERTEX_TYPE
name
version

17 dependencies

BlockReason
DEFAULT_LOCATION
FinishReason
FunctionCallingMode
HarmBlockMethod
HarmBlockThreshold
HarmCategory
HarmProbability
HarmSeverity
ImagenAspectRatio
ImagenPersonFilterLevel
ImagenSafetyFilterLevel
SchemaType
Task
VERTEX_TYPE
name
version

+ ImagenAspectRatio
+ ImagenPersonFilterLevel
+ ImagenSafetyFilterLevel

`VertexAIModel`

Size

Type	Base (`32bf021`)	Merge (`1abe201`)	Diff
size	?	4.31 kB	? (?)
size-with-ext-deps	?	22.1 kB	? (?)

Dependency

Type	Base (`32bf021`)	Merge (`1abe201`)	Diff
functions	?	registerVertex	?
classes	?	VertexAIError VertexAIModel VertexAIService	?
variables	?	17 dependencies BlockReason DEFAULT_LOCATION FinishReason FunctionCallingMode HarmBlockMethod HarmBlockThreshold HarmCategory HarmProbability HarmSeverity ImagenAspectRatio ImagenPersonFilterLevel ImagenSafetyFilterLevel SchemaType Task VERTEX_TYPE name version	?
enums	?		?

External Dependency

Module	Base (`32bf021`)	Merge (`1abe201`)	Diff
`@firebase/app`	?	_registerComponent registerVersion	?
`@firebase/component`	?	Component	?
`@firebase/logger`	?	Logger	?
`@firebase/util`	?	FirebaseError	?

`getGenerativeModel`

Size

Type	Base (`32bf021`)	Merge (`1abe201`)	Diff
size	17.3 kB	17.9 kB	+582 B (+3.4%)
size-with-ext-deps	35.8 kB	36.4 kB	+581 B (+1.6%)

Dependency

Type Base (32bf021) Merge (1abe201) Diff

classes

ChatSession
GenerativeModel
RequestUrl
VertexAIError
VertexAIService

ChatSession
GenerativeModel
RequestUrl
VertexAIError
VertexAIModel
VertexAIService

+ VertexAIModel

variables

27 dependencies

BlockReason
DEFAULT_API_VERSION
DEFAULT_BASE_URL
DEFAULT_FETCH_TIMEOUT_MS
DEFAULT_LOCATION
FinishReason
FunctionCallingMode
HarmBlockMethod
HarmBlockThreshold
HarmCategory
HarmProbability
HarmSeverity
LANGUAGE_TAG
PACKAGE_VERSION
POSSIBLE_ROLES
SILENT_ERROR
SchemaType
Task
VALID_PARTS_PER_ROLE
VALID_PART_FIELDS
VALID_PREVIOUS_CONTENT_ROLES
VERTEX_TYPE
badFinishReasons
logger
name
responseLineRE
version

30 dependencies

BlockReason
DEFAULT_API_VERSION
DEFAULT_BASE_URL
DEFAULT_FETCH_TIMEOUT_MS
DEFAULT_LOCATION
FinishReason
FunctionCallingMode
HarmBlockMethod
HarmBlockThreshold
HarmCategory
HarmProbability
HarmSeverity
ImagenAspectRatio
ImagenPersonFilterLevel
ImagenSafetyFilterLevel
LANGUAGE_TAG
PACKAGE_VERSION
POSSIBLE_ROLES
SILENT_ERROR
SchemaType
Task
VALID_PARTS_PER_ROLE
VALID_PART_FIELDS
VALID_PREVIOUS_CONTENT_ROLES
VERTEX_TYPE
badFinishReasons
logger
name
responseLineRE
version

+ ImagenAspectRatio
+ ImagenPersonFilterLevel
+ ImagenSafetyFilterLevel

`getImagenModel`

Size

Type	Base (`32bf021`)	Merge (`1abe201`)	Diff
size	?	9.25 kB	? (?)
size-with-ext-deps	?	27.4 kB	? (?)

Dependency

Type	Base (`32bf021`)	Merge (`1abe201`)	Diff
functions	?	constructRequest createPredictRequestBody getClientHeaders getHeaders getImagenModel handlePredictResponse makeRequest registerVertex	?
classes	?	ImagenImageFormat ImagenModel RequestUrl VertexAIError VertexAIModel VertexAIService	?
variables	?	23 dependencies BlockReason DEFAULT_API_VERSION DEFAULT_BASE_URL DEFAULT_FETCH_TIMEOUT_MS DEFAULT_LOCATION FinishReason FunctionCallingMode HarmBlockMethod HarmBlockThreshold HarmCategory HarmProbability HarmSeverity ImagenAspectRatio ImagenPersonFilterLevel ImagenSafetyFilterLevel LANGUAGE_TAG PACKAGE_VERSION SchemaType Task VERTEX_TYPE logger name version	?
enums	?		?

External Dependency

Module	Base (`32bf021`)	Merge (`1abe201`)	Diff
`@firebase/app`	?	_registerComponent registerVersion	?
`@firebase/component`	?	Component	?
`@firebase/logger`	?	Logger	?
`@firebase/util`	?	FirebaseError	?
`tslib`	?	__rest	?

`getVertexAI`

Size

Type	Base (`32bf021`)	Merge (`1abe201`)	Diff
size	2.70 kB	3.19 kB	+493 B (+18.3%)
size-with-ext-deps	27.8 kB	28.3 kB	+502 B (+1.8%)

Dependency

Type Base (32bf021) Merge (1abe201) Diff

variables

14 dependencies

BlockReason
DEFAULT_LOCATION
FinishReason
FunctionCallingMode
HarmBlockMethod
HarmBlockThreshold
HarmCategory
HarmProbability
HarmSeverity
SchemaType
Task
VERTEX_TYPE
name
version

17 dependencies

BlockReason
DEFAULT_LOCATION
FinishReason
FunctionCallingMode
HarmBlockMethod
HarmBlockThreshold
HarmCategory
HarmProbability
HarmSeverity
ImagenAspectRatio
ImagenPersonFilterLevel
ImagenSafetyFilterLevel
SchemaType
Task
VERTEX_TYPE
name
version

+ ImagenAspectRatio
+ ImagenPersonFilterLevel
+ ImagenSafetyFilterLevel

Test Logs

https://storage.googleapis.com/firebase-sdk-metric-reports/SXQlbfgyKa.html

WIP

ec35231

dlarocque force-pushed the dl/vertex-imagen branch from c1d397f to ec35231 Compare December 17, 2024 17:08

hsubox76 reviewed Dec 17, 2024

View reviewed changes

dlarocque added 12 commits January 2, 2025 12:38

Introduce VertexAIModel base class, add documentation, and respond to…

180f091

… other comments

Generate devsite docs

497727f

revert dataconnect change

8471bbc

formatting

5c518b1

WIP

b680a2a

Introduce VertexAIModel base class, add documentation, and respond to…

d00cccd

… other comments

Generate devsite docs

4b6c42f

revert dataconnect change

6215781

formatting

025035a

Fix ImagenRequestConfig comment

2f8b45d

Improve tests

89a73de

Merge branch 'dl/vertex-imagen' of https://github.com/firebase/fireba…

a0c8c89

…se-js-sdk into dl/vertex-imagen

dlarocque changed the title ~~WIP~~ Add Image Generation support with Imagen Jan 3, 2025

dlarocque changed the title ~~Add Image Generation support with Imagen~~ Add Image Generation support using Imagen Jan 3, 2025

Formatting

80021f9

Add Image Generation support using Imagen #8683

Are you sure you want to change the base?

Add Image Generation support using Imagen #8683

Conversation

dlarocque commented Dec 17, 2024

changeset-bot bot commented Dec 17, 2024 • edited Loading

⚠️ No Changeset found

hsubox76 left a comment

Choose a reason for hiding this comment

hsubox76 Dec 17, 2024

Choose a reason for hiding this comment

dlarocque Dec 18, 2024

Choose a reason for hiding this comment

google-oss-bot commented Jan 3, 2025 • edited Loading

Size Report 1

Affected Products

@firebase/vertexai

firebase

Test Logs

google-oss-bot commented Jan 3, 2025

Size Analysis Report 1

Affected Products

@firebase/vertexai

ArraySchema

BlockReason

BooleanSchema

ChatSession

FinishReason

FunctionCallingMode

GenerativeModel

HarmBlockMethod

HarmBlockThreshold

HarmCategory

HarmProbability

HarmSeverity

ImagenAspectRatio

ImagenImageFormat

ImagenModel

ImagenPersonFilterLevel

ImagenSafetyFilterLevel

IntegerSchema

NumberSchema

ObjectSchema

POSSIBLE_ROLES

Schema

SchemaType

StringSchema

VertexAIError

VertexAIModel

getGenerativeModel

getImagenModel

getVertexAI

Test Logs

changeset-bot bot commented Dec 17, 2024 •

edited

Loading

google-oss-bot commented Jan 3, 2025 •

edited

Loading

Size Report ¹

`@firebase/vertexai`

`firebase`

Size Analysis Report ¹

`@firebase/vertexai`

`ArraySchema`

`BlockReason`

`BooleanSchema`

`ChatSession`

`FinishReason`

`FunctionCallingMode`

`GenerativeModel`

`HarmBlockMethod`

`HarmBlockThreshold`

`HarmCategory`

`HarmProbability`

`HarmSeverity`

`ImagenAspectRatio`

`ImagenImageFormat`

`ImagenModel`

`ImagenPersonFilterLevel`

`ImagenSafetyFilterLevel`

`IntegerSchema`

`NumberSchema`

`ObjectSchema`

`POSSIBLE_ROLES`

`Schema`

`SchemaType`

`StringSchema`

`VertexAIError`

`VertexAIModel`

`getGenerativeModel`

`getImagenModel`

`getVertexAI`