Add Image Generation support using Imagen #8683

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

Adds Image Generation support using Imagen.

See go/firebase-vertex-imagen-api (internal) for all API changes.

In addition to the Imagen API, this also introduces a new VertexAIModel class. This base class eliminates the duplicate logic in GenerativeModel and ImagenModel for initializing the API settings and fully qualified model name.

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

🦋 Changeset detected

Latest commit: 4a306fa

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages

Name	Type
firebase	Minor
@firebase/vertexai	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another 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

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

… other comments

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

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

Size Report ¹

Affected Products

@firebase/app-check
Type Base (b92592d) Merge (02ce42e) Diff
browser 26.3 kB 26.4 kB +128 B (+0.5%)
main 27.3 kB 27.4 kB +128 B (+0.5%)
module 26.3 kB 26.4 kB +128 B (+0.5%)
@firebase/vertexai
Type Base (b92592d) Merge (02ce42e) Diff
browser 29.2 kB 33.7 kB +4.51 kB (+15.4%)
main 30.0 kB 34.7 kB +4.61 kB (+15.3%)
module 29.2 kB 33.7 kB +4.51 kB (+15.4%)

`bundle`

Type	Base (`b92592d`)	Merge (`02ce42e`)	Diff
app-check (CustomProvider)	37.4 kB	37.5 kB	+102 B (+0.3%)
app-check (ReCaptchaEnterpriseProvider)	39.9 kB	40.0 kB	+102 B (+0.3%)
app-check (ReCaptchaV3Provider)	39.9 kB	40.0 kB	+102 B (+0.3%)

`firebase`

Type	Base (`b92592d`)	Merge (`02ce42e`)	Diff
firebase-app-check-compat.js	22.6 kB	22.7 kB	+89 B (+0.4%)
firebase-app-check.js	24.9 kB	25.0 kB	+101 B (+0.4%)
firebase-compat.js	792 kB	792 kB	+92 B (+0.0%)
firebase-vertexai.js	24.4 kB	27.5 kB	+3.05 kB (+12.5%)

Test Logs

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

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

Size Analysis Report ¹

Affected Products

@firebase/app-check
- initializeAppCheck
  Size
  Type Base (b92592d) Merge (02ce42e) Diff
  size 11.2 kB 11.3 kB +100 B (+0.9%)
  size-with-ext-deps 36.4 kB 36.5 kB +102 B (+0.3%)

`@firebase/vertexai`

`ArraySchema`

Size

Type	Base (`b92592d`)	Merge (`02ce42e`)	Diff
size	4.61 kB	5.10 kB	+493 B (+10.7%)
size-with-ext-deps	22.5 kB	23.0 kB	+502 B (+2.2%)

Dependency

Type Base (b92592d) Merge (02ce42e) 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 (`b92592d`)	Merge (`02ce42e`)	Diff
size	2.52 kB	3.01 kB	+493 B (+19.6%)
size-with-ext-deps	20.4 kB	20.9 kB	+502 B (+2.5%)

Dependency

Type Base (b92592d) Merge (02ce42e) 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 (`b92592d`)	Merge (`02ce42e`)	Diff
size	4.61 kB	5.11 kB	+493 B (+10.7%)
size-with-ext-deps	22.5 kB	23.0 kB	+502 B (+2.2%)

Dependency

Type Base (b92592d) Merge (02ce42e) 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 (`b92592d`)	Merge (`02ce42e`)	Diff
size	14.8 kB	15.3 kB	+500 B (+3.4%)
size-with-ext-deps	33.7 kB	34.2 kB	+502 B (+1.5%)

Dependency

Type Base (b92592d) Merge (02ce42e) 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 (`b92592d`)	Merge (`02ce42e`)	Diff
size	2.52 kB	3.01 kB	+493 B (+19.6%)
size-with-ext-deps	20.4 kB	20.9 kB	+502 B (+2.5%)

Dependency

Type Base (b92592d) Merge (02ce42e) 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 (`b92592d`)	Merge (`02ce42e`)	Diff
size	2.53 kB	3.02 kB	+493 B (+19.5%)
size-with-ext-deps	20.4 kB	20.9 kB	+502 B (+2.5%)

Dependency

Type Base (b92592d) Merge (02ce42e) 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 (`b92592d`)	Merge (`02ce42e`)	Diff
size	17.5 kB	18.1 kB	+581 B (+3.3%)
size-with-ext-deps	36.5 kB	37.0 kB	+581 B (+1.6%)

