Merge branch 'main' into dl/remove-groundingattribution

Author: dlarocque

.changeset/five-kids-grow.md

@@ -0,0 +1,6 @@
+---
+'firebase': minor
+'@firebase/ai': minor
+---
+
+Add support for Grounding with Google Search.

.changeset/hip-impalas-divide.md

@@ -0,0 +1,6 @@
+---
+'firebase': minor
+'@firebase/ai': minor
+---
+
+Add support for Thinking Budget.

.changeset/late-beers-develop.md

@@ -0,0 +1,5 @@
+---
+'firebase': major
+---
+
+Remove `vertexai` import path

.changeset/thirty-eggs-laugh.md

@@ -0,0 +1,6 @@
+---
+'@firebase/ai': major
+'firebase': major
+---
+
+Remove `VertexAI` APIs.

common/api-review/ai.api.md

@@ -27,7 +27,7 @@ export class AIError extends FirebaseError {
 }
 
 // @public
-const enum AIErrorCode {
+export const enum AIErrorCode {
     API_NOT_ENABLED = "api-not-enabled",
     ERROR = "error",
     FETCH_ERROR = "fetch-error",
@@ -43,10 +43,6 @@ const enum AIErrorCode {
     UNSUPPORTED = "unsupported"
 }
 
-export { AIErrorCode }
-
-export { AIErrorCode as VertexAIErrorCode }
-
 // @public
 export abstract class AIModel {
     // @internal
@@ -381,6 +377,7 @@ export interface GenerationConfig {
     stopSequences?: string[];
     // (undocumented)
     temperature?: number;
+    thinkingConfig?: ThinkingConfig;
     // (undocumented)
     topK?: number;
     // (undocumented)
@@ -424,9 +421,6 @@ export function getGenerativeModel(ai: AI, modelParams: ModelParams, requestOpti
 // @beta
 export function getImagenModel(ai: AI, modelParams: ImagenModelParams, requestOptions?: RequestOptions): ImagenModel;
 
-// @public @deprecated (undocumented)
-export function getVertexAI(app?: FirebaseApp, options?: VertexAIOptions): VertexAI;
-
 // @public
 export class GoogleAIBackend extends Backend {
     constructor();
@@ -486,14 +480,36 @@ export interface GoogleAIGenerateContentResponse {
     usageMetadata?: UsageMetadata;
 }
 
+// @public
+export interface GoogleSearch {
+}
+
+// @public
+export interface GoogleSearchTool {
+    googleSearch: GoogleSearch;
+}
+
+// @public
+export interface GroundingChunk {
+    web?: WebGroundingChunk;
+}
+
 // @public
 export interface GroundingMetadata {
-    // (undocumented)
+    groundingChunks?: GroundingChunk[];
+    groundingSupports?: GroundingSupport[];
+    // @deprecated (undocumented)
     retrievalQueries?: string[];
-    // (undocumented)
+    searchEntryPoint?: SearchEntrypoint;
     webSearchQueries?: string[];
 }
 
+// @public
+export interface GroundingSupport {
+    groundingChunkIndices?: number[];
+    segment?: Segment;
+}
+
 // @public
 export enum HarmBlockMethod {
     PROBABILITY = "PROBABILITY",
@@ -843,14 +859,17 @@ export enum SchemaType {
     STRING = "string"
 }
 
-// @public (undocumented)
+// @public
+export interface SearchEntrypoint {
+    renderedContent?: string;
+}
+
+// @public
 export interface Segment {
-    // (undocumented)
     endIndex: number;
-    // (undocumented)
     partIndex: number;
-    // (undocumented)
     startIndex: number;
+    text: string;
 }
 
 // @public
@@ -887,7 +906,12 @@ export interface TextPart {
 }
 
 // @public
-export type Tool = FunctionDeclarationsTool;
+export interface ThinkingConfig {
+    thinkingBudget?: number;
+}
+
+// @public
+export type Tool = FunctionDeclarationsTool | GoogleSearchTool;
 
 // @public
 export interface ToolConfig {
@@ -908,31 +932,17 @@ export interface UsageMetadata {
     promptTokenCount: number;
     // (undocumented)
     promptTokensDetails?: ModalityTokenCount[];
+    thoughtsTokenCount?: number;
     // (undocumented)
     totalTokenCount: number;
 }
 
-// @public @deprecated (undocumented)
-export type VertexAI = AI;
-
 // @public
 export class VertexAIBackend extends Backend {
     constructor(location?: string);
     readonly location: string;
 }
 
-// @public @deprecated (undocumented)
-export const VertexAIError: typeof AIError;
-
-// @public @deprecated (undocumented)
-export const VertexAIModel: typeof AIModel;
-
-// @public
-export interface VertexAIOptions {
-    // (undocumented)
-    location?: string;
-}
-
 // @public
 export interface VideoMetadata {
     endOffset: string;
@@ -947,5 +957,12 @@ export interface WebAttribution {
     uri: string;
 }
 
+// @public
+export interface WebGroundingChunk {
+    domain?: string;
+    title?: string;
+    uri?: string;
+}
+
 
 ```

docs-devsite/_toc.yaml

@@ -76,8 +76,16 @@ toc:
     path: /docs/reference/js/ai.generativemodel.md
   - title: GoogleAIBackend
     path: /docs/reference/js/ai.googleaibackend.md
+  - title: GoogleSearch
+    path: /docs/reference/js/ai.googlesearch.md
+  - title: GoogleSearchTool
+    path: /docs/reference/js/ai.googlesearchtool.md
+  - title: GroundingChunk
+    path: /docs/reference/js/ai.groundingchunk.md
   - title: GroundingMetadata
     path: /docs/reference/js/ai.groundingmetadata.md
+  - title: GroundingSupport
+    path: /docs/reference/js/ai.groundingsupport.md
   - title: ImagenGCSImage
     path: /docs/reference/js/ai.imagengcsimage.md
   - title: ImagenGenerationConfig
@@ -128,6 +136,8 @@ toc:
     path: /docs/reference/js/ai.schemarequest.md
   - title: SchemaShared
     path: /docs/reference/js/ai.schemashared.md
+  - title: SearchEntrypoint
+    path: /docs/reference/js/ai.searchentrypoint.md
   - title: Segment
     path: /docs/reference/js/ai.segment.md
   - title: StartChatParams
@@ -136,18 +146,20 @@ toc:
     path: /docs/reference/js/ai.stringschema.md
   - title: TextPart
     path: /docs/reference/js/ai.textpart.md
+  - title: ThinkingConfig
+    path: /docs/reference/js/ai.thinkingconfig.md
   - title: ToolConfig
     path: /docs/reference/js/ai.toolconfig.md
   - title: UsageMetadata
     path: /docs/reference/js/ai.usagemetadata.md
   - title: VertexAIBackend
     path: /docs/reference/js/ai.vertexaibackend.md
-  - title: VertexAIOptions
-    path: /docs/reference/js/ai.vertexaioptions.md
   - title: VideoMetadata
     path: /docs/reference/js/ai.videometadata.md
   - title: WebAttribution
     path: /docs/reference/js/ai.webattribution.md
+  - title: WebGroundingChunk
+    path: /docs/reference/js/ai.webgroundingchunk.md
 - title: analytics
   path: /docs/reference/js/analytics.md
   section:

docs-devsite/ai.functiondeclaration.md

@@ -15,7 +15,7 @@ Structured representation of a function declaration as defined by the [OpenAPI 3
 <b>Signature:</b>
 
 ```typescript
-export declare interface FunctionDeclaration 
+export interface FunctionDeclaration 
 ```
 
 ## Properties

docs-devsite/ai.functiondeclarationstool.md

@@ -15,7 +15,7 @@ A `FunctionDeclarationsTool` is a piece of code that enables the system to inter
 <b>Signature:</b>
 
 ```typescript
-export declare interface FunctionDeclarationsTool 
+export interface FunctionDeclarationsTool 
 ```
 
 ## Properties

docs-devsite/ai.generationconfig.md

@@ -31,6 +31,7 @@ export interface GenerationConfig
 |  [responseSchema](./ai.generationconfig.md#generationconfigresponseschema) | [TypedSchema](./ai.md#typedschema) \| [SchemaRequest](./ai.schemarequest.md#schemarequest_interface) | Output response schema of the generated candidate text. This value can be a class generated with a [Schema](./ai.schema.md#schema_class) static method like <code>Schema.string()</code> or <code>Schema.object()</code> or it can be a plain JS object matching the [SchemaRequest](./ai.schemarequest.md#schemarequest_interface) interface. <br/>Note: This only applies when the specified <code>responseMIMEType</code> supports a schema; currently this is limited to <code>application/json</code> and <code>text/x.enum</code>. |
 |  [stopSequences](./ai.generationconfig.md#generationconfigstopsequences) | string\[\] |  |
 |  [temperature](./ai.generationconfig.md#generationconfigtemperature) | number |  |
+|  [thinkingConfig](./ai.generationconfig.md#generationconfigthinkingconfig) | [ThinkingConfig](./ai.thinkingconfig.md#thinkingconfig_interface) | Configuration for "thinking" behavior of compatible Gemini models. |
 |  [topK](./ai.generationconfig.md#generationconfigtopk) | number |  |
 |  [topP](./ai.generationconfig.md#generationconfigtopp) | number |  |
 
@@ -117,6 +118,16 @@ stopSequences?: string[];
 temperature?: number;
 ```
 
+## GenerationConfig.thinkingConfig
+
+Configuration for "thinking" behavior of compatible Gemini models.
+
+<b>Signature:</b>
+
+```typescript
+thinkingConfig?: ThinkingConfig;
+```
+
 ## GenerationConfig.topK
 
 <b>Signature:</b>

docs-devsite/ai.vertexaioptions.md renamed to docs-devsite/ai.googlesearch.md

@@ -9,25 +9,13 @@ overwritten. Changes should be made in the source code at
 https://github.com/firebase/firebase-js-sdk
 {% endcomment %}
 
-# VertexAIOptions interface
-Options when initializing the Firebase AI SDK.
+# GoogleSearch interface
+Specifies the Google Search configuration.
 
-<b>Signature:</b>
-
-```typescript
-export interface VertexAIOptions 
-```
-
-## Properties
-
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [location](./ai.vertexaioptions.md#vertexaioptionslocation) | string |  |
-
-## VertexAIOptions.location
+Currently, this is an empty object, but it's reserved for future configuration options.
 
 <b>Signature:</b>
 
 ```typescript
-location?: string;
+export interface GoogleSearch 
 ```