@firebase/ai 2.3.0 → 2.4.0-canary.22e0a1adb

package/dist/esm/src/api.d.ts

@@ -81,7 +81,7 @@ export declare function getGenerativeModel(ai: AI, modelParams: ModelParams | Hy
  * @throws If the `apiKey` or `projectId` fields are missing in your
  * Firebase config.
  *
- * @beta
+ * @public
  */
 export declare function getImagenModel(ai: AI, modelParams: ImagenModelParams, requestOptions?: RequestOptions): ImagenModel;
 /**

package/dist/esm/src/methods/chrome-adapter.d.ts

@@ -25,11 +25,11 @@ import { LanguageModel } from '../types/language-model';
 export declare class ChromeAdapterImpl implements ChromeAdapter {
     languageModelProvider: LanguageModel;
     mode: InferenceMode;
-    onDeviceParams: OnDeviceParams;
     static SUPPORTED_MIME_TYPES: string[];
     private isDownloading;
     private downloadPromise;
     private oldSession;
+    onDeviceParams: OnDeviceParams;
     constructor(languageModelProvider: LanguageModel, mode: InferenceMode, onDeviceParams?: OnDeviceParams);
     /**
      * Checks if a given request can be made on-device.

package/dist/esm/src/methods/live-session-helpers.d.ts

@@ -14,7 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { LiveServerToolCall, Part } from '../types';
+import { FunctionCall, FunctionResponse } from '../types';
 import { LiveSession } from './live-session';
 /**
  * A controller for managing an active audio conversation.
@@ -39,7 +39,7 @@ export interface StartAudioConversationOptions {
      * The handler should perform the function call and return the result as a `Part`,
      * which will then be sent back to the model.
      */
-    functionCallingHandler?: (functionCalls: LiveServerToolCall['functionCalls']) => Promise<Part>;
+    functionCallingHandler?: (functionCalls: FunctionCall[]) => Promise<FunctionResponse>;
 }
 /**
  * Dependencies needed by the {@link AudioConversationRunner}.

package/dist/esm/src/methods/live-session.d.ts

@@ -14,7 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { GenerativeContentBlob, LiveServerContent, LiveServerToolCall, LiveServerToolCallCancellation, Part } from '../public-types';
+import { FunctionResponse, GenerativeContentBlob, LiveServerContent, LiveServerToolCall, LiveServerToolCallCancellation, Part } from '../public-types';
 import { WebSocketHandler } from '../websocket';
 /**
  * Represents an active, real-time, bidirectional conversation with the model.
@@ -53,23 +53,65 @@ export declare class LiveSession {
      */
     send(request: string | Array<string | Part>, turnComplete?: boolean): Promise<void>;
     /**
-     * Sends realtime input to the server.
+     * Sends text to the server in realtime.
      *
-     * @param mediaChunks - The media chunks to send.
+     * @example
+     * ```javascript
+     * liveSession.sendTextRealtime("Hello, how are you?");
+     * ```
+     *
+     * @param text - The text data to send.
      * @throws If this session has been closed.
      *
      * @beta
      */
-    sendMediaChunks(mediaChunks: GenerativeContentBlob[]): Promise<void>;
+    sendTextRealtime(text: string): Promise<void>;
     /**
-     * Sends a stream of {@link GenerativeContentBlob}.
+     * Sends audio data to the server in realtime.
      *
-     * @param mediaChunkStream - The stream of {@link GenerativeContentBlob} to send.
+     * @remarks The server requires that the audio data is base64-encoded 16-bit PCM at 16kHz
+     * little-endian.
+     *
+     * @example
+     * ```javascript
+     * // const pcmData = ... base64-encoded 16-bit PCM at 16kHz little-endian.
+     * const blob = { mimeType: "audio/pcm", data: pcmData };
+     * liveSession.sendAudioRealtime(blob);
+     * ```
+     *
+     * @param blob - The base64-encoded PCM data to send to the server in realtime.
      * @throws If this session has been closed.
      *
      * @beta
      */