Dependency

Type Base (b92592d) Merge (02ce42e) 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 (`b92592d`)	Merge (`02ce42e`)	Diff
size	2.52 kB	3.02 kB	+493 B (+19.5%)
size-with-ext-deps	20.4 kB	20.9 kB	+502 B (+2.5%)

Dependency

Type Base (b92592d) Merge (02ce42e) 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 (`b92592d`)	Merge (`02ce42e`)	Diff
size	2.53 kB	3.02 kB	+493 B (+19.5%)
size-with-ext-deps	20.4 kB	20.9 kB	+502 B (+2.5%)

Dependency

Type Base (b92592d) Merge (02ce42e) 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 (`b92592d`)	Merge (`02ce42e`)	Diff
size	2.52 kB	3.01 kB	+493 B (+19.6%)
size-with-ext-deps	20.4 kB	20.9 kB	+502 B (+2.5%)

Dependency

Type Base (b92592d) Merge (02ce42e) 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 (`b92592d`)	Merge (`02ce42e`)	Diff
size	2.52 kB	3.02 kB	+493 B (+19.5%)
size-with-ext-deps	20.4 kB	20.9 kB	+502 B (+2.5%)

Dependency

Type Base (b92592d) Merge (02ce42e) 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 (`b92592d`)	Merge (`02ce42e`)	Diff
size	2.52 kB	3.01 kB	+493 B (+19.6%)
size-with-ext-deps	20.4 kB	20.9 kB	+502 B (+2.5%)

Dependency

Type Base (b92592d) Merge (02ce42e) 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 (`b92592d`)	Merge (`02ce42e`)	Diff
size	?	3.02 kB	? (?)
size-with-ext-deps	?	20.9 kB	? (?)

Dependency

Type	Base (`b92592d`)	Merge (`02ce42e`)	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 (`b92592d`)	Merge (`02ce42e`)	Diff
`@firebase/app`	?	_registerComponent registerVersion	?
`@firebase/component`	?	Component	?
`@firebase/logger`	?	Logger	?

`ImagenImageFormat`

Size

Type	Base (`b92592d`)	Merge (`02ce42e`)	Diff
size	?	3.30 kB	? (?)
size-with-ext-deps	?	21.2 kB	? (?)

Dependency

Type	Base (`b92592d`)	Merge (`02ce42e`)	Diff
functions	?	registerVertex	?
classes	?	ImagenImageFormat VertexAIService	?
variables	?	18 dependencies BlockReason DEFAULT_LOCATION FinishReason FunctionCallingMode HarmBlockMethod HarmBlockThreshold HarmCategory HarmProbability HarmSeverity ImagenAspectRatio ImagenPersonFilterLevel ImagenSafetyFilterLevel SchemaType Task VERTEX_TYPE logger name version	?
enums	?		?

External Dependency

Module	Base (`b92592d`)	Merge (`02ce42e`)	Diff
`@firebase/app`	?	_registerComponent registerVersion	?
`@firebase/component`	?	Component	?
`@firebase/logger`	?	Logger	?

`ImagenModel`

Size

Type	Base (`b92592d`)	Merge (`02ce42e`)	Diff
size	?	9.23 kB	? (?)
size-with-ext-deps	?	27.2 kB	? (?)

Dependency

Type	Base (`b92592d`)	Merge (`02ce42e`)	Diff
functions	?	constructRequest createPredictRequestBody getClientHeaders getHeaders handlePredictResponse makeRequest registerVertex	?
classes	?	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 (`b92592d`)	Merge (`02ce42e`)	Diff
`@firebase/app`	?	_isFirebaseServerApp _registerComponent registerVersion	?
`@firebase/component`	?	Component	?
`@firebase/logger`	?	Logger	?
`@firebase/util`	?	FirebaseError	?

`ImagenPersonFilterLevel`

Size

Type	Base (`b92592d`)	Merge (`02ce42e`)	Diff
size	?	3.03 kB	? (?)
size-with-ext-deps	?	20.9 kB	? (?)

Dependency

Type	Base (`b92592d`)	Merge (`02ce42e`)	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 (`b92592d`)	Merge (`02ce42e`)	Diff
`@firebase/app`	?	_registerComponent registerVersion	?
`@firebase/component`	?	Component	?
`@firebase/logger`	?	Logger	?

