@firebase/ai 2.5.0-canary.6abe52967 → 2.5.0-canary.f06cbf99b

package/dist/ai-public.d.ts

@@ -216,6 +216,8 @@ export declare abstract class Backend {
      * @param type - The backend type.
      */
     protected constructor(type: BackendType);
+    /* Excluded from this release type: _getModelPath */
+    /* Excluded from this release type: _getTemplatePath */
 }
 
 /**
@@ -1076,6 +1078,28 @@ export declare function getImagenModel(ai: AI, modelParams: ImagenModelParams, r
  */
 export declare function getLiveGenerativeModel(ai: AI, modelParams: LiveModelParams): LiveGenerativeModel;
 
+/**
+ * Returns a {@link TemplateGenerativeModel} class for executing server-side
+ * templates.
+ *
+ * @param ai - An {@link AI} instance.
+ * @param requestOptions - Additional options to use when making requests.
+ *
+ * @beta
+ */
+export declare function getTemplateGenerativeModel(ai: AI, requestOptions?: RequestOptions): TemplateGenerativeModel;
+
+/**
+ * Returns a {@link TemplateImagenModel} class for executing server-side
+ * Imagen templates.
+ *
+ * @param ai - An {@link AI} instance.
+ * @param requestOptions - Additional options to use when making requests.
+ *
+ * @beta
+ */
+export declare function getTemplateImagenModel(ai: AI, requestOptions?: RequestOptions): TemplateImagenModel;
+
 /**
  * Configuration class for the Gemini Developer API.
  *
@@ -1089,6 +1113,8 @@ export declare class GoogleAIBackend extends Backend {
      * Creates a configuration object for the Gemini Developer API backend.
      */
     constructor();
+    /* Excluded from this release type: _getModelPath */
+    /* Excluded from this release type: _getTemplatePath */
 }
 
 /* Excluded from this release type: GoogleAICitationMetadata */
@@ -2922,6 +2948,79 @@ export declare class StringSchema extends Schema {
     /* Excluded from this release type: toJSON */
 }
 
+/**
+ * {@link GenerativeModel} APIs that execute on a server-side template.
+ *
+ * This class should only be instantiated with {@link getTemplateGenerativeModel}.
+ *
+ * @beta
+ */
+export declare class TemplateGenerativeModel {
+    /* Excluded from this release type: _apiSettings */
+    /**
+     * Additional options to use when making requests.
+     */
+    requestOptions?: RequestOptions;
+    /**
+     * @hideconstructor
+     */
+    constructor(ai: AI, requestOptions?: RequestOptions);
+    /**
+     * Makes a single non-streaming call to the model and returns an object
+     * containing a single {@link GenerateContentResponse}.
+     *
+     * @param templateId - The ID of the server-side template to execute.
+     * @param templateVariables - A key-value map of variables to populate the
+     * template with.
+     *
+     * @beta
+     */
+    generateContent(templateId: string, templateVariables: object): Promise<GenerateContentResult>;
+    /**
+     * Makes a single streaming call to the model and returns an object
+     * containing an iterable stream that iterates over all chunks in the
+     * streaming response as well as a promise that returns the final aggregated
+     * response.
+     *
+     * @param templateId - The ID of the server-side template to execute.
+     * @param templateVariables - A key-value map of variables to populate the
+     * template with.
+     *
+     * @beta
+     */
+    generateContentStream(templateId: string, templateVariables: object): Promise<GenerateContentStreamResult>;
+}
+
+/**
+ * Class for Imagen model APIs that execute on a server-side template.
+ *
+ * This class should only be instantiated with {@link getTemplateImagenModel}.
+ *
+ * @beta
+ */
+export declare class TemplateImagenModel {
+    /* Excluded from this release type: _apiSettings */
+    /**
+     * Additional options to use when making requests.
+     */
+    requestOptions?: RequestOptions;
+    /**
+     * @hideconstructor
+     */
+    constructor(ai: AI, requestOptions?: RequestOptions);
+    /**
+     * Makes a single call to the model and returns an object containing a single
+     * {@link ImagenGenerationResponse}.
+     *
+     * @param templateId - The ID of the server-side template to execute.
+     * @param templateVariables - A key-value map of variables to populate the
+     * template with.
+     *
+     * @beta
+     */
+    generateImages(templateId: string, templateVariables: object): Promise<ImagenGenerationResponse<ImagenInlineImage>>;
+}
+
 /**
  * Content part interface if the part represents a text string.
  * @public
@@ -3162,6 +3261,8 @@ export declare class VertexAIBackend extends Backend {
      * for a list of supported locations.
      */
     constructor(location?: string);
+    /* Excluded from this release type: _getModelPath */
+    /* Excluded from this release type: _getTemplatePath */
 }
 
 /**

package/dist/ai.d.ts

@@ -256,6 +256,14 @@ export declare abstract class Backend {
      * @param type - The backend type.
      */
     protected constructor(type: BackendType);
