summaryrefslogtreecommitdiff
path: root/frontend-old/node_modules/@firebase/ai/dist/src/models/imagen-model.d.ts
diff options
context:
space:
mode:
authoraltaf-creator <dev@altafcreator.com>2025-11-09 11:15:19 +0800
committeraltaf-creator <dev@altafcreator.com>2025-11-09 11:15:19 +0800
commit8eff962cab608341a6f2fedc640a0e32d96f26e2 (patch)
tree05534d1a720ddc3691d346c69b4972555820a061 /frontend-old/node_modules/@firebase/ai/dist/src/models/imagen-model.d.ts
pain
Diffstat (limited to 'frontend-old/node_modules/@firebase/ai/dist/src/models/imagen-model.d.ts')
-rw-r--r--frontend-old/node_modules/@firebase/ai/dist/src/models/imagen-model.d.ts102
1 files changed, 102 insertions, 0 deletions
diff --git a/frontend-old/node_modules/@firebase/ai/dist/src/models/imagen-model.d.ts b/frontend-old/node_modules/@firebase/ai/dist/src/models/imagen-model.d.ts
new file mode 100644
index 0000000..699f2a2
--- /dev/null
+++ b/frontend-old/node_modules/@firebase/ai/dist/src/models/imagen-model.d.ts
@@ -0,0 +1,102 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { AI } from '../public-types';
+import { ImagenGCSImage, ImagenGenerationConfig, ImagenInlineImage, RequestOptions, ImagenModelParams, ImagenGenerationResponse, ImagenSafetySettings } from '../types';
+import { AIModel } from './ai-model';
+/**
+ * Class for Imagen model APIs.
+ *
+ * This class provides methods for generating images using the Imagen model.
+ *
+ * @example
+ * ```javascript
+ * const imagen = new ImagenModel(
+ * ai,
+ * {
+ * model: 'imagen-3.0-generate-002'
+ * }
+ * );
+ *
+ * const response = await imagen.generateImages('A photo of a cat');
+ * if (response.images.length > 0) {
+ * console.log(response.images[0].bytesBase64Encoded);
+ * }
+ * ```
+ *
+ * @public
+ */
+export declare class ImagenModel extends AIModel {
+ requestOptions?: RequestOptions | undefined;
+ /**
+ * The Imagen generation configuration.
+ */
+ generationConfig?: ImagenGenerationConfig;
+ /**
+ * Safety settings for filtering inappropriate content.
+ */
+ safetySettings?: ImagenSafetySettings;
+ /**
+ * Constructs a new instance of the {@link ImagenModel} class.
+ *
+ * @param ai - an {@link AI} instance.
+ * @param modelParams - Parameters to use when making requests to Imagen.
+ * @param requestOptions - Additional options to use when making requests.
+ *
+ * @throws If the `apiKey` or `projectId` fields are missing in your
+ * Firebase config.
+ */
+ constructor(ai: AI, modelParams: ImagenModelParams, requestOptions?: RequestOptions | undefined);
+ /**
+ * Generates images using the Imagen model and returns them as
+ * base64-encoded strings.
+ *
+ * @param prompt - A text prompt describing the image(s) to generate.
+ * @returns A promise that resolves to an {@link ImagenGenerationResponse}
+ * object containing the generated images.
+ *
+ * @throws If the request to generate images fails. This happens if the
+ * prompt is blocked.
+ *
+ * @remarks
+ * If the prompt was not blocked, but one or more of the generated images were filtered, the
+ * returned object will have a `filteredReason` property.
+ * If all images are filtered, the `images` array will be empty.
+ *
+ * @public
+ */
+ generateImages(prompt: string): Promise<ImagenGenerationResponse<ImagenInlineImage>>;
+ /**
+ * Generates images to Cloud Storage for Firebase using the Imagen model.
+ *
+ * @internal This method is temporarily internal.
+ *
+ * @param prompt - A text prompt describing the image(s) to generate.
+ * @param gcsURI - The URI of file stored in a Cloud Storage for Firebase bucket.
+ * This should be a directory. For example, `gs://my-bucket/my-directory/`.
+ * @returns A promise that resolves to an {@link ImagenGenerationResponse}
+ * object containing the URLs of the generated images.
+ *
+ * @throws If the request fails to generate images fails. This happens if
+ * the prompt is blocked.
+ *
+ * @remarks
+ * If the prompt was not blocked, but one or more of the generated images were filtered, the
+ * returned object will have a `filteredReason` property.
+ * If all images are filtered, the `images` array will be empty.
+ */
+ generateImagesGCS(prompt: string, gcsURI: string): Promise<ImagenGenerationResponse<ImagenGCSImage>>;
+}