`ImagenSafetyFilterLevel`

Size

Type	Base (`b92592d`)	Merge (`02ce42e`)	Diff
size	?	3.03 kB	? (?)
size-with-ext-deps	?	20.9 kB	? (?)

Dependency

Type	Base (`b92592d`)	Merge (`02ce42e`)	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 (`b92592d`)	Merge (`02ce42e`)	Diff
`@firebase/app`	?	_registerComponent registerVersion	?
`@firebase/component`	?	Component	?
`@firebase/logger`	?	Logger	?

`IntegerSchema`

Size

Type	Base (`b92592d`)	Merge (`02ce42e`)	Diff
size	4.61 kB	5.11 kB	+493 B (+10.7%)
size-with-ext-deps	22.5 kB	23.0 kB	+502 B (+2.2%)

Dependency

Type Base (b92592d) Merge (02ce42e) 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 (`b92592d`)	Merge (`02ce42e`)	Diff
size	4.61 kB	5.10 kB	+493 B (+10.7%)
size-with-ext-deps	22.5 kB	23.0 kB	+502 B (+2.2%)

Dependency

Type Base (b92592d) Merge (02ce42e) 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 (`b92592d`)	Merge (`02ce42e`)	Diff
size	4.61 kB	5.10 kB	+493 B (+10.7%)
size-with-ext-deps	22.5 kB	23.0 kB	+502 B (+2.2%)

Dependency

Type Base (b92592d) Merge (02ce42e) 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 (`b92592d`)	Merge (`02ce42e`)	Diff
size	2.57 kB	3.06 kB	+493 B (+19.2%)
size-with-ext-deps	20.5 kB	21.0 kB	+502 B (+2.5%)

Dependency

Type Base (b92592d) Merge (02ce42e) 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 (`b92592d`)	Merge (`02ce42e`)	Diff
size	4.61 kB	5.10 kB	+493 B (+10.7%)
size-with-ext-deps	22.5 kB	23.0 kB	+502 B (+2.2%)

Dependency

Type Base (b92592d) Merge (02ce42e) 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 (`b92592d`)	Merge (`02ce42e`)	Diff
size	2.52 kB	3.01 kB	+493 B (+19.6%)
size-with-ext-deps	20.4 kB	20.9 kB	+502 B (+2.5%)

Dependency

Type Base (b92592d) Merge (02ce42e) 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 (`b92592d`)	Merge (`02ce42e`)	Diff
size	4.61 kB	5.10 kB	+493 B (+10.7%)
size-with-ext-deps	22.5 kB	23.0 kB	+502 B (+2.2%)

Dependency

Type Base (b92592d) Merge (02ce42e) 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 (`b92592d`)	Merge (`02ce42e`)	Diff
size	2.83 kB	3.32 kB	+493 B (+17.4%)
size-with-ext-deps	20.7 kB	21.2 kB	+502 B (+2.4%)

Dependency

Type Base (b92592d) Merge (02ce42e) 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 (`b92592d`)	Merge (`02ce42e`)	Diff
size	?	4.49 kB	? (?)
size-with-ext-deps	?	22.4 kB	? (?)

Dependency

Type	Base (`b92592d`)	Merge (`02ce42e`)	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 (`b92592d`)	Merge (`02ce42e`)	Diff
`@firebase/app`	?	_isFirebaseServerApp _registerComponent registerVersion	?
`@firebase/component`	?	Component	?
`@firebase/logger`	?	Logger	?
`@firebase/util`	?	FirebaseError	?

`getGenerativeModel`

Size

Type	Base (`b92592d`)	Merge (`02ce42e`)	Diff
size	17.6 kB	18.2 kB	+581 B (+3.3%)
size-with-ext-deps	36.6 kB	37.2 kB	+581 B (+1.6%)

Dependency

Type Base (b92592d) Merge (02ce42e) 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 (`b92592d`)	Merge (`02ce42e`)	Diff
size	?	9.39 kB	? (?)
size-with-ext-deps	?	27.4 kB	? (?)

Dependency

Type	Base (`b92592d`)	Merge (`02ce42e`)	Diff
functions	?	constructRequest createPredictRequestBody getClientHeaders getHeaders getImagenModel handlePredictResponse makeRequest registerVertex	?
classes	?	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 (`b92592d`)	Merge (`02ce42e`)	Diff
`@firebase/app`	?	_isFirebaseServerApp _registerComponent registerVersion	?
`@firebase/component`	?	Component	?
`@firebase/logger`	?	Logger	?
`@firebase/util`	?	FirebaseError	?

