Skip to content

Commit a6e43e5

Browse files
committed
Merge branch 'dl/genai' into dl/ai
2 parents 5911872 + 9529e08 commit a6e43e5

File tree

10 files changed

+881
-17
lines changed

10 files changed

+881
-17
lines changed

docs-devsite/_toc.yaml

Lines changed: 149 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -618,3 +618,152 @@ toc:
618618
path: /docs/reference/js/storage.uploadtask.md
619619
- title: UploadTaskSnapshot
620620
path: /docs/reference/js/storage.uploadtasksnapshot.md
621+
- title: vertexai
622+
path: /docs/reference/js/vertexai.md
623+
section:
624+
- title: AI
625+
path: /docs/reference/js/vertexai.ai.md
626+
- title: AIError
627+
path: /docs/reference/js/vertexai.aierror.md
628+
- title: AIModel
629+
path: /docs/reference/js/vertexai.aimodel.md
630+
- title: AIOptions
631+
path: /docs/reference/js/vertexai.aioptions.md
632+
- title: ArraySchema
633+
path: /docs/reference/js/vertexai.arrayschema.md
634+
- title: Backend
635+
path: /docs/reference/js/vertexai.backend.md
636+
- title: BaseParams
637+
path: /docs/reference/js/vertexai.baseparams.md
638+
- title: BooleanSchema
639+
path: /docs/reference/js/vertexai.booleanschema.md
640+
- title: ChatSession
641+
path: /docs/reference/js/vertexai.chatsession.md
642+
- title: Citation
643+
path: /docs/reference/js/vertexai.citation.md
644+
- title: CitationMetadata
645+
path: /docs/reference/js/vertexai.citationmetadata.md
646+
- title: Content
647+
path: /docs/reference/js/vertexai.content.md
648+
- title: CountTokensRequest
649+
path: /docs/reference/js/vertexai.counttokensrequest.md
650+
- title: CountTokensResponse
651+
path: /docs/reference/js/vertexai.counttokensresponse.md
652+
- title: CustomErrorData
653+
path: /docs/reference/js/vertexai.customerrordata.md
654+
- title: Date_2
655+
path: /docs/reference/js/vertexai.date_2.md
656+
- title: EnhancedGenerateContentResponse
657+
path: /docs/reference/js/vertexai.enhancedgeneratecontentresponse.md
658+
- title: ErrorDetails
659+
path: /docs/reference/js/vertexai.errordetails.md
660+
- title: FileData
661+
path: /docs/reference/js/vertexai.filedata.md
662+
- title: FileDataPart
663+
path: /docs/reference/js/vertexai.filedatapart.md
664+
- title: FunctionCall
665+
path: /docs/reference/js/vertexai.functioncall.md
666+
- title: FunctionCallingConfig
667+
path: /docs/reference/js/vertexai.functioncallingconfig.md
668+
- title: FunctionCallPart
669+
path: /docs/reference/js/vertexai.functioncallpart.md
670+
- title: FunctionDeclaration
671+
path: /docs/reference/js/vertexai.functiondeclaration.md
672+
- title: FunctionDeclarationsTool
673+
path: /docs/reference/js/vertexai.functiondeclarationstool.md
674+
- title: FunctionResponse
675+
path: /docs/reference/js/vertexai.functionresponse.md
676+
- title: FunctionResponsePart
677+
path: /docs/reference/js/vertexai.functionresponsepart.md
678+
- title: GenerateContentCandidate
679+
path: /docs/reference/js/vertexai.generatecontentcandidate.md
680+
- title: GenerateContentRequest
681+
path: /docs/reference/js/vertexai.generatecontentrequest.md
682+
- title: GenerateContentResponse
683+
path: /docs/reference/js/vertexai.generatecontentresponse.md
684+
- title: GenerateContentResult
685+
path: /docs/reference/js/vertexai.generatecontentresult.md
686+
- title: GenerateContentStreamResult
687+
path: /docs/reference/js/vertexai.generatecontentstreamresult.md
688+
- title: GenerationConfig
689+
path: /docs/reference/js/vertexai.generationconfig.md
690+
- title: GenerativeContentBlob
691+
path: /docs/reference/js/vertexai.generativecontentblob.md
692+
- title: GenerativeModel
693+
path: /docs/reference/js/vertexai.generativemodel.md
694+
- title: GoogleAIBackend
695+
path: /docs/reference/js/vertexai.googleaibackend.md
696+
- title: GroundingAttribution
697+
path: /docs/reference/js/vertexai.groundingattribution.md
698+
- title: GroundingMetadata
699+
path: /docs/reference/js/vertexai.groundingmetadata.md
700+
- title: ImagenGCSImage
701+
path: /docs/reference/js/vertexai.imagengcsimage.md
702+
- title: ImagenGenerationConfig
703+
path: /docs/reference/js/vertexai.imagengenerationconfig.md
704+
- title: ImagenGenerationResponse
705+
path: /docs/reference/js/vertexai.imagengenerationresponse.md
706+
- title: ImagenImageFormat
707+
path: /docs/reference/js/vertexai.imagenimageformat.md
708+
- title: ImagenInlineImage
709+
path: /docs/reference/js/vertexai.imageninlineimage.md
710+
- title: ImagenModel
711+
path: /docs/reference/js/vertexai.imagenmodel.md
712+
- title: ImagenModelParams
713+
path: /docs/reference/js/vertexai.imagenmodelparams.md
714+
- title: ImagenSafetySettings
715+
path: /docs/reference/js/vertexai.imagensafetysettings.md
716+
- title: InlineDataPart
717+
path: /docs/reference/js/vertexai.inlinedatapart.md
718+
- title: IntegerSchema
719+
path: /docs/reference/js/vertexai.integerschema.md
720+
- title: ModalityTokenCount
721+
path: /docs/reference/js/vertexai.modalitytokencount.md
722+
- title: ModelParams
723+
path: /docs/reference/js/vertexai.modelparams.md
724+
- title: NumberSchema
725+
path: /docs/reference/js/vertexai.numberschema.md
726+
- title: ObjectSchema
727+
path: /docs/reference/js/vertexai.objectschema.md
728+
- title: ObjectSchemaInterface
729+
path: /docs/reference/js/vertexai.objectschemainterface.md
730+
- title: PromptFeedback
731+
path: /docs/reference/js/vertexai.promptfeedback.md
732+
- title: RequestOptions
733+
path: /docs/reference/js/vertexai.requestoptions.md
734+
- title: RetrievedContextAttribution
735+
path: /docs/reference/js/vertexai.retrievedcontextattribution.md
736+
- title: SafetyRating
737+
path: /docs/reference/js/vertexai.safetyrating.md
738+
- title: SafetySetting
739+
path: /docs/reference/js/vertexai.safetysetting.md
740+
- title: Schema
741+
path: /docs/reference/js/vertexai.schema.md
742+
- title: SchemaInterface
743+
path: /docs/reference/js/vertexai.schemainterface.md
744+
- title: SchemaParams
745+
path: /docs/reference/js/vertexai.schemaparams.md
746+
- title: SchemaRequest
747+
path: /docs/reference/js/vertexai.schemarequest.md
748+
- title: SchemaShared
749+
path: /docs/reference/js/vertexai.schemashared.md
750+
- title: Segment
751+
path: /docs/reference/js/vertexai.segment.md
752+
- title: StartChatParams
753+
path: /docs/reference/js/vertexai.startchatparams.md
754+
- title: StringSchema
755+
path: /docs/reference/js/vertexai.stringschema.md
756+
- title: TextPart
757+
path: /docs/reference/js/vertexai.textpart.md
758+
- title: ToolConfig
759+
path: /docs/reference/js/vertexai.toolconfig.md
760+
- title: UsageMetadata
761+
path: /docs/reference/js/vertexai.usagemetadata.md
762+
- title: VertexAIBackend
763+
path: /docs/reference/js/vertexai.vertexaibackend.md
764+
- title: VertexAIOptions
765+
path: /docs/reference/js/vertexai.vertexaioptions.md
766+
- title: VideoMetadata
767+
path: /docs/reference/js/vertexai.videometadata.md
768+
- title: WebAttribution
769+
path: /docs/reference/js/vertexai.webattribution.md