+    /**
+     * @internal
+     */
+    abstract _getModelPath(project: string, model: string): string;
+    /**
+     * @internal
+     */
+    abstract _getTemplatePath(project: string, templateId: string): string;
 }
 
 /**
@@ -1137,6 +1145,28 @@ export declare function getImagenModel(ai: AI, modelParams: ImagenModelParams, r
  */
 export declare function getLiveGenerativeModel(ai: AI, modelParams: LiveModelParams): LiveGenerativeModel;
 
+/**
+ * Returns a {@link TemplateGenerativeModel} class for executing server-side
+ * templates.
+ *
+ * @param ai - An {@link AI} instance.
+ * @param requestOptions - Additional options to use when making requests.
+ *
+ * @beta
+ */
+export declare function getTemplateGenerativeModel(ai: AI, requestOptions?: RequestOptions): TemplateGenerativeModel;
+
+/**
+ * Returns a {@link TemplateImagenModel} class for executing server-side
+ * Imagen templates.
+ *
+ * @param ai - An {@link AI} instance.
+ * @param requestOptions - Additional options to use when making requests.
+ *
+ * @beta
+ */
+export declare function getTemplateImagenModel(ai: AI, requestOptions?: RequestOptions): TemplateImagenModel;
+
 /**
  * Configuration class for the Gemini Developer API.
  *
@@ -1150,6 +1180,14 @@ export declare class GoogleAIBackend extends Backend {
      * Creates a configuration object for the Gemini Developer API backend.
      */
     constructor();
+    /**
+     * @internal
+     */
+    _getModelPath(project: string, model: string): string;
+    /**
+     * @internal
+     */
+    _getTemplatePath(project: string, templateId: string): string;
 }
 
 /**
@@ -3064,6 +3102,85 @@ export declare class StringSchema extends Schema {
     toJSON(): SchemaRequest;
 }
 
+/**
+ * {@link GenerativeModel} APIs that execute on a server-side template.
+ *
+ * This class should only be instantiated with {@link getTemplateGenerativeModel}.
+ *
+ * @beta
+ */
+export declare class TemplateGenerativeModel {
+    /**
+     * @internal
+     */
+    _apiSettings: ApiSettings;
+    /**
+     * Additional options to use when making requests.
+     */
+    requestOptions?: RequestOptions;
+    /**
+     * @hideconstructor
+     */
+    constructor(ai: AI, requestOptions?: RequestOptions);
+    /**
+     * Makes a single non-streaming call to the model and returns an object
+     * containing a single {@link GenerateContentResponse}.
+     *
+     * @param templateId - The ID of the server-side template to execute.
+     * @param templateVariables - A key-value map of variables to populate the
+     * template with.
+     *
+     * @beta
+     */
+    generateContent(templateId: string, templateVariables: object): Promise<GenerateContentResult>;
+    /**
+     * Makes a single streaming call to the model and returns an object
+     * containing an iterable stream that iterates over all chunks in the
+     * streaming response as well as a promise that returns the final aggregated
+     * response.
+     *
+     * @param templateId - The ID of the server-side template to execute.
+     * @param templateVariables - A key-value map of variables to populate the
+     * template with.
+     *
+     * @beta
+     */
+    generateContentStream(templateId: string, templateVariables: object): Promise<GenerateContentStreamResult>;
+}
+
+/**
+ * Class for Imagen model APIs that execute on a server-side template.
+ *
+ * This class should only be instantiated with {@link getTemplateImagenModel}.
+ *
+ * @beta
+ */
+export declare class TemplateImagenModel {
+    /**
+     * @internal
+     */
+    _apiSettings: ApiSettings;
+    /**
+     * Additional options to use when making requests.
+     */
+    requestOptions?: RequestOptions;
+    /**
+     * @hideconstructor
+     */
+    constructor(ai: AI, requestOptions?: RequestOptions);
+    /**
+     * Makes a single call to the model and returns an object containing a single
+     * {@link ImagenGenerationResponse}.
+     *
+     * @param templateId - The ID of the server-side template to execute.
+     * @param templateVariables - A key-value map of variables to populate the
+     * template with.
+     *
+     * @beta
+     */
+    generateImages(templateId: string, templateVariables: object): Promise<ImagenGenerationResponse<ImagenInlineImage>>;
+}
+
 /**
  * Content part interface if the part represents a text string.
  * @public
@@ -3307,6 +3424,14 @@ export declare class VertexAIBackend extends Backend {
      * for a list of supported locations.
      */
     constructor(location?: string);
+    /**
+     * @internal
+     */
+    _getModelPath(project: string, model: string): string;
+    /**
+     * @internal
+     */
+    _getTemplatePath(project: string, templateId: string): string;
 }
 
 /**