`getVertexAI`

Size

Type	Base (`b92592d`)	Merge (`02ce42e`)	Diff
size	2.70 kB	3.19 kB	+493 B (+18.3%)
size-with-ext-deps	27.9 kB	28.4 kB	+502 B (+1.8%)

Dependency

Type Base (b92592d) Merge (02ce42e) 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/J6oJbcooel.html

hsubox76

Looks pretty good, don't forget to add the changeset.

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

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

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

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

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

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

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

* Revert "remove public docs" This reverts commit f095563. * update docs * update docs * format * minor fixes * format * mark all APIs beta instead of public * review fixes * format * Replace (BETA) with (Public Preview) in docs * fix links * another pass * format * review fixes

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

dlarocque added 4 commits January 9, 2025 12:23

Add ImagenGenerationResponse

858f260

Formatting

bfc2c0f

Update to match API changes

886a4df

Merge branch 'main' into dl/vertex-imagen

b8dd77e

dlarocque requested a review from hsubox76 February 3, 2025 17:39

hsubox76 reviewed Feb 3, 2025

View reviewed changes

dlarocque and others added 3 commits February 3, 2025 14:55

fixes

d967900

format

d53d3dd

Update API reports

ae0f87e

dlarocque and others added 6 commits February 6, 2025 11:26

Merge branch 'main' into dl/vertex-imagen

f7f919d

update

ece898f

format

967cd78

Update API reports

b27a45e

remove public docs

f095563

Merge branch 'main' into dl/vertex-imagen

0cd9ae4

dlarocque mentioned this pull request Feb 7, 2025

Imagen Documentation #8776

Merged

andrewheard reviewed Feb 10, 2025

View reviewed changes

packages/vertexai/src/types/imagen/internal.ts Outdated Show resolved Hide resolved

dlarocque added 4 commits February 10, 2025 15:53

Nest imageFormat in outputOptions

d6a4f24

remove unecessary console.log

66b3b9f

Log warning if compressionQuality outside of range

48b658d

format

c3173a9

dlarocque mentioned this pull request Feb 12, 2025

Publish VertexAI API's tagged with @beta #8788

Merged

dlarocque added 3 commits February 12, 2025 13:35

Merge branch 'main' into dl/vertex-imagen

a33e819

Merge branch 'main' into dl/vertex-imagen

0e9ff0a

dlarocque marked this pull request as ready for review February 20, 2025 15:24

dlarocque requested review from a team as code owners February 20, 2025 15:24

dlarocque requested a review from hsubox76 February 20, 2025 15:25

Cleanup

5e7df2f

hsubox76 approved these changes Feb 20, 2025

View reviewed changes

update changeset

4a306fa

rachelsaunders approved these changes Feb 20, 2025

View reviewed changes

dlarocque merged commit ce2c775 into main Feb 21, 2025
38 checks passed

dlarocque deleted the dl/vertex-imagen branch February 21, 2025 00:14

google-oss-bot mentioned this pull request Feb 26, 2025

Version Packages #8794

Merged

firebase locked and limited conversation to collaborators Mar 23, 2025

Add Image Generation support using Imagen #8683

Add Image Generation support using Imagen #8683

Uh oh!

Conversation

dlarocque commented Dec 17, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

changeset-bot bot commented Dec 17, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

hsubox76 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

google-oss-bot commented Jan 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Size Report 1

Affected Products

@firebase/app-check

@firebase/vertexai

bundle

firebase

Test Logs

Uh oh!

google-oss-bot commented Jan 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Size Analysis Report 1

Affected Products

@firebase/app-check

initializeAppCheck

@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

Uh oh!

hsubox76 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dlarocque commented Dec 17, 2024 •

edited

Loading

changeset-bot bot commented Dec 17, 2024 •

edited

Loading

google-oss-bot commented Jan 3, 2025 •

edited

Loading

Size Report ¹

`@firebase/app-check`

`@firebase/vertexai`

`bundle`

`firebase`

google-oss-bot commented Jan 3, 2025 •

edited

Loading

Size Analysis Report ¹

`@firebase/app-check`

`initializeAppCheck`

`@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`