feat(ai): Add support for `AbortSignal` #8890

dlarocque · 2025-04-02T14:12:34Z

Add an AbortSignal to a new SingleRequestOptions that can be passed to all methods that make requests to the backend, allowing them to be aborted.

Fixes #8859

API Proposal: go/vinf-abort-request-api (internal)

changeset-bot · 2025-04-02T14:12:37Z

🦋 Changeset detected

Latest commit: 931972d

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/ai	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

github-actions · 2025-04-02T14:15:54Z

Changeset File Check ✅

No modified packages are missing from the changeset file.
No changeset formatting errors detected.

google-oss-bot · 2025-04-02T14:22:09Z

Size Report ¹

Affected Products

@firebase/ai
Type Base (40be2db) Merge (37bdd41) Diff
browser 42.5 kB 43.9 kB +1.40 kB (+3.3%)
main 43.7 kB 45.1 kB +1.40 kB (+3.2%)
module 42.5 kB 43.9 kB +1.40 kB (+3.3%)
firebase
Type Base (40be2db) Merge (37bdd41) Diff
firebase-ai.js 33.8 kB 34.5 kB +717 B (+2.1%)
firebase-vertexai.js 33.8 kB 34.5 kB +717 B (+2.1%)

Test Logs

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

google-oss-bot · 2025-04-02T14:34:10Z

Size Analysis Report ¹

Affected Products

`@firebase/ai`

`ChatSession`

Size

Type	Base (`40be2db`)	Merge (`37bdd41`)	Diff
size	20.0 kB	20.5 kB	+517 B (+2.6%)
size-with-ext-deps	39.0 kB	39.5 kB	+516 B (+1.3%)

Dependency

Type Base (40be2db) Merge (37bdd41) Diff

variables

32 dependencies

AI_TYPE
BackendType
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
Modality
PACKAGE_VERSION
POSSIBLE_ROLES
SILENT_ERROR
SchemaType
Task
VALID_PARTS_PER_ROLE
VALID_PART_FIELDS
VALID_PREVIOUS_CONTENT_ROLES
badFinishReasons
logger
name
responseLineRE
version

34 dependencies

ABORT_ERROR_NAME
AI_TYPE
BackendType
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
Modality
PACKAGE_VERSION
POSSIBLE_ROLES
SILENT_ERROR
SchemaType
TIMEOUT_EXPIRED_MESSAGE
Task
VALID_PARTS_PER_ROLE
VALID_PART_FIELDS
VALID_PREVIOUS_CONTENT_ROLES
badFinishReasons
logger
name
responseLineRE
version

+ ABORT_ERROR_NAME
+ TIMEOUT_EXPIRED_MESSAGE

`GenerativeModel`

Size

Type	Base (`40be2db`)	Merge (`37bdd41`)	Diff
size	23.6 kB	24.3 kB	+655 B (+2.8%)
size-with-ext-deps	42.6 kB	43.3 kB	+647 B (+1.5%)

Dependency

Type Base (40be2db) Merge (37bdd41) Diff

variables

32 dependencies

AI_TYPE
BackendType
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
Modality
PACKAGE_VERSION
POSSIBLE_ROLES
SILENT_ERROR
SchemaType
Task
VALID_PARTS_PER_ROLE
VALID_PART_FIELDS
VALID_PREVIOUS_CONTENT_ROLES
badFinishReasons
logger
name
responseLineRE
version

34 dependencies

ABORT_ERROR_NAME
AI_TYPE
BackendType
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
Modality
PACKAGE_VERSION
POSSIBLE_ROLES
SILENT_ERROR
SchemaType
TIMEOUT_EXPIRED_MESSAGE
Task
VALID_PARTS_PER_ROLE
VALID_PART_FIELDS
VALID_PREVIOUS_CONTENT_ROLES
badFinishReasons
logger
name
responseLineRE
version

+ ABORT_ERROR_NAME
+ TIMEOUT_EXPIRED_MESSAGE

`ImagenModel`

Size

Type	Base (`40be2db`)	Merge (`37bdd41`)	Diff
size	11.3 kB	11.8 kB	+510 B (+4.5%)
size-with-ext-deps	29.3 kB	29.9 kB	+516 B (+1.8%)

Dependency

Type Base (40be2db) Merge (37bdd41) Diff

variables

25 dependencies

