@google/genai 2.4.0 → 2.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/genai.d.ts +148 -72
- package/dist/index.cjs +470 -36
- package/dist/index.mjs +471 -37
- package/dist/index.mjs.map +1 -1
- package/dist/node/index.cjs +470 -36
- package/dist/node/index.mjs +471 -37
- package/dist/node/index.mjs.map +1 -1
- package/dist/node/node.d.ts +148 -72
- package/dist/tokenizer/node.cjs +56 -16
- package/dist/tokenizer/node.d.ts +26 -21
- package/dist/tokenizer/node.mjs +56 -16
- package/dist/tokenizer/node.mjs.map +1 -1
- package/dist/vertex_internal/index.cjs +57 -17
- package/dist/vertex_internal/index.cjs.map +1 -1
- package/dist/vertex_internal/index.d.ts +143 -67
- package/dist/vertex_internal/index.js +57 -17
- package/dist/vertex_internal/index.js.map +1 -1
- package/dist/web/index.mjs +471 -37
- package/dist/web/index.mjs.map +1 -1
- package/dist/web/web.d.ts +148 -72
- package/package.json +1 -1
package/dist/genai.d.ts
CHANGED
|
@@ -84,7 +84,7 @@ declare interface Agent {
|
|
|
84
84
|
/**
|
|
85
85
|
* The environment configuration for the agent.
|
|
86
86
|
*/
|
|
87
|
-
base_environment?:
|
|
87
|
+
base_environment?: InteractionsAPI.Environment | string;
|
|
88
88
|
/**
|
|
89
89
|
* Agent description for developers to quickly read and understand.
|
|
90
90
|
*/
|
|
@@ -164,7 +164,7 @@ declare interface AgentCreateParams {
|
|
|
164
164
|
/**
|
|
165
165
|
* Body param: The environment configuration for the agent.
|
|
166
166
|
*/
|
|
167
|
-
base_environment?:
|
|
167
|
+
base_environment?: InteractionsAPI.Environment | string;
|
|
168
168
|
/**
|
|
169
169
|
* Body param: Agent description for developers to quickly read and understand.
|
|
170
170
|
*/
|
|
@@ -1447,7 +1447,7 @@ export declare interface BatchJobOutputInfo {
|
|
|
1447
1447
|
vertexMultimodalDatasetName?: string;
|
|
1448
1448
|
/** The full path of the Cloud Storage directory created, into which the prediction output is written. */
|
|
1449
1449
|
gcsOutputDirectory?: string;
|
|
1450
|
-
/** The name of the BigQuery table created, in `
|
|
1450
|
+
/** The name of the BigQuery table created, in `predictions_TIMESTAMP` format, into which the prediction output is written. */
|
|
1451
1451
|
bigqueryOutputTable?: string;
|
|
1452
1452
|
}
|
|
1453
1453
|
|
|
@@ -2079,15 +2079,13 @@ declare namespace CodeExecutionCallStep {
|
|
|
2079
2079
|
}
|
|
2080
2080
|
}
|
|
2081
2081
|
|
|
2082
|
-
/** Result of executing the `
|
|
2083
|
-
|
|
2084
|
-
Generated only when the `CodeExecution` tool is used. */
|
|
2082
|
+
/** Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. */
|
|
2085
2083
|
export declare interface CodeExecutionResult {
|
|
2086
2084
|
/** Required. Outcome of the code execution. */
|
|
2087
2085
|
outcome?: Outcome;
|
|
2088
2086
|
/** Optional. Contains stdout when code execution is successful, stderr or other description otherwise. */
|
|
2089
2087
|
output?: string;
|
|
2090
|
-
/** The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. */
|
|
2088
|
+
/** Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. This field is not supported in Vertex AI. */
|
|
2091
2089
|
id?: string;
|
|
2092
2090
|
}
|
|
2093
2091
|
|
|
@@ -2136,6 +2134,9 @@ export declare interface ComputerUse {
|
|
|
2136
2134
|
1. Using a more restricted / different action space.
|
|
2137
2135
|
2. Improving the definitions / instructions of predefined functions. */
|
|
2138
2136
|
excludedPredefinedFunctions?: string[];
|
|
2137
|
+
/** Optional. Whether enable the prompt injection detection check on computer-use request.
|
|
2138
|
+
*/
|
|
2139
|
+
enablePromptInjectionDetection?: boolean;
|
|
2139
2140
|
}
|
|
2140
2141
|
|
|
2141
2142
|
/** Optional parameters for computing tokens. */
|
|
@@ -3021,35 +3022,51 @@ export declare interface DistillationDataStats {
|
|
|
3021
3022
|
trainingDatasetStats?: DatasetStats;
|
|
3022
3023
|
}
|
|
3023
3024
|
|
|
3024
|
-
/**
|
|
3025
|
+
/** Distillation hyperparameters for tuning. */
|
|
3025
3026
|
export declare interface DistillationHyperParameters {
|
|
3026
|
-
/**
|
|
3027
|
+
/** The size of the adapter. Can be 'small', 'medium', or 'large'. */
|
|
3027
3028
|
adapterSize?: AdapterSize;
|
|
3028
|
-
/**
|
|
3029
|
+
/** Number of complete passes the model makes over the entire training dataset
|
|
3030
|
+
during training. */
|
|
3029
3031
|
epochCount?: string;
|
|
3030
|
-
/**
|
|
3032
|
+
/** Multiplier for adjusting the default learning rate. */
|
|
3031
3033
|
learningRateMultiplier?: number;
|
|
3032
|
-
/**
|
|
3033
|
-
|
|
3034
|
-
|
|
3035
|
-
|
|
3036
|
-
|
|
3034
|
+
/** Generation config for Distillation teacher model sampling. Only the
|
|
3035
|
+
following fields are supported for distillation teacher samplings:
|
|
3036
|
+
- temperature
|
|
3037
|
+
- top_p
|
|
3038
|
+
- top_k
|
|
3039
|
+
- candidate_count
|
|
3040
|
+
- thinking_config */
|
|
3041
|
+
generationConfig?: GenerationConfig;
|
|
3042
|
+
/** The learning rate for distillation tuning. */
|
|
3037
3043
|
learningRate?: number;
|
|
3044
|
+
/** Batch size for tuning. This feature is only available for open
|
|
3045
|
+
source models. */
|
|
3046
|
+
batchSize?: number;
|
|
3038
3047
|
}
|
|
3039
3048
|
|
|
3040
|
-
/**
|
|
3049
|
+
/** Distillation sampling spec for tuning. */
|
|
3041
3050
|
export declare interface DistillationSamplingSpec {
|
|
3042
|
-
/**
|
|
3051
|
+
/** The base teacher model that is being distilled. See [Supported
|
|
3052
|
+
models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models). */
|
|
3043
3053
|
baseTeacherModel?: string;
|
|
3044
|
-
/**
|
|
3054
|
+
/** The resource name of the Tuned teacher model. Format:
|
|
3055
|
+
`projects/{project}/locations/{location}/models/{model}`. */
|
|
3045
3056
|
tunedTeacherModelSource?: string;
|
|
3046
|
-
/**
|
|
3057
|
+
/** Cloud Storage path to file containing validation dataset for distillation.
|
|
3058
|
+
The dataset must be formatted as a JSONL file. */
|
|
3047
3059
|
validationDatasetUri?: string;
|
|
3060
|
+
/** Cloud Storage path to file containing prompt dataset for distillation.
|
|
3061
|
+
The dataset must be formatted as a JSONL file. */
|
|
3062
|
+
promptDatasetUri?: string;
|
|
3063
|
+
/** Hyperparameters for distillation tuning. */
|
|
3064
|
+
hyperparameters?: DistillationHyperParameters;
|
|
3048
3065
|
}
|
|
3049
3066
|
|
|
3050
3067
|
/** Distillation tuning spec for tuning. */
|
|
3051
3068
|
export declare interface DistillationSpec {
|
|
3052
|
-
/**
|
|
3069
|
+
/** Optional. Cloud Storage path to file containing prompt dataset for distillation. The dataset must be formatted as a JSONL file. */
|
|
3053
3070
|
promptDatasetUri?: string;
|
|
3054
3071
|
/** 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). */
|
|
3055
3072
|
baseTeacherModel?: string;
|
|
@@ -3065,7 +3082,7 @@ export declare interface DistillationSpec {
|
|
|
3065
3082
|
tunedTeacherModelSource?: string;
|
|
3066
3083
|
/** Optional. Cloud Storage path to file containing validation dataset for tuning. The dataset must be formatted as a JSONL file. */
|
|
3067
3084
|
validationDatasetUri?: string;
|
|
3068
|
-
/**
|
|
3085
|
+
/** Optional. Specifies the tuning mode for distillation (sft part). This feature is only available for open source models. */
|
|
3069
3086
|
tuningMode?: TuningMode;
|
|
3070
3087
|
}
|
|
3071
3088
|
|
|
@@ -3342,15 +3359,6 @@ export declare interface EmbedContentBatch {
|
|
|
3342
3359
|
|
|
3343
3360
|
/** Optional parameters for the embed_content method. */
|
|
3344
3361
|
export declare interface EmbedContentConfig {
|
|
3345
|
-
/** Used to override HTTP request options. */
|
|
3346
|
-
httpOptions?: HttpOptions;
|
|
3347
|
-
/** Abort signal which can be used to cancel the request.
|
|
3348
|
-
|
|
3349
|
-
NOTE: AbortSignal is a client-only operation. Using it to cancel an
|
|
3350
|
-
operation will not cancel the request in the service. You will still
|
|
3351
|
-
be charged usage for any applicable operations.
|
|
3352
|
-
*/
|
|
3353
|
-
abortSignal?: AbortSignal;
|
|
3354
3362
|
/** Type of task for which the embedding will be used.
|
|
3355
3363
|
*/
|
|
3356
3364
|
taskType?: string;
|
|
@@ -3380,6 +3388,15 @@ export declare interface EmbedContentConfig {
|
|
|
3380
3388
|
Only applicable to Gemini Embedding 2 models.
|
|
3381
3389
|
*/
|
|
3382
3390
|
audioTrackExtraction?: boolean;
|
|
3391
|
+
/** Used to override HTTP request options. */
|
|
3392
|
+
httpOptions?: HttpOptions;
|
|
3393
|
+
/** Abort signal which can be used to cancel the request.
|
|
3394
|
+
|
|
3395
|
+
NOTE: AbortSignal is a client-only operation. Using it to cancel an
|
|
3396
|
+
operation will not cancel the request in the service. You will still
|
|
3397
|
+
be charged usage for any applicable operations.
|
|
3398
|
+
*/
|
|
3399
|
+
abortSignal?: AbortSignal;
|
|
3383
3400
|
}
|
|
3384
3401
|
|
|
3385
3402
|
/** Request-level metadata for the Gemini Enterprise Agent Platform Embed Content API. */
|
|
@@ -3512,7 +3529,15 @@ export declare enum Environment {
|
|
|
3512
3529
|
/**
|
|
3513
3530
|
* Operates in a web browser.
|
|
3514
3531
|
*/
|
|
3515
|
-
ENVIRONMENT_BROWSER = "ENVIRONMENT_BROWSER"
|
|
3532
|
+
ENVIRONMENT_BROWSER = "ENVIRONMENT_BROWSER",
|
|
3533
|
+
/**
|
|
3534
|
+
* Operates in a mobile environment.
|
|
3535
|
+
*/
|
|
3536
|
+
ENVIRONMENT_MOBILE = "ENVIRONMENT_MOBILE",
|
|
3537
|
+
/**
|
|
3538
|
+
* Operates in a desktop environment.
|
|
3539
|
+
*/
|
|
3540
|
+
ENVIRONMENT_DESKTOP = "ENVIRONMENT_DESKTOP"
|
|
3516
3541
|
}
|
|
3517
3542
|
|
|
3518
3543
|
/**
|
|
@@ -3668,17 +3693,13 @@ export declare interface ExactMatchMetricValue {
|
|
|
3668
3693
|
score?: number;
|
|
3669
3694
|
}
|
|
3670
3695
|
|
|
3671
|
-
/**
|
|
3672
|
-
|
|
3673
|
-
Only generated when using the `CodeExecution` tool, in which the code will
|
|
3674
|
-
be automatically executed, and a corresponding `CodeExecutionResult` will
|
|
3675
|
-
also be generated. */
|
|
3696
|
+
/** Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. */
|
|
3676
3697
|
export declare interface ExecutableCode {
|
|
3677
3698
|
/** Required. The code to be executed. */
|
|
3678
3699
|
code?: string;
|
|
3679
3700
|
/** Required. Programming language of the `code`. */
|
|
3680
3701
|
language?: Language;
|
|
3681
|
-
/** Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. */
|
|
3702
|
+
/** Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. This field is not supported in Vertex AI. */
|
|
3682
3703
|
id?: string;
|
|
3683
3704
|
}
|
|
3684
3705
|
|
|
@@ -3999,22 +4020,21 @@ declare interface FileSearchResultStep {
|
|
|
3999
4020
|
|
|
4000
4021
|
/** A collection of Documents. */
|
|
4001
4022
|
export declare interface FileSearchStore {
|
|
4002
|
-
/** The resource name
|
|
4023
|
+
/** Output only. Immutable. Identifier. The `FileSearchStore` resource name. It is an ID (name excluding the "fileSearchStores/" prefix) that can contain up to 40 characters that are lowercase alphanumeric or dashes (-). It is output only. The unique name will be derived from `display_name` along with a 12 character random suffix. Example: `fileSearchStores/my-awesome-file-search-store-123a456b789c` If `display_name` is not provided, the name will be randomly generated. */
|
|
4003
4024
|
name?: string;
|
|
4004
|
-
/** The human-readable display name for the FileSearchStore. */
|
|
4025
|
+
/** Optional. The human-readable display name for the `FileSearchStore`. The display name must be no more than 512 characters in length, including spaces. Example: "Docs on Semantic Retriever". */
|
|
4005
4026
|
displayName?: string;
|
|
4006
|
-
/** The Timestamp of when the FileSearchStore was created. */
|
|
4027
|
+
/** Output only. The Timestamp of when the `FileSearchStore` was created. */
|
|
4007
4028
|
createTime?: string;
|
|
4008
|
-
/** The Timestamp of when the FileSearchStore was last updated. */
|
|
4029
|
+
/** Output only. The Timestamp of when the `FileSearchStore` was last updated. */
|
|
4009
4030
|
updateTime?: string;
|
|
4010
|
-
/** The number of documents in the FileSearchStore that are active and ready for retrieval. */
|
|
4031
|
+
/** Output only. The number of documents in the `FileSearchStore` that are active and ready for retrieval. */
|
|
4011
4032
|
activeDocumentsCount?: string;
|
|
4012
|
-
/** The number of documents in the FileSearchStore that are being processed. */
|
|
4033
|
+
/** Output only. The number of documents in the `FileSearchStore` that are being processed. */
|
|
4013
4034
|
pendingDocumentsCount?: string;
|
|
4014
|
-
/** The number of documents in the FileSearchStore that have failed processing. */
|
|
4035
|
+
/** Output only. The number of documents in the `FileSearchStore` that have failed processing. */
|
|
4015
4036
|
failedDocumentsCount?: string;
|
|
4016
|
-
/** The size of raw bytes ingested into the FileSearchStore
|
|
4017
|
-
total size of all the documents in the FileSearchStore. */
|
|
4037
|
+
/** Output only. The size of raw bytes ingested into the `FileSearchStore`. This is the total size of all the documents in the `FileSearchStore`. */
|
|
4018
4038
|
sizeBytes?: string;
|
|
4019
4039
|
/** The embedding model used by the FileSearchStore. */
|
|
4020
4040
|
embeddingModel?: string;
|
|
@@ -4278,9 +4298,9 @@ export declare interface FunctionCall {
|
|
|
4278
4298
|
/** The unique id of the function call. If populated, the client to execute the
|
|
4279
4299
|
`function_call` and return the response with the matching `id`. */
|
|
4280
4300
|
id?: string;
|
|
4281
|
-
/** Optional. The function parameters and values in JSON object format. See
|
|
4301
|
+
/** Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. */
|
|
4282
4302
|
args?: Record<string, unknown>;
|
|
4283
|
-
/** Optional. The name of the function to call. Matches
|
|
4303
|
+
/** Optional. The name of the function to call. Matches FunctionDeclaration.name. */
|
|
4284
4304
|
name?: string;
|
|
4285
4305
|
/** 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. */
|
|
4286
4306
|
partialArgs?: PartialArg[];
|
|
@@ -4290,11 +4310,11 @@ export declare interface FunctionCall {
|
|
|
4290
4310
|
|
|
4291
4311
|
/** Function calling config. */
|
|
4292
4312
|
export declare interface FunctionCallingConfig {
|
|
4293
|
-
/** Optional. Function names to call. Only set when the Mode is ANY. Function names should match
|
|
4313
|
+
/** 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. */
|
|
4294
4314
|
allowedFunctionNames?: string[];
|
|
4295
4315
|
/** Optional. Function calling mode. */
|
|
4296
4316
|
mode?: FunctionCallingConfigMode;
|
|
4297
|
-
/** 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
|
|
4317
|
+
/** 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. */
|
|
4298
4318
|
streamFunctionCallArguments?: boolean;
|
|
4299
4319
|
}
|
|
4300
4320
|
|
|
@@ -4351,7 +4371,7 @@ declare interface FunctionCallStep {
|
|
|
4351
4371
|
export declare interface FunctionDeclaration {
|
|
4352
4372
|
/** Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. */
|
|
4353
4373
|
description?: string;
|
|
4354
|
-
/** Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of
|
|
4374
|
+
/** Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. */
|
|
4355
4375
|
name?: string;
|
|
4356
4376
|
/** Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 */
|
|
4357
4377
|
parameters?: Schema;
|
|
@@ -4376,7 +4396,7 @@ export declare class FunctionResponse {
|
|
|
4376
4396
|
parts?: FunctionResponsePart[];
|
|
4377
4397
|
/** Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. */
|
|
4378
4398
|
id?: string;
|
|
4379
|
-
/** Required. The name of the function to call. Matches
|
|
4399
|
+
/** Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. */
|
|
4380
4400
|
name?: string;
|
|
4381
4401
|
/** Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. */
|
|
4382
4402
|
response?: Record<string, unknown>;
|
|
@@ -5139,7 +5159,7 @@ export declare interface GenerationConfig {
|
|
|
5139
5159
|
presencePenalty?: number;
|
|
5140
5160
|
/** Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. */
|
|
5141
5161
|
responseLogprobs?: boolean;
|
|
5142
|
-
/** Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined.
|
|
5162
|
+
/** Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. */
|
|
5143
5163
|
responseMimeType?: string;
|
|
5144
5164
|
/** Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. */
|
|
5145
5165
|
responseModalities?: Modality[];
|
|
@@ -5967,9 +5987,9 @@ export declare interface GroundingChunkRetrievedContext {
|
|
|
5967
5987
|
customMetadata?: GroundingChunkCustomMetadata[];
|
|
5968
5988
|
/** Optional. Name of the `FileSearchStore` containing the document. Example: `fileSearchStores/123`. This field is not supported in Vertex AI. */
|
|
5969
5989
|
fileSearchStore?: string;
|
|
5970
|
-
/** Optional. Page number of the retrieved context. This field is not supported in Vertex AI. */
|
|
5990
|
+
/** Optional. Page number of the retrieved context, if applicable. This field is not supported in Vertex AI. */
|
|
5971
5991
|
pageNumber?: number;
|
|
5972
|
-
/** Optional.
|
|
5992
|
+
/** Optional. The media blob resource name for multimodal file search results. Format: fileSearchStores/{file_search_store_id}/media/{blob_id}. This field is not supported in Vertex AI. */
|
|
5973
5993
|
mediaId?: string;
|
|
5974
5994
|
}
|
|
5975
5995
|
|
|
@@ -6570,7 +6590,7 @@ declare interface Interaction {
|
|
|
6570
6590
|
/**
|
|
6571
6591
|
* Required. Output only. The status of the interaction.
|
|
6572
6592
|
*/
|
|
6573
|
-
status: 'in_progress' | 'requires_action' | 'completed' | 'failed' | 'cancelled' | 'incomplete';
|
|
6593
|
+
status: 'in_progress' | 'requires_action' | 'completed' | 'failed' | 'cancelled' | 'incomplete' | 'budget_exceeded';
|
|
6574
6594
|
/**
|
|
6575
6595
|
* Required. Output only. The steps that make up the interaction.
|
|
6576
6596
|
*/
|
|
@@ -6858,7 +6878,7 @@ declare type InteractionSSEEvent = InteractionCreatedEvent | InteractionComplete
|
|
|
6858
6878
|
declare interface InteractionStatusUpdate {
|
|
6859
6879
|
event_type: 'interaction.status_update';
|
|
6860
6880
|
interaction_id: string;
|
|
6861
|
-
status: 'in_progress' | 'requires_action' | 'completed' | 'failed' | 'cancelled' | 'incomplete';
|
|
6881
|
+
status: 'in_progress' | 'requires_action' | 'completed' | 'failed' | 'cancelled' | 'incomplete' | 'budget_exceeded';
|
|
6862
6882
|
/**
|
|
6863
6883
|
* The event_id token to be used to resume the interaction stream, from this event.
|
|
6864
6884
|
*/
|
|
@@ -8049,7 +8069,7 @@ export declare enum MaskReferenceMode {
|
|
|
8049
8069
|
MASK_MODE_SEMANTIC = "MASK_MODE_SEMANTIC"
|
|
8050
8070
|
}
|
|
8051
8071
|
|
|
8052
|
-
/** A MCPServer is a server that can be called by the model to perform actions. It is a server that implements the MCP protocol. Next ID:
|
|
8072
|
+
/** A MCPServer is a server that can be called by the model to perform actions. It is a server that implements the MCP protocol. Next ID: 6. This data type is not supported in Vertex AI. */
|
|
8053
8073
|
export declare interface McpServer {
|
|
8054
8074
|
/** The name of the MCPServer. */
|
|
8055
8075
|
name?: string;
|
|
@@ -8272,7 +8292,7 @@ export declare interface Model {
|
|
|
8272
8292
|
* The model that will complete your prompt.\n\nSee
|
|
8273
8293
|
* [models](https://ai.google.dev/gemini-api/docs/models) for additional details.
|
|
8274
8294
|
*/
|
|
8275
|
-
declare type Model_2 = 'gemini-2.5-computer-use-preview-10-2025' | 'gemini-2.5-flash' | 'gemini-2.5-flash-image' | 'gemini-2.5-flash-lite' | 'gemini-2.5-flash-lite-preview-09-2025' | 'gemini-2.5-flash-native-audio-preview-12-2025' | 'gemini-2.5-flash-preview-09-2025' | 'gemini-2.5-flash-preview-tts' | 'gemini-2.5-pro' | 'gemini-2.5-pro-preview-tts' | 'gemini-3-flash-preview' | 'gemini-3-pro-image-preview' | 'gemini-3-pro-preview' | 'gemini-3.1-pro-preview' | 'gemini-3.1-flash-image-preview' | 'gemini-3.1-flash-lite' | 'gemini-3.1-flash-lite-preview' | 'gemini-3.1-flash-tts-preview' | 'lyria-3-clip-preview' | 'lyria-3-pro-preview' | (string & {});
|
|
8295
|
+
declare type Model_2 = 'gemini-2.5-computer-use-preview-10-2025' | 'gemini-2.5-flash' | 'gemini-2.5-flash-image' | 'gemini-2.5-flash-lite' | 'gemini-2.5-flash-lite-preview-09-2025' | 'gemini-2.5-flash-native-audio-preview-12-2025' | 'gemini-2.5-flash-preview-09-2025' | 'gemini-2.5-flash-preview-tts' | 'gemini-2.5-pro' | 'gemini-2.5-pro-preview-tts' | 'gemini-3-flash-preview' | 'gemini-3-pro-image-preview' | 'gemini-3-pro-preview' | 'gemini-3.1-pro-preview' | 'gemini-3.1-flash-image-preview' | 'gemini-3.1-flash-lite' | 'gemini-3.1-flash-lite-preview' | 'gemini-3.1-flash-tts-preview' | 'lyria-3-clip-preview' | 'lyria-3-pro-preview' | 'gemini-3.5-flash' | (string & {});
|
|
8276
8296
|
|
|
8277
8297
|
/** Configuration for Model Armor. Model Armor is a Google Cloud service that provides safety and security filtering for prompts and responses. It helps protect your AI applications from risks such as harmful content, sensitive data leakage, and prompt injection attacks. This data type is not supported in Gemini API. */
|
|
8278
8298
|
export declare interface ModelArmorConfig {
|
|
@@ -8851,15 +8871,15 @@ export declare enum Outcome {
|
|
|
8851
8871
|
*/
|
|
8852
8872
|
OUTCOME_UNSPECIFIED = "OUTCOME_UNSPECIFIED",
|
|
8853
8873
|
/**
|
|
8854
|
-
* Code execution completed successfully.
|
|
8874
|
+
* Code execution completed successfully. `output` contains the stdout, if any.
|
|
8855
8875
|
*/
|
|
8856
8876
|
OUTCOME_OK = "OUTCOME_OK",
|
|
8857
8877
|
/**
|
|
8858
|
-
* Code execution
|
|
8878
|
+
* Code execution failed. `output` contains the stderr and stdout, if any.
|
|
8859
8879
|
*/
|
|
8860
8880
|
OUTCOME_FAILED = "OUTCOME_FAILED",
|
|
8861
8881
|
/**
|
|
8862
|
-
* Code execution ran for too long, and was cancelled. There may or may not be a partial output present.
|
|
8882
|
+
* Code execution ran for too long, and was cancelled. There may or may not be a partial `output` present.
|
|
8863
8883
|
*/
|
|
8864
8884
|
OUTCOME_DEADLINE_EXCEEDED = "OUTCOME_DEADLINE_EXCEEDED"
|
|
8865
8885
|
}
|
|
@@ -9372,6 +9392,10 @@ export declare interface RagChunk {
|
|
|
9372
9392
|
pageSpan?: RagChunkPageSpan;
|
|
9373
9393
|
/** The content of the chunk. */
|
|
9374
9394
|
text?: string;
|
|
9395
|
+
/** The ID of the chunk. */
|
|
9396
|
+
chunkId?: string;
|
|
9397
|
+
/** The ID of the file that the chunk belongs to. */
|
|
9398
|
+
fileId?: string;
|
|
9375
9399
|
}
|
|
9376
9400
|
|
|
9377
9401
|
/** Represents where the chunk starts and ends in the document. This data type is not supported in Gemini API. */
|
|
@@ -11168,7 +11192,7 @@ declare interface ToolChoiceConfig {
|
|
|
11168
11192
|
|
|
11169
11193
|
declare type ToolChoiceType = 'auto' | 'any' | 'none' | 'validated';
|
|
11170
11194
|
|
|
11171
|
-
/** Tool that executes code generated by the model, and automatically returns the result to the model. See also
|
|
11195
|
+
/** 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. This data type is not supported in Gemini API. */
|
|
11172
11196
|
export declare interface ToolCodeExecution {
|
|
11173
11197
|
}
|
|
11174
11198
|
|
|
@@ -11405,10 +11429,11 @@ export declare interface TuningJob {
|
|
|
11405
11429
|
tuningJobState?: TuningJobState;
|
|
11406
11430
|
/** Tuning Spec for Veo Tuning. */
|
|
11407
11431
|
veoTuningSpec?: VeoTuningSpec;
|
|
11408
|
-
/** Optional. Spec for creating a distillation dataset. */
|
|
11409
|
-
distillationSamplingSpec?: DistillationSamplingSpec;
|
|
11410
11432
|
/** Output only. Tuning Job metadata. */
|
|
11411
11433
|
tuningJobMetadata?: TuningJobMetadata;
|
|
11434
|
+
/** Tuning Spec for Veo LoRA Tuning. */
|
|
11435
|
+
veoLoraTuningSpec?: VeoLoraTuningSpec;
|
|
11436
|
+
distillationSamplingSpec?: DistillationSamplingSpec;
|
|
11412
11437
|
}
|
|
11413
11438
|
|
|
11414
11439
|
/** Tuning job metadata. This data type is not supported in Gemini API. */
|
|
@@ -11549,7 +11574,23 @@ declare class Tunings extends BaseModule {
|
|
|
11549
11574
|
private tuneMldevInternal;
|
|
11550
11575
|
}
|
|
11551
11576
|
|
|
11552
|
-
/** The tuning
|
|
11577
|
+
/** The speed of the tuning job. Only supported for Veo 3.0 models. This enum is not supported in Gemini API. */
|
|
11578
|
+
export declare enum TuningSpeed {
|
|
11579
|
+
/**
|
|
11580
|
+
* The default / unset value. For Veo 3.0 models, this defaults to FAST.
|
|
11581
|
+
*/
|
|
11582
|
+
TUNING_SPEED_UNSPECIFIED = "TUNING_SPEED_UNSPECIFIED",
|
|
11583
|
+
/**
|
|
11584
|
+
* Regular tuning speed.
|
|
11585
|
+
*/
|
|
11586
|
+
REGULAR = "REGULAR",
|
|
11587
|
+
/**
|
|
11588
|
+
* Fast tuning speed.
|
|
11589
|
+
*/
|
|
11590
|
+
FAST = "FAST"
|
|
11591
|
+
}
|
|
11592
|
+
|
|
11593
|
+
/** The tuning task for Veo. This enum is not supported in Gemini API. */
|
|
11553
11594
|
export declare enum TuningTask {
|
|
11554
11595
|
/**
|
|
11555
11596
|
* Default value. This value is unused.
|
|
@@ -11761,8 +11802,8 @@ declare namespace types {
|
|
|
11761
11802
|
createPartFromExecutableCode,
|
|
11762
11803
|
createUserContent,
|
|
11763
11804
|
createModelContent,
|
|
11764
|
-
Language,
|
|
11765
11805
|
Outcome,
|
|
11806
|
+
Language,
|
|
11766
11807
|
FunctionResponseScheduling,
|
|
11767
11808
|
Type,
|
|
11768
11809
|
Environment,
|
|
@@ -11794,7 +11835,9 @@ declare namespace types {
|
|
|
11794
11835
|
TuningJobState,
|
|
11795
11836
|
AggregationMetric,
|
|
11796
11837
|
PairwiseChoice,
|
|
11838
|
+
TuningSpeed,
|
|
11797
11839
|
TuningTask,
|
|
11840
|
+
VideoOrientation,
|
|
11798
11841
|
DocumentState,
|
|
11799
11842
|
PartMediaResolutionLevel,
|
|
11800
11843
|
ToolType,
|
|
@@ -11827,11 +11870,11 @@ declare namespace types {
|
|
|
11827
11870
|
Scale,
|
|
11828
11871
|
MusicGenerationMode,
|
|
11829
11872
|
LiveMusicPlaybackControl,
|
|
11830
|
-
ExecutableCode,
|
|
11831
|
-
CodeExecutionResult,
|
|
11832
11873
|
PartMediaResolution,
|
|
11833
11874
|
ToolCall,
|
|
11834
11875
|
ToolResponse,
|
|
11876
|
+
CodeExecutionResult,
|
|
11877
|
+
ExecutableCode,
|
|
11835
11878
|
FileData,
|
|
11836
11879
|
PartialArg,
|
|
11837
11880
|
FunctionCall,
|
|
@@ -12019,6 +12062,7 @@ declare namespace types {
|
|
|
12019
12062
|
PreferenceOptimizationHyperParameters,
|
|
12020
12063
|
PreferenceOptimizationSpec,
|
|
12021
12064
|
DistillationHyperParameters,
|
|
12065
|
+
DistillationSamplingSpec,
|
|
12022
12066
|
DistillationSpec,
|
|
12023
12067
|
GoogleRpcStatus,
|
|
12024
12068
|
PreTunedModel,
|
|
@@ -12054,8 +12098,8 @@ declare namespace types {
|
|
|
12054
12098
|
FullFineTuningSpec,
|
|
12055
12099
|
VeoHyperParameters,
|
|
12056
12100
|
VeoTuningSpec,
|
|
12057
|
-
DistillationSamplingSpec,
|
|
12058
12101
|
TuningJobMetadata,
|
|
12102
|
+
VeoLoraTuningSpec,
|
|
12059
12103
|
TuningJob,
|
|
12060
12104
|
ListTuningJobsConfig,
|
|
12061
12105
|
ListTuningJobsParameters,
|
|
@@ -12873,10 +12917,26 @@ export declare interface VeoHyperParameters {
|
|
|
12873
12917
|
epochCount?: string;
|
|
12874
12918
|
/** Optional. Multiplier for adjusting the default learning rate. */
|
|
12875
12919
|
learningRateMultiplier?: number;
|
|
12876
|
-
/**
|
|
12920
|
+
/** The tuning task for Veo. */
|
|
12877
12921
|
tuningTask?: TuningTask;
|
|
12878
12922
|
/** Optional. The ratio of Google internal dataset to use in the training mixture, in range of `[0, 1)`. If `0.2`, it means 20% of Google internal dataset and 80% of user dataset will be used for training. If not set, the default value is 0.1. */
|
|
12879
12923
|
veoDataMixtureRatio?: number;
|
|
12924
|
+
/** Optional. The adapter size for LoRA tuning. */
|
|
12925
|
+
adapterSize?: AdapterSize;
|
|
12926
|
+
/** The speed of the tuning job. Only supported for Veo 3.0 models. */
|
|
12927
|
+
tuningSpeed?: TuningSpeed;
|
|
12928
|
+
}
|
|
12929
|
+
|
|
12930
|
+
/** Tuning Spec for Veo LoRA Model Tuning. This data type is not supported in Gemini API. */
|
|
12931
|
+
export declare interface VeoLoraTuningSpec {
|
|
12932
|
+
/** Optional. Hyperparameters for Veo LoRA. */
|
|
12933
|
+
hyperParameters?: VeoHyperParameters;
|
|
12934
|
+
/** 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. */
|
|
12935
|
+
trainingDatasetUri?: string;
|
|
12936
|
+
/** 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. */
|
|
12937
|
+
validationDatasetUri?: string;
|
|
12938
|
+
/** Optional. The orientation of the video. Defaults to LANDSCAPE. */
|
|
12939
|
+
videoOrientation?: VideoOrientation;
|
|
12880
12940
|
}
|
|
12881
12941
|
|
|
12882
12942
|
/** Tuning Spec for Veo Model Tuning. This data type is not supported in Gemini API. */
|
|
@@ -13064,6 +13124,22 @@ export declare interface VideoMetadata {
|
|
|
13064
13124
|
startOffset?: string;
|
|
13065
13125
|
}
|
|
13066
13126
|
|
|
13127
|
+
/** The orientation of the video. Defaults to LANDSCAPE. This enum is not supported in Gemini API. */
|
|
13128
|
+
export declare enum VideoOrientation {
|
|
13129
|
+
/**
|
|
13130
|
+
* Unspecified video orientation. Defaults to landscape.
|
|
13131
|
+
*/
|
|
13132
|
+
VIDEO_ORIENTATION_UNSPECIFIED = "VIDEO_ORIENTATION_UNSPECIFIED",
|
|
13133
|
+
/**
|
|
13134
|
+
* Landscape orientation (e.g. 16:9, 1280x720).
|
|
13135
|
+
*/
|
|
13136
|
+
LANDSCAPE = "LANDSCAPE",
|
|
13137
|
+
/**
|
|
13138
|
+
* Portrait orientation (e.g. 9:16, 720x1280).
|
|
13139
|
+
*/
|
|
13140
|
+
PORTRAIT = "PORTRAIT"
|
|
13141
|
+
}
|
|
13142
|
+
|
|
13067
13143
|
/** Voice activity signal. */
|
|
13068
13144
|
export declare interface VoiceActivity {
|
|
13069
13145
|
/** The type of the voice activity signal. */
|