@firebase/ai 1.4.0-canary.c0617a341 → 1.4.0-canary.ec5f37403

package/dist/ai.d.ts

@@ -58,7 +58,7 @@ export declare class AIError extends FirebaseError {
  *
  * @public
  */
-declare const enum AIErrorCode {
+export declare const enum AIErrorCode {
     /** A generic error occurred. */
     ERROR = "error",
     /** An error occurred in a request. */
@@ -86,8 +86,6 @@ declare const enum AIErrorCode {
     /** An error occurred due an attempt to use an unsupported feature. */
     UNSUPPORTED = "unsupported"
 }
-export { AIErrorCode }
-export { AIErrorCode as VertexAIErrorCode }
 
 /**
  * Base class for Firebase AI model APIs.
@@ -383,11 +381,10 @@ export declare interface CountTokensResponse {
      */
     totalTokens: number;
     /**
+     * @deprecated Use `totalTokens` instead. This property is undefined when using models greater than `gemini-1.5-*`.
+     *
      * The total number of billable characters counted across all instances
      * from the request.
-     *
-     * This property is only supported when using the Vertex AI Gemini API ({@link VertexAIBackend}).
-     * When using the Gemini Developer API ({@link GoogleAIBackend}), this property is not supported and will default to 0.
      */
     totalBillableCharacters?: number;
     /**
@@ -606,7 +603,7 @@ export declare interface FunctionDeclaration {
      * format. Reflects the Open API 3.03 Parameter Object. Parameter names are
      * case-sensitive. For a function with no parameters, this can be left unset.
      */
-    parameters?: ObjectSchemaInterface;
+    parameters?: ObjectSchema | ObjectSchemaRequest;
 }
 
 /**
@@ -753,6 +750,10 @@ export declare interface GenerationConfig {
      * @beta
      */
     responseModalities?: ResponseModality[];
+    /**
+     * Configuration for "thinking" behavior of compatible Gemini models.
+     */
+    thinkingConfig?: ThinkingConfig;
 }
 
 /**
@@ -856,22 +857,6 @@ export declare function getGenerativeModel(ai: AI, modelParams: ModelParams, req
  */
 export declare function getImagenModel(ai: AI, modelParams: ImagenModelParams, requestOptions?: RequestOptions): ImagenModel;
 
-/**
- * @deprecated Use the new {@link getAI | getAI()} instead. The Vertex AI in Firebase SDK has been
- * replaced with the Firebase AI SDK to accommodate the evolving set of supported features and
- * services. For migration details, see the {@link https://firebase.google.com/docs/vertex-ai/migrate-to-latest-sdk | migration guide}.
- *
- * Returns a {@link VertexAI} instance for the given app, configured to use the
- * Vertex AI Gemini API. This instance will be
- * configured to use the Vertex AI Gemini API.
- *
- * @param app - The {@link @firebase/app#FirebaseApp} to use.
- * @param options - Options to configure the Vertex AI instance, including the location.
- *
- * @public
- */
-export declare function getVertexAI(app?: FirebaseApp, options?: VertexAIOptions): VertexAI;
-
 /**
  * Configuration class for the Gemini Developer API.
  *
@@ -929,6 +914,42 @@ export declare interface GoogleAIGenerateContentResponse {
     usageMetadata?: UsageMetadata;
 }
 
+/**
+ * Specifies the Google Search configuration.
+ *
+ * @remarks Currently, this is an empty object, but it's reserved for future configuration options.
+ *
+ * @public
+ */
+export declare interface GoogleSearch {
+}
+
+/**
+ * A tool that allows a Gemini model to connect to Google Search to access and incorporate
+ * up-to-date information from the web into its responses.
+ *
+ * Important: If using Grounding with Google Search, you are required to comply with the
+ * "Grounding with Google Search" usage requirements for your chosen API provider: {@link https://ai.google.dev/gemini-api/terms#grounding-with-google-search | Gemini Developer API}
+ * or Vertex AI Gemini API (see {@link https://cloud.google.com/terms/service-terms | Service Terms}
+ * section within the Service Specific Terms).
+ *
+ * @public
+ */
+export declare interface GoogleSearchTool {
+    /**
+     * Specifies the Google Search configuration.
+     * Currently, this is an empty object, but it's reserved for future configuration options.
+     * Specifies the Google Search configuration. Currently, this is an empty object, but it's
+     * reserved for future configuration options.
+     *
+     * When using this feature, you are required to comply with the "Grounding with Google Search"
+     * usage requirements for your chosen API provider: {@link https://ai.google.dev/gemini-api/terms#grounding-with-google-search | Gemini Developer API}
+     * or Vertex AI Gemini API (see {@link https://cloud.google.com/terms/service-terms | Service Terms}
+     * section within the Service Specific Terms).
+     */
+    googleSearch: GoogleSearch;
+}
+
 /**
  * @deprecated
  * @public
@@ -941,18 +962,83 @@ export declare interface GroundingAttribution {
 }
 
 /**
- * Metadata returned to client when grounding is enabled.
+ * Represents a chunk of retrieved data that supports a claim in the model's response. This is part
+ * of the grounding information provided when grounding is enabled.
+ *
+ * @public
+ */
+export declare interface GroundingChunk {
+    /**
+     * Contains details if the grounding chunk is from a web source.
+     */
+    web?: WebGroundingChunk;
+}
+
+/**
+ * Metadata returned when grounding is enabled.
+ *
+ * Currently, only Grounding with Google Search is supported (see {@link GoogleSearchTool}).
+ *
+ * Important: If using Grounding with Google Search, you are required to comply with the
+ * "Grounding with Google Search" usage requirements for your chosen API provider: {@link https://ai.google.dev/gemini-api/terms#grounding-with-google-search | Gemini Developer API}
+ * or Vertex AI Gemini API (see {@link https://cloud.google.com/terms/service-terms | Service Terms}
+ * section within the Service Specific Terms).
+ *
  * @public
  */
 export declare interface GroundingMetadata {
+    /**
+     * Google Search entry point for web searches. This contains an HTML/CSS snippet that must be
+     * embedded in an app to display a Google Search entry point for follow-up web searches related to
+     * a model's “Grounded Response”.
+     */
+    searchEntryPoint?: SearchEntrypoint;
+    /**
+     * A list of {@link GroundingChunk} objects. Each chunk represents a piece of retrieved content
+     * (for example, from a web page). that the model used to ground its response.
+     */
+    groundingChunks?: GroundingChunk[];
+    /**
+     * A list of {@link GroundingSupport} objects. Each object details how specific segments of the
+     * model's response are supported by the `groundingChunks`.
+     */
+    groundingSupports?: GroundingSupport[];
+    /**
+     * A list of web search queries that the model performed to gather the grounding information.
+     * These can be used to allow users to explore the search results themselves.
+     */
     webSearchQueries?: string[];
+    /**
+     * @deprecated Use {@link GroundingSupport} instead.
+     */
     retrievalQueries?: string[];
     /**
-     * @deprecated
+     * @deprecated Use {@link GroundingChunk} instead.
      */
     groundingAttributions: GroundingAttribution[];
 }
 
+/**
+ * Provides information about how a specific segment of the model's response is supported by the
+ * retrieved grounding chunks.
+ *
+ * @public
+ */
+export declare interface GroundingSupport {
+    /**
+     * Specifies the segment of the model's response content that this grounding support pertains to.
+     */
+    segment?: Segment;
+    /**
+     * A list of indices that refer to specific {@link GroundingChunk} objects within the
+     * {@link GroundingMetadata.groundingChunks} array. These referenced chunks
+     * are the sources that support the claim made in the associated `segment` of the response.
+     * For example, an array `[1, 3, 4]` means that `groundingChunks[1]`, `groundingChunks[3]`,
+     * and `groundingChunks[4]` are the retrieved content supporting this part of the response.
+     */
+    groundingChunkIndices?: number[];
+}
+
 /**
  * This property is not supported in the Gemini Developer API ({@link GoogleAIBackend}).
  *
@@ -1593,12 +1679,20 @@ export declare class ObjectSchema extends Schema {
 }
 
 /**
- * Interface for {@link ObjectSchema} class.
+ * Interface for JSON parameters in {@link SchemaType.OBJECT} format when
+ * not using the {@link ObjectSchema} helper.
  * @public
  */
-export declare interface ObjectSchemaInterface extends SchemaInterface {
+export declare interface ObjectSchemaRequest extends SchemaRequest {
     type: SchemaType.OBJECT;
-    optionalProperties?: string[];
+    /**
+     * This is not a property accepted in the final request to the backend, but is
+     * a client-side convenience property that is only usable by constructing
+     * a schema through the `Schema.object()` helper method. Populating this
+     * property will cause response errors if the object is not wrapped with
+     * `Schema.object()`.
+     */
+    optionalProperties?: never;
 }
 
 /**
@@ -1928,12 +2022,58 @@ export declare enum SchemaType {
 }
 
 /**
+ * Google search entry point.
+ *
+ * @public
+ */
+export declare interface SearchEntrypoint {
+    /**
+     * HTML/CSS snippet that must be embedded in a web page. The snippet is designed to avoid
+     * undesired interaction with the rest of the page's CSS.
+     *
+     * To ensure proper rendering and prevent CSS conflicts, it is recommended
+     * to encapsulate this `renderedContent` within a shadow DOM when embedding it
+     * into a webpage. See {@link https://developer.mozilla.org/en-US/docs/Web/API/Web_components/Using_shadow_DOM | MDN: Using shadow DOM}.
+     *
+     * @example
+     * ```javascript
+     * const container = document.createElement('div');
+     * document.body.appendChild(container);
+     * container.attachShadow({ mode: 'open' }).innerHTML = renderedContent;
+     * ```
+     */
+    renderedContent?: string;
+}
+
+/**
+ * Represents a specific segment within a {@link Content} object, often used to
+ * pinpoint the exact location of text or data that grounding information refers to.
+ *
  * @public
  */
 export declare interface Segment {
+    /**
+     * The zero-based index of the {@link Part} object within the `parts` array
+     * of its parent {@link Content} object. This identifies which part of the
+     * content the segment belongs to.
+     */
     partIndex: number;
+    /**
+     * The zero-based start index of the segment within the specified `Part`,
+     * measured in UTF-8 bytes. This offset is inclusive, starting from 0 at the
+     * beginning of the part's content (e.g., `Part.text`).
+     */
     startIndex: number;
+    /**
+     * The zero-based end index of the segment within the specified `Part`,
+     * measured in UTF-8 bytes. This offset is exclusive, meaning the character
+     * at this index is not included in the segment.
+     */
     endIndex: number;
+    /**
+     * The text corresponding to the segment from the response.
+     */
+    text: string;
 }
 
 /**
@@ -1972,11 +2112,36 @@ export declare interface TextPart {
     functionResponse?: never;
 }
 
+/**
+ * Configuration for "thinking" behavior of compatible Gemini models.
+ *
+ * Certain models utilize a thinking process before generating a response. This allows them to
+ * reason through complex problems and plan a more coherent and accurate answer.
+ *
+ * @public
+ */
+export declare interface ThinkingConfig {
+    /**
+     * The thinking budget, in tokens.
+     *
+     * This parameter sets an upper limit on the number of tokens the model can use for its internal
+     * "thinking" process. A higher budget may result in higher quality responses for complex tasks
+     * but can also increase latency and cost.
+     *
+     * If you don't specify a budget, the model will determine the appropriate amount
+     * of thinking based on the complexity of the prompt.
+     *
+     * An error will be thrown if you set a thinking budget for a model that does not support this
+     * feature or if the specified budget is not within the model's supported range.
+     */
+    thinkingBudget?: number;
+}
+
 /**
  * Defines a tool that model can call to access external knowledge.
  * @public
  */
-export declare type Tool = FunctionDeclarationsTool;
+export declare type Tool = FunctionDeclarationsTool | GoogleSearchTool;
 
 /**
  * Tool config. This config is shared for all tools provided in the request.
@@ -2000,22 +2165,15 @@ export declare type TypedSchema = IntegerSchema | NumberSchema | StringSchema |
 export declare interface UsageMetadata {
     promptTokenCount: number;
     candidatesTokenCount: number;
+    /**
+     * The number of tokens used by the model's internal "thinking" process.
+     */
+    thoughtsTokenCount?: number;
     totalTokenCount: number;
     promptTokensDetails?: ModalityTokenCount[];
     candidatesTokensDetails?: ModalityTokenCount[];
 }
 
-/**
- * @deprecated Use the new {@link AI | AI} instead. The Vertex AI in Firebase SDK has been
- * replaced with the Firebase AI SDK to accommodate the evolving set of supported features and
- * services. For migration details, see the {@link https://firebase.google.com/docs/vertex-ai/migrate-to-latest-sdk | migration guide}.
- *
- * An instance of the Firebase AI SDK.
- *
- * @public
- */
-export declare type VertexAI = AI;
-
 /**
  * Configuration class for the Vertex AI Gemini API.
  *
@@ -2041,37 +2199,6 @@ export declare class VertexAIBackend extends Backend {
     constructor(location?: string);
 }
 
-/**
- * @deprecated Use the new {@link AIError} instead. The Vertex AI in Firebase SDK has been
- * replaced with the Firebase AI SDK to accommodate the evolving set of supported features and
- * services. For migration details, see the {@link https://firebase.google.com/docs/vertex-ai/migrate-to-latest-sdk | migration guide}.
- *
- * Error class for the Firebase AI SDK.
- *
- * @public
- */
-export declare const VertexAIError: typeof AIError;
-
-/**
- * @deprecated Use the new {@link AIModel} instead. The Vertex AI in Firebase SDK has been
- * replaced with the Firebase AI SDK to accommodate the evolving set of supported features and
- * services. For migration details, see the {@link https://firebase.google.com/docs/vertex-ai/migrate-to-latest-sdk | migration guide}.
- *
- * Base class for Firebase AI model APIs.
- *
- * @public
- */
-export declare const VertexAIModel: typeof AIModel;
-
-/**
- * Options when initializing the Firebase AI SDK.
- *
- * @public
- */
-export declare interface VertexAIOptions {
-    location?: string;
-}
-
 /**
  * Describes the input video content.
  * @public
@@ -2097,4 +2224,31 @@ export declare interface WebAttribution {
     title: string;
 }
 
+/**
+ * A grounding chunk from the web.
+ *
+ * Important: If using Grounding with Google Search, you are required to comply with the
+ * {@link https://cloud.google.com/terms/service-terms | Service Specific Terms} for "Grounding with Google Search".
+ *
+ * @public
+ */
+export declare interface WebGroundingChunk {
+    /**
+     * The URI of the retrieved web page.
+     */
+    uri?: string;
+    /**
+     * The title of the retrieved web page.
+     */
+    title?: string;
+    /**
+     * The domain of the original URI from which the content was retrieved.
+     *
+     * This property is only supported in the Vertex AI Gemini API ({@link VertexAIBackend}).
+     * When using the Gemini Developer API ({@link GoogleAIBackend}), this property will be
+     * `undefined`.
+     */
+    domain?: string;
+}
+
 export { }

package/dist/esm/index.esm2017.js

@@ -5,7 +5,7 @@ import { Logger } from '@firebase/logger';
 import { __asyncGenerator, __await } from 'tslib';
 
 var name = "@firebase/ai";
-var version = "1.4.0-canary.c0617a341";
+var version = "1.4.0-canary.ec5f37403";
 
 /**
  * @license
@@ -996,6 +996,7 @@ async function makeRequest(model, task, apiSettings, stream, body, requestOption
                 // ignored
             }
             if (response.status === 403 &&
+                errorDetails &&
                 errorDetails.some((detail) => detail.reason === 'SERVICE_DISABLED') &&
                 errorDetails.some((detail) => {
                     var _a, _b;
@@ -1575,6 +1576,8 @@ function aggregateResponses(responses) {
                     candidate.finishMessage;
                 aggregatedResponse.candidates[i].safetyRatings =
                     candidate.safetyRatings;
+                aggregatedResponse.candidates[i].groundingMetadata =
+                    candidate.groundingMetadata;
                 /**
                  * Candidates should always have content and parts, but this handles
                  * possible malformed responses.
@@ -2488,50 +2491,6 @@ class ImagenImageFormat {
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-/**
- * @deprecated Use the new {@link AIModel} instead. The Vertex AI in Firebase SDK has been
- * replaced with the Firebase AI SDK to accommodate the evolving set of supported features and
- * services. For migration details, see the {@link https://firebase.google.com/docs/vertex-ai/migrate-to-latest-sdk | migration guide}.
- *
- * Base class for Firebase AI model APIs.
- *
- * @public
- */
-const VertexAIModel = AIModel;
-/**
- * @deprecated Use the new {@link AIError} instead. The Vertex AI in Firebase SDK has been
- * replaced with the Firebase AI SDK to accommodate the evolving set of supported features and
- * services. For migration details, see the {@link https://firebase.google.com/docs/vertex-ai/migrate-to-latest-sdk | migration guide}.
- *
- * Error class for the Firebase AI SDK.
- *
- * @public
- */
-const VertexAIError = AIError;
-/**
- * @deprecated Use the new {@link getAI | getAI()} instead. The Vertex AI in Firebase SDK has been
- * replaced with the Firebase AI SDK to accommodate the evolving set of supported features and
- * services. For migration details, see the {@link https://firebase.google.com/docs/vertex-ai/migrate-to-latest-sdk | migration guide}.
- *
- * Returns a {@link VertexAI} instance for the given app, configured to use the
- * Vertex AI Gemini API. This instance will be
- * configured to use the Vertex AI Gemini API.
- *
- * @param app - The {@link @firebase/app#FirebaseApp} to use.
- * @param options - Options to configure the Vertex AI instance, including the location.
- *
- * @public
- */
-function getVertexAI(app = getApp(), options) {
-    app = getModularInstance(app);
-    // Dependencies
-    const AIProvider = _getProvider(app, AI_TYPE);
-    const backend = new VertexAIBackend(options === null || options === void 0 ? void 0 : options.location);
-    const identifier = encodeInstanceIdentifier(backend);
-    return AIProvider.getImmediate({
-        identifier
-    });
-}
 /**
  * Returns the default {@link AI} instance that is associated with the provided
  * {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new instance with the
@@ -2625,5 +2584,5 @@ function registerAI() {
 }
 registerAI();
 
-export { AIError, AIModel, ArraySchema, Backend, BackendType, BlockReason, BooleanSchema, ChatSession, FinishReason, FunctionCallingMode, GenerativeModel, GoogleAIBackend, HarmBlockMethod, HarmBlockThreshold, HarmCategory, HarmProbability, HarmSeverity, ImagenAspectRatio, ImagenImageFormat, ImagenModel, ImagenPersonFilterLevel, ImagenSafetyFilterLevel, IntegerSchema, Modality, NumberSchema, ObjectSchema, POSSIBLE_ROLES, ResponseModality, Schema, SchemaType, StringSchema, VertexAIBackend, VertexAIError, VertexAIModel, getAI, getGenerativeModel, getImagenModel, getVertexAI };
+export { AIError, AIModel, ArraySchema, Backend, BackendType, BlockReason, BooleanSchema, ChatSession, FinishReason, FunctionCallingMode, GenerativeModel, GoogleAIBackend, HarmBlockMethod, HarmBlockThreshold, HarmCategory, HarmProbability, HarmSeverity, ImagenAspectRatio, ImagenImageFormat, ImagenModel, ImagenPersonFilterLevel, ImagenSafetyFilterLevel, IntegerSchema, Modality, NumberSchema, ObjectSchema, POSSIBLE_ROLES, ResponseModality, Schema, SchemaType, StringSchema, VertexAIBackend, getAI, getGenerativeModel, getImagenModel };
 //# sourceMappingURL=index.esm2017.js.map