@google/genai 1.13.0 → 1.14.0

package/dist/genai.d.ts

@@ -1425,6 +1425,8 @@ export declare interface CreateTuningJobConfig {
     learningRateMultiplier?: number;
     /** If set to true, disable intermediate checkpoints for SFT and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for SFT. */
     exportLastCheckpointOnly?: boolean;
+    /** The optional checkpoint id of the pre-tuned model to use for tuning, if applicable. */
+    preTunedModelCheckpointId?: string;
     /** Adapter size for tuning. */
     adapterSize?: AdapterSize;
     /** The batch size hyperparameter for tuning. If not set, a default of 4 or 16 will be used based on the number of training examples. */
@@ -1435,7 +1437,7 @@ export declare interface CreateTuningJobConfig {
 
 /** Supervised fine-tuning job creation parameters - optional fields. */
 export declare interface CreateTuningJobParameters {
-    /** The base model that is being tuned, e.g., "gemini-1.0-pro-002". */
+    /** The base model that is being tuned, e.g., "gemini-2.5-flash". */
     baseModel: string;
     /** Cloud Storage path to file containing training dataset for tuning. The dataset must be formatted as a JSONL file. */
     trainingDataset: TuningDataset;
@@ -1443,6 +1445,18 @@ export declare interface CreateTuningJobParameters {
     config?: CreateTuningJobConfig;
 }
 
+/** Supervised fine-tuning job creation parameters - optional fields. */
+export declare interface CreateTuningJobParametersPrivate {
+    /** The base model that is being tuned, e.g., "gemini-2.5-flash". */
+    baseModel?: string;
+    /** The PreTunedModel that is being tuned. */
+    preTunedModel?: PreTunedModel;
+    /** Cloud Storage path to file containing training dataset for tuning. The dataset must be formatted as a JSONL file. */
+    trainingDataset: TuningDataset;
+    /** Configuration for the tuning job. */
+    config?: CreateTuningJobConfig;
+}
+
 /**
  * Creates a `Content` object with a user role from a `PartListUnion` object or `string`.
  */
@@ -1612,34 +1626,6 @@ export declare interface DistillationDataStats {
     trainingDatasetStats?: DatasetStats;
 }
 
-/** Hyperparameters for Distillation. */
-export declare interface DistillationHyperParameters {
-    /** Optional. Adapter size for distillation. */
-    adapterSize?: AdapterSize;
-    /** Optional. Number of complete passes the model makes over the entire training dataset during training. */
-    epochCount?: string;
-    /** Optional. Multiplier for adjusting the default learning rate. */
-    learningRateMultiplier?: number;
-}
-
-/** Tuning Spec for Distillation. */
-export declare interface DistillationSpec {
-    /** The base teacher model that is being distilled. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models). */
-    baseTeacherModel?: string;
-    /** Optional. Hyperparameters for Distillation. */
-    hyperParameters?: DistillationHyperParameters;
-    /** Deprecated. A path in a Cloud Storage bucket, which will be treated as the root output directory of the distillation pipeline. It is used by the system to generate the paths of output artifacts. */
-    pipelineRootDirectory?: string;
-    /** The student model that is being tuned, e.g., "google/gemma-2b-1.1-it". Deprecated. Use base_model instead. */
-    studentModel?: string;
-    /** Deprecated. Cloud Storage path to file containing training dataset for tuning. The dataset must be formatted as a JSONL file. */
-    trainingDatasetUri?: string;
-    /** The resource name of the Tuned teacher model. Format: `projects/{project}/locations/{location}/models/{model}`. */
-    tunedTeacherModelSource?: string;
-    /** Optional. Cloud Storage path to file containing validation dataset for tuning. The dataset must be formatted as a JSONL file. */
-    validationDatasetUri?: string;
-}
-
 export declare type DownloadableFileUnion = string | File_2 | GeneratedVideo | Video;
 
 declare interface Downloader {
@@ -1895,9 +1881,11 @@ export declare enum EndSensitivity {
 
 /** Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. */
 export declare interface EnterpriseWebSearch {
+    /** Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. */
+    excludeDomains?: string[];
 }
 
-/** Required. The environment being operated. */
+/** The environment being operated. */
 export declare enum Environment {
     /**
      * Defaults to browser.
@@ -2331,6 +2319,22 @@ export declare enum FunctionResponseScheduling {
     INTERRUPT = "INTERRUPT"
 }
 
+/** Input example for preference optimization. */
+export declare interface GeminiPreferenceExample {
+    /** List of completions for a given prompt. */
+    completions?: GeminiPreferenceExampleCompletion[];
+    /** Multi-turn contents that represents the Prompt. */
+    contents?: Content[];
+}
+
+/** Completion and its preference score. */
+export declare interface GeminiPreferenceExampleCompletion {
+    /** Single turn completion for the given prompt. */
+    completion?: Content;
+    /** The score for the given completion. */
+    score?: number;
+}
+
 /** Optional model configuration parameters.
 
  For more information, see `Content generation parameters
@@ -2960,7 +2964,7 @@ export declare interface GenerationConfigRoutingConfigManualRoutingMode {
 export declare interface GenerationConfigThinkingConfig {
     /** Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. */
     includeThoughts?: boolean;
-    /** Optional. Indicates the thinking budget in tokens. This is only applied when enable_thinking is true. */
+    /** Optional. Indicates the thinking budget in tokens. */
     thinkingBudget?: number;
 }
 
@@ -3224,6 +3228,9 @@ export declare interface GoogleSearch {
      If customers set a start time, they must set an end time (and vice versa).
      */
     timeRangeFilter?: Interval;
+    /** Optional. List of domains to be excluded from the search results.
+     The default limit is 2000 domains. */
+    excludeDomains?: string[];
 }
 
 /** Tool to retrieve public web data for grounding, powered by Google. */
@@ -3244,14 +3251,64 @@ export declare interface GoogleTypeDate {
 
 /** Grounding chunk. */
 export declare interface GroundingChunk {
+    /** Grounding chunk from Google Maps. */
+    maps?: GroundingChunkMaps;
     /** Grounding chunk from context retrieved by the retrieval tools. */
     retrievedContext?: GroundingChunkRetrievedContext;
     /** Grounding chunk from the web. */
     web?: GroundingChunkWeb;
 }
 
+/** Chunk from Google Maps. */
+export declare interface GroundingChunkMaps {
+    /** Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content. */
+    placeAnswerSources?: GroundingChunkMapsPlaceAnswerSources;
+    /** This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. */
+    placeId?: string;
+    /** Text of the chunk. */
+    text?: string;
+    /** Title of the chunk. */
+    title?: string;
+    /** URI reference of the chunk. */
+    uri?: string;
+}
+
+/** Sources used to generate the place answer. */
+export declare interface GroundingChunkMapsPlaceAnswerSources {
+    /** A link where users can flag a problem with the generated answer. */
+    flagContentUri?: string;
+    /** Snippets of reviews that are used to generate the answer. */
+    reviewSnippets?: GroundingChunkMapsPlaceAnswerSourcesReviewSnippet[];
+}
+
+/** Author attribution for a photo or review. */
+export declare interface GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution {
+    /** Name of the author of the Photo or Review. */
+    displayName?: string;
+    /** Profile photo URI of the author of the Photo or Review. */
+    photoUri?: string;
+    /** URI of the author of the Photo or Review. */
+    uri?: string;
+}
+
+/** Encapsulates a review snippet. */
+export declare interface GroundingChunkMapsPlaceAnswerSourcesReviewSnippet {
+    /** This review's author. */
+    authorAttribution?: GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution;
+    /** A link where users can flag a problem with the review. */
+    flagContentUri?: string;
+    /** A link to show the review on Google Maps. */
+    googleMapsUri?: string;
+    /** A string of formatted recent time, expressing the review time relative to the current time in a form appropriate for the language and country. */
+    relativePublishTimeDescription?: string;
+    /** A reference representing this place review which may be used to look up this place review again. */
+    review?: string;
+}
+
 /** Chunk from context retrieved by the retrieval tools. */
 export declare interface GroundingChunkRetrievedContext {
+    /** Output only. The full document name for the referenced Vertex AI Search document. */
+    documentName?: string;
     /** Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool. */
     ragChunk?: RagChunk;
     /** Text of the attribution. */
@@ -3274,6 +3331,8 @@ export declare interface GroundingChunkWeb {
 
 /** Metadata returned to client when grounding is enabled. */
 export declare interface GroundingMetadata {
+    /** Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding. */
+    googleMapsWidgetContextToken?: string;
     /** List of supporting references retrieved from specified grounding source. */
     groundingChunks?: GroundingChunk[];
     /** Optional. List of grounding support. */
@@ -5472,6 +5531,36 @@ export declare interface PrebuiltVoiceConfig {
     voiceName?: string;
 }
 
+/** Statistics computed for datasets used for preference optimization. */
+export declare interface PreferenceOptimizationDataStats {
+    /** Output only. Dataset distributions for scores variance per example. */
+    scoreVariancePerExampleDistribution?: DatasetDistribution;
+    /** Output only. Dataset distributions for scores. */
+    scoresDistribution?: DatasetDistribution;
+    /** Output only. Number of billable tokens in the tuning dataset. */
+    totalBillableTokenCount?: string;
+    /** Output only. Number of examples in the tuning dataset. */
+    tuningDatasetExampleCount?: string;
+    /** Output only. Number of tuning steps for this Tuning Job. */
+    tuningStepCount?: string;
+    /** Output only. Sample user examples in the training dataset. */
+    userDatasetExamples?: GeminiPreferenceExample[];
+    /** Output only. Dataset distributions for the user input tokens. */
+    userInputTokenDistribution?: DatasetDistribution;
+    /** Output only. Dataset distributions for the user output tokens. */
+    userOutputTokenDistribution?: DatasetDistribution;
+}
+
+/** A pre-tuned model for continuous tuning. */
+export declare interface PreTunedModel {
+    /** Output only. The name of the base model this PreTunedModel was tuned from. */
+    baseModel?: string;
+    /** Optional. The source checkpoint id. If not specified, the default checkpoint will be used. */
+    checkpointId?: string;
+    /** The resource name of the Model. E.g., a model resource name with a specified version id or alias: `projects/{project}/locations/{location}/models/{model}@{version_id}` `projects/{project}/locations/{location}/models/{model}@{alias}` Or, omit the version id to use the default version: `projects/{project}/locations/{location}/models/{model}` */
+    tunedModelName?: string;
+}
+
 /** Config for proactivity features. */
 export declare interface ProactivityConfig {
     /** If enabled, the model can reject responding to the last prompt. For
@@ -6204,9 +6293,13 @@ export declare enum SubjectReferenceType {
 export declare interface SupervisedHyperParameters {
     /** Optional. Adapter size for tuning. */
     adapterSize?: AdapterSize;
+    /** Optional. Batch size for tuning. This feature is only available for open source models. */
+    batchSize?: string;
     /** Optional. Number of complete passes the model makes over the entire training dataset during training. */
     epochCount?: string;
-    /** Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with `learning_rate`. */
+    /** Optional. Learning rate for tuning. Mutually exclusive with `learning_rate_multiplier`. This feature is only available for open source models. */
+    learningRate?: number;
+    /** Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with `learning_rate`. This feature is only available for 1P models. */
     learningRateMultiplier?: number;
 }
 
@@ -6278,6 +6371,8 @@ export declare interface SupervisedTuningSpec {
     hyperParameters?: SupervisedHyperParameters;
     /** Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset. */
     trainingDatasetUri?: string;
+    /** Tuning mode. */
+    tuningMode?: TuningMode;
     /** Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset. */
     validationDatasetUri?: string;
 }
@@ -6437,10 +6532,12 @@ export declare interface Tool {
     googleMaps?: GoogleMaps;
     /** Optional. Tool to support URL context retrieval. */
     urlContext?: UrlContext;
+    /** Optional. Tool to support the model interacting directly with the
+     computer. If enabled, it automatically populates computer-use specific
+     Function Declarations. */
+    computerUse?: ToolComputerUse;
     /** Optional. CodeExecution tool type. Enables the model to execute code as part of generation. */
     codeExecution?: ToolCodeExecution;
-    /** Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. */
-    computerUse?: ToolComputerUse;
 }
 
 /** Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. */
@@ -6495,7 +6592,7 @@ export declare interface Transcription {
 }
 
 export declare interface TunedModel {
-    /** Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}`. */
+    /** Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version_id will be 1. For continuous tuning, the version id will be incremented by 1 from the last version id in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}` */
     model?: string;
     /** Output only. A resource name of an Endpoint. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`. */
     endpoint?: string;
@@ -6546,6 +6643,8 @@ export declare interface TuningDataset {
 export declare interface TuningDataStats {
     /** Output only. Statistics for distillation. */
     distillationDataStats?: DistillationDataStats;
+    /** Output only. Statistics for preference optimization. */
+    preferenceOptimizationDataStats?: PreferenceOptimizationDataStats;
     /** The SFT Tuning data stats. */
     supervisedTuningDataStats?: SupervisedTuningDataStats;
 }
@@ -6581,6 +6680,8 @@ export declare interface TuningJob {
     baseModel?: string;
     /** Output only. The tuned model resources associated with this TuningJob. */
     tunedModel?: TunedModel;
+    /** The pre-tuned model for continuous tuning. */
+    preTunedModel?: PreTunedModel;
     /** Tuning Spec for Supervised Fine Tuning. */
     supervisedTuningSpec?: SupervisedTuningSpec;
     /** Output only. The tuning data statistics associated with this TuningJob. */
@@ -6589,24 +6690,38 @@ export declare interface TuningJob {
     encryptionSpec?: EncryptionSpec;
     /** Tuning Spec for open sourced and third party Partner models. */
     partnerModelTuningSpec?: PartnerModelTuningSpec;
-    /** Tuning Spec for Distillation. */
-    distillationSpec?: DistillationSpec;
+    /** Optional. The user-provided path to custom model weights. Set this field to tune a custom model. The path must be a Cloud Storage directory that contains the model weights in .safetensors format along with associated model metadata files. If this field is set, the base_model field must still be set to indicate which base model the custom model is derived from. This feature is only available for open source models. */
+    customBaseModel?: string;
     /** Output only. The Experiment associated with this TuningJob. */
     experiment?: string;
     /** Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and Endpoint. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. */
     labels?: Record<string, string>;
+    /** Optional. Cloud Storage path to the directory where tuning job outputs are written to. This field is only available and required for open source models. */
+    outputUri?: string;
     /** Output only. The resource name of the PipelineJob associated with the TuningJob. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`. */
     pipelineJob?: string;
-    /** Output only. Reserved for future use. */
-    satisfiesPzi?: boolean;
-    /** Output only. Reserved for future use. */
-    satisfiesPzs?: boolean;
     /** The service account that the tuningJob workload runs as. If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account. */
     serviceAccount?: string;
     /** Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. */
     tunedModelDisplayName?: string;
 }
 
+/** Tuning mode. */
+export declare enum TuningMode {
+    /**
+     * Tuning mode is unspecified.
+     */
+    TUNING_MODE_UNSPECIFIED = "TUNING_MODE_UNSPECIFIED",
+    /**
+     * Full fine-tuning mode.
+     */
+    TUNING_MODE_FULL = "TUNING_MODE_FULL",
+    /**
+     * PEFT adapter tuning mode.
+     */
+    TUNING_MODE_PEFT_ADAPTER = "TUNING_MODE_PEFT_ADAPTER"
+}
+
 /** A long-running operation. */
 export declare interface TuningOperation {
     /** Used to retain the full HTTP response. */
@@ -6739,7 +6854,6 @@ declare namespace types {
         Mode,
         AuthType,
         ApiSpec,
-        Environment,
         UrlRetrievalStatus,
         FinishReason,
         HarmProbability,
@@ -6749,10 +6863,12 @@ declare namespace types {
         Modality,
         MediaResolution,
         JobState,
+        TuningMode,
         AdapterSize,
         FeatureSelectionPreference,
         Behavior,
         DynamicRetrievalConfigMode,
+        Environment,
         FunctionCallingConfigMode,
         SafetyFilterLevel,
         PersonGeneration,
@@ -6800,6 +6916,7 @@ declare namespace types {
         AuthConfig,
         GoogleMaps,
         UrlContext,
+        ToolComputerUse,
         ApiAuthApiKeyConfig,
         ApiAuth,
         ExternalApiElasticSearchParams,
@@ -6817,7 +6934,6 @@ declare namespace types {
         VertexRagStore,
         Retrieval,
         ToolCodeExecution,
-        ToolComputerUse,
         Tool,
         FunctionCallingConfig,
         LatLng,
@@ -6842,6 +6958,10 @@ declare namespace types {
         CitationMetadata,
         UrlMetadata,
         UrlContextMetadata,
+        GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution,
+        GroundingChunkMapsPlaceAnswerSourcesReviewSnippet,
+        GroundingChunkMapsPlaceAnswerSources,
+        GroundingChunkMaps,
         RagChunkPageSpan,
         RagChunk,
         GroundingChunkRetrievedContext,
@@ -6920,20 +7040,22 @@ declare namespace types {
         TunedModelCheckpoint,
         TunedModel,
         GoogleRpcStatus,
+        PreTunedModel,
         SupervisedHyperParameters,
         SupervisedTuningSpec,
         DatasetDistributionDistributionBucket,
         DatasetDistribution,
         DatasetStats,
         DistillationDataStats,
+        GeminiPreferenceExampleCompletion,
+        GeminiPreferenceExample,
+        PreferenceOptimizationDataStats,
         SupervisedTuningDatasetDistributionDatasetBucket,
         SupervisedTuningDatasetDistribution,
         SupervisedTuningDataStats,
         TuningDataStats,
         EncryptionSpec,
         PartnerModelTuningSpec,
-        DistillationHyperParameters,
-        DistillationSpec,
         TuningJob,
         ListTuningJobsConfig,
         ListTuningJobsParameters,
@@ -6942,7 +7064,7 @@ declare namespace types {
         TuningDataset,
         TuningValidationDataset,
         CreateTuningJobConfig,
-        CreateTuningJobParameters,
+        CreateTuningJobParametersPrivate,
         TuningOperation,
         CreateCachedContentConfig,
         CreateCachedContentParameters,
@@ -7034,8 +7156,8 @@ declare namespace types {
         ActivityStart,
         ActivityEnd,
         LiveClientRealtimeInput,
-        LiveSendRealtimeInputParameters,
         LiveClientToolResponse,
+        LiveSendRealtimeInputParameters,
         LiveClientMessage,
         LiveConnectConfig,
         LiveConnectParameters,
@@ -7065,6 +7187,7 @@ declare namespace types {
         LiveConnectConstraints,
         CreateAuthTokenConfig,
         CreateAuthTokenParameters,
+        CreateTuningJobParameters,
         BlobImageUnion,
         PartUnion,
         PartListUnion,