-    sendMediaStream(mediaChunkStream: ReadableStream<GenerativeContentBlob>): Promise<void>;
+    sendAudioRealtime(blob: GenerativeContentBlob): Promise<void>;
+    /**
+     * Sends video data to the server in realtime.
+     *
+     * @remarks The server requires that the video is sent as individual video frames at 1 FPS. It
+     * is recommended to set `mimeType` to `image/jpeg`.
+     *
+     * @example
+     * ```javascript
+     * // const videoFrame = ... base64-encoded JPEG data
+     * const blob = { mimeType: "image/jpeg", data: videoFrame };
+     * liveSession.sendVideoRealtime(blob);
+     * ```
+     * @param blob - The base64-encoded video data to send to the server in realtime.
+     * @throws If this session has been closed.
+     *
+     * @beta
+     */
+    sendVideoRealtime(blob: GenerativeContentBlob): Promise<void>;
+    /**
+     * Sends function responses to the server.
+     *
+     * @param functionResponses - The function responses to send.
+     * @throws If this session has been closed.
+     *
+     * @beta
+     */
+    sendFunctionResponses(functionResponses: FunctionResponse[]): Promise<void>;
     /**
      * Yields messages received from the server.
      * This can only be used by one consumer at a time.
@@ -87,4 +129,26 @@ export declare class LiveSession {
      * @beta
      */
     close(): Promise<void>;
+    /**
+     * Sends realtime input to the server.
+     *
+     * @deprecated Use `sendTextRealtime()`, `sendAudioRealtime()`, and `sendVideoRealtime()` instead.
+     *
+     * @param mediaChunks - The media chunks to send.
+     * @throws If this session has been closed.
+     *
+     * @beta
+     */
+    sendMediaChunks(mediaChunks: GenerativeContentBlob[]): Promise<void>;
+    /**
+     * @deprecated Use `sendTextRealtime()`, `sendAudioRealtime()`, and `sendVideoRealtime()` instead.
+     *
+     * Sends a stream of {@link GenerativeContentBlob}.
+     *
+     * @param mediaChunkStream - The stream of {@link GenerativeContentBlob} to send.
+     * @throws If this session has been closed.
+     *
+     * @beta
+     */
+    sendMediaStream(mediaChunkStream: ReadableStream<GenerativeContentBlob>): Promise<void>;
 }

package/dist/esm/src/models/imagen-model.d.ts

@@ -37,7 +37,7 @@ import { AIModel } from './ai-model';
  * }
  * ```
  *
- * @beta
+ * @public
  */
 export declare class ImagenModel extends AIModel {
     requestOptions?: RequestOptions | undefined;
@@ -76,7 +76,7 @@ export declare class ImagenModel extends AIModel {
      * returned object will have a `filteredReason` property.
      * If all images are filtered, the `images` array will be empty.
      *
-     * @beta
+     * @public
      */
     generateImages(prompt: string): Promise<ImagenGenerationResponse<ImagenInlineImage>>;
     /**

package/dist/esm/src/requests/hybrid-helpers.d.ts

@@ -14,7 +14,11 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { GenerateContentRequest, ChromeAdapter } from '../types';
+import { GenerateContentRequest, ChromeAdapter, InferenceSource } from '../types';
+interface CallResult<Response> {
+    response: Response;
+    inferenceSource: InferenceSource;
+}
 /**
  * Dispatches a request to the appropriate backend (on-device or in-cloud)
  * based on the inference mode.
@@ -25,4 +29,5 @@ import { GenerateContentRequest, ChromeAdapter } from '../types';
  * @param inCloudCall - The function to call for in-cloud inference.
  * @returns The response from the backend.
  */
-export declare function callCloudOrDevice<Response>(request: GenerateContentRequest, chromeAdapter: ChromeAdapter | undefined, onDeviceCall: () => Promise<Response>, inCloudCall: () => Promise<Response>): Promise<Response>;
+export declare function callCloudOrDevice<Response>(request: GenerateContentRequest, chromeAdapter: ChromeAdapter | undefined, onDeviceCall: () => Promise<Response>, inCloudCall: () => Promise<Response>): Promise<CallResult<Response>>;
+export {};

package/dist/esm/src/requests/imagen-image-format.d.ts

@@ -29,7 +29,7 @@
  * }
  * ```
  *
