@google/genai 1.30.0 → 1.32.0

package/dist/genai.d.ts

@@ -436,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.
      *
@@ -471,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;
@@ -741,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
@@ -900,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.
@@ -1922,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);
      * }
@@ -1942,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;
 }
 
@@ -2362,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);
      * }
      * ```
      */
@@ -2510,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.
@@ -2547,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.
      *
@@ -2582,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;
     /**
@@ -2959,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.
@@ -3023,6 +3017,10 @@ export declare interface GenerateContentConfig {
     /** The image generation configuration.
      */
     imageConfig?: ImageConfig;
+    /** Enables enhanced civic answers. It may not be available for all
+     models. This field is not supported in Vertex AI.
+     */
+    enableEnhancedCivicAnswers?: boolean;
 }
 
 /** Config for models.generate_content parameters. */
@@ -3740,6 +3738,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;
@@ -6704,6 +6703,17 @@ export declare class ReplayResponse {
     sdkResponseSegments?: Record<string, unknown>[];
 }
 
+/** ReplicatedVoiceConfig is used to configure replicated voice. */
+export declare interface ReplicatedVoiceConfig {
+    /** The mime type of the replicated voice.
+     */
+    mimeType?: string;
+    /** The sample audio of the replicated voice.
+
+     * @remarks Encoded as base64 string. */
+    voiceSampleAudio?: string;
+}
+
 /** Defines a retrieval tool that model can call to access external knowledge. This data type is not supported in Gemini API. */
 export declare interface Retrieval {
     /** Optional. Deprecated. This option is no longer supported. */
@@ -7194,12 +7204,11 @@ export declare interface SpeakerVoiceConfig {
     voiceConfig?: VoiceConfig;
 }
 
-/** The speech generation config. */
 export declare interface SpeechConfig {
+    /** Configuration for the voice of the response. */
+    voiceConfig?: VoiceConfig;
     /** Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. */
     languageCode?: string;
-    /** The configuration for the speaker to use. */
-    voiceConfig?: VoiceConfig;
     /** Optional. The configuration for the multi-speaker setup. It is mutually exclusive with the voice_config field. This field is not supported in Vertex AI. */
     multiSpeakerVoiceConfig?: MultiSpeakerVoiceConfig;
 }
@@ -7775,25 +7784,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.
      *
@@ -7817,7 +7831,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;
 }
@@ -8044,6 +8058,12 @@ declare namespace types {
         LatLng,
         RetrievalConfig,
         ToolConfig,
+        ReplicatedVoiceConfig,
+        PrebuiltVoiceConfig,
+        VoiceConfig,
+        SpeakerVoiceConfig,
+        MultiSpeakerVoiceConfig,
+        SpeechConfig,
         AutomaticFunctionCallingConfig,
         ThinkingConfig,
         ImageConfig,
@@ -8131,11 +8151,6 @@ declare namespace types {
         DeleteModelConfig,
         DeleteModelParameters,
         DeleteModelResponse,
-        PrebuiltVoiceConfig,
-        VoiceConfig,
-        SpeakerVoiceConfig,
-        MultiSpeakerVoiceConfig,
-        SpeechConfig,
         GenerationConfig,
         CountTokensConfig,
         CountTokensParameters,
@@ -8185,6 +8200,7 @@ declare namespace types {
         ListTuningJobsResponse,
         CancelTuningJobConfig,
         CancelTuningJobParameters,
+        CancelTuningJobResponse,
         TuningExample,
         TuningDataset,
         TuningValidationDataset,
@@ -8843,8 +8859,9 @@ export declare interface VideoMetadata {
     startOffset?: string;
 }
 
-/** The configuration for the voice to use. */
 export declare interface VoiceConfig {
+    /** If true, the model will use a replicated voice for the response. */
+    replicatedVoiceConfig?: ReplicatedVoiceConfig;
     /** The configuration for the prebuilt voice to use. */
     prebuiltVoiceConfig?: PrebuiltVoiceConfig;
 }