@firebase/ai 1.4.0-canary.d590889d6 → 1.4.0-canary.e59cd7da1

package/dist/src/types/requests.d.ts

@@ -14,10 +14,10 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { TypedSchema } from '../requests/schema-builder';
+import { ObjectSchema, TypedSchema } from '../requests/schema-builder';
 import { Content, Part } from './content';
 import { FunctionCallingMode, HarmBlockMethod, HarmBlockThreshold, HarmCategory, ResponseModality } from './enums';
-import { ObjectSchemaInterface, SchemaRequest } from './schema';
+import { ObjectSchemaRequest, SchemaRequest } from './schema';
 /**
  * Base parameters for a number of methods.
  * @public
@@ -101,6 +101,10 @@ export interface GenerationConfig {
      * @beta
      */
     responseModalities?: ResponseModality[];
+    /**
+     * Configuration for "thinking" behavior of compatible Gemini models.
+     */
+    thinkingConfig?: ThinkingConfig;
 }
 /**
  * Params for {@link GenerativeModel.startChat}.
@@ -149,7 +153,7 @@ export interface RequestOptions {
  * Defines a tool that model can call to access external knowledge.
  * @public
  */
-export declare type Tool = FunctionDeclarationsTool;
+export type Tool = FunctionDeclarationsTool | GoogleSearchTool;
 /**
  * Structured representation of a function declaration as defined by the
  * {@link https://spec.openapis.org/oas/v3.0.3 | OpenAPI 3.0 specification}.
@@ -159,7 +163,7 @@ export declare type Tool = FunctionDeclarationsTool;
  * as a Tool by the model and executed by the client.
  * @public
  */
