@google/genai 1.38.0 → 1.40.0

package/dist/genai.d.ts

@@ -567,6 +567,10 @@ declare class BadRequestError extends APIError<400, Headers> {
 }
 
 declare interface BaseCreateAgentInteractionParams {
+    /**
+     * Path param: Which version of the API to use.
+     */
+    api_version?: string;
     /**
      * Body param: The name of the `Agent` used for generating the interaction.
      */
@@ -575,10 +579,6 @@ declare interface BaseCreateAgentInteractionParams {
      * Body param: The inputs for the interaction.
      */
     input: string | Array<Content_2> | Array<Turn> | TextContent | ImageContent | AudioContent | DocumentContent | VideoContent | ThoughtContent | FunctionCallContent | FunctionResultContent | CodeExecutionCallContent | CodeExecutionResultContent | URLContextCallContent | URLContextResultContent | GoogleSearchCallContent | GoogleSearchResultContent | MCPServerToolCallContent | MCPServerToolResultContent | FileSearchCallContent | FileSearchResultContent;
-    /**
-     * Path param: Which version of the API to use.
-     */
-    api_version?: string;
     /**
      * Body param: Configuration for the agent.
      */
@@ -623,6 +623,10 @@ declare interface BaseCreateAgentInteractionParams {
 }
 
 declare interface BaseCreateModelInteractionParams {
+    /**
+     * Path param: Which version of the API to use.
+     */
+    api_version?: string;
     /**
      * Body param: The inputs for the interaction.
      */
@@ -631,10 +635,6 @@ declare interface BaseCreateModelInteractionParams {
      * Body param: The name of the `Model` used for generating the interaction.
      */
     model: Model_2;
-    /**
-     * Path param: Which version of the API to use.
-     */
-    api_version?: string;
     /**
      * Body param: Input only. Whether to run the model interaction in the background.
      */
@@ -775,6 +775,7 @@ declare class BaseInteractions extends APIResource {
      * @example
      * ```ts
      * const interaction = await client.interactions.create({
+     *   api_version: 'api_version',
      *   input: 'string',
      *   model: 'gemini-2.5-pro',
      * });
@@ -790,7 +791,9 @@ declare class BaseInteractions extends APIResource {
      *
      * @example
      * ```ts
-     * const interaction = await client.interactions.delete('id');
+     * const interaction = await client.interactions.delete('id', {
+     *   api_version: 'api_version',
+     * });
      * ```
      */
     delete(id: string, params?: InteractionDeleteParams | null | undefined, options?: RequestOptions): APIPromise<unknown>;
@@ -799,7 +802,9 @@ declare class BaseInteractions extends APIResource {
      *
      * @example
      * ```ts
-     * const interaction = await client.interactions.cancel('id');
+     * const interaction = await client.interactions.cancel('id', {
+     *   api_version: 'api_version',
+     * });
      * ```
      */
     cancel(id: string, params?: InteractionCancelParams | null | undefined, options?: RequestOptions): APIPromise<Interaction>;
@@ -808,7 +813,9 @@ declare class BaseInteractions extends APIResource {
      *
      * @example
      * ```ts
-     * const interaction = await client.interactions.get('id');
+     * const interaction = await client.interactions.get('id', {
+     *   api_version: 'api_version',
+     * });
      * ```
      */
     get(id: string, params?: InteractionGetParamsNonStreaming, options?: RequestOptions): APIPromise<Interaction>;
@@ -1824,7 +1831,7 @@ declare namespace ContentDelta {
     }
     namespace FunctionResultDelta {
         interface Items {
-            items?: Array<string | InteractionsAPI.ImageContent | unknown>;
+            items?: Array<InteractionsAPI.TextContent | InteractionsAPI.ImageContent | unknown>;
         }
     }
     interface CodeExecutionCallDelta {
@@ -2439,7 +2446,7 @@ export declare interface CreateTuningJobConfig {
      be charged usage for any applicable operations.
      */
     abortSignal?: AbortSignal;
-    /** The method to use for tuning (SUPERVISED_FINE_TUNING or PREFERENCE_TUNING). If not set, the default method (SFT) will be used. */
+    /** The method to use for tuning (SUPERVISED_FINE_TUNING or PREFERENCE_TUNING or DISTILLATION). If not set, the default method (SFT) will be used. */
     method?: TuningMethod;
     /** Validation dataset for tuning. The dataset must be formatted as a JSONL file. */
     validationDataset?: TuningValidationDataset;
@@ -2449,7 +2456,7 @@ export declare interface CreateTuningJobConfig {
     description?: string;
     /** Number of complete passes the model makes over the entire training dataset during training. */
     epochCount?: number;
-    /** Multiplier for adjusting the default learning rate. */
+    /** Multiplier for adjusting the default learning rate. 1P models only. Mutually exclusive with learning_rate. */
     learningRateMultiplier?: number;
     /** If set to true, disable intermediate checkpoints and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints. */
     exportLastCheckpointOnly?: boolean;
@@ -2457,14 +2464,26 @@ export declare interface CreateTuningJobConfig {
     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. */
+    /** Tuning mode for SFT tuning. */
+    tuningMode?: TuningMode;
+    /** Custom base model for tuning. This is only supported for OSS models in Vertex. */
+    customBaseModel?: string;
+    /** The batch size hyperparameter for tuning. This is only supported for OSS models in Vertex. */
     batchSize?: number;
-    /** The learning rate hyperparameter for tuning. If not set, a default of 0.001 or 0.0002 will be calculated based on the number of training examples. */
+    /** The learning rate for tuning. OSS models only. Mutually exclusive with learning_rate_multiplier. */
     learningRate?: number;
     /** 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>;
     /** Weight for KL Divergence regularization, Preference Optimization tuning only. */
     beta?: number;
+    /** The base teacher model that is being distilled. Distillation only. */
+    baseTeacherModel?: string;
+    /** The resource name of the Tuned teacher model. Distillation only. */
+    tunedTeacherModelSource?: string;
+    /** Multiplier for adjusting the weight of the SFT loss. Distillation only. */
+    sftLossWeightMultiplier?: number;
+    /** The Google Cloud Storage location where the tuning job outputs are written. */
+    outputUri?: string;
 }
 
 /** Fine-tuning job creation parameters - optional fields. */
@@ -2739,6 +2758,36 @@ export declare interface DistillationDataStats {
     trainingDatasetStats?: DatasetStats;
 }
 
+/** Hyperparameters for Distillation. This data type is not supported in Gemini API. */
+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;
+}
+
+/** Distillation tuning spec for tuning. */
+export declare interface DistillationSpec {
+    /** The GCS URI of the prompt dataset to use during distillation. */
+    promptDatasetUri?: string;
+    /** 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;
+}
+
 /** A Document is a collection of Chunks. */
 declare interface Document_2 {
     /** The resource name of the Document.
@@ -3372,6 +3421,12 @@ export declare class Files extends BaseModule {
      * ```
      */
     download(params: types.DownloadFileParameters): Promise<void>;
+    /**
+     * Registers Google Cloud Storage files for use with the API.
+     * This method is only available in Node.js environments.
+     */
+    registerFiles(params: types.RegisterFilesParameters): Promise<types.RegisterFilesResponse>;
+    protected _registerFiles(params: types.InternalRegisterFilesParameters): Promise<types.RegisterFilesResponse>;
     private listInternal;
     private createInternal;
     /**
@@ -3404,6 +3459,7 @@ export declare class Files extends BaseModule {
      * ```
      */
     delete(params: types.DeleteFileParameters): Promise<types.DeleteFileResponse>;
+    private registerFilesInternal;
 }
 
 /** Tool to retrieve knowledge from the File Search Stores. */
@@ -3906,7 +3962,7 @@ declare interface FunctionResultContent {
 
 declare namespace FunctionResultContent {
     interface Items {
-        items?: Array<string | InteractionsAPI.ImageContent | unknown>;
+        items?: Array<InteractionsAPI.TextContent | InteractionsAPI.ImageContent | unknown>;
     }
 }
 
@@ -5630,6 +5686,8 @@ export declare class InlinedResponse {
     /** The response to the request.
      */
     response?: GenerateContentResponse;
+    /** The metadata to be associated with the request. */
+    metadata?: Record<string, string>;
     /** The error encountered while processing the request.
      */
     error?: JobError;
@@ -5690,6 +5748,18 @@ declare interface InteractionCancelParams {
     api_version?: string;
 }
 
+declare interface InteractionCompleteEvent {
+    /**
+     * The event_id token to be used to resume the interaction stream, from this event.
+     */
+    event_id?: string;
+    event_type?: 'interaction.complete';
+    /**
+     * The Interaction resource.
+     */
+    interaction?: Interaction;
+}
+
 declare type InteractionCreateParams = CreateModelInteractionParamsNonStreaming | CreateModelInteractionParamsStreaming | CreateAgentInteractionParamsNonStreaming | CreateAgentInteractionParamsStreaming;
 
 declare interface InteractionDeleteParams {
@@ -5701,18 +5771,6 @@ declare interface InteractionDeleteParams {
 
 declare type InteractionDeleteResponse = unknown;
 
-declare interface InteractionEvent {
-    /**
-     * The event_id token to be used to resume the interaction stream, from this event.
-     */
-    event_id?: string;
-    event_type?: 'interaction.start' | 'interaction.complete';
-    /**
-     * The Interaction resource.
-     */
-    interaction?: Interaction;
-}
-
 declare type InteractionGetParams = InteractionGetParamsNonStreaming | InteractionGetParamsStreaming;
 
 declare namespace InteractionGetParams {
@@ -5725,6 +5783,10 @@ declare interface InteractionGetParamsBase {
      * Path param: Which version of the API to use.
      */
     api_version?: string;
+    /**
+     * Query param: If set to true, includes the input in the response.
+     */
+    include_input?: boolean;
     /**
      * Query param: Optional. If set, resumes the interaction stream from the next chunk after the event marked by the event id. Can only be used if `stream` is true.
      */
@@ -5753,7 +5815,7 @@ export declare class Interactions extends BaseInteractions {
 }
 
 export declare namespace Interactions {
-    export { type AllowedTools as AllowedTools, type Annotation as Annotation, type AudioContent as AudioContent, type AudioMimeType as AudioMimeType, type CodeExecutionCallArguments as CodeExecutionCallArguments, type CodeExecutionCallContent as CodeExecutionCallContent, type CodeExecutionResultContent as CodeExecutionResultContent, type Content_2 as Content, type ContentDelta as ContentDelta, type ContentStart as ContentStart, type ContentStop as ContentStop, type DeepResearchAgentConfig as DeepResearchAgentConfig, type DocumentContent as DocumentContent, type DocumentMimeType as DocumentMimeType, type DynamicAgentConfig as DynamicAgentConfig, type ErrorEvent_2 as ErrorEvent, type FileSearchCallContent as FileSearchCallContent, type FileSearchResultContent as FileSearchResultContent, type Function_2 as Function, type FunctionCallContent as FunctionCallContent, type FunctionResultContent as FunctionResultContent, type GenerationConfig_2 as GenerationConfig, type GoogleSearchCallArguments as GoogleSearchCallArguments, type GoogleSearchCallContent as GoogleSearchCallContent, type GoogleSearchResult as GoogleSearchResult, type GoogleSearchResultContent as GoogleSearchResultContent, type ImageConfig_2 as ImageConfig, type ImageContent as ImageContent, type ImageMimeType as ImageMimeType, type Interaction as Interaction, type InteractionEvent as InteractionEvent, type InteractionSSEEvent as InteractionSSEEvent, type InteractionStatusUpdate as InteractionStatusUpdate, type MCPServerToolCallContent as MCPServerToolCallContent, type MCPServerToolResultContent as MCPServerToolResultContent, type Model_2 as Model, type SpeechConfig_2 as SpeechConfig, type TextContent as TextContent, type ThinkingLevel_2 as ThinkingLevel, type ThoughtContent as ThoughtContent, type Tool_2 as Tool, type ToolChoice as ToolChoice, type ToolChoiceConfig as ToolChoiceConfig, type ToolChoiceType as ToolChoiceType, type Turn as Turn, type URLContextCallArguments as URLContextCallArguments, type URLContextCallContent as URLContextCallContent, type URLContextResult as URLContextResult, type URLContextResultContent as URLContextResultContent, type Usage as Usage, type VideoContent as VideoContent, type VideoMimeType as VideoMimeType, type InteractionDeleteResponse as InteractionDeleteResponse, type InteractionCreateParams as InteractionCreateParams, type CreateModelInteractionParamsNonStreaming as CreateModelInteractionParamsNonStreaming, type CreateModelInteractionParamsStreaming as CreateModelInteractionParamsStreaming, type CreateAgentInteractionParamsNonStreaming as CreateAgentInteractionParamsNonStreaming, type CreateAgentInteractionParamsStreaming as CreateAgentInteractionParamsStreaming, type InteractionDeleteParams as InteractionDeleteParams, type InteractionCancelParams as InteractionCancelParams, type InteractionGetParams as InteractionGetParams, type InteractionGetParamsNonStreaming as InteractionGetParamsNonStreaming, type InteractionGetParamsStreaming as InteractionGetParamsStreaming, };
+    export { type AllowedTools as AllowedTools, type Annotation as Annotation, type AudioContent as AudioContent, type AudioMimeType as AudioMimeType, type CodeExecutionCallArguments as CodeExecutionCallArguments, type CodeExecutionCallContent as CodeExecutionCallContent, type CodeExecutionResultContent as CodeExecutionResultContent, type Content_2 as Content, type ContentDelta as ContentDelta, type ContentStart as ContentStart, type ContentStop as ContentStop, type DeepResearchAgentConfig as DeepResearchAgentConfig, type DocumentContent as DocumentContent, type DocumentMimeType as DocumentMimeType, type DynamicAgentConfig as DynamicAgentConfig, type ErrorEvent_2 as ErrorEvent, type FileSearchCallContent as FileSearchCallContent, type FileSearchResultContent as FileSearchResultContent, type Function_2 as Function, type FunctionCallContent as FunctionCallContent, type FunctionResultContent as FunctionResultContent, type GenerationConfig_2 as GenerationConfig, type GoogleSearchCallArguments as GoogleSearchCallArguments, type GoogleSearchCallContent as GoogleSearchCallContent, type GoogleSearchResult as GoogleSearchResult, type GoogleSearchResultContent as GoogleSearchResultContent, type ImageConfig_2 as ImageConfig, type ImageContent as ImageContent, type ImageMimeType as ImageMimeType, type Interaction as Interaction, type InteractionCompleteEvent as InteractionCompleteEvent, type InteractionSSEEvent as InteractionSSEEvent, type InteractionStartEvent as InteractionStartEvent, type InteractionStatusUpdate as InteractionStatusUpdate, type MCPServerToolCallContent as MCPServerToolCallContent, type MCPServerToolResultContent as MCPServerToolResultContent, type Model_2 as Model, type SpeechConfig_2 as SpeechConfig, type TextContent as TextContent, type ThinkingLevel_2 as ThinkingLevel, type ThoughtContent as ThoughtContent, type Tool_2 as Tool, type ToolChoice as ToolChoice, type ToolChoiceConfig as ToolChoiceConfig, type ToolChoiceType as ToolChoiceType, type Turn as Turn, type URLContextCallArguments as URLContextCallArguments, type URLContextCallContent as URLContextCallContent, type URLContextResult as URLContextResult, type URLContextResultContent as URLContextResultContent, type Usage as Usage, type VideoContent as VideoContent, type VideoMimeType as VideoMimeType, type InteractionDeleteResponse as InteractionDeleteResponse, type InteractionCreateParams as InteractionCreateParams, type CreateModelInteractionParamsNonStreaming as CreateModelInteractionParamsNonStreaming, type CreateModelInteractionParamsStreaming as CreateModelInteractionParamsStreaming, type CreateAgentInteractionParamsNonStreaming as CreateAgentInteractionParamsNonStreaming, type CreateAgentInteractionParamsStreaming as CreateAgentInteractionParamsStreaming, type InteractionDeleteParams as InteractionDeleteParams, type InteractionCancelParams as InteractionCancelParams, type InteractionGetParams as InteractionGetParams, type InteractionGetParamsNonStreaming as InteractionGetParamsNonStreaming, type InteractionGetParamsStreaming as InteractionGetParamsStreaming, };
 }
 
 declare namespace InteractionsAPI {
@@ -5790,8 +5852,9 @@ declare namespace InteractionsAPI {
         ImageContent,
         ImageMimeType,
         Interaction,
-        InteractionEvent,
+        InteractionCompleteEvent,
         InteractionSSEEvent,
+        InteractionStartEvent,
         InteractionStatusUpdate,
         MCPServerToolCallContent,
         MCPServerToolResultContent,
@@ -5829,7 +5892,19 @@ declare namespace InteractionsAPI {
     }
 }
 
-declare type InteractionSSEEvent = InteractionEvent | InteractionStatusUpdate | ContentStart | ContentDelta | ContentStop | ErrorEvent_2;
+declare type InteractionSSEEvent = InteractionStartEvent | InteractionCompleteEvent | InteractionStatusUpdate | ContentStart | ContentDelta | ContentStop | ErrorEvent_2;
+
+declare interface InteractionStartEvent {
+    /**
+     * The event_id token to be used to resume the interaction stream, from this event.
+     */
+    event_id?: string;
+    event_type?: 'interaction.start';
+    /**
+     * The Interaction resource.
+     */
+    interaction?: Interaction;
+}
 
 declare interface InteractionStatusUpdate {
     /**
@@ -5841,6 +5916,14 @@ declare interface InteractionStatusUpdate {
     status?: 'in_progress' | 'requires_action' | 'completed' | 'failed' | 'cancelled';
 }
 
+/** Parameters for the private _Register method. */
+export declare interface InternalRegisterFilesParameters {
+    /** The Google Cloud Storage URIs to register. Example: `gs://bucket/object`. */
+    uris: string[];
+    /** Used to override the default configuration. */
+    config?: RegisterFilesConfig;
+}
+
 declare class InternalServerError extends APIError<number, Headers> {
 }
 
@@ -8299,6 +8382,41 @@ declare interface ReferenceImageAPIInternal {
     subjectImageConfig?: types.SubjectReferenceConfig;
 }
 
+/** Used to override the default configuration. */
+export declare interface RegisterFilesConfig {
+    /** 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;
+}
+
+/** Generates the parameters for the private registerFiles method. */
+export declare interface RegisterFilesParameters {
+    /**
+     * The authentication object.
+     */
+    auth?: any;
+    /**
+     * The Google Cloud Storage URIs to register. Example: `gs://bucket/object`.
+     */
+    uris: string[];
+    /** Used to override the default configuration. */
+    config?: RegisterFilesConfig;
+}
+
+/** Response for the _register file method. */
+export declare class RegisterFilesResponse {
+    /** Used to retain the full HTTP response. */
+    sdkHttpResponse?: HttpResponse;
+    /** The registered files. */
+    files?: File_2[];
+}
+
 /** Represents a recorded session. */
 export declare interface ReplayFile {
     replayId?: string;
@@ -9606,6 +9724,8 @@ export declare interface TuningJob {
     supervisedTuningSpec?: SupervisedTuningSpec;
     /** Tuning Spec for Preference Optimization. */
     preferenceOptimizationSpec?: PreferenceOptimizationSpec;
+    /** Tuning Spec for Distillation. */
+    distillationSpec?: DistillationSpec;
     /** Output only. The tuning data statistics associated with this TuningJob. */
     tuningDataStats?: TuningDataStats;
     /** Customer-managed encryption key options for a TuningJob. If this is set, then all resources created by the TuningJob will be encrypted with the provided encryption key. */
@@ -9639,7 +9759,11 @@ export declare enum TuningMethod {
     /**
      * Preference optimization tuning.
      */
-    PREFERENCE_TUNING = "PREFERENCE_TUNING"
+    PREFERENCE_TUNING = "PREFERENCE_TUNING",
+    /**
+     * Distillation tuning.
+     */
+    DISTILLATION = "DISTILLATION"
 }
 
 /** Tuning mode. This enum is not supported in Gemini API. */
@@ -10084,6 +10208,8 @@ declare namespace types {
         SupervisedTuningSpec,
         PreferenceOptimizationHyperParameters,
         PreferenceOptimizationSpec,
+        DistillationHyperParameters,
+        DistillationSpec,
         GoogleRpcStatus,
         PreTunedModel,
         DatasetDistributionDistributionBucket,
@@ -10170,6 +10296,9 @@ declare namespace types {
         DeleteFileConfig,
         DeleteFileParameters,
         DeleteFileResponse,
+        RegisterFilesConfig,
+        InternalRegisterFilesParameters,
+        RegisterFilesResponse,
         InlinedRequest,
         BatchJobSource,
         JobError,
@@ -10229,6 +10358,7 @@ declare namespace types {
         LiveServerMessage,
         OperationFromAPIResponseParameters,
         GenerationConfigThinkingConfig,
+        RegisterFilesParameters,
         AutomaticActivityDetection,
         RealtimeInputConfig,
         SessionResumptionConfig,