- * @beta
+ * @public
  */
 export declare class ImagenImageFormat {
     /**
@@ -47,7 +47,7 @@ export declare class ImagenImageFormat {
      * @param compressionQuality - The level of compression (a number between 0 and 100).
      * @returns An {@link ImagenImageFormat} object for a JPEG image.
      *
-     * @beta
+     * @public
      */
     static jpeg(compressionQuality?: number): ImagenImageFormat;
     /**
@@ -55,7 +55,7 @@ export declare class ImagenImageFormat {
      *
      * @returns An {@link ImagenImageFormat} object for a PNG image.
      *
-     * @beta
+     * @public
      */
     static png(): ImagenImageFormat;
 }

package/dist/esm/src/requests/response-helpers.d.ts

@@ -14,12 +14,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { EnhancedGenerateContentResponse, FunctionCall, GenerateContentResponse, ImagenGCSImage, ImagenInlineImage, InlineDataPart, Part } from '../types';
+import { EnhancedGenerateContentResponse, FunctionCall, GenerateContentResponse, ImagenGCSImage, ImagenInlineImage, InlineDataPart, Part, InferenceSource } from '../types';
 /**
  * Creates an EnhancedGenerateContentResponse object that has helper functions and
  * other modifications that improve usability.
  */
-export declare function createEnhancedContentResponse(response: GenerateContentResponse): EnhancedGenerateContentResponse;
+export declare function createEnhancedContentResponse(response: GenerateContentResponse, inferenceSource?: InferenceSource): EnhancedGenerateContentResponse;
 /**
  * Adds convenience helper methods to a response object, including stream
  * chunks (as long as each chunk is a complete GenerateContentResponse JSON).

package/dist/esm/src/requests/stream-reader.d.ts

@@ -16,6 +16,7 @@
  */
 import { GenerateContentResponse, GenerateContentStreamResult } from '../types';
 import { ApiSettings } from '../types/internal';
+import { InferenceSource } from '../public-types';
 /**
  * Process a response.body stream from the backend and return an
  * iterator that provides one complete GenerateContentResponse at a time
@@ -24,7 +25,7 @@ import { ApiSettings } from '../types/internal';
  *
  * @param response - Response from a fetch call
  */
