@google/genai 1.29.1 → 1.31.0

package/dist/genai.d.ts

@@ -1,4 +1,3 @@
-// @ts-ignore
 import type { Client } from '@modelcontextprotocol/sdk/client/index.js';
 import { GoogleAuthOptions } from 'google-auth-library';
 
@@ -437,6 +436,21 @@ export declare interface BaseUrlParameters {
 export declare class Batches extends BaseModule {
     private readonly apiClient;
     constructor(apiClient: ApiClient);
+    /**
+     * Lists batch jobs.
+     *
+     * @param params - The parameters for the list request.
+     * @return - A pager of batch jobs.
+     *
+     * @example
+     * ```ts
+     * const batchJobs = await ai.batches.list({config: {'pageSize': 2}});
+     * for await (const batchJob of batchJobs) {
+     *   console.log(batchJob);
+     * }
+     * ```
+     */
+    list: (params?: types.ListBatchJobsParameters) => Promise<Pager<types.BatchJob>>;
     /**
      * Create batch job.
      *
@@ -472,21 +486,6 @@ export declare class Batches extends BaseModule {
      * ```
      */
     createEmbeddings: (params: types.CreateEmbeddingsBatchJobParameters) => Promise<types.BatchJob>;
-    /**
-     * Lists batch job configurations.
-     *
-     * @param params - The parameters for the list request.
-     * @return The paginated results of the list of batch jobs.
-     *
-     * @example
-     * ```ts
-     * const batchJobs = await ai.batches.list({config: {'pageSize': 2}});
-     * for await (const batchJob of batchJobs) {
-     *   console.log(batchJob);
-     * }
-     * ```
-     */
-    list: (params?: types.ListBatchJobsParameters) => Promise<Pager<types.BatchJob>>;
     private createInlinedGenerateContentRequest;
     private getGcsUri;
     private getBigqueryUri;
@@ -742,10 +741,10 @@ export declare class Caches extends BaseModule {
     private readonly apiClient;
     constructor(apiClient: ApiClient);
     /**
-     * Lists cached content configurations.
+     * Lists cached contents.
      *
      * @param params - The parameters for the list request.
-     * @return The paginated results of the list of cached contents.
+     * @return - A pager of cached contents.
      *
      * @example
      * ```ts
@@ -901,6 +900,12 @@ export declare interface CancelTuningJobParameters {
     config?: CancelTuningJobConfig;
 }
 
+/** Empty response for tunings.cancel method. */
+export declare class CancelTuningJobResponse {
+    /** Used to retain the full HTTP response. */
+    sdkHttpResponse?: HttpResponse;
+}
+
 /** A response candidate generated from the model. */
 export declare interface Candidate {
     /** Contains the multi-part content of the response.
@@ -1558,7 +1563,7 @@ export declare function createModelContent(partOrString: PartListUnion | string)
 /**
  * Creates a `Part` object from a `base64` encoded `string`.
  */
-export declare function createPartFromBase64(data: string, mimeType: string): Part;
+export declare function createPartFromBase64(data: string, mimeType: string, mediaResolution?: PartMediaResolutionLevel): Part;
 
 /**
  * Creates a `Part` object from the `outcome` and `output` of a `CodeExecutionResult` object.
@@ -1588,7 +1593,7 @@ export declare function createPartFromText(text: string): Part;
 /**
  * Creates a `Part` object from a `URI` string.
  */
-export declare function createPartFromUri(uri: string, mimeType: string): Part;
+export declare function createPartFromUri(uri: string, mimeType: string, mediaResolution?: PartMediaResolutionLevel): Part;
 
 /** Fine-tuning job creation request - optional fields. */
 export declare interface CreateTuningJobConfig {
@@ -1923,7 +1928,7 @@ declare class Documents extends BaseModule {
      *
      * @example
      * ```ts
-     * const documents = await ai.documents.list({config: {'pageSize': 2}});
+     * const documents = await ai.documents.list({parent:'rag_store_name', config: {'pageSize': 2}});
      * for await (const document of documents) {
      *   console.log(document);
      * }
@@ -1943,12 +1948,6 @@ declare class Documents extends BaseModule {
      * @param params - The parameters for deleting a document.
      */
     delete(params: types.DeleteDocumentParameters): Promise<void>;
-    /**
-     * Lists all Documents in a FileSearchStore.
-     *
-     * @param params - The parameters for listing documents.
-     * @return ListDocumentsResponse.
-     */
     private listInternal;
 }
 
@@ -2363,19 +2362,16 @@ export declare class Files extends BaseModule {
     private readonly apiClient;
     constructor(apiClient: ApiClient);
     /**
-     * Lists all current project files from the service.
+     * Lists files.
      *
-     * @param params - The parameters for the list request
-     * @return The paginated results of the list of files
+     * @param params - The parameters for the list request.
+     * @return - A pager of files.
      *
      * @example
-     * The following code prints the names of all files from the service, the
-     * size of each page is 10.
-     *
      * ```ts
-     * const listResponse = await ai.files.list({config: {'pageSize': 10}});
-     * for await (const file of listResponse) {
-     *   console.log(file.name);
+     * const files = await ai.files.list({config: {'pageSize': 2}});
+     * for await (const file of files) {
+     *   console.log(file);
      * }
      * ```
      */
@@ -2511,6 +2507,21 @@ declare class FileSearchStores extends BaseModule {
     private readonly apiClient;
     readonly documents: Documents;
     constructor(apiClient: ApiClient, documents?: Documents);
+    /**
+     * Lists file search stores.
+     *
+     * @param params - The parameters for the list request.
+     * @return - A pager of file search stores.
+     *
+     * @example
+     * ```ts
+     * const fileSearchStores = await ai.fileSearchStores.list({config: {'pageSize': 2}});
+     * for await (const fileSearchStore of fileSearchStores) {
+     *   console.log(fileSearchStore);
+     * }
+     * ```
+     */
+    list: (params?: types.ListFileSearchStoresParameters) => Promise<Pager<types.FileSearchStore>>;
     /**
      * Uploads a file asynchronously to a given File Search Store.
      * This method is not available in Vertex AI.
@@ -2548,21 +2559,6 @@ declare class FileSearchStores extends BaseModule {
      * ```
      */
     uploadToFileSearchStore(params: types.UploadToFileSearchStoreParameters): Promise<types.UploadToFileSearchStoreOperation>;
-    /**
-     * Lists file search stores.
-     *
-     * @param params - The parameters for the list request.
-     * @return - A pager of file search stores.
-     *
-     * @example
-     * ```ts
-     * const fileSearchStores = await ai.fileSearchStores.list({config: {'pageSize': 2}});
-     * for await (const fileSearchStore of fileSearchStores) {
-     *   console.log(fileSearchStore);
-     * }
-     * ```
-     */
-    list: (params?: types.ListFileSearchStoresParameters) => Promise<Pager<types.FileSearchStore>>;
     /**
      * Creates a File Search Store.
      *
@@ -2583,12 +2579,6 @@ declare class FileSearchStores extends BaseModule {
      * @param params - The parameters for deleting a File Search Store.
      */
     delete(params: types.DeleteFileSearchStoreParameters): Promise<void>;
-    /**
-     * Lists all FileSearchStore owned by the user.
-     *
-     * @param params - The parameters for listing file search stores.
-     * @return ListFileSearchStoresResponse.
-     */
     private listInternal;
     private uploadToFileSearchStoreInternal;
     /**
@@ -2719,6 +2709,10 @@ export declare interface FunctionCall {
     args?: Record<string, unknown>;
     /** Optional. The name of the function to call. Matches [FunctionDeclaration.name]. */
     name?: string;
+    /** Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. This field is not supported in Gemini API. */
+    partialArgs?: PartialArg[];
+    /** Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. This field is not supported in Gemini API. */
+    willContinue?: boolean;
 }
 
 /** Function calling config. */
@@ -2727,6 +2721,8 @@ export declare interface FunctionCallingConfig {
     mode?: FunctionCallingConfigMode;
     /** Optional. Function names to call. Only set when the Mode is ANY. Function names should match [FunctionDeclaration.name]. With mode set to ANY, model will predict a function call from the set of function names provided. */
     allowedFunctionNames?: string[];
+    /** Optional. When set to true, arguments of a single function call will be streamed out in multiple parts/contents/responses. Partial parameter results will be returned in the [FunctionCall.partial_args] field. This field is not supported in Gemini API. */
+    streamFunctionCallArguments?: boolean;
 }
 
 /** Config for the function calling config mode. */
@@ -2801,6 +2797,9 @@ export declare class FunctionResponseBlob {
     /** Required. Inline media bytes.
      * @remarks Encoded as base64 string. */
     data?: string;
+    /** Optional. Display name of the blob.
+     Used to provide a label or filename to distinguish blobs. */
+    displayName?: string;
 }
 
 /** URI based data for function response. */
@@ -2809,6 +2808,9 @@ export declare class FunctionResponseFileData {
     fileUri?: string;
     /** Required. The IANA standard MIME type of the source data. */
     mimeType?: string;
+    /** Optional. Display name of the file.
+     Used to provide a label or filename to distinguish files. */
+    displayName?: string;
 }
 
 /** A datatype containing media that is part of a `FunctionResponse` message.
@@ -2948,6 +2950,9 @@ export declare interface GenerateContentConfig {
      object](https://spec.openapis.org/oas/v3.0.3#schema).
      If set, a compatible response_mime_type must also be set.
      Compatible mimetypes: `application/json`: Schema for JSON response.
+
+     If `response_schema` doesn't process your schema correctly, try using
+     `response_json_schema` instead.
      */
     responseSchema?: SchemaUnion;
     /** Optional. Output schema of the generated response.
@@ -3729,6 +3734,7 @@ export declare class GoogleGenAI {
     private readonly apiKey?;
     readonly vertexai: boolean;
     private readonly apiVersion?;
+    private readonly httpOptions?;
     readonly models: Models;
     readonly live: Live;
     readonly batches: Batches;
@@ -4237,6 +4243,12 @@ export declare interface ImageConfig {
      values are `1K`, `2K`, `4K`. If not specified, the model will use default
      value `1K`. */
     imageSize?: string;
+    /** MIME type of the generated image. This field is not
+     supported in Gemini API. */
+    outputMimeType?: string;
+    /** Compression quality of the generated image (for
+     ``image/jpeg`` only). This field is not supported in Gemini API. */
+    outputCompressionQuality?: number;
 }
 
 /** Enum that specifies the language of the text in the prompt. */
@@ -6271,16 +6283,17 @@ export declare class Pager<T> implements AsyncIterable<T> {
  of content being conveyed. Using multiple fields within the same `Part`
  instance is considered invalid. */
 export declare interface Part {
-    /** A predicted [FunctionCall] returned from the model that contains a string
-     representing the [FunctionDeclaration.name] and a structured JSON object
-     containing the parameters and their values. */
-    functionCall?: FunctionCall;
+    /** Media resolution for the input media.
+     */
+    mediaResolution?: PartMediaResolution;
     /** Optional. Result of executing the [ExecutableCode]. */
     codeExecutionResult?: CodeExecutionResult;
     /** Optional. Code generated by the model that is meant to be executed. */
     executableCode?: ExecutableCode;
     /** Optional. URI based data. */
     fileData?: FileData;
+    /** Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. */
+    functionCall?: FunctionCall;
     /** Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. */
     functionResponse?: FunctionResponse;
     /** Optional. Inlined bytes data. */
@@ -6296,8 +6309,54 @@ export declare interface Part {
     videoMetadata?: VideoMetadata;
 }
 
+/** Partial argument value of the function call. This data type is not supported in Gemini API. */
+export declare interface PartialArg {
+    /** Optional. Represents a null value. */
+    nullValue?: 'NULL_VALUE';
+    /** Optional. Represents a double value. */
+    numberValue?: number;
+    /** Optional. Represents a string value. */
+    stringValue?: string;
+    /** Optional. Represents a boolean value. */
+    boolValue?: boolean;
+    /** Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". */
+    jsonPath?: string;
+    /** Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. */
+    willContinue?: boolean;
+}
+
 export declare type PartListUnion = PartUnion[] | PartUnion;
 
+/** Media resolution for the input media. */
+export declare interface PartMediaResolution {
+    /** The tokenization quality used for given media.
+     */
+    level?: PartMediaResolutionLevel;
+    /** Specifies the required sequence length for media tokenization.
+     */
+    numTokens?: number;
+}
+
+/** The tokenization quality used for given media. */
+export declare enum PartMediaResolutionLevel {
+    /**
+     * Media resolution has not been set.
+     */
+    MEDIA_RESOLUTION_UNSPECIFIED = "MEDIA_RESOLUTION_UNSPECIFIED",
+    /**
+     * Media resolution set to low.
+     */
+    MEDIA_RESOLUTION_LOW = "MEDIA_RESOLUTION_LOW",
+    /**
+     * Media resolution set to medium.
+     */
+    MEDIA_RESOLUTION_MEDIUM = "MEDIA_RESOLUTION_MEDIUM",
+    /**
+     * Media resolution set to high.
+     */
+    MEDIA_RESOLUTION_HIGH = "MEDIA_RESOLUTION_HIGH"
+}
+
 /** Tuning spec for Partner models. This data type is not supported in Gemini API. */
 export declare interface PartnerModelTuningSpec {
     /** Hyperparameters for tuning. The accepted hyper_parameters and their valid range of values will differ depending on the base model. */
@@ -7347,6 +7406,24 @@ export declare interface ThinkingConfig {
     /** Indicates the thinking budget in tokens. 0 is DISABLED. -1 is AUTOMATIC. The default values and allowed ranges are model dependent.
      */
     thinkingBudget?: number;
+    /** Optional. The level of thoughts tokens that the model should generate. */
+    thinkingLevel?: ThinkingLevel;
+}
+
+/** The level of thoughts tokens that the model should generate. */
+export declare enum ThinkingLevel {
+    /**
+     * Default value.
+     */
+    THINKING_LEVEL_UNSPECIFIED = "THINKING_LEVEL_UNSPECIFIED",
+    /**
+     * Low thinking level.
+     */
+    LOW = "LOW",
+    /**
+     * High thinking level.
+     */
+    HIGH = "HIGH"
 }
 
 export declare class Tokens extends BaseModule {
@@ -7693,25 +7770,30 @@ declare class Tunings extends BaseModule {
     private readonly apiClient;
     constructor(apiClient: ApiClient);
     /**
-     * Gets a TuningJob.
+     * Lists tuning jobs.
      *
-     * @param name - The resource name of the tuning job.
-     * @return - A TuningJob object.
+     * @param params - The parameters for the list request.
+     * @return - A pager of tuning jobs.
      *
-     * @experimental - The SDK's tuning implementation is experimental, and may
-     * change in future versions.
+     * @example
+     * ```ts
+     * const tuningJobs = await ai.tunings.list({config: {'pageSize': 2}});
+     * for await (const tuningJob of tuningJobs) {
+     *   console.log(tuningJob);
+     * }
+     * ```
      */
-    get: (params: types.GetTuningJobParameters) => Promise<types.TuningJob>;
+    list: (params?: types.ListTuningJobsParameters) => Promise<Pager<types.TuningJob>>;
     /**
-     * Lists tuning jobs.
+     * Gets a TuningJob.
      *
-     * @param config - The configuration for the list request.
-     * @return - A list of tuning jobs.
+     * @param name - The resource name of the tuning job.
+     * @return - A TuningJob object.
      *
      * @experimental - The SDK's tuning implementation is experimental, and may
      * change in future versions.
      */
-    list: (params?: types.ListTuningJobsParameters) => Promise<Pager<types.TuningJob>>;
+    get: (params: types.GetTuningJobParameters) => Promise<types.TuningJob>;
     /**
      * Creates a supervised fine-tuning job.
      *
@@ -7735,7 +7817,7 @@ declare class Tunings extends BaseModule {
      * await ai.tunings.cancel({name: '...'}); // The server-generated resource name.
      * ```
      */
-    cancel(params: types.CancelTuningJobParameters): Promise<void>;
+    cancel(params: types.CancelTuningJobParameters): Promise<types.CancelTuningJobResponse>;
     private tuneInternal;
     private tuneMldevInternal;
 }
@@ -7861,6 +7943,7 @@ declare namespace types {
         AuthType,
         HttpElementLocation,
         PhishBlockThreshold,
+        ThinkingLevel,
         HarmCategory,
         HarmBlockMethod,
         HarmBlockThreshold,
@@ -7876,6 +7959,7 @@ declare namespace types {
         AdapterSize,
         JobState,
         TuningTask,
+        PartMediaResolutionLevel,
         FeatureSelectionPreference,
         Behavior,
         DynamicRetrievalConfigMode,
@@ -7905,10 +7989,12 @@ declare namespace types {
         Scale,
         MusicGenerationMode,
         LiveMusicPlaybackControl,
-        FunctionCall,
+        PartMediaResolution,
         CodeExecutionResult,
         ExecutableCode,
         FileData,
+        PartialArg,
+        FunctionCall,
         FunctionResponseBlob,
         FunctionResponseFileData,
         FunctionResponsePart,
@@ -8099,6 +8185,7 @@ declare namespace types {
         ListTuningJobsResponse,
         CancelTuningJobConfig,
         CancelTuningJobParameters,
+        CancelTuningJobResponse,
         TuningExample,
         TuningDataset,
         TuningValidationDataset,