Skip to content

fix(ai): remove accidental factory export #9232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 28, 2025
+6 −37
Merged

fix(ai): remove accidental factory export #9232

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/stupid-files-reflect.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@firebase/ai': patch
---

Remove accidental `factory` export.
13 changes: 0 additions & 13 deletions common/api-review/ai.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,10 @@

```ts

import { AppCheckInternalComponentName } from '@firebase/app-check-interop-types';
import { AppCheckTokenResult } from '@firebase/app-check-interop-types';
import { ComponentContainer } from '@firebase/component';
import { FirebaseApp } from '@firebase/app';
import { FirebaseAppCheckInternal } from '@firebase/app-check-interop-types';
import { FirebaseAuthInternal } from '@firebase/auth-interop-types';
import { FirebaseAuthInternalName } from '@firebase/auth-interop-types';
import { FirebaseAuthTokenData } from '@firebase/auth-interop-types';
import { FirebaseError } from '@firebase/util';
import { _FirebaseService } from '@firebase/app';
import { InstanceFactoryOptions } from '@firebase/component';
import { Provider } from '@firebase/component';

// @public
export interface AI {
Expand Down Expand Up @@ -245,11 +237,6 @@ export interface ErrorDetails {
reason?: string;
}

// Warning: (ae-forgotten-export) The symbol "AIService" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export function factory(container: ComponentContainer, { instanceIdentifier }: InstanceFactoryOptions): AIService;

// @public
export interface FileData {
// (undocumented)
Expand Down
23 changes: 0 additions & 23 deletions docs-devsite/ai.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,6 @@ The Firebase AI Web SDK.
| [getGenerativeModel(ai, modelParams, requestOptions)](./ai.md#getgenerativemodel_c63f46a) | Returns a [GenerativeModel](./ai.generativemodel.md#generativemodel_class) class with methods for inference and other functionality. |
| [getImagenModel(ai, modelParams, requestOptions)](./ai.md#getimagenmodel_e1f6645) | <b><i>(Public Preview)</i></b> Returns an [ImagenModel](./ai.imagenmodel.md#imagenmodel_class) class with methods for using Imagen.<!-- -->Only Imagen 3 models (named <code>imagen-3.0-*</code>) are supported. |
| [getLiveGenerativeModel(ai, modelParams)](./ai.md#getlivegenerativemodel_f2099ac) | <b><i>(Public Preview)</i></b> Returns a [LiveGenerativeModel](./ai.livegenerativemodel.md#livegenerativemodel_class) class for real-time, bidirectional communication.<!-- -->The Live API is only supported in modern browser windows and Node &gt;<!-- -->= 22. |
| <b>function(container, ...)</b> |
| [factory(container, { instanceIdentifier })](./ai.md#factory_6581aeb) | |
| <b>function(liveSession, ...)</b> |
| [startAudioConversation(liveSession, options)](./ai.md#startaudioconversation_01c8e7f) | <b><i>(Public Preview)</i></b> Starts a real-time, bidirectional audio conversation with the model. This helper function manages the complexities of microphone access, audio recording, playback, and interruptions. |

Expand Down Expand Up @@ -327,27 +325,6 @@ export declare function getLiveGenerativeModel(ai: AI, modelParams: LiveModelPar

If the `apiKey` or `projectId` fields are missing in your Firebase config.

## function(container, ...)

### factory(container, { instanceIdentifier }) {:#factory_6581aeb}

<b>Signature:</b>

```typescript
export declare function factory(container: ComponentContainer, { instanceIdentifier }: InstanceFactoryOptions): AIService;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| container | ComponentContainer | |
| { instanceIdentifier } | InstanceFactoryOptions | |

<b>Returns:</b>

AIService

## function(liveSession, ...)

### startAudioConversation(liveSession, options) {:#startaudioconversation_01c8e7f}
Expand Down
2 changes: 1 addition & 1 deletion packages/ai/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ declare global {
}
}

export function factory(
function factory(
container: ComponentContainer,
{ instanceIdentifier }: InstanceFactoryOptions
): AIService {
Expand Down
Loading