AI_TYPE
BackendType
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
Modality
PACKAGE_VERSION
SchemaType
Task
logger
name
version

27 dependencies

ABORT_ERROR_NAME
AI_TYPE
BackendType
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
Modality
PACKAGE_VERSION
SchemaType
TIMEOUT_EXPIRED_MESSAGE
Task
logger
name
version

+ ABORT_ERROR_NAME
+ TIMEOUT_EXPIRED_MESSAGE

`getGenerativeModel`

Size

Type	Base (`40be2db`)	Merge (`37bdd41`)	Diff
size	23.8 kB	24.4 kB	+655 B (+2.8%)
size-with-ext-deps	42.8 kB	43.4 kB	+647 B (+1.5%)

Dependency

Type Base (40be2db) Merge (37bdd41) Diff

variables

32 dependencies

AI_TYPE
BackendType
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
Modality
PACKAGE_VERSION
POSSIBLE_ROLES
SILENT_ERROR
SchemaType
Task
VALID_PARTS_PER_ROLE
VALID_PART_FIELDS
VALID_PREVIOUS_CONTENT_ROLES
badFinishReasons
logger
name
responseLineRE
version

34 dependencies

ABORT_ERROR_NAME
AI_TYPE
BackendType
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
Modality
PACKAGE_VERSION
POSSIBLE_ROLES
SILENT_ERROR
SchemaType
TIMEOUT_EXPIRED_MESSAGE
Task
VALID_PARTS_PER_ROLE
VALID_PART_FIELDS
VALID_PREVIOUS_CONTENT_ROLES
badFinishReasons
logger
name
responseLineRE
version

+ ABORT_ERROR_NAME
+ TIMEOUT_EXPIRED_MESSAGE

`getImagenModel`

Size

Type	Base (`40be2db`)	Merge (`37bdd41`)	Diff
size	11.5 kB	12.0 kB	+510 B (+4.4%)
size-with-ext-deps	29.5 kB	30.0 kB	+516 B (+1.7%)

Dependency

Type Base (40be2db) Merge (37bdd41) Diff

variables

25 dependencies

AI_TYPE
BackendType
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
Modality
PACKAGE_VERSION
SchemaType
Task
logger
name
version

27 dependencies

ABORT_ERROR_NAME
AI_TYPE
BackendType
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
Modality
PACKAGE_VERSION
SchemaType
TIMEOUT_EXPIRED_MESSAGE
Task
logger
name
version

+ ABORT_ERROR_NAME
+ TIMEOUT_EXPIRED_MESSAGE

Test Logs

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

github-actions · 2025-04-02T20:35:46Z

Vertex AI Mock Responses Check ⚠️

A newer major version of the mock responses for Vertex AI unit tests is available. update_vertexai_responses.sh should be updated to clone the latest version of the responses: v8.0

DellaBitta

Looks good, but won't approve until council review.

DellaBitta · 2025-05-12T17:50:24Z

docs-devsite/vertexai.singlerequestoptions.md

+
+If provided, calling `abort()` on the corresponding `AbortController` will attempt to cancel the underlying HTTP request. An `AbortError` will be thrown if cancellation is successful.
+
+Note that this will not cancel the request in the backend, so billing will still be applied despite cancellation.


hsubox76

Approved, pending merge of #9011 where you'll have to update the changeset and regenerate docs and the api.md.

.changeset/long-keys-watch.md

docs-devsite/ai.md

docs-devsite/ai.singlerequestoptions.md

dlarocque force-pushed the dl/abort-signal branch from 496add1 to f9950ce Compare April 2, 2025 14:14

dlarocque force-pushed the dl/abort-signal branch from b9a363a to 3e0cc6b Compare April 3, 2025 15:36

dlarocque force-pushed the dl/abort-signal branch from 9c73306 to ef4ab12 Compare May 6, 2025 14:30

feat(vertexai): Add support for AbortSignal

c616128

dlarocque force-pushed the dl/abort-signal branch from b3e7dd8 to c616128 Compare May 12, 2025 17:04

dlarocque marked this pull request as ready for review May 12, 2025 17:05

dlarocque requested review from a team as code owners May 12, 2025 17:05

Run formatter

54589ad

DellaBitta reviewed May 12, 2025

View reviewed changes

DellaBitta approved these changes May 12, 2025

View reviewed changes

hsubox76 approved these changes May 12, 2025