docs-devsite/ai.aimodel.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ https://github.com/firebase/firebase-js-sdk
1212
# AIModel class
1313
Base class for Firebase AI model APIs.
1414

15-
Instances of this class are associated with a specific Firebase AI backend (either the Vertex AI Gemini API or the Gemini Developer API via Google AI) and provide methods for interacting with the configured generative model.
15+
Instances of this class are associated with a specific Firebase AI [Backend](./ai.backend.md#backend_class) and provide methods for interacting with the configured generative model.
1616

1717
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `AIModel` class.
1818

docs-devsite/ai.backend.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

1212
# Backend class
13-
Abstract base class representing the configuration for an AI service backend, determining whether to use the Gemini Developer API (via Google AI) or the Vertex AI Gemini API. This class should not be instantiated directly. Use its subclasses: - [GoogleAIBackend](./ai.googleaibackend.md#googleaibackend_class)<!-- -->: For the Gemini Developer API (via Google AI). - [VertexAIBackend](./ai.vertexaibackend.md#vertexaibackend_class)<!-- -->: For the Vertex AI Gemini API.
13+
Abstract base class representing the configuration for an AI service backend. This class should not be instantiated directly. Use its subclasses; [GoogleAIBackend](./ai.googleaibackend.md#googleaibackend_class) for the Gemini Developer API (via [Google AI](https://ai.google/)<!-- -->), and [VertexAIBackend](./ai.vertexaibackend.md#vertexaibackend_class) for the Vertex AI Gemini API.
1414

1515
<b>Signature:</b>
1616

@@ -44,7 +44,7 @@ protected constructor(type: BackendType);
4444

4545
| Parameter | Type | Description |
4646
| --- | --- | --- |
47-
| type | [BackendType](./ai.md#backendtype) | The specific backend type constant (e.g., BackendType.GOOGLE\_AI). |
47+
| type | [BackendType](./ai.md#backendtype) | The backend type. |
4848

4949
## Backend.backendType
5050

docs-devsite/ai.googleaibackend.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

1212
# GoogleAIBackend class
13-
Configuration class for the Gemini Developer API (using Google AI).
13+
Configuration class for the Gemini Developer API (using [Google AI](https://ai.google/)<!-- -->).
1414

1515
Use this with [AIOptions](./ai.aioptions.md#aioptions_interface) when initializing the AI service via [getAI()](./ai.md#getai_a94a413) to specify the Gemini Developer API as the backend.
1616

docs-devsite/ai.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,13 @@ The Firebase AI Web SDK.
2828
| Class | Description |
2929
| --- | --- |
3030
| [AIError](./ai.aierror.md#aierror_class) | Error class for the Firebase AI SDK. |
31-
| [AIModel](./ai.aimodel.md#aimodel_class) | Base class for Firebase AI model APIs.<!-- -->Instances of this class are associated with a specific Firebase AI backend (either the Vertex AI Gemini API or the Gemini Developer API via Google AI) and provide methods for interacting with the configured generative model. |
31+
| [AIModel](./ai.aimodel.md#aimodel_class) | Base class for Firebase AI model APIs.<!-- -->Instances of this class are associated with a specific Firebase AI [Backend](./ai.backend.md#backend_class) and provide methods for interacting with the configured generative model. |
3232
| [ArraySchema](./ai.arrayschema.md#arrayschema_class) | Schema class for "array" types. The <code>items</code> param should refer to the type of item that can be a member of the array. |
33-
| [Backend](./ai.backend.md#backend_class) | Abstract base class representing the configuration for an AI service backend, determining whether to use the Gemini Developer API (via Google AI) or the Vertex AI Gemini API. This class should not be instantiated directly. Use its subclasses: - [GoogleAIBackend](./ai.googleaibackend.md#googleaibackend_class)<!-- -->: For the Gemini Developer API (via Google AI). - [VertexAIBackend](./ai.vertexaibackend.md#vertexaibackend_class)<!-- -->: For the Vertex AI Gemini API. |
33+
| [Backend](./ai.backend.md#backend_class) | Abstract base class representing the configuration for an AI service backend. This class should not be instantiated directly. Use its subclasses; [GoogleAIBackend](./ai.googleaibackend.md#googleaibackend_class) for the Gemini Developer API (via [Google AI](https://ai.google/)<!-- -->), and [VertexAIBackend](./ai.vertexaibackend.md#vertexaibackend_class) for the Vertex AI Gemini API. |
3434
| [BooleanSchema](./ai.booleanschema.md#booleanschema_class) | Schema class for "boolean" types. |
3535
| [ChatSession](./ai.chatsession.md#chatsession_class) | ChatSession class that enables sending chat messages and stores history of sent and received messages so far. |
3636
| [GenerativeModel](./ai.generativemodel.md#generativemodel_class) | Class for generative model APIs. |
37-
| [GoogleAIBackend](./ai.googleaibackend.md#googleaibackend_class) | Configuration class for the Gemini Developer API (using Google AI).<!-- -->Use this with [AIOptions](./ai.aioptions.md#aioptions_interface) when initializing the AI service via [getAI()](./ai.md#getai_a94a413) to specify the Gemini Developer API as the backend. |
37+
| [GoogleAIBackend](./ai.googleaibackend.md#googleaibackend_class) | Configuration class for the Gemini Developer API (using [Google AI](https://ai.google/)<!-- -->).<!-- -->Use this with [AIOptions](./ai.aioptions.md#aioptions_interface) when initializing the AI service via [getAI()](./ai.md#getai_a94a413) to specify the Gemini Developer API as the backend. |
3838
| [ImagenImageFormat](./ai.imagenimageformat.md#imagenimageformat_class) | <b><i>(Public Preview)</i></b> Defines the image format for images generated by Imagen.<!-- -->Use this class to specify the desired format (JPEG or PNG) and compression quality for images generated by Imagen. This is typically included as part of [ImagenModelParams](./ai.imagenmodelparams.md#imagenmodelparams_interface)<!-- -->. |
3939
| [ImagenModel](./ai.imagenmodel.md#imagenmodel_class) | <b><i>(Public Preview)</i></b> Class for Imagen model APIs.<!-- -->This class provides methods for generating images using the Imagen model. |
4040
| [IntegerSchema](./ai.integerschema.md#integerschema_class) | Schema class for "integer" types. |

docs-devsite/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,5 @@ https://github.com/firebase/firebase-js-sdk
2828
| [@firebase/performance](./performance.md#performance_package) | The Firebase Performance Monitoring Web SDK. This SDK does not work in a Node.js environment. |
2929
| [@firebase/remote-config](./remote-config.md#remote-config_package) | The Firebase Remote Config Web SDK. This SDK does not work in a Node.js environment. |
3030
| [@firebase/storage](./storage.md#storage_package) | Cloud Storage for Firebase |
31+
| [@firebase/vertexai](./vertexai.md#vertexai_package) | The Firebase AI Web SDK. |
3132

0 commit comments

Comments
 (0)