@firebase/ai 1.4.1-canary.2d720995d → 1.4.1-canary.574800585

package/dist/ai-public.d.ts

@@ -129,6 +129,19 @@ export declare interface AIOptions {
     backend: Backend;
 }
 
+/**
+ * Schema class representing a value that can conform to any of the provided sub-schemas. This is
+ * useful when a field can accept multiple distinct types or structures.
+ * @public
+ */
+export declare class AnyOfSchema extends Schema {
+    anyOf: TypedSchema[];
+    constructor(schemaParams: SchemaParams & {
+        anyOf: TypedSchema[];
+    });
+    /* Excluded from this release type: toJSON */
+}
+
 declare interface ApiSettings {
     apiKey: string;
     project: string;
@@ -720,7 +733,7 @@ export declare interface GenerationConfig {
      * value can be a class generated with a {@link Schema} static method
      * like `Schema.string()` or `Schema.object()` or it can be a plain
      * JS object matching the {@link SchemaRequest} interface.
-     * <br/>Note: This only applies when the specified `responseMIMEType` supports a schema; currently
+     * <br/>Note: This only applies when the specified `responseMimeType` supports a schema; currently
      * this is limited to `application/json` and `text/x.enum`.
      */
     responseSchema?: TypedSchema | SchemaRequest;
@@ -900,17 +913,6 @@ export declare interface GoogleSearchTool {
     googleSearch: GoogleSearch;
 }
 
-/**
- * @deprecated
- * @public
- */
-export declare interface GroundingAttribution {
-    segment: Segment;
-    confidenceScore?: number;
-    web?: WebAttribution;
-    retrievedContext?: RetrievedContextAttribution;
-}
-
 /**
  * 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.
@@ -940,7 +942,7 @@ 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”.
+     * a model's "Grounded Response".
      */
     searchEntryPoint?: SearchEntrypoint;
     /**
@@ -962,10 +964,6 @@ export declare interface GroundingMetadata {
      * @deprecated Use {@link GroundingSupport} instead.
      */
     retrievalQueries?: string[];
-    /**
-     * @deprecated Use {@link GroundingChunk} instead.
-     */
-    groundingAttributions: GroundingAttribution[];
 }
 
 /**
@@ -1134,7 +1132,7 @@ export declare type HarmSeverity = (typeof HarmSeverity)[keyof typeof HarmSeveri
  * To specify an aspect ratio for generated images, set the `aspectRatio` property in your
  * {@link ImagenGenerationConfig}.
  *
- * See the the {@link http://firebase.google.com/docs/vertex-ai/generate-images | documentation }
+ * See the {@link http://firebase.google.com/docs/vertex-ai/generate-images | documentation }
  * for more details and examples of the supported aspect ratios.
  *
  * @beta
@@ -1168,7 +1166,7 @@ export declare const ImagenAspectRatio: {
  * To specify an aspect ratio for generated images, set the `aspectRatio` property in your
  * {@link ImagenGenerationConfig}.
  *
- * See the the {@link http://firebase.google.com/docs/vertex-ai/generate-images | documentation }
+ * See the {@link http://firebase.google.com/docs/vertex-ai/generate-images | documentation }
  * for more details and examples of the supported aspect ratios.
  *
  * @beta
@@ -1853,10 +1851,11 @@ export declare interface SafetySetting {
  */
 export declare abstract class Schema implements SchemaInterface {
     /**
-     * Optional. The type of the property. {@link
-     * (SchemaType:type)}.
+     * Optional. The type of the property.
+     * This can only be undefined when using `anyOf` schemas, which do not have an
+     * explicit type in the {@link https://swagger.io/docs/specification/v3_0/data-models/data-types/#any-type | OpenAPI specification}.
      */
-    type: SchemaType;
+    type?: SchemaType;
     /** Optional. The format of the property.
      * Supported formats:<br/>
      * <ul>
@@ -1901,6 +1900,9 @@ export declare abstract class Schema implements SchemaInterface {
     static integer(integerParams?: SchemaParams): IntegerSchema;
     static number(numberParams?: SchemaParams): NumberSchema;
     static boolean(booleanParams?: SchemaParams): BooleanSchema;
+    static anyOf(anyOfParams: SchemaParams & {
+        anyOf: TypedSchema[];
+    }): AnyOfSchema;
 }
 
 /**
@@ -1909,10 +1911,10 @@ export declare abstract class Schema implements SchemaInterface {
  */
 export declare interface SchemaInterface extends SchemaShared<SchemaInterface> {
     /**
-     * The type of the property. {@link
-     * (SchemaType:type)}.
+     * The type of the property. this can only be undefined when using `anyof` schemas,
+     * which do not have an explicit type in the {@link https://swagger.io/docs/specification/v3_0/data-models/data-types/#any-type | OpenAPI Specification}.
      */
-    type: SchemaType;
+    type?: SchemaType;
 }
 
 /**
@@ -1929,10 +1931,10 @@ export declare interface SchemaParams extends SchemaShared<SchemaInterface> {
  */
 export declare interface SchemaRequest extends SchemaShared<SchemaRequest> {
     /**
-     * The type of the property. {@link
-     * (SchemaType:type)}.
+     * The type of the property. this can only be undefined when using `anyOf` schemas,
+     * which do not have an explicit type in the {@link https://swagger.io/docs/specification/v3_0/data-models/data-types/#any-type | OpenAPI specification }.
      */
-    type: SchemaType;
+    type?: SchemaType;
     /** Optional. Array of required property. */
     required?: string[];
 }
@@ -1943,6 +1945,12 @@ export declare interface SchemaRequest extends SchemaShared<SchemaRequest> {
  * @public
  */
 export declare interface SchemaShared<T> {
+    /**
+     * An array of {@link Schema}. The generated data must be valid against any of the schemas
+     * listed in this array. This allows specifying multiple possible structures or types for a
+     * single field.
+     */
+    anyOf?: T[];
     /** Optional. The format of the property.
      * When using the Gemini Developer API ({@link GoogleAIBackend}), this must be either `'enum'` or
      * `'date-time'`, otherwise requests will fail.
@@ -2141,7 +2149,7 @@ export declare interface ToolConfig {
  * A type that includes all specific Schema types.
  * @public
  */
-export declare type TypedSchema = IntegerSchema | NumberSchema | StringSchema | BooleanSchema | ObjectSchema | ArraySchema;
+export declare type TypedSchema = IntegerSchema | NumberSchema | StringSchema | BooleanSchema | ObjectSchema | ArraySchema | AnyOfSchema;
 
 /**
  * Usage metadata about a {@link GenerateContentResponse}.

package/dist/ai.d.ts

@@ -163,6 +163,22 @@ export declare interface AIOptions {
     backend: Backend;
 }
 
+/**
+ * Schema class representing a value that can conform to any of the provided sub-schemas. This is
+ * useful when a field can accept multiple distinct types or structures.
+ * @public
+ */
+export declare class AnyOfSchema extends Schema {
+    anyOf: TypedSchema[];
+    constructor(schemaParams: SchemaParams & {
+        anyOf: TypedSchema[];
+    });
+    /**
+     * @internal
+     */
+    toJSON(): SchemaRequest;
+}
+
 declare interface ApiSettings {
     apiKey: string;
     project: string;
@@ -757,7 +773,7 @@ export declare interface GenerationConfig {
      * value can be a class generated with a {@link Schema} static method
      * like `Schema.string()` or `Schema.object()` or it can be a plain
      * JS object matching the {@link SchemaRequest} interface.
-     * <br/>Note: This only applies when the specified `responseMIMEType` supports a schema; currently
+     * <br/>Note: This only applies when the specified `responseMimeType` supports a schema; currently
      * this is limited to `application/json` and `text/x.enum`.
      */
     responseSchema?: TypedSchema | SchemaRequest;
@@ -971,17 +987,6 @@ export declare interface GoogleSearchTool {
     googleSearch: GoogleSearch;
 }
 
-/**
- * @deprecated
- * @public
- */
-export declare interface GroundingAttribution {
-    segment: Segment;
-    confidenceScore?: number;
-    web?: WebAttribution;
-    retrievedContext?: RetrievedContextAttribution;
-}
-
 /**
  * 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.
@@ -1011,7 +1016,7 @@ 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”.
+     * a model's "Grounded Response".
      */
     searchEntryPoint?: SearchEntrypoint;
     /**
@@ -1033,10 +1038,6 @@ export declare interface GroundingMetadata {
      * @deprecated Use {@link GroundingSupport} instead.
      */
     retrievalQueries?: string[];
-    /**
-     * @deprecated Use {@link GroundingChunk} instead.
-     */
-    groundingAttributions: GroundingAttribution[];
 }
 
 /**
@@ -1205,7 +1206,7 @@ export declare type HarmSeverity = (typeof HarmSeverity)[keyof typeof HarmSeveri
  * To specify an aspect ratio for generated images, set the `aspectRatio` property in your
  * {@link ImagenGenerationConfig}.
  *
- * See the the {@link http://firebase.google.com/docs/vertex-ai/generate-images | documentation }
+ * See the {@link http://firebase.google.com/docs/vertex-ai/generate-images | documentation }
  * for more details and examples of the supported aspect ratios.
  *
  * @beta
@@ -1239,7 +1240,7 @@ export declare const ImagenAspectRatio: {
  * To specify an aspect ratio for generated images, set the `aspectRatio` property in your
  * {@link ImagenGenerationConfig}.
  *
- * See the the {@link http://firebase.google.com/docs/vertex-ai/generate-images | documentation }
+ * See the {@link http://firebase.google.com/docs/vertex-ai/generate-images | documentation }
  * for more details and examples of the supported aspect ratios.
  *
  * @beta
@@ -1946,10 +1947,11 @@ export declare interface SafetySetting {
  */
 export declare abstract class Schema implements SchemaInterface {
     /**
-     * Optional. The type of the property. {@link
-     * (SchemaType:type)}.
+     * Optional. The type of the property.
+     * This can only be undefined when using `anyOf` schemas, which do not have an
+     * explicit type in the {@link https://swagger.io/docs/specification/v3_0/data-models/data-types/#any-type | OpenAPI specification}.
      */
-    type: SchemaType;
+    type?: SchemaType;
     /** Optional. The format of the property.
      * Supported formats:<br/>
      * <ul>
@@ -1999,6 +2001,9 @@ export declare abstract class Schema implements SchemaInterface {
     static integer(integerParams?: SchemaParams): IntegerSchema;
     static number(numberParams?: SchemaParams): NumberSchema;
     static boolean(booleanParams?: SchemaParams): BooleanSchema;
+    static anyOf(anyOfParams: SchemaParams & {
+        anyOf: TypedSchema[];
+    }): AnyOfSchema;
 }
 
 /**
@@ -2007,10 +2012,10 @@ export declare abstract class Schema implements SchemaInterface {
  */
 export declare interface SchemaInterface extends SchemaShared<SchemaInterface> {
     /**
-     * The type of the property. {@link
-     * (SchemaType:type)}.
+     * The type of the property. this can only be undefined when using `anyof` schemas,
+     * which do not have an explicit type in the {@link https://swagger.io/docs/specification/v3_0/data-models/data-types/#any-type | OpenAPI Specification}.
      */
-    type: SchemaType;
+    type?: SchemaType;
 }
 
 /**
@@ -2027,10 +2032,10 @@ export declare interface SchemaParams extends SchemaShared<SchemaInterface> {
  */
 export declare interface SchemaRequest extends SchemaShared<SchemaRequest> {
     /**
-     * The type of the property. {@link
-     * (SchemaType:type)}.
+     * The type of the property. this can only be undefined when using `anyOf` schemas,
+     * which do not have an explicit type in the {@link https://swagger.io/docs/specification/v3_0/data-models/data-types/#any-type | OpenAPI specification }.
      */
-    type: SchemaType;
+    type?: SchemaType;
     /** Optional. Array of required property. */
     required?: string[];
 }
@@ -2041,6 +2046,12 @@ export declare interface SchemaRequest extends SchemaShared<SchemaRequest> {
  * @public
  */
 export declare interface SchemaShared<T> {
+    /**
+     * An array of {@link Schema}. The generated data must be valid against any of the schemas
+     * listed in this array. This allows specifying multiple possible structures or types for a
+     * single field.
+     */
+    anyOf?: T[];
     /** Optional. The format of the property.
      * When using the Gemini Developer API ({@link GoogleAIBackend}), this must be either `'enum'` or
      * `'date-time'`, otherwise requests will fail.
@@ -2242,7 +2253,7 @@ export declare interface ToolConfig {
  * A type that includes all specific Schema types.
  * @public
  */
-export declare type TypedSchema = IntegerSchema | NumberSchema | StringSchema | BooleanSchema | ObjectSchema | ArraySchema;
+export declare type TypedSchema = IntegerSchema | NumberSchema | StringSchema | BooleanSchema | ObjectSchema | ArraySchema | AnyOfSchema;
 
 /**
  * Usage metadata about a {@link GenerateContentResponse}.

package/dist/esm/index.esm.js

@@ -4,7 +4,7 @@ import { FirebaseError, getModularInstance } from '@firebase/util';
 import { Logger } from '@firebase/logger';
 
 var name = "@firebase/ai";
-var version = "1.4.1-canary.2d720995d";
+var version = "1.4.1-canary.574800585";
 
 /**
  * @license
@@ -460,7 +460,7 @@ const ImagenPersonFilterLevel = {
  * To specify an aspect ratio for generated images, set the `aspectRatio` property in your
  * {@link ImagenGenerationConfig}.
  *
- * See the the {@link http://firebase.google.com/docs/vertex-ai/generate-images | documentation }
+ * See the {@link http://firebase.google.com/docs/vertex-ai/generate-images | documentation }
  * for more details and examples of the supported aspect ratios.
  *
  * @beta
@@ -2307,12 +2307,19 @@ class ImagenModel extends AIModel {
  */
 class Schema {
     constructor(schemaParams) {
+        // TODO(dlarocque): Enforce this with union types
+        if (!schemaParams.type && !schemaParams.anyOf) {
+            throw new AIError(AIErrorCode.INVALID_SCHEMA, "A schema must have either a 'type' or an 'anyOf' array of sub-schemas.");
+        }
         // eslint-disable-next-line guard-for-in
         for (const paramKey in schemaParams) {
             this[paramKey] = schemaParams[paramKey];
         }
         // Ensure these are explicitly set to avoid TS errors.
         this.type = schemaParams.type;
+        this.format = schemaParams.hasOwnProperty('format')
+            ? schemaParams.format
+            : undefined;
         this.nullable = schemaParams.hasOwnProperty('nullable')
             ? !!schemaParams.nullable
             : false;
@@ -2359,6 +2366,9 @@ class Schema {
     static boolean(booleanParams) {
         return new BooleanSchema(booleanParams);
     }
+    static anyOf(anyOfParams) {
+        return new AnyOfSchema(anyOfParams);
+    }
 }
 /**
  * Schema class for "integer" types.
@@ -2486,6 +2496,34 @@ class ObjectSchema extends Schema {
         return obj;
     }
 }
+/**
+ * Schema class representing a value that can conform to any of the provided sub-schemas. This is
+ * useful when a field can accept multiple distinct types or structures.
+ * @public
+ */
+class AnyOfSchema extends Schema {
+    constructor(schemaParams) {
+        if (schemaParams.anyOf.length === 0) {
+            throw new AIError(AIErrorCode.INVALID_SCHEMA, "The 'anyOf' array must not be empty.");
+        }
+        super({
+            ...schemaParams,
+            type: undefined // anyOf schemas do not have an explicit type
+        });
+        this.anyOf = schemaParams.anyOf;
+    }
+    /**
+     * @internal
+     */
+    toJSON() {
+        const obj = super.toJSON();
+        // Ensure the 'anyOf' property contains serialized SchemaRequest objects.
+        if (this.anyOf && Array.isArray(this.anyOf)) {
+            obj.anyOf = this.anyOf.map(s => s.toJSON());
+        }
+        return obj;
+    }
+}
 
 /**
  * @license
@@ -2660,5 +2698,5 @@ function registerAI() {
 }
 registerAI();
 
-export { AIError, AIErrorCode, 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 };
+export { AIError, AIErrorCode, AIModel, AnyOfSchema, 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.esm.js.map