@depup/firebase__ai 2.9.0-depup.0

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

@@ -0,0 +1,419 @@
+/**
+ * @license
+ * Copyright 2024 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.
+ */
+/**
+ * Role is the producer of the content.
+ * @public
+ */
+export type Role = (typeof POSSIBLE_ROLES)[number];
+/**
+ * Possible roles.
+ * @public
+ */
+export declare const POSSIBLE_ROLES: readonly ["user", "model", "function", "system"];
+/**
+ * Harm categories that would cause prompts or candidates to be blocked.
+ * @public
+ */
+export declare const HarmCategory: {
+    readonly HARM_CATEGORY_HATE_SPEECH: "HARM_CATEGORY_HATE_SPEECH";
+    readonly HARM_CATEGORY_SEXUALLY_EXPLICIT: "HARM_CATEGORY_SEXUALLY_EXPLICIT";
+    readonly HARM_CATEGORY_HARASSMENT: "HARM_CATEGORY_HARASSMENT";
+    readonly HARM_CATEGORY_DANGEROUS_CONTENT: "HARM_CATEGORY_DANGEROUS_CONTENT";
+};
+/**
+ * Harm categories that would cause prompts or candidates to be blocked.
+ * @public
+ */
+export type HarmCategory = (typeof HarmCategory)[keyof typeof HarmCategory];
+/**
+ * Threshold above which a prompt or candidate will be blocked.
+ * @public
+ */
+export declare const HarmBlockThreshold: {
+    /**
+     * Content with `NEGLIGIBLE` will be allowed.
+     */
+    readonly BLOCK_LOW_AND_ABOVE: "BLOCK_LOW_AND_ABOVE";
+    /**
+     * Content with `NEGLIGIBLE` and `LOW` will be allowed.
+     */
+    readonly BLOCK_MEDIUM_AND_ABOVE: "BLOCK_MEDIUM_AND_ABOVE";
+    /**
+     * Content with `NEGLIGIBLE`, `LOW`, and `MEDIUM` will be allowed.
+     */
+    readonly BLOCK_ONLY_HIGH: "BLOCK_ONLY_HIGH";
+    /**
+     * All content will be allowed.
+     */
+    readonly BLOCK_NONE: "BLOCK_NONE";
+    /**
+     * All content will be allowed. This is the same as `BLOCK_NONE`, but the metadata corresponding
+     * to the {@link (HarmCategory:type)} will not be present in the response.
+     */
+    readonly OFF: "OFF";
+};
+/**
+ * Threshold above which a prompt or candidate will be blocked.
+ * @public
+ */
+export type HarmBlockThreshold = (typeof HarmBlockThreshold)[keyof typeof HarmBlockThreshold];
+/**
+ * This property is not supported in the Gemini Developer API ({@link GoogleAIBackend}).
+ *
+ * @public
+ */
+export declare const HarmBlockMethod: {
+    /**
+     * The harm block method uses both probability and severity scores.
+     */
+    readonly SEVERITY: "SEVERITY";
+    /**
+     * The harm block method uses the probability score.
+     */
+    readonly PROBABILITY: "PROBABILITY";
+};
+/**
+ * This property is not supported in the Gemini Developer API ({@link GoogleAIBackend}).
+ *
+ * @public
+ */
+export type HarmBlockMethod = (typeof HarmBlockMethod)[keyof typeof HarmBlockMethod];
+/**
+ * Probability that a prompt or candidate matches a harm category.
+ * @public
+ */
+export declare const HarmProbability: {
+    /**
+     * Content has a negligible chance of being unsafe.
+     */
+    readonly NEGLIGIBLE: "NEGLIGIBLE";
+    /**
+     * Content has a low chance of being unsafe.
+     */
+    readonly LOW: "LOW";
+    /**
+     * Content has a medium chance of being unsafe.
+     */
+    readonly MEDIUM: "MEDIUM";
+    /**
+     * Content has a high chance of being unsafe.
+     */
+    readonly HIGH: "HIGH";
+};
+/**
+ * Probability that a prompt or candidate matches a harm category.
+ * @public
+ */
+export type HarmProbability = (typeof HarmProbability)[keyof typeof HarmProbability];
+/**
+ * Harm severity levels.
+ * @public
+ */
+export declare const HarmSeverity: {
+    /**
+     * Negligible level of harm severity.
+     */
+    readonly HARM_SEVERITY_NEGLIGIBLE: "HARM_SEVERITY_NEGLIGIBLE";
+    /**
+     * Low level of harm severity.
+     */
+    readonly HARM_SEVERITY_LOW: "HARM_SEVERITY_LOW";
+    /**
+     * Medium level of harm severity.
+     */
+    readonly HARM_SEVERITY_MEDIUM: "HARM_SEVERITY_MEDIUM";
+    /**
+     * High level of harm severity.
+     */
+    readonly HARM_SEVERITY_HIGH: "HARM_SEVERITY_HIGH";
+    /**
+     * Harm severity is not supported.
+     *
+     * @remarks
+     * The GoogleAI backend does not support `HarmSeverity`, so this value is used as a fallback.
+     */
+    readonly HARM_SEVERITY_UNSUPPORTED: "HARM_SEVERITY_UNSUPPORTED";
+};
+/**
+ * Harm severity levels.
+ * @public
+ */
+export type HarmSeverity = (typeof HarmSeverity)[keyof typeof HarmSeverity];
+/**
+ * Reason that a prompt was blocked.
+ * @public
+ */
+export declare const BlockReason: {
+    /**
+     * Content was blocked by safety settings.
+     */
+    readonly SAFETY: "SAFETY";
+    /**
+     * Content was blocked, but the reason is uncategorized.
+     */
+    readonly OTHER: "OTHER";
+    /**
+     * Content was blocked because it contained terms from the terminology blocklist.
+     */
+    readonly BLOCKLIST: "BLOCKLIST";
+    /**
+     * Content was blocked due to prohibited content.
+     */
+    readonly PROHIBITED_CONTENT: "PROHIBITED_CONTENT";
+};
+/**
+ * Reason that a prompt was blocked.
+ * @public
+ */
+export type BlockReason = (typeof BlockReason)[keyof typeof BlockReason];
+/**
+ * Reason that a candidate finished.
+ * @public
+ */
+export declare const FinishReason: {
+    /**
+     * Natural stop point of the model or provided stop sequence.
+     */
+    readonly STOP: "STOP";
+    /**
+     * The maximum number of tokens as specified in the request was reached.
+     */
+    readonly MAX_TOKENS: "MAX_TOKENS";
+    /**
+     * The candidate content was flagged for safety reasons.
+     */
+    readonly SAFETY: "SAFETY";
+    /**
+     * The candidate content was flagged for recitation reasons.
+     */
+    readonly RECITATION: "RECITATION";
+    /**
+     * Unknown reason.
+     */
+    readonly OTHER: "OTHER";
+    /**
+     * The candidate content contained forbidden terms.
+     */
+    readonly BLOCKLIST: "BLOCKLIST";
+    /**
+     * The candidate content potentially contained prohibited content.
+     */
+    readonly PROHIBITED_CONTENT: "PROHIBITED_CONTENT";
+    /**
+     * The candidate content potentially contained Sensitive Personally Identifiable Information (SPII).
+     */
+    readonly SPII: "SPII";
+    /**
+     * The function call generated by the model was invalid.
+     */
+    readonly MALFORMED_FUNCTION_CALL: "MALFORMED_FUNCTION_CALL";
+};
+/**
+ * Reason that a candidate finished.
+ * @public
+ */
+export type FinishReason = (typeof FinishReason)[keyof typeof FinishReason];
+/**
+ * @public
+ */
+export declare const FunctionCallingMode: {
+    /**
+     * Default model behavior; model decides to predict either a function call
+     * or a natural language response.
+     */
+    readonly AUTO: "AUTO";
+    /**
+     * Model is constrained to always predicting a function call only.
+     * If `allowed_function_names` is set, the predicted function call will be
+     * limited to any one of `allowed_function_names`, else the predicted
+     * function call will be any one of the provided `function_declarations`.
+     */
+    readonly ANY: "ANY";
+    /**
+     * Model will not predict any function call. Model behavior is same as when
+     * not passing any function declarations.
+     */
+    readonly NONE: "NONE";
+};
+/**
+ * @public
+ */
+export type FunctionCallingMode = (typeof FunctionCallingMode)[keyof typeof FunctionCallingMode];
+/**
+ * Content part modality.
+ * @public
+ */
+export declare const Modality: {
+    /**
+     * Unspecified modality.
+     */
+    readonly MODALITY_UNSPECIFIED: "MODALITY_UNSPECIFIED";
+    /**
+     * Plain text.
+     */
+    readonly TEXT: "TEXT";
+    /**
+     * Image.
+     */
+    readonly IMAGE: "IMAGE";
+    /**
+     * Video.
+     */
+    readonly VIDEO: "VIDEO";
+    /**
+     * Audio.
+     */
+    readonly AUDIO: "AUDIO";
+    /**
+     * Document (for example, PDF).
+     */
+    readonly DOCUMENT: "DOCUMENT";
+};
+/**
+ * Content part modality.
+ * @public
+ */
+export type Modality = (typeof Modality)[keyof typeof Modality];
+/**
+ * Generation modalities to be returned in generation responses.
+ *
+ * @beta
+ */
+export declare const ResponseModality: {
+    /**
+     * Text.
+     * @beta
+     */
+    readonly TEXT: "TEXT";
+    /**
+     * Image.
+     * @beta
+     */
+    readonly IMAGE: "IMAGE";
+    /**
+     * Audio.
+     * @beta
+     */
+    readonly AUDIO: "AUDIO";
+};
+/**
+ * Generation modalities to be returned in generation responses.
+ *
+ * @beta
+ */
+export type ResponseModality = (typeof ResponseModality)[keyof typeof ResponseModality];
+/**
+ * Determines whether inference happens on-device or in-cloud.
+ *
+ * @remarks
+ * <b>PREFER_ON_DEVICE:</b> Attempt to make inference calls using an
+ * on-device model. If on-device inference is not available, the SDK
+ * will fall back to using a cloud-hosted model.
+ * <br/>
+ * <b>ONLY_ON_DEVICE:</b> Only attempt to make inference calls using an
+ * on-device model. The SDK will not fall back to a cloud-hosted model.
+ * If on-device inference is not available, inference methods will throw.
+ * <br/>
+ * <b>ONLY_IN_CLOUD:</b> Only attempt to make inference calls using a
+ * cloud-hosted model. The SDK will not fall back to an on-device model.
+ * <br/>
+ * <b>PREFER_IN_CLOUD:</b> Attempt to make inference calls to a
+ * cloud-hosted model. If not available, the SDK will fall back to an
+ * on-device model.
+ *
+ * @beta
+ */
+export declare const InferenceMode: {
+    readonly PREFER_ON_DEVICE: "prefer_on_device";
+    readonly ONLY_ON_DEVICE: "only_on_device";
+    readonly ONLY_IN_CLOUD: "only_in_cloud";
+    readonly PREFER_IN_CLOUD: "prefer_in_cloud";
+};
+/**
+ * Determines whether inference happens on-device or in-cloud.
+ *
+ * @beta
+ */
+export type InferenceMode = (typeof InferenceMode)[keyof typeof InferenceMode];
+/**
+ * Indicates whether inference happened on-device or in-cloud.
+ *
+ * @beta
+ */
+export declare const InferenceSource: {
+    readonly ON_DEVICE: "on_device";
+    readonly IN_CLOUD: "in_cloud";
+};
+/**
+ * Indicates whether inference happened on-device or in-cloud.
+ *
+ * @beta
+ */
+export type InferenceSource = (typeof InferenceSource)[keyof typeof InferenceSource];
+/**
+ * Represents the result of the code execution.
+ *
+ * @public
+ */
+export declare const Outcome: {
+    UNSPECIFIED: string;
+    OK: string;
+    FAILED: string;
+    DEADLINE_EXCEEDED: string;
+};
+/**
+ * Represents the result of the code execution.
+ *
+ * @public
+ */
+export type Outcome = (typeof Outcome)[keyof typeof Outcome];
+/**
+ * The programming language of the code.
+ *
+ * @public
+ */
+export declare const Language: {
+    UNSPECIFIED: string;
+    PYTHON: string;
+};
+/**
+ * The programming language of the code.
+ *
+ * @public
+ */
+export type Language = (typeof Language)[keyof typeof Language];
+/**
+ * A preset that controls the model's "thinking" process. Use
+ * `ThinkingLevel.LOW` for faster responses on less complex tasks, and
+ * `ThinkingLevel.HIGH` for better reasoning on more complex tasks.
+ *
+ * @public
+ */
+export declare const ThinkingLevel: {
+    MINIMAL: string;
+    LOW: string;
+    MEDIUM: string;
+    HIGH: string;
+};
+/**
+ * A preset that controls the model's "thinking" process. Use
+ * `ThinkingLevel.LOW` for faster responses on less complex tasks, and
+ * `ThinkingLevel.HIGH` for better reasoning on more complex tasks.
+ *
+ * @public
+ */
+export type ThinkingLevel = (typeof ThinkingLevel)[keyof typeof ThinkingLevel];

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