-export declare interface FunctionDeclaration {
+export interface FunctionDeclaration {
     /**
      * The name of the function to call. Must start with a letter or an
      * underscore. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with
@@ -176,7 +180,41 @@ 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;
+}
+/**
+ * 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 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;
+}
+/**
+ * Specifies the Google Search configuration.
+ *
+ * @remarks Currently, this is an empty object, but it's reserved for future configuration options.
+ *
+ * @public
+ */
+export interface GoogleSearch {
 }
 /**
  * A `FunctionDeclarationsTool` is a piece of code that enables the system to
@@ -184,7 +222,7 @@ export declare interface FunctionDeclaration {
  * outside of knowledge and scope of the model.
  * @public
  */
-export declare interface FunctionDeclarationsTool {
+export interface FunctionDeclarationsTool {
     /**
      * Optional. One or more function declarations
      * to be passed to the model along with the current user query. Model may
@@ -211,3 +249,27 @@ export interface FunctionCallingConfig {
     mode?: FunctionCallingMode;
     allowedFunctionNames?: string[];
 }
+/**
+ * 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 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;
+}

package/dist/src/types/responses.d.ts

@@ -78,6 +78,10 @@ export interface GenerateContentResponse {
 export 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[];
@@ -151,34 +155,168 @@ export interface Citation {
     publicationDate?: Date;
 }
 /**
- * Metadata returned to client when grounding is enabled.
+ * 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 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[];
 }
 /**
- * @deprecated
+ * Google search entry point.
+ *
  * @public
  */
-export interface GroundingAttribution {
-    segment: Segment;
-    confidenceScore?: number;
-    web?: WebAttribution;
-    retrievedContext?: RetrievedContextAttribution;
+export 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 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 interface GroundingChunk {
+    /**
+     * Contains details if the grounding chunk is from a web source.
+     */
+    web?: WebGroundingChunk;
 }
 /**
+ * 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 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;
+}
+/**
+ * Provides information about how a specific segment of the model's response is supported by the
+ * retrieved grounding chunks.
+ *
+ * @public
+ */
+export 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[];
+}
+/**
+ * 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 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;
+}
+/**
+ * @deprecated
+ * @public
+ */
+export interface GroundingAttribution {
+    segment: Segment;
+    confidenceScore?: number;
+    web?: WebAttribution;
+    retrievedContext?: RetrievedContextAttribution;
 }
 /**
  * @public
@@ -243,11 +381,10 @@ export 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;
     /**

package/dist/src/types/schema.d.ts

@@ -20,20 +20,27 @@
  * {@link https://swagger.io/docs/specification/data-models/data-types/ | OpenAPI specification}
  * @public
  */
-export declare enum SchemaType {
+export declare const SchemaType: {
     /** String type. */
-    STRING = "string",
+    readonly STRING: "string";
     /** Number type. */
-    NUMBER = "number",
+    readonly NUMBER: "number";
     /** Integer type. */
-    INTEGER = "integer",
+    readonly INTEGER: "integer";
     /** Boolean type. */
-    BOOLEAN = "boolean",
+    readonly BOOLEAN: "boolean";
     /** Array type. */
-    ARRAY = "array",
+    readonly ARRAY: "array";
     /** Object type. */
-    OBJECT = "object"
-}
+    readonly OBJECT: "object";
+};
+/**
+ * Contains the list of OpenAPI data types
+ * as defined by the
+ * {@link https://swagger.io/docs/specification/data-models/data-types/ | OpenAPI specification}
+ * @public
+ */
+export type SchemaType = (typeof SchemaType)[keyof typeof SchemaType];
 /**
  * Basic {@link Schema} properties shared across several Schema-related
  * types.
@@ -55,9 +62,9 @@ export interface SchemaShared<T> {
     title?: string;
     /** Optional. The items of the property. */
     items?: T;
-    /** The minimum number of items (elements) in a schema of type {@link SchemaType.ARRAY}. */
+    /** The minimum number of items (elements) in a schema of {@link (SchemaType:type)} `array`. */
     minItems?: number;
-    /** The maximum number of items (elements) in a schema of type {@link SchemaType.ARRAY}. */
+    /** The maximum number of items (elements) in a schema of {@link (SchemaType:type)} `array`. */
     maxItems?: number;
     /** Optional. Map of `Schema` objects. */
     properties?: {
@@ -91,7 +98,7 @@ export interface SchemaParams extends SchemaShared<SchemaInterface> {
 export interface SchemaRequest extends SchemaShared<SchemaRequest> {
     /**
      * The type of the property. {@link
-     * SchemaType}.
+     * (SchemaType:type)}.
      */
     type: SchemaType;
     /** Optional. Array of required property. */
@@ -104,15 +111,23 @@ export interface SchemaRequest extends SchemaShared<SchemaRequest> {
 export interface SchemaInterface extends SchemaShared<SchemaInterface> {
     /**
      * The type of the property. {@link
-     * SchemaType}.
+     * (SchemaType:type)}.
      */
     type: SchemaType;
 }
 /**
- * Interface for {@link ObjectSchema} class.
+ * Interface for JSON parameters in a schema of {@link SchemaType}
+ * "object" when not using the `Schema.object()` helper.
  * @public
  */
-export interface ObjectSchemaInterface extends SchemaInterface {
-    type: SchemaType.OBJECT;
-    optionalProperties?: string[];
+export interface ObjectSchemaRequest extends SchemaRequest {
+    type: 'object';
+    /**
+     * 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;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@firebase/ai",
-  "version": "1.4.0-canary.d590889d6",
+  "version": "1.4.0-canary.e59cd7da1",
   "description": "The Firebase AI SDK",
   "author": "Firebase <firebase-support@google.com> (https://firebase.google.com/)",
   "engines": {
@@ -45,19 +45,19 @@
     "trusted-type-check": "tsec -p tsconfig.json --noEmit"
   },
   "peerDependencies": {
-    "@firebase/app": "0.13.1-canary.d590889d6",
-    "@firebase/app-types": "0.9.3-canary.d590889d6"
+    "@firebase/app": "0.13.1-canary.e59cd7da1",
+    "@firebase/app-types": "0.9.3-canary.e59cd7da1"
   },
   "dependencies": {
-    "@firebase/app-check-interop-types": "0.3.3-canary.d590889d6",
-    "@firebase/component": "0.6.17-canary.d590889d6",
-    "@firebase/logger": "0.4.4-canary.d590889d6",
-    "@firebase/util": "1.12.0-canary.d590889d6",
+    "@firebase/app-check-interop-types": "0.3.3-canary.e59cd7da1",
+    "@firebase/component": "0.6.17-canary.e59cd7da1",
+    "@firebase/logger": "0.4.4-canary.e59cd7da1",
+    "@firebase/util": "1.12.0-canary.e59cd7da1",
     "tslib": "^2.1.0"
   },
   "license": "Apache-2.0",
   "devDependencies": {
-    "@firebase/app": "0.13.1-canary.d590889d6",
+    "@firebase/app": "0.13.1-canary.e59cd7da1",
     "@rollup/plugin-json": "6.1.0",
     "rollup": "2.79.2",
     "rollup-plugin-replace": "2.2.0",