-export declare function processStream(response: Response, apiSettings: ApiSettings): GenerateContentStreamResult;
+export declare function processStream(response: Response, apiSettings: ApiSettings, inferenceSource?: InferenceSource): GenerateContentStreamResult;
 /**
  * Reads a raw stream from the fetch response and join incomplete
  * chunks, returning a new stream that provides a single complete

package/dist/esm/src/types/content.d.ts

@@ -138,7 +138,7 @@ export interface FileDataPart {
 /**
  * Represents the code that is executed by the model.
  *
- * @public
+ * @beta
  */
 export interface ExecutableCodePart {
     text?: never;
@@ -157,7 +157,7 @@ export interface ExecutableCodePart {
 /**
  * Represents the code execution result from the model.
  *
- * @public
+ * @beta
  */
 export interface CodeExecutionResultPart {
     text?: never;
@@ -176,7 +176,7 @@ export interface CodeExecutionResultPart {
 /**
  * An interface for executable code returned by the model.
  *
- * @public
+ * @beta
  */
 export interface ExecutableCode {
     /**
@@ -191,7 +191,7 @@ export interface ExecutableCode {
 /**
  * The results of code execution run by the model.
  *
- * @public
+ * @beta
  */
 export interface CodeExecutionResult {
     /**

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

@@ -349,10 +349,25 @@ export declare const InferenceMode: {
  * @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
+ * @beta
  */
 export declare const Outcome: {
     UNSPECIFIED: string;
@@ -363,13 +378,13 @@ export declare const Outcome: {
 /**
  * Represents the result of the code execution.
  *
- * @public
+ * @beta
  */
 export type Outcome = (typeof Outcome)[keyof typeof Outcome];
 /**
  * The programming language of the code.
  *
- * @public
+ * @beta
  */
 export declare const Language: {
     UNSPECIFIED: string;
@@ -378,6 +393,6 @@ export declare const Language: {
 /**
  * The programming language of the code.
  *
- * @public
+ * @beta
  */
 export type Language = (typeof Language)[keyof typeof Language];

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

@@ -14,7 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { Tool, GenerationConfig, Citation, FinishReason, GroundingMetadata, PromptFeedback, SafetyRating, UsageMetadata } from '../public-types';
+import { Tool, GenerationConfig, Citation, FinishReason, GroundingMetadata, PromptFeedback, SafetyRating, UsageMetadata, URLContextMetadata } from '../public-types';
 import { Content, Part } from './content';
 /**
  * @internal
@@ -47,6 +47,7 @@ export interface GoogleAIGenerateContentCandidate {
     safetyRatings?: SafetyRating[];
     citationMetadata?: GoogleAICitationMetadata;
     groundingMetadata?: GroundingMetadata;
+    urlContextMetadata?: URLContextMetadata;
 }
 /**
  * @internal

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

@@ -18,7 +18,7 @@ import { ImagenImageFormat } from '../../requests/imagen-image-format';
 /**
  * Parameters for configuring an {@link ImagenModel}.
  *
- * @beta
+ * @public
  */
 export interface ImagenModelParams {
     /**
@@ -46,7 +46,7 @@ export interface ImagenModelParams {
  * See the {@link http://firebase.google.com/docs/vertex-ai/generate-images-imagen | documentation} for
  * more details.
  *
- * @beta
+ * @public
  */
 export interface ImagenGenerationConfig {
     /**
@@ -104,7 +104,7 @@ export interface ImagenGenerationConfig {
  * and the {@link https://cloud.google.com/vertex-ai/generative-ai/docs/image/responsible-ai-imagen#safety-filters | Responsible AI and usage guidelines}
  * for more details.
  *
- * @beta
+ * @public
  */
 export declare const ImagenSafetyFilterLevel: {
     /**
@@ -137,7 +137,7 @@ export declare const ImagenSafetyFilterLevel: {
  * and the {@link https://cloud.google.com/vertex-ai/generative-ai/docs/image/responsible-ai-imagen#safety-filters | Responsible AI and usage guidelines}
  * for more details.
  *
- * @beta
+ * @public
  */
 export type ImagenSafetyFilterLevel = (typeof ImagenSafetyFilterLevel)[keyof typeof ImagenSafetyFilterLevel];
 /**
@@ -146,7 +146,7 @@ export type ImagenSafetyFilterLevel = (typeof ImagenSafetyFilterLevel)[keyof typ
  * See the <a href="http://firebase.google.com/docs/vertex-ai/generate-images">personGeneration</a>
  * documentation for more details.
  *
- * @beta
+ * @public
  */
 export declare const ImagenPersonFilterLevel: {
     /**
@@ -176,7 +176,7 @@ export declare const ImagenPersonFilterLevel: {
  * See the <a href="http://firebase.google.com/docs/vertex-ai/generate-images">personGeneration</a>
  * documentation for more details.
  *
- * @beta
+ * @public
  */
 export type ImagenPersonFilterLevel = (typeof ImagenPersonFilterLevel)[keyof typeof ImagenPersonFilterLevel];
 /**
@@ -185,7 +185,7 @@ export type ImagenPersonFilterLevel = (typeof ImagenPersonFilterLevel)[keyof typ
  * See the {@link http://firebase.google.com/docs/vertex-ai/generate-images | documentation }
  * for more details.
  *
- * @beta
+ * @public
  */
 export interface ImagenSafetySettings {
     /**
@@ -207,7 +207,7 @@ export interface ImagenSafetySettings {
  * See the {@link http://firebase.google.com/docs/vertex-ai/generate-images | documentation }
  * for more details and examples of the supported aspect ratios.
  *
- * @beta
+ * @public
  */
 export declare const ImagenAspectRatio: {
     /**
@@ -240,6 +240,6 @@ export declare const ImagenAspectRatio: {
  * See the {@link http://firebase.google.com/docs/vertex-ai/generate-images | documentation }
  * for more details and examples of the supported aspect ratios.
  *
- * @beta
+ * @public
  */
 export type ImagenAspectRatio = (typeof ImagenAspectRatio)[keyof typeof ImagenAspectRatio];

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

@@ -17,7 +17,7 @@
 /**
  * An image generated by Imagen, represented as inline data.
  *
- * @beta
+ * @public
  */
 export interface ImagenInlineImage {
     /**
@@ -35,7 +35,7 @@ export interface ImagenInlineImage {
  * An image generated by Imagen, stored in a Cloud Storage for Firebase bucket.
  *
  * This feature is not available yet.
- * @beta
+ * @public
  */
 export interface ImagenGCSImage {
     /**
@@ -54,7 +54,7 @@ export interface ImagenGCSImage {
 /**
  * The response from a request to generate images with Imagen.
  *
- * @beta
+ * @public
  */
 export interface ImagenGenerationResponse<T extends ImagenInlineImage | ImagenGCSImage> {
     /**

package/dist/esm/src/types/live-responses.d.ts

@@ -14,7 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { Content, GenerativeContentBlob, Part } from './content';
+import { Content, FunctionResponse, GenerativeContentBlob, Part } from './content';
 import { LiveGenerationConfig, Tool, ToolConfig } from './requests';
 /**
  * User input that is sent to the model.
@@ -34,7 +34,21 @@ export interface _LiveClientContent {
  */
 export interface _LiveClientRealtimeInput {
     realtimeInput: {
-        mediaChunks: GenerativeContentBlob[];
+        text?: string;
+        audio?: GenerativeContentBlob;
+        video?: GenerativeContentBlob;
+        /**
+         * @deprecated Use `text`, `audio`, and `video` instead.
+         */
+        mediaChunks?: GenerativeContentBlob[];
+    };
+}
+/**
+ * Function responses that are sent to the model in real time.
+ */
+export interface _LiveClientToolResponse {
+    toolResponse: {
+        functionResponses: FunctionResponse[];
     };
 }
 /**

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

@@ -218,7 +218,7 @@ export interface RequestOptions {
  * Defines a tool that model can call to access external knowledge.
  * @public
  */
-export type Tool = FunctionDeclarationsTool | GoogleSearchTool | CodeExecutionTool;
+export type Tool = FunctionDeclarationsTool | GoogleSearchTool | CodeExecutionTool | URLContextTool;
 /**
  * Structured representation of a function declaration as defined by the
  * {@link https://spec.openapis.org/oas/v3.0.3 | OpenAPI 3.0 specification}.
@@ -273,7 +273,7 @@ export interface GoogleSearchTool {
 /**
  * A tool that enables the model to use code execution.
  *
- * @public
+ * @beta
  */
 export interface CodeExecutionTool {
     /**
@@ -291,6 +291,26 @@ export interface CodeExecutionTool {
  */
 export interface GoogleSearch {
 }
+/**
+ * A tool that allows you to provide additional context to the models in the form of public web
+ * URLs. By including URLs in your request, the Gemini model will access the content from those
+ * pages to inform and enhance its response.
+ *
+ * @beta
+ */
+export interface URLContextTool {
+    /**
+     * Specifies the URL Context configuration.
+     */
+    urlContext: URLContext;
+}
+/**
+ * Specifies the URL Context configuration.
+ *
+ * @beta
+ */
+export interface URLContext {
+}
 /**
  * A `FunctionDeclarationsTool` is a piece of code that enables the system to
  * interact with external systems to perform an action, or set of actions,

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

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 import { Content, FunctionCall, InlineDataPart } from './content';
-import { BlockReason, FinishReason, HarmCategory, HarmProbability, HarmSeverity, Modality } from './enums';
+import { BlockReason, FinishReason, HarmCategory, HarmProbability, HarmSeverity, InferenceSource, Modality } from './enums';
 /**
  * Result object returned from {@link GenerativeModel.generateContent} call.
  *
@@ -76,6 +76,12 @@ export interface EnhancedGenerateContentResponse extends GenerateContentResponse
      * set to `true`.
      */
     thoughtSummary: () => string | undefined;
+    /**
+     * Indicates whether inference happened on-device or in-cloud.
+     *
+     * @beta
+     */
+    inferenceSource?: InferenceSource;
 }
 /**
  * Individual response from {@link GenerativeModel.generateContent} and
@@ -102,8 +108,16 @@ export interface UsageMetadata {
      */
     thoughtsTokenCount?: number;
     totalTokenCount: number;
+    /**
+     * The number of tokens used by tools.
+     */
+    toolUsePromptTokenCount?: number;
     promptTokensDetails?: ModalityTokenCount[];
     candidatesTokensDetails?: ModalityTokenCount[];
+    /**
+     * A list of tokens used by tools, broken down by modality.
+     */
+    toolUsePromptTokensDetails?: ModalityTokenCount[];
 }
 /**
  * Represents token counting info for a single modality.
@@ -143,6 +157,7 @@ export interface GenerateContentCandidate {
     safetyRatings?: SafetyRating[];
     citationMetadata?: CitationMetadata;
     groundingMetadata?: GroundingMetadata;
+    urlContextMetadata?: URLContextMetadata;
 }
 /**
  * Citation metadata that may be found on a {@link GenerateContentCandidate}.
@@ -323,6 +338,89 @@ export interface Segment {
      */
     text: string;
 }
+/**
+ * Metadata related to {@link URLContextTool}.
+ *
+ * @beta
+ */
+export interface URLContextMetadata {
+    /**
+     * List of URL metadata used to provide context to the Gemini model.
+     */
+    urlMetadata: URLMetadata[];
+}
+/**
+ * Metadata for a single URL retrieved by the {@link URLContextTool} tool.
+ *
+ * @beta
+ */
+export interface URLMetadata {
+    /**
+     * The retrieved URL.
+     */
+    retrievedUrl?: string;
+    /**
+     * The status of the URL retrieval.
+     */
+    urlRetrievalStatus?: URLRetrievalStatus;
+}
+/**
+ * The status of a URL retrieval.
+ *
+ * @remarks
+ * <b>URL_RETRIEVAL_STATUS_UNSPECIFIED:</b> Unspecified retrieval status.
+ * <br/>
+ * <b>URL_RETRIEVAL_STATUS_SUCCESS:</b> The URL retrieval was successful.
+ * <br/>
+ * <b>URL_RETRIEVAL_STATUS_ERROR:</b> The URL retrieval failed.
+ * <br/>
+ * <b>URL_RETRIEVAL_STATUS_PAYWALL:</b> The URL retrieval failed because the content is behind a paywall.
+ * <br/>
+ * <b>URL_RETRIEVAL_STATUS_UNSAFE:</b> The URL retrieval failed because the content is unsafe.
+ * <br/>
+ *
+ * @beta
+ */
+export declare const URLRetrievalStatus: {
+    /**
+     * Unspecified retrieval status.
+     */
+    URL_RETRIEVAL_STATUS_UNSPECIFIED: string;
+    /**
+     * The URL retrieval was successful.
+     */
+    URL_RETRIEVAL_STATUS_SUCCESS: string;
+    /**
+     * The URL retrieval failed.
+     */
+    URL_RETRIEVAL_STATUS_ERROR: string;
+    /**
+     * The URL retrieval failed because the content is behind a paywall.
+     */
+    URL_RETRIEVAL_STATUS_PAYWALL: string;
+    /**
+     * The URL retrieval failed because the content is unsafe.
+     */
+    URL_RETRIEVAL_STATUS_UNSAFE: string;
+};
+/**
+ * The status of a URL retrieval.
+ *
+ * @remarks
+ * <b>URL_RETRIEVAL_STATUS_UNSPECIFIED:</b> Unspecified retrieval status.
+ * <br/>
+ * <b>URL_RETRIEVAL_STATUS_SUCCESS:</b> The URL retrieval was successful.
+ * <br/>
+ * <b>URL_RETRIEVAL_STATUS_ERROR:</b> The URL retrieval failed.
+ * <br/>
+ * <b>URL_RETRIEVAL_STATUS_PAYWALL:</b> The URL retrieval failed because the content is behind a paywall.
+ * <br/>
+ * <b>URL_RETRIEVAL_STATUS_UNSAFE:</b> The URL retrieval failed because the content is unsafe.
+ * <br/>
+ *
+ * @beta
+ */
+export type URLRetrievalStatus = (typeof URLRetrievalStatus)[keyof typeof URLRetrievalStatus];
 /**
  * @public
  */