@@ -0,0 +1,89 @@
+/**
+ * @license
+ * Copyright 2024 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 { GenerateContentResponse } from './responses';
+/**
+ * Details object that may be included in an error response.
+ *
+ * @public
+ */
+export interface ErrorDetails {
+    '@type'?: string;
+    /** The reason for the error. */
+    reason?: string;
+    /** The domain where the error occurred. */
+    domain?: string;
+    /** Additional metadata about the error. */
+    metadata?: Record<string, unknown>;
+    /** Any other relevant information about the error. */
+    [key: string]: unknown;
+}
+/**
+ * Details object that contains data originating from a bad HTTP response.
+ *
+ * @public
+ */
+export interface CustomErrorData {
+    /** HTTP status code of the error response. */
+    status?: number;
+    /** HTTP status text of the error response. */
+    statusText?: string;
+    /** Response from a {@link GenerateContentRequest} */
+    response?: GenerateContentResponse;
+    /** Optional additional details about the error. */
+    errorDetails?: ErrorDetails[];
+}
+/**
+ * Standardized error codes that {@link AIError} can have.
+ *
+ * @public
+ */
+export declare const AIErrorCode: {
+    /** A generic error occurred. */
+    readonly ERROR: "error";
+    /** An error occurred in a request. */
+    readonly REQUEST_ERROR: "request-error";
+    /** An error occurred in a response. */
+    readonly RESPONSE_ERROR: "response-error";
+    /** An error occurred while performing a fetch. */
+    readonly FETCH_ERROR: "fetch-error";
+    /** An error occurred because an operation was attempted on a closed session. */
+    readonly SESSION_CLOSED: "session-closed";
+    /** An error associated with a Content object.  */
+    readonly INVALID_CONTENT: "invalid-content";
+    /** An error due to the Firebase API not being enabled in the Console. */
+    readonly API_NOT_ENABLED: "api-not-enabled";
+    /** An error due to invalid Schema input.  */
+    readonly INVALID_SCHEMA: "invalid-schema";
+    /** An error occurred due to a missing Firebase API key. */
+    readonly NO_API_KEY: "no-api-key";
+    /** An error occurred due to a missing Firebase app ID. */
+    readonly NO_APP_ID: "no-app-id";
+    /** An error occurred due to a model name not being specified during initialization. */
+    readonly NO_MODEL: "no-model";
+    /** An error occurred due to a missing project ID. */
+    readonly NO_PROJECT_ID: "no-project-id";
+    /** An error occurred while parsing. */
+    readonly PARSE_FAILED: "parse-failed";
+    /** An error occurred due an attempt to use an unsupported feature. */
+    readonly UNSUPPORTED: "unsupported";
+};
+/**
+ * Standardized error codes that {@link AIError} can have.
+ *
+ * @public
+ */
+export type AIErrorCode = (typeof AIErrorCode)[keyof typeof AIErrorCode];

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

