@google/genai 1.20.0 → 1.22.0

package/dist/genai.d.ts

@@ -1069,6 +1069,18 @@ export declare interface CodeExecutionResult {
     output?: string;
 }
 
+/** Tool to support computer use. */
+export declare interface ComputerUse {
+    /** Required. The environment being operated. */
+    environment?: Environment;
+    /** By default, predefined functions are included in the final model call.
+     Some of them can be explicitly excluded from being automatically included.
+     This can serve two purposes:
+     1. Using a more restricted / different action space.
+     2. Improving the definitions / instructions of predefined functions. */
+    excludedPredefinedFunctions?: string[];
+}
+
 /** Optional parameters for computing tokens. */
 export declare interface ComputeTokensConfig {
     /** Used to override HTTP request options. */
@@ -1137,6 +1149,23 @@ export declare interface ContentEmbeddingStatistics {
 
 export declare type ContentListUnion = Content | Content[] | PartUnion | PartUnion[];
 
+/** A content reference image.
+
+ A content reference image represents a subject to reference (ex. person,
+ product, animal) provided by the user. It can optionally be provided in
+ addition to a style reference image (ex. background, style reference).
+ */
+export declare class ContentReferenceImage {
+    /** The reference image for the editing operation. */
+    referenceImage?: Image_2;
+    /** The id of the reference image. */
+    referenceId?: number;
+    /** The type of the reference image. Only set by the SDK. */
+    referenceType?: string;
+    /** Internal method to convert to ReferenceImageAPIInternal. */
+    toReferenceImageAPI(): ReferenceImageAPIInternal;
+}
+
 export declare type ContentUnion = Content | PartUnion[] | PartUnion;
 
 /** Enables context window compression -- mechanism managing model context window so it does not exceed given length. */
@@ -2327,7 +2356,11 @@ export declare enum FinishReason {
     /**
      * The tool call generated by the model is invalid.
      */
-    UNEXPECTED_TOOL_CALL = "UNEXPECTED_TOOL_CALL"
+    UNEXPECTED_TOOL_CALL = "UNEXPECTED_TOOL_CALL",
+    /**
+     * Image generation stopped because the generated images have prohibited content.
+     */
+    IMAGE_PROHIBITED_CONTENT = "IMAGE_PROHIBITED_CONTENT"
 }
 
 /** A function call. */
@@ -2401,6 +2434,9 @@ export declare class FunctionResponse {
     willContinue?: boolean;
     /** Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. */
     scheduling?: FunctionResponseScheduling;
+    /** List of parts that constitute a function response. Each part may
+     have a different IANA MIME type. */
+    parts?: FunctionResponsePart[];
     /** Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. */
     id?: string;
     /** Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. */
@@ -2409,6 +2445,44 @@ export declare class FunctionResponse {
     response?: Record<string, unknown>;
 }
 
+/** Raw media bytes for function response.
+
+ Text should not be sent as raw bytes, use the FunctionResponse.response
+ field.
+ */
+export declare class FunctionResponseBlob {
+    /** Required. The IANA standard MIME type of the source data. */
+    mimeType?: string;
+    /** Required. Inline media bytes.
+     * @remarks Encoded as base64 string. */
+    data?: string;
+}
+
+/** URI based data for function response. */
+export declare class FunctionResponseFileData {
+    /** Required. URI. */
+    fileUri?: string;
+    /** Required. The IANA standard MIME type of the source data. */
+    mimeType?: string;
+}
+
+/** A datatype containing media that is part of a `FunctionResponse` message.
+
+ A `FunctionResponsePart` consists of data which has an associated datatype. A
+ `FunctionResponsePart` can only contain one of the accepted types in
+ `FunctionResponsePart.data`.
+
+ A `FunctionResponsePart` must have a fixed IANA MIME type identifying the
+ type and subtype of the media if the `inline_data` field is filled with raw
+ bytes.
+ */
+export declare class FunctionResponsePart {
+    /** Optional. Inline media bytes. */
+    inlineData?: FunctionResponseBlob;
+    /** Optional. URI based data. */
+    fileData?: FunctionResponseFileData;
+}
+
 /** Specifies how the response should be scheduled in the conversation. */
 export declare enum FunctionResponseScheduling {
     /**
@@ -2592,6 +2666,9 @@ export declare interface GenerateContentConfig {
     /** The thinking features configuration.
      */
     thinkingConfig?: ThinkingConfig;
+    /** The image generation configuration.
+     */
+    imageConfig?: ImageConfig;
 }
 
 /** Config for models.generate_content parameters. */
@@ -3713,6 +3790,13 @@ declare interface Image_2 {
 }
 export { Image_2 as Image }
 
+/** The image generation configuration to be used in GenerateContentConfig. */
+export declare interface ImageConfig {
+    /** Aspect ratio of the generated images. Supported values are
+     "1:1", "2:3", "3:2", "3:4", "4:3", "9:16", "16:9", and "21:9". */
+    aspectRatio?: string;
+}
+
 /** Enum that specifies the language of the text in the prompt. */
 export declare enum ImagePromptLanguage {
     /**
@@ -4292,6 +4376,11 @@ export declare interface LiveConnectConfig {
     /** The speech generation configuration.
      */
     speechConfig?: SpeechConfig;
+    /** Config for thinking features.
+     An error will be returned if this field is set for models that don't
+     support thinking.
+     */
+    thinkingConfig?: ThinkingConfig;
     /** If enabled, the model will detect emotions and adapt its responses accordingly. */
     enableAffectiveDialog?: boolean;
     /** The user provided system instructions for the model.
@@ -5873,7 +5962,7 @@ export declare interface RecontextImageSource {
     productImages?: ProductImage[];
 }
 
-export declare type ReferenceImage = RawReferenceImage | MaskReferenceImage | ControlReferenceImage | StyleReferenceImage | SubjectReferenceImage;
+export declare type ReferenceImage = RawReferenceImage | MaskReferenceImage | ControlReferenceImage | StyleReferenceImage | SubjectReferenceImage | ContentReferenceImage;
 
 /** Private class that represents a Reference image that is sent to API. */
 declare interface ReferenceImageAPIInternal {
@@ -6757,7 +6846,7 @@ export declare interface Tool {
     /** Optional. Tool to support the model interacting directly with the
      computer. If enabled, it automatically populates computer-use specific
      Function Declarations. */
-    computerUse?: ToolComputerUse;
+    computerUse?: ComputerUse;
     /** Optional. CodeExecution tool type. Enables the model to execute code as part of generation. */
     codeExecution?: ToolCodeExecution;
 }
@@ -6766,12 +6855,6 @@ export declare interface Tool {
 export declare interface ToolCodeExecution {
 }
 
-/** Tool to support computer use. */
-export declare interface ToolComputerUse {
-    /** Required. The environment being operated. */
-    environment?: Environment;
-}
-
 /** Tool config.
 
  This config is shared for all tools provided in the request.
@@ -6926,6 +7009,8 @@ export declare interface TuningJob {
     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 Spec for Veo Tuning. */
+    veoTuningSpec?: VeoTuningSpec;
 }
 
 /** Tuning mode. */
@@ -7009,6 +7094,22 @@ declare class Tunings extends BaseModule {
     private tuneMldevInternal;
 }
 
+/** Optional. The tuning task. Either I2V or T2V. */
+export declare enum TuningTask {
+    /**
+     * Default value. This value is unused.
+     */
+    TUNING_TASK_UNSPECIFIED = "TUNING_TASK_UNSPECIFIED",
+    /**
+     * Tuning task for image to video.
+     */
+    TUNING_TASK_I2V = "TUNING_TASK_I2V",
+    /**
+     * Tuning task for text to video.
+     */
+    TUNING_TASK_T2V = "TUNING_TASK_T2V"
+}
+
 export declare interface TuningValidationDataset {
     /** GCS URI of the file containing validation dataset in JSONL format. */
     gcsUri?: string;
@@ -7119,6 +7220,7 @@ declare namespace types {
         JobState,
         TuningMode,
         AdapterSize,
+        TuningTask,
         FeatureSelectionPreference,
         Behavior,
         DynamicRetrievalConfigMode,
@@ -7153,6 +7255,9 @@ declare namespace types {
         FunctionCall,
         CodeExecutionResult,
         ExecutableCode,
+        FunctionResponseBlob,
+        FunctionResponseFileData,
+        FunctionResponsePart,
         FunctionResponse,
         Part,
         Content,
@@ -7174,7 +7279,7 @@ declare namespace types {
         AuthConfig,
         GoogleMaps,
         UrlContext,
-        ToolComputerUse,
+        ComputerUse,
         ApiAuthApiKeyConfig,
         ApiAuth,
         ExternalApiElasticSearchParams,
@@ -7204,6 +7309,7 @@ declare namespace types {
         SpeechConfig,
         AutomaticFunctionCallingConfig,
         ThinkingConfig,
+        ImageConfig,
         GenerationConfigRoutingConfigAutoRoutingMode,
         GenerationConfigRoutingConfigManualRoutingMode,
         GenerationConfigRoutingConfig,
@@ -7326,6 +7432,8 @@ declare namespace types {
         TuningDataStats,
         EncryptionSpec,
         PartnerModelTuningSpec,
+        VeoHyperParameters,
+        VeoTuningSpec,
         TuningJob,
         ListTuningJobsConfig,
         ListTuningJobsParameters,
@@ -7409,6 +7517,7 @@ declare namespace types {
         ControlReferenceImage,
         StyleReferenceImage,
         SubjectReferenceImage,
+        ContentReferenceImage,
         LiveServerSetupComplete,
         Transcription,
         LiveServerContent,
@@ -7702,6 +7811,26 @@ export declare interface UsageMetadata {
     trafficType?: TrafficType;
 }
 
+/** Hyperparameters for Veo. */
+export declare interface VeoHyperParameters {
+    /** 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;
+    /** Optional. The tuning task. Either I2V or T2V. */
+    tuningTask?: TuningTask;
+}
+
+/** Tuning Spec for Veo Model Tuning. */
+export declare interface VeoTuningSpec {
+    /** Optional. Hyperparameters for Veo. */
+    hyperParameters?: VeoHyperParameters;
+    /** 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;
+    /** 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;
+}
+
 /** Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder */
 export declare interface VertexAISearch {
     /** Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. */