View reviewed changes

.changeset/long-keys-watch.md Outdated Show resolved Hide resolved

dlarocque requested a review from rachelsaunders May 22, 2025 15:11

dlarocque added 2 commits May 22, 2025 11:23

Merge branch 'main' into dl/abort-signal

b4ae062

Fix docs

a82a809

dlarocque requested review from lisajian, Xiaoshouzi-gh, sam-gc, pashanka, mansisampat, NhienLam, maneesht and tonyjhuang as code owners May 22, 2025 15:27

dlarocque requested a review from aashishpatil-g as a code owner May 22, 2025 15:27

dlarocque added 3 commits May 22, 2025 11:27

Update changeset to use @firebase/ai

f690611

remove ghost changeset

821e580

update example in docs

15239fb

rachelsaunders requested changes May 27, 2025

View reviewed changes

docs-devsite/ai.md Outdated Show resolved Hide resolved

docs-devsite/ai.singlerequestoptions.md Outdated Show resolved Hide resolved

docs-devsite/ai.singlerequestoptions.md Outdated Show resolved Hide resolved

docs-devsite/ai.singlerequestoptions.md Outdated Show resolved Hide resolved

dlarocque added 2 commits May 27, 2025 10:47

Docs review

0096b9a

Merge branch 'main' into dl/abort-signal

931972d

dlarocque requested a review from rachelsaunders May 27, 2025 14:49

rachelsaunders approved these changes May 27, 2025

View reviewed changes

dlarocque changed the title ~~feat(vertexai): Add support for AbortSignal~~ feat(ai): Add support for AbortSignal May 28, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(ai): Add support for `AbortSignal` #8890

feat(ai): Add support for `AbortSignal` #8890

Uh oh!

dlarocque commented Apr 2, 2025 •

edited

Loading

Uh oh!

changeset-bot bot commented Apr 2, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Apr 2, 2025 •

edited

Loading

Uh oh!

google-oss-bot commented Apr 2, 2025 •

edited

Loading

`@firebase/ai`

`firebase`

Uh oh!

google-oss-bot commented Apr 2, 2025 •

edited

Loading

`@firebase/ai`

`ChatSession`

`GenerativeModel`

`ImagenModel`

`getGenerativeModel`

`getImagenModel`

Uh oh!

github-actions bot commented Apr 2, 2025

Uh oh!

DellaBitta left a comment

Uh oh!

DellaBitta May 12, 2025

Uh oh!

hsubox76 left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!


		If provided, calling `abort()` on the corresponding `AbortController` will attempt to cancel the underlying HTTP request. An `AbortError` will be thrown if cancellation is successful.

		Note that this will not cancel the request in the backend, so billing will still be applied despite cancellation.

feat(ai): Add support for AbortSignal #8890

Are you sure you want to change the base?

feat(ai): Add support for AbortSignal #8890

Uh oh!

Conversation

dlarocque commented Apr 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

changeset-bot bot commented Apr 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

github-actions bot commented Apr 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changeset File Check ✅

Uh oh!

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

Uh oh!

Size Report 1

Affected Products

@firebase/ai

firebase

Test Logs

Uh oh!

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

Uh oh!

Size Analysis Report 1

Affected Products

@firebase/ai

ChatSession

GenerativeModel

ImagenModel

getGenerativeModel

getImagenModel

Test Logs

Uh oh!

github-actions bot commented Apr 2, 2025

Vertex AI Mock Responses Check ⚠️

Uh oh!

DellaBitta left a comment

Choose a reason for hiding this comment

Uh oh!

DellaBitta May 12, 2025

Choose a reason for hiding this comment

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!

feat(ai): Add support for `AbortSignal` #8890

feat(ai): Add support for `AbortSignal` #8890

dlarocque commented Apr 2, 2025 •

edited

Loading

changeset-bot bot commented Apr 2, 2025 •

edited

Loading

github-actions bot commented Apr 2, 2025 •

edited

Loading

google-oss-bot commented Apr 2, 2025 •

edited

Loading

Size Report ¹

`@firebase/ai`

`firebase`

google-oss-bot commented Apr 2, 2025 •

edited

Loading

Size Analysis Report ¹

`@firebase/ai`

`ChatSession`

`GenerativeModel`

`ImagenModel`

`getGenerativeModel`

`getImagenModel`