@@ -0,0 +1,57 @@
+/**
+ * @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 { Tool, GenerationConfig, Citation, FinishReason, GroundingMetadata, PromptFeedback, SafetyRating, UsageMetadata, URLContextMetadata } from '../public-types';
+import { Content, Part } from './content';
+/**
+ * @internal
+ */
+export interface GoogleAICountTokensRequest {
+    generateContentRequest: {
+        model: string;
+        contents: Content[];
+        systemInstruction?: string | Part | Content;
+        tools?: Tool[];
+        generationConfig?: GenerationConfig;
+    };
+}
+/**
+ * @internal
+ */
+export interface GoogleAIGenerateContentResponse {
+    candidates?: GoogleAIGenerateContentCandidate[];
+    promptFeedback?: PromptFeedback;
+    usageMetadata?: UsageMetadata;
+}
+/**
+ * @internal
+ */
+export interface GoogleAIGenerateContentCandidate {
+    index: number;
+    content: Content;
+    finishReason?: FinishReason;
+    finishMessage?: string;
+    safetyRatings?: SafetyRating[];
+    citationMetadata?: GoogleAICitationMetadata;
+    groundingMetadata?: GroundingMetadata;
+    urlContextMetadata?: URLContextMetadata;
+}
+/**
+ * @internal
+ */
+export interface GoogleAICitationMetadata {
+    citationSources: Citation[];
+}

package/dist/src/types/imagen/index.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @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.
+ */
+export * from './requests';
+export * from './responses';