@google/genai 0.12.0 → 0.13.0

package/dist/genai.d.ts

@@ -41,6 +41,21 @@ export declare enum AdapterSize {
 declare class ApiClient {
     readonly clientOptions: ApiClientInitOptions;
     constructor(opts: ApiClientInitOptions);
+    /**
+     * Determines the base URL for Vertex AI based on project and location.
+     * Uses the global endpoint if location is 'global' or if project/location
+     * are not specified (implying API key usage).
+     * @private
+     */
+    private baseUrlFromProjectLocation;
+    /**
+     * Normalizes authentication parameters for Vertex AI.
+     * If project and location are provided, API key is cleared.
+     * If project and location are not provided (implying API key usage),
+     * project and location are cleared.
+     * @private
+     */
+    private normalizeAuthParameters;
     isVertexAI(): boolean;
     getProject(): string | undefined;
     getLocation(): string | undefined;
@@ -77,6 +92,13 @@ declare class ApiClient {
      * @throws An error if the `mimeType` is not provided and can not be inferred,
      */
     uploadFile(file: string | Blob, config?: UploadFileConfig): Promise<File_2>;
+    /**
+     * Downloads a file asynchronously to the specified path.
+     *
+     * @params params - The parameters for the download request, see {@link
+     * DownloadFileParameters}
+     */
+    downloadFile(params: DownloadFileParameters): Promise<void>;
     private fetchUploadUrl;
 }
 
@@ -95,6 +117,12 @@ declare interface ApiClientInitOptions {
      * creating a client, will be set through the Node_client or Web_client.
      */
     uploader: Uploader;
+    /**
+     * Optional. The downloader to use for downloading files. This field is
+     * required for creating a client, will be set through the Node_client or
+     * Web_client.
+     */
+    downloader: Downloader;
     /**
      * Optional. The Google Cloud project ID for Vertex AI users.
      * It is not the numeric project name.
@@ -132,6 +160,12 @@ declare interface ApiClientInitOptions {
     userAgentExtra?: string;
 }
 
+/** Config for authentication with API key. */
+export declare interface ApiKeyConfig {
+    /** The API key to be used in the request directly. */
+    apiKeyString?: string;
+}
+
 /** The audio transcription configuration in Setup. */
 export declare interface AudioTranscriptionConfig {
 }
@@ -153,6 +187,61 @@ declare interface Auth {
     addAuthHeaders(headers: Headers): Promise<void>;
 }
 
+/** Auth configuration to run the extension. */
+export declare interface AuthConfig {
+    /** Config for API key auth. */
+    apiKeyConfig?: ApiKeyConfig;
+    /** Type of auth scheme. */
+    authType?: AuthType;
+    /** Config for Google Service Account auth. */
+    googleServiceAccountConfig?: AuthConfigGoogleServiceAccountConfig;
+    /** Config for HTTP Basic auth. */
+    httpBasicAuthConfig?: AuthConfigHttpBasicAuthConfig;
+    /** Config for user oauth. */
+    oauthConfig?: AuthConfigOauthConfig;
+    /** Config for user OIDC auth. */
+    oidcConfig?: AuthConfigOidcConfig;
+}
+
+/** Config for Google Service Account Authentication. */
+export declare interface AuthConfigGoogleServiceAccountConfig {
+    /** Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. */
+    serviceAccount?: string;
+}
+
+/** Config for HTTP Basic Authentication. */
+export declare interface AuthConfigHttpBasicAuthConfig {
+    /** Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. */
+    credentialSecret?: string;
+}
+
+/** Config for user oauth. */
+export declare interface AuthConfigOauthConfig {
+    /** Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. */
+    accessToken?: string;
+    /** The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. */
+    serviceAccount?: string;
+}
+
+/** Config for user OIDC auth. */
+export declare interface AuthConfigOidcConfig {
+    /** OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. */
+    idToken?: string;
+    /** The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). */
+    serviceAccount?: string;
+}
+
+/** Type of auth scheme. */
+export declare enum AuthType {
+    AUTH_TYPE_UNSPECIFIED = "AUTH_TYPE_UNSPECIFIED",
+    NO_AUTH = "NO_AUTH",
+    API_KEY_AUTH = "API_KEY_AUTH",
+    HTTP_BASIC_AUTH = "HTTP_BASIC_AUTH",
+    GOOGLE_SERVICE_ACCOUNT_AUTH = "GOOGLE_SERVICE_ACCOUNT_AUTH",
+    OAUTH = "OAUTH",
+    OIDC_AUTH = "OIDC_AUTH"
+}
+
 /** Configures automatic detection of activity. */
 export declare interface AutomaticActivityDetection {
     /** If enabled, detected voice and text input count as activity. If disabled, the client must send activity signals. */
@@ -1005,6 +1094,19 @@ export declare interface DistillationSpec {
     validationDatasetUri?: string;
 }
 
+export declare type DownloadableFileUnion = string | File_2 | GeneratedVideo | Video;
+
+declare interface Downloader {
+    /**
+     * Downloads a file to the given location.
+     *
+     * @param params The parameters for downloading the file.
+     * @param apiClient The ApiClient to use for uploading.
+     * @return A Promises that resolves when the download is complete.
+     */
+    download(params: DownloadFileParameters, apiClient: ApiClient): Promise<void>;
+}
+
 /** Used to override the default configuration. */
 export declare interface DownloadFileConfig {
     /** Used to override HTTP request options. */
@@ -1018,6 +1120,16 @@ export declare interface DownloadFileConfig {
     abortSignal?: AbortSignal;
 }
 
+/** Parameters used to download a file. */
+export declare interface DownloadFileParameters {
+    /** The file to download. It can be a file name, a file object or a generated video. */
+    file: DownloadableFileUnion;
+    /** Location where the file should be downloaded to. */
+    downloadPath: string;
+    /** Configuration to for the download operation. */
+    config?: DownloadFileConfig;
+}
+
 /** Describes the options to customize dynamic retrieval. */
 export declare interface DynamicRetrievalConfig {
     /** The mode of the predictor to be used in dynamic retrieval. */
@@ -1118,6 +1230,10 @@ export declare enum EndSensitivity {
     END_SENSITIVITY_LOW = "END_SENSITIVITY_LOW"
 }
 
+/** Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. */
+export declare interface EnterpriseWebSearch {
+}
+
 /** Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [FunctionDeclaration] tool and [FunctionCallingConfig] mode is set to [Mode.CODE]. */
 export declare interface ExecutableCode {
     /** Required. The code to be executed. */
@@ -1261,6 +1377,23 @@ export declare class Files extends BaseModule {
      * ```
      */
     upload(params: types.UploadFileParameters): Promise<types.File>;
+    /**
+     * Downloads a remotely stored file asynchronously to a location specified in
+     * the `params` object. This method only works on Node environment, to
+     * download files in the browser, use a browser compliant method like an <a>
+     * tag.
+     *
+     * @param params - The parameters for the download request.
+     *
+     * @example
+     * The following code downloads an example file named "files/mehozpxf877d" as
+     * "file.txt".
+     *
+     * ```ts
+     * await ai.files.download({file: file.name, downloadPath: 'file.txt'});
+     * ```
+     */
+    download(params: types.DownloadFileParameters): Promise<void>;
     private listInternal;
     private createInternal;
     /**
@@ -2174,6 +2307,12 @@ export declare interface GoogleGenAIOptions {
     httpOptions?: HttpOptions;
 }
 
+/** Tool to support Google Maps in Model. */
+export declare interface GoogleMaps {
+    /** Optional. Auth config for the Google Maps tool. */
+    authConfig?: AuthConfig;
+}
+
 /** The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */
 export declare interface GoogleRpcStatus {
     /** The status code, which should be an enum value of google.rpc.Code. */
@@ -2422,6 +2561,20 @@ export declare enum Language {
     PYTHON = "PYTHON"
 }
 
+/** An object that represents a latitude/longitude pair.
+
+ This is expressed as a pair of doubles to represent degrees latitude and
+ degrees longitude. Unless specified otherwise, this object must conform to the
+ <a href="https://en.wikipedia.org/wiki/World_Geodetic_System#1984_version">
+ WGS84 standard</a>. Values must be within normalized ranges.
+ */
+export declare interface LatLng {
+    /** The latitude in degrees. It must be in the range [-90.0, +90.0]. */
+    latitude?: number;
+    /** The longitude in degrees. It must be in the range [-180.0, +180.0] */
+    longitude?: number;
+}
+
 /** Config for caches.list method. */
 export declare interface ListCachedContentsConfig {
     /** Used to override HTTP request options. */
@@ -2480,6 +2633,32 @@ export declare class ListFilesResponse {
     files?: File_2[];
 }
 
+export declare interface ListModelsConfig {
+    /** Used to override HTTP request options. */
+    httpOptions?: HttpOptions;
+    /** Abort signal which can be used to cancel the request.
+
+     NOTE: AbortSignal is a client-only operation. Using it to cancel an
+     operation will not cancel the request in the service. You will still
+     be charged usage for any applicable operations.
+     */
+    abortSignal?: AbortSignal;
+    pageSize?: number;
+    pageToken?: string;
+    filter?: string;
+    /** Set true to list base models, false to list tuned models. */
+    queryBase?: boolean;
+}
+
+export declare interface ListModelsParameters {
+    config?: ListModelsConfig;
+}
+
+export declare class ListModelsResponse {
+    nextPageToken?: string;
+    models?: Model[];
+}
+
 /** Configuration for the list tuning jobs method. */
 export declare interface ListTuningJobsConfig {
     /** Used to override HTTP request options. */
@@ -2876,7 +3055,7 @@ export declare interface LiveServerGoAway {
 }
 
 /** Response message for API call. */
-export declare interface LiveServerMessage {
+export declare class LiveServerMessage {
     /** Sent in response to a `LiveClientSetup` message from the client. */
     setupComplete?: LiveServerSetupComplete;
     /** Content generated by the model in response to client messages. */
@@ -2891,6 +3070,23 @@ export declare interface LiveServerMessage {
     goAway?: LiveServerGoAway;
     /** Update of the session resumption state. */
     sessionResumptionUpdate?: LiveServerSessionResumptionUpdate;
+    /**
+     * Returns the concatenation of all text parts from the server content if present.
+     *
+     * @remarks
+     * If there are non-text parts in the response, the concatenation of all text
+     * parts will be returned, and a warning will be logged.
+     */
+    get text(): string | undefined;
+    /**
+     * Returns the concatenation of all inline data parts from the server content if present.
+     *
+     * @remarks
+     * If there are non-inline data parts in the
+     * response, the concatenation of all inline data parts will be returned, and
+     * a warning will be logged.
+     */
+    get data(): string | undefined;
 }
 
 /** Update of the session resumption state.
@@ -3172,6 +3368,7 @@ export declare class Models extends BaseModule {
      * ```
      */
     generateImages: (params: types.GenerateImagesParameters) => Promise<types.GenerateImagesResponse>;
+    list: (params?: types.ListModelsParameters) => Promise<Pager<types.Model>>;
     private generateContentInternal;
     private generateContentStreamInternal;
     /**
@@ -3225,6 +3422,7 @@ export declare class Models extends BaseModule {
      * ```
      */
     get(params: types.GetModelParameters): Promise<types.Model>;
+    private listInternal;
     /**
      * Updates a tuned model by its name.
      *
@@ -3667,6 +3865,13 @@ export declare interface Retrieval {
     vertexRagStore?: VertexRagStore;
 }
 
+/** Retrieval config.
+ */
+export declare interface RetrievalConfig {
+    /** Optional. The location of the user. */
+    latLng?: LatLng;
+}
+
 /** Metadata related to retrieval in the grounding flow. */
 export declare interface RetrievalMetadata {
     /** Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search. */
@@ -4198,6 +4403,12 @@ export declare interface Tool {
     googleSearch?: GoogleSearch;
     /** Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. */
     googleSearchRetrieval?: GoogleSearchRetrieval;
+    /** Optional. Enterprise web search tool type. Specialized retrieval
+     tool that is powered by Vertex AI Search and Sec4 compliance. */
+    enterpriseWebSearch?: EnterpriseWebSearch;
+    /** Optional. Google Maps tool type. Specialized retrieval tool
+     that is powered by Google Maps. */
+    googleMaps?: GoogleMaps;
     /** Optional. CodeExecution tool type. Enables the model to execute code as part of generation. This field is only used by the Gemini Developer API services. */
     codeExecution?: ToolCodeExecution;
     /** Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. */
@@ -4215,6 +4426,8 @@ export declare interface ToolCodeExecution {
 export declare interface ToolConfig {
     /** Optional. Function calling config. */
     functionCallingConfig?: FunctionCallingConfig;
+    /** Optional. Retrieval config. */
+    retrievalConfig?: RetrievalConfig;
 }
 
 export declare type ToolListUnion = Tool[];
@@ -4397,6 +4610,7 @@ declare namespace types {
         HarmBlockMethod,
         HarmBlockThreshold,
         Mode,
+        AuthType,
         Type,
         FinishReason,
         HarmProbability,
@@ -4438,6 +4652,14 @@ declare namespace types {
         GoogleSearch,
         DynamicRetrievalConfig,
         GoogleSearchRetrieval,
+        EnterpriseWebSearch,
+        ApiKeyConfig,
+        AuthConfigGoogleServiceAccountConfig,
+        AuthConfigHttpBasicAuthConfig,
+        AuthConfigOauthConfig,
+        AuthConfigOidcConfig,
+        AuthConfig,
+        GoogleMaps,
         VertexAISearch,
         VertexRagStoreRagResource,
         RagRetrievalConfigFilter,
@@ -4453,6 +4675,8 @@ declare namespace types {
         FunctionDeclaration,
         Tool,
         FunctionCallingConfig,
+        LatLng,
+        RetrievalConfig,
         ToolConfig,
         PrebuiltVoiceConfig,
         VoiceConfig,
@@ -4500,6 +4724,9 @@ declare namespace types {
         Endpoint,
         TunedModelInfo,
         Model,
+        ListModelsConfig,
+        ListModelsParameters,
+        ListModelsResponse,
         UpdateModelConfig,
         UpdateModelParameters,
         DeleteModelConfig,
@@ -4589,6 +4816,7 @@ declare namespace types {
         ReplayFile,
         UploadFileConfig,
         DownloadFileConfig,
+        DownloadFileParameters,
         UpscaleImageConfig,
         UpscaleImageParameters,
         RawReferenceImage,
@@ -4637,7 +4865,8 @@ declare namespace types {
         ContentListUnion,
         SchemaUnion,
         SpeechConfigUnion,
-        ToolListUnion
+        ToolListUnion,
+        DownloadableFileUnion
     }
 }