@google/genai 1.7.0 → 1.9.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/README.md +43 -0
- package/dist/genai.d.ts +240 -22
- package/dist/index.cjs +373 -224
- package/dist/index.mjs +374 -225
- package/dist/index.mjs.map +1 -1
- package/dist/node/index.cjs +373 -223
- package/dist/node/index.mjs +374 -224
- package/dist/node/index.mjs.map +1 -1
- package/dist/node/node.d.ts +240 -22
- package/dist/web/index.mjs +374 -225
- package/dist/web/index.mjs.map +1 -1
- package/dist/web/web.d.ts +240 -22
- package/package.json +5 -5
package/dist/node/node.d.ts
CHANGED
|
@@ -66,6 +66,20 @@ export declare enum AdapterSize {
|
|
|
66
66
|
ADAPTER_SIZE_THIRTY_TWO = "ADAPTER_SIZE_THIRTY_TWO"
|
|
67
67
|
}
|
|
68
68
|
|
|
69
|
+
/** The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. */
|
|
70
|
+
export declare interface ApiAuth {
|
|
71
|
+
/** The API secret. */
|
|
72
|
+
apiKeyConfig?: ApiAuthApiKeyConfig;
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
/** The API secret. */
|
|
76
|
+
export declare interface ApiAuthApiKeyConfig {
|
|
77
|
+
/** Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} */
|
|
78
|
+
apiKeySecretVersion?: string;
|
|
79
|
+
/** The API key string. Either this or `api_key_secret_version` must be set. */
|
|
80
|
+
apiKeyString?: string;
|
|
81
|
+
}
|
|
82
|
+
|
|
69
83
|
/**
|
|
70
84
|
* The ApiClient class is used to send requests to the Gemini API or Vertex AI
|
|
71
85
|
* endpoints.
|
|
@@ -222,9 +236,26 @@ export declare interface ApiKeyConfig {
|
|
|
222
236
|
apiKeyString?: string;
|
|
223
237
|
}
|
|
224
238
|
|
|
239
|
+
/** The API spec that the external API implements. */
|
|
240
|
+
export declare enum ApiSpec {
|
|
241
|
+
/**
|
|
242
|
+
* Unspecified API spec. This value should not be used.
|
|
243
|
+
*/
|
|
244
|
+
API_SPEC_UNSPECIFIED = "API_SPEC_UNSPECIFIED",
|
|
245
|
+
/**
|
|
246
|
+
* Simple search API spec.
|
|
247
|
+
*/
|
|
248
|
+
SIMPLE_SEARCH = "SIMPLE_SEARCH",
|
|
249
|
+
/**
|
|
250
|
+
* Elastic search API spec.
|
|
251
|
+
*/
|
|
252
|
+
ELASTIC_SEARCH = "ELASTIC_SEARCH"
|
|
253
|
+
}
|
|
254
|
+
|
|
225
255
|
/** Representation of an audio chunk. */
|
|
226
256
|
export declare interface AudioChunk {
|
|
227
|
-
/** Raw
|
|
257
|
+
/** Raw bytes of audio data.
|
|
258
|
+
* @remarks Encoded as base64 string. */
|
|
228
259
|
data?: string;
|
|
229
260
|
/** MIME type of the audio chunk. */
|
|
230
261
|
mimeType?: string;
|
|
@@ -454,6 +485,18 @@ export declare class Batches extends BaseModule {
|
|
|
454
485
|
*/
|
|
455
486
|
cancel(params: types.CancelBatchJobParameters): Promise<void>;
|
|
456
487
|
private listInternal;
|
|
488
|
+
/**
|
|
489
|
+
* Deletes a batch job.
|
|
490
|
+
*
|
|
491
|
+
* @param params - The parameters for the delete request.
|
|
492
|
+
* @return The empty response returned by the API.
|
|
493
|
+
*
|
|
494
|
+
* @example
|
|
495
|
+
* ```ts
|
|
496
|
+
* await ai.batches.delete({name: '...'}); // The server-generated resource name.
|
|
497
|
+
* ```
|
|
498
|
+
*/
|
|
499
|
+
delete(params: types.DeleteBatchJobParameters): Promise<types.DeleteResourceJob>;
|
|
457
500
|
}
|
|
458
501
|
|
|
459
502
|
/** Config for batches.create return value. */
|
|
@@ -560,7 +603,8 @@ export declare enum Behavior {
|
|
|
560
603
|
declare interface Blob_2 {
|
|
561
604
|
/** Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is not currently used in the Gemini GenerateContent calls. */
|
|
562
605
|
displayName?: string;
|
|
563
|
-
/** Required. Raw bytes.
|
|
606
|
+
/** Required. Raw bytes.
|
|
607
|
+
* @remarks Encoded as base64 string. */
|
|
564
608
|
data?: string;
|
|
565
609
|
/** Required. The IANA standard MIME type of the source data. */
|
|
566
610
|
mimeType?: string;
|
|
@@ -590,7 +634,11 @@ export declare enum BlockedReason {
|
|
|
590
634
|
/**
|
|
591
635
|
* Candidates blocked due to prohibited content.
|
|
592
636
|
*/
|
|
593
|
-
PROHIBITED_CONTENT = "PROHIBITED_CONTENT"
|
|
637
|
+
PROHIBITED_CONTENT = "PROHIBITED_CONTENT",
|
|
638
|
+
/**
|
|
639
|
+
* Candidates blocked due to unsafe image generation content.
|
|
640
|
+
*/
|
|
641
|
+
IMAGE_SAFETY = "IMAGE_SAFETY"
|
|
594
642
|
}
|
|
595
643
|
|
|
596
644
|
/** A resource used in LLM queries for users to explicitly specify what to cache. */
|
|
@@ -956,7 +1004,7 @@ export declare interface CitationMetadata {
|
|
|
956
1004
|
citations?: Citation[];
|
|
957
1005
|
}
|
|
958
1006
|
|
|
959
|
-
/** Result of executing the [ExecutableCode].
|
|
1007
|
+
/** Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. */
|
|
960
1008
|
export declare interface CodeExecutionResult {
|
|
961
1009
|
/** Required. Outcome of the code execution. */
|
|
962
1010
|
outcome?: Outcome;
|
|
@@ -1444,6 +1492,30 @@ export declare interface DatasetStats {
|
|
|
1444
1492
|
userOutputTokenDistribution?: DatasetDistribution;
|
|
1445
1493
|
}
|
|
1446
1494
|
|
|
1495
|
+
/** Optional parameters for models.get method. */
|
|
1496
|
+
export declare interface DeleteBatchJobConfig {
|
|
1497
|
+
/** Used to override HTTP request options. */
|
|
1498
|
+
httpOptions?: HttpOptions;
|
|
1499
|
+
/** Abort signal which can be used to cancel the request.
|
|
1500
|
+
|
|
1501
|
+
NOTE: AbortSignal is a client-only operation. Using it to cancel an
|
|
1502
|
+
operation will not cancel the request in the service. You will still
|
|
1503
|
+
be charged usage for any applicable operations.
|
|
1504
|
+
*/
|
|
1505
|
+
abortSignal?: AbortSignal;
|
|
1506
|
+
}
|
|
1507
|
+
|
|
1508
|
+
/** Config for batches.delete parameters. */
|
|
1509
|
+
export declare interface DeleteBatchJobParameters {
|
|
1510
|
+
/** A fully-qualified BatchJob resource name or ID.
|
|
1511
|
+
Example: "projects/.../locations/.../batchPredictionJobs/456"
|
|
1512
|
+
or "456" when project and location are initialized in the client.
|
|
1513
|
+
*/
|
|
1514
|
+
name: string;
|
|
1515
|
+
/** Optional parameters for the request. */
|
|
1516
|
+
config?: DeleteBatchJobConfig;
|
|
1517
|
+
}
|
|
1518
|
+
|
|
1447
1519
|
/** Optional parameters for caches.delete method. */
|
|
1448
1520
|
export declare interface DeleteCachedContentConfig {
|
|
1449
1521
|
/** Used to override HTTP request options. */
|
|
@@ -1519,6 +1591,13 @@ export declare interface DeleteModelParameters {
|
|
|
1519
1591
|
export declare class DeleteModelResponse {
|
|
1520
1592
|
}
|
|
1521
1593
|
|
|
1594
|
+
/** The return value of delete operation. */
|
|
1595
|
+
export declare interface DeleteResourceJob {
|
|
1596
|
+
name?: string;
|
|
1597
|
+
done?: boolean;
|
|
1598
|
+
error?: JobError;
|
|
1599
|
+
}
|
|
1600
|
+
|
|
1522
1601
|
/** Statistics computed for datasets used for distillation. */
|
|
1523
1602
|
export declare interface DistillationDataStats {
|
|
1524
1603
|
/** Output only. Statistics computed for the training dataset. */
|
|
@@ -1803,7 +1882,19 @@ export declare enum EndSensitivity {
|
|
|
1803
1882
|
export declare interface EnterpriseWebSearch {
|
|
1804
1883
|
}
|
|
1805
1884
|
|
|
1806
|
-
/**
|
|
1885
|
+
/** Required. The environment being operated. */
|
|
1886
|
+
export declare enum Environment {
|
|
1887
|
+
/**
|
|
1888
|
+
* Defaults to browser.
|
|
1889
|
+
*/
|
|
1890
|
+
ENVIRONMENT_UNSPECIFIED = "ENVIRONMENT_UNSPECIFIED",
|
|
1891
|
+
/**
|
|
1892
|
+
* Operates in a web browser.
|
|
1893
|
+
*/
|
|
1894
|
+
ENVIRONMENT_BROWSER = "ENVIRONMENT_BROWSER"
|
|
1895
|
+
}
|
|
1896
|
+
|
|
1897
|
+
/** 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. */
|
|
1807
1898
|
export declare interface ExecutableCode {
|
|
1808
1899
|
/** Required. The code to be executed. */
|
|
1809
1900
|
code?: string;
|
|
@@ -1811,6 +1902,36 @@ export declare interface ExecutableCode {
|
|
|
1811
1902
|
language?: Language;
|
|
1812
1903
|
}
|
|
1813
1904
|
|
|
1905
|
+
/** Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. */
|
|
1906
|
+
export declare interface ExternalApi {
|
|
1907
|
+
/** The authentication config to access the API. Deprecated. Please use auth_config instead. */
|
|
1908
|
+
apiAuth?: ApiAuth;
|
|
1909
|
+
/** The API spec that the external API implements. */
|
|
1910
|
+
apiSpec?: ApiSpec;
|
|
1911
|
+
/** The authentication config to access the API. */
|
|
1912
|
+
authConfig?: AuthConfig;
|
|
1913
|
+
/** Parameters for the elastic search API. */
|
|
1914
|
+
elasticSearchParams?: ExternalApiElasticSearchParams;
|
|
1915
|
+
/** The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search */
|
|
1916
|
+
endpoint?: string;
|
|
1917
|
+
/** Parameters for the simple search API. */
|
|
1918
|
+
simpleSearchParams?: ExternalApiSimpleSearchParams;
|
|
1919
|
+
}
|
|
1920
|
+
|
|
1921
|
+
/** The search parameters to use for the ELASTIC_SEARCH spec. */
|
|
1922
|
+
export declare interface ExternalApiElasticSearchParams {
|
|
1923
|
+
/** The ElasticSearch index to use. */
|
|
1924
|
+
index?: string;
|
|
1925
|
+
/** Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. */
|
|
1926
|
+
numHits?: number;
|
|
1927
|
+
/** The ElasticSearch search template to use. */
|
|
1928
|
+
searchTemplate?: string;
|
|
1929
|
+
}
|
|
1930
|
+
|
|
1931
|
+
/** The search parameters to use for SIMPLE_SEARCH spec. */
|
|
1932
|
+
export declare interface ExternalApiSimpleSearchParams {
|
|
1933
|
+
}
|
|
1934
|
+
|
|
1814
1935
|
/** Options for feature selection preference. */
|
|
1815
1936
|
export declare enum FeatureSelectionPreference {
|
|
1816
1937
|
FEATURE_SELECTION_PREFERENCE_UNSPECIFIED = "FEATURE_SELECTION_PREFERENCE_UNSPECIFIED",
|
|
@@ -2746,6 +2867,8 @@ export declare interface GenerationConfig {
|
|
|
2746
2867
|
audioTimestamp?: boolean;
|
|
2747
2868
|
/** Optional. Number of candidates to generate. */
|
|
2748
2869
|
candidateCount?: number;
|
|
2870
|
+
/** Optional. If enabled, the model will detect emotions and adapt its responses accordingly. */
|
|
2871
|
+
enableAffectiveDialog?: boolean;
|
|
2749
2872
|
/** Optional. Frequency penalties. */
|
|
2750
2873
|
frequencyPenalty?: number;
|
|
2751
2874
|
/** Optional. Logit probabilities. */
|
|
@@ -2756,6 +2879,8 @@ export declare interface GenerationConfig {
|
|
|
2756
2879
|
mediaResolution?: MediaResolution;
|
|
2757
2880
|
/** Optional. Positive penalties. */
|
|
2758
2881
|
presencePenalty?: number;
|
|
2882
|
+
/** Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. */
|
|
2883
|
+
responseJsonSchema?: unknown;
|
|
2759
2884
|
/** Optional. If true, export the logprobs results in response. */
|
|
2760
2885
|
responseLogprobs?: boolean;
|
|
2761
2886
|
/** Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. */
|
|
@@ -2764,8 +2889,6 @@ export declare interface GenerationConfig {
|
|
|
2764
2889
|
responseModalities?: Modality[];
|
|
2765
2890
|
/** Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema 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. */
|
|
2766
2891
|
responseSchema?: Schema;
|
|
2767
|
-
/** Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. */
|
|
2768
|
-
responseJsonSchema?: unknown;
|
|
2769
2892
|
/** Optional. Routing configuration. */
|
|
2770
2893
|
routingConfig?: GenerationConfigRoutingConfig;
|
|
2771
2894
|
/** Optional. Seed. */
|
|
@@ -3150,7 +3273,7 @@ export declare interface GroundingMetadata {
|
|
|
3150
3273
|
|
|
3151
3274
|
/** Grounding support. */
|
|
3152
3275
|
export declare interface GroundingSupport {
|
|
3153
|
-
/** Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident.
|
|
3276
|
+
/** Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. For Gemini 2.0 and before, this list must have the same size as the grounding_chunk_indices. For Gemini 2.5 and after, this list will be empty and should be ignored. */
|
|
3154
3277
|
confidenceScores?: number[];
|
|
3155
3278
|
/** A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim. */
|
|
3156
3279
|
groundingChunkIndices?: number[];
|
|
@@ -3227,7 +3350,23 @@ export declare enum HarmCategory {
|
|
|
3227
3350
|
/**
|
|
3228
3351
|
* Deprecated: Election filter is not longer supported. The harm category is civic integrity.
|
|
3229
3352
|
*/
|
|
3230
|
-
HARM_CATEGORY_CIVIC_INTEGRITY = "HARM_CATEGORY_CIVIC_INTEGRITY"
|
|
3353
|
+
HARM_CATEGORY_CIVIC_INTEGRITY = "HARM_CATEGORY_CIVIC_INTEGRITY",
|
|
3354
|
+
/**
|
|
3355
|
+
* The harm category is image hate.
|
|
3356
|
+
*/
|
|
3357
|
+
HARM_CATEGORY_IMAGE_HATE = "HARM_CATEGORY_IMAGE_HATE",
|
|
3358
|
+
/**
|
|
3359
|
+
* The harm category is image dangerous content.
|
|
3360
|
+
*/
|
|
3361
|
+
HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT = "HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT",
|
|
3362
|
+
/**
|
|
3363
|
+
* The harm category is image harassment.
|
|
3364
|
+
*/
|
|
3365
|
+
HARM_CATEGORY_IMAGE_HARASSMENT = "HARM_CATEGORY_IMAGE_HARASSMENT",
|
|
3366
|
+
/**
|
|
3367
|
+
* The harm category is image sexually explicit content.
|
|
3368
|
+
*/
|
|
3369
|
+
HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT = "HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT"
|
|
3231
3370
|
}
|
|
3232
3371
|
|
|
3233
3372
|
/** Output only. Harm probability levels in the content. */
|
|
@@ -3361,7 +3500,8 @@ declare interface Image_2 {
|
|
|
3361
3500
|
gcsUri?: string;
|
|
3362
3501
|
/** The image bytes data. ``Image`` can contain a value for this field
|
|
3363
3502
|
or the ``gcs_uri`` field but not both.
|
|
3364
|
-
|
|
3503
|
+
|
|
3504
|
+
* @remarks Encoded as base64 string. */
|
|
3365
3505
|
imageBytes?: string;
|
|
3366
3506
|
/** The MIME type of the image. */
|
|
3367
3507
|
mimeType?: string;
|
|
@@ -3370,11 +3510,38 @@ export { Image_2 as Image }
|
|
|
3370
3510
|
|
|
3371
3511
|
/** Enum that specifies the language of the text in the prompt. */
|
|
3372
3512
|
export declare enum ImagePromptLanguage {
|
|
3513
|
+
/**
|
|
3514
|
+
* Auto-detect the language.
|
|
3515
|
+
*/
|
|
3373
3516
|
auto = "auto",
|
|
3517
|
+
/**
|
|
3518
|
+
* English
|
|
3519
|
+
*/
|
|
3374
3520
|
en = "en",
|
|
3521
|
+
/**
|
|
3522
|
+
* Japanese
|
|
3523
|
+
*/
|
|
3375
3524
|
ja = "ja",
|
|
3525
|
+
/**
|
|
3526
|
+
* Korean
|
|
3527
|
+
*/
|
|
3376
3528
|
ko = "ko",
|
|
3377
|
-
|
|
3529
|
+
/**
|
|
3530
|
+
* Hindi
|
|
3531
|
+
*/
|
|
3532
|
+
hi = "hi",
|
|
3533
|
+
/**
|
|
3534
|
+
* Chinese
|
|
3535
|
+
*/
|
|
3536
|
+
zh = "zh",
|
|
3537
|
+
/**
|
|
3538
|
+
* Portuguese
|
|
3539
|
+
*/
|
|
3540
|
+
pt = "pt",
|
|
3541
|
+
/**
|
|
3542
|
+
* Spanish
|
|
3543
|
+
*/
|
|
3544
|
+
es = "es"
|
|
3378
3545
|
}
|
|
3379
3546
|
|
|
3380
3547
|
/** Config for inlined request. */
|
|
@@ -3672,7 +3839,7 @@ export declare class Live {
|
|
|
3672
3839
|
if (GOOGLE_GENAI_USE_VERTEXAI) {
|
|
3673
3840
|
model = 'gemini-2.0-flash-live-preview-04-09';
|
|
3674
3841
|
} else {
|
|
3675
|
-
model = 'gemini-2.
|
|
3842
|
+
model = 'gemini-live-2.5-flash-preview';
|
|
3676
3843
|
}
|
|
3677
3844
|
const session = await ai.live.connect({
|
|
3678
3845
|
model: model,
|
|
@@ -4373,6 +4540,8 @@ export declare interface LiveServerSessionResumptionUpdate {
|
|
|
4373
4540
|
}
|
|
4374
4541
|
|
|
4375
4542
|
export declare interface LiveServerSetupComplete {
|
|
4543
|
+
/** The session id of the live session. */
|
|
4544
|
+
sessionId?: string;
|
|
4376
4545
|
}
|
|
4377
4546
|
|
|
4378
4547
|
/** Request for the client to execute the `function_calls` and return the responses with the matching `id`s. */
|
|
@@ -4636,6 +4805,14 @@ export declare class Models extends BaseModule {
|
|
|
4636
4805
|
* ```
|
|
4637
4806
|
*/
|
|
4638
4807
|
generateContent: (params: types.GenerateContentParameters) => Promise<types.GenerateContentResponse>;
|
|
4808
|
+
/**
|
|
4809
|
+
* This logic is needed for GenerateContentConfig only.
|
|
4810
|
+
* Previously we made GenerateContentConfig.responseSchema field to accept
|
|
4811
|
+
* unknown. Since v1.9.0, we switch to use backend JSON schema support.
|
|
4812
|
+
* To maintain backward compatibility, we move the data that was treated as
|
|
4813
|
+
* JSON schema from the responseSchema field to the responseJsonSchema field.
|
|
4814
|
+
*/
|
|
4815
|
+
private maybeMoveToResponseJsonSchem;
|
|
4639
4816
|
/**
|
|
4640
4817
|
* Makes an API request to generate content with a given model and yields the
|
|
4641
4818
|
* response in chunks.
|
|
@@ -5106,7 +5283,8 @@ export declare interface Part {
|
|
|
5106
5283
|
inlineData?: Blob_2;
|
|
5107
5284
|
/** Optional. URI based data. */
|
|
5108
5285
|
fileData?: FileData;
|
|
5109
|
-
/** An opaque signature for the thought so it can be reused in subsequent requests.
|
|
5286
|
+
/** An opaque signature for the thought so it can be reused in subsequent requests.
|
|
5287
|
+
* @remarks Encoded as base64 string. */
|
|
5110
5288
|
thoughtSignature?: string;
|
|
5111
5289
|
/** Optional. Result of executing the [ExecutableCode]. */
|
|
5112
5290
|
codeExecutionResult?: CodeExecutionResult;
|
|
@@ -5311,6 +5489,8 @@ export declare class ReplayResponse {
|
|
|
5311
5489
|
export declare interface Retrieval {
|
|
5312
5490
|
/** Optional. Deprecated. This option is no longer supported. */
|
|
5313
5491
|
disableAttribution?: boolean;
|
|
5492
|
+
/** Use data source powered by external API for grounding. */
|
|
5493
|
+
externalApi?: ExternalApi;
|
|
5314
5494
|
/** Set to use data source powered by Vertex AI Search. */
|
|
5315
5495
|
vertexAiSearch?: VertexAISearch;
|
|
5316
5496
|
/** Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. */
|
|
@@ -5359,6 +5539,8 @@ export declare interface SafetyRating {
|
|
|
5359
5539
|
blocked?: boolean;
|
|
5360
5540
|
/** Output only. Harm category. */
|
|
5361
5541
|
category?: HarmCategory;
|
|
5542
|
+
/** Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold. */
|
|
5543
|
+
overwrittenThreshold?: HarmBlockThreshold;
|
|
5362
5544
|
/** Output only. Harm probability levels in the content. */
|
|
5363
5545
|
probability?: HarmProbability;
|
|
5364
5546
|
/** Output only. Harm probability score. */
|
|
@@ -5495,7 +5677,8 @@ export declare type SchemaUnion = Schema | unknown;
|
|
|
5495
5677
|
export declare interface SearchEntryPoint {
|
|
5496
5678
|
/** Optional. Web content snippet that can be embedded in a web page or an app webview. */
|
|
5497
5679
|
renderedContent?: string;
|
|
5498
|
-
/** Optional. Base64 encoded JSON representing array of tuple.
|
|
5680
|
+
/** Optional. Base64 encoded JSON representing array of tuple.
|
|
5681
|
+
* @remarks Encoded as base64 string. */
|
|
5499
5682
|
sdkBlob?: string;
|
|
5500
5683
|
}
|
|
5501
5684
|
|
|
@@ -5642,7 +5825,7 @@ export declare class Session {
|
|
|
5642
5825
|
if (GOOGLE_GENAI_USE_VERTEXAI) {
|
|
5643
5826
|
model = 'gemini-2.0-flash-live-preview-04-09';
|
|
5644
5827
|
} else {
|
|
5645
|
-
model = 'gemini-2.
|
|
5828
|
+
model = 'gemini-live-2.5-flash-preview';
|
|
5646
5829
|
}
|
|
5647
5830
|
const session = await ai.live.connect({
|
|
5648
5831
|
model: model,
|
|
@@ -5816,7 +5999,7 @@ export declare interface SupervisedHyperParameters {
|
|
|
5816
5999
|
adapterSize?: AdapterSize;
|
|
5817
6000
|
/** Optional. Number of complete passes the model makes over the entire training dataset during training. */
|
|
5818
6001
|
epochCount?: string;
|
|
5819
|
-
/** Optional. Multiplier for adjusting the default learning rate. */
|
|
6002
|
+
/** Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with `learning_rate`. */
|
|
5820
6003
|
learningRateMultiplier?: number;
|
|
5821
6004
|
}
|
|
5822
6005
|
|
|
@@ -5886,9 +6069,9 @@ export declare interface SupervisedTuningSpec {
|
|
|
5886
6069
|
exportLastCheckpointOnly?: boolean;
|
|
5887
6070
|
/** Optional. Hyperparameters for SFT. */
|
|
5888
6071
|
hyperParameters?: SupervisedHyperParameters;
|
|
5889
|
-
/** Required.
|
|
6072
|
+
/** 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. */
|
|
5890
6073
|
trainingDatasetUri?: string;
|
|
5891
|
-
/** Optional.
|
|
6074
|
+
/** 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. */
|
|
5892
6075
|
validationDatasetUri?: string;
|
|
5893
6076
|
}
|
|
5894
6077
|
|
|
@@ -5937,14 +6120,20 @@ export declare class Tokens extends BaseModule {
|
|
|
5937
6120
|
* @experimental
|
|
5938
6121
|
*
|
|
5939
6122
|
* @remarks
|
|
5940
|
-
*
|
|
6123
|
+
* Ephemeral auth tokens is only supported in the Gemini Developer API.
|
|
5941
6124
|
* It can be used for the session connection to the Live constrained API.
|
|
6125
|
+
* Support in v1alpha only.
|
|
5942
6126
|
*
|
|
5943
6127
|
* @param params - The parameters for the create request.
|
|
5944
6128
|
* @return The created auth token.
|
|
5945
6129
|
*
|
|
5946
6130
|
* @example
|
|
5947
6131
|
* ```ts
|
|
6132
|
+
* const ai = new GoogleGenAI({
|
|
6133
|
+
* apiKey: token.name,
|
|
6134
|
+
* httpOptions: { apiVersion: 'v1alpha' } // Support in v1alpha only.
|
|
6135
|
+
* });
|
|
6136
|
+
*
|
|
5948
6137
|
* // Case 1: If LiveEphemeralParameters is unset, unlock LiveConnectConfig
|
|
5949
6138
|
* // when using the token in Live API sessions. Each session connection can
|
|
5950
6139
|
* // use a different configuration.
|
|
@@ -6017,7 +6206,8 @@ export declare interface TokensInfo {
|
|
|
6017
6206
|
role?: string;
|
|
6018
6207
|
/** A list of token ids from the input. */
|
|
6019
6208
|
tokenIds?: string[];
|
|
6020
|
-
/** A list of tokens from the input.
|
|
6209
|
+
/** A list of tokens from the input.
|
|
6210
|
+
* @remarks Encoded as base64 string. */
|
|
6021
6211
|
tokens?: string[];
|
|
6022
6212
|
}
|
|
6023
6213
|
|
|
@@ -6042,12 +6232,20 @@ export declare interface Tool {
|
|
|
6042
6232
|
urlContext?: UrlContext;
|
|
6043
6233
|
/** Optional. CodeExecution tool type. Enables the model to execute code as part of generation. */
|
|
6044
6234
|
codeExecution?: ToolCodeExecution;
|
|
6235
|
+
/** Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. */
|
|
6236
|
+
computerUse?: ToolComputerUse;
|
|
6045
6237
|
}
|
|
6046
6238
|
|
|
6047
6239
|
/** 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. */
|
|
6048
6240
|
export declare interface ToolCodeExecution {
|
|
6049
6241
|
}
|
|
6050
6242
|
|
|
6243
|
+
/** Tool to support computer use. */
|
|
6244
|
+
export declare interface ToolComputerUse {
|
|
6245
|
+
/** Required. The environment being operated. */
|
|
6246
|
+
environment?: Environment;
|
|
6247
|
+
}
|
|
6248
|
+
|
|
6051
6249
|
/** Tool config.
|
|
6052
6250
|
|
|
6053
6251
|
This config is shared for all tools provided in the request.
|
|
@@ -6131,6 +6329,8 @@ export declare interface TunedModelInfo {
|
|
|
6131
6329
|
export declare interface TuningDataset {
|
|
6132
6330
|
/** GCS URI of the file containing training dataset in JSONL format. */
|
|
6133
6331
|
gcsUri?: string;
|
|
6332
|
+
/** The resource name of the Vertex Multimodal Dataset that is used as training dataset. Example: 'projects/my-project-id-or-number/locations/my-location/datasets/my-dataset-id'. */
|
|
6333
|
+
vertexDatasetResource?: string;
|
|
6134
6334
|
/** Inline examples with simple input/output text. */
|
|
6135
6335
|
examples?: TuningExample[];
|
|
6136
6336
|
}
|
|
@@ -6188,6 +6388,10 @@ export declare interface TuningJob {
|
|
|
6188
6388
|
labels?: Record<string, string>;
|
|
6189
6389
|
/** Output only. The resource name of the PipelineJob associated with the TuningJob. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`. */
|
|
6190
6390
|
pipelineJob?: string;
|
|
6391
|
+
/** Output only. Reserved for future use. */
|
|
6392
|
+
satisfiesPzi?: boolean;
|
|
6393
|
+
/** Output only. Reserved for future use. */
|
|
6394
|
+
satisfiesPzs?: boolean;
|
|
6191
6395
|
/** 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. */
|
|
6192
6396
|
serviceAccount?: string;
|
|
6193
6397
|
/** Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. */
|
|
@@ -6236,6 +6440,8 @@ declare class Tunings extends BaseModule {
|
|
|
6236
6440
|
export declare interface TuningValidationDataset {
|
|
6237
6441
|
/** GCS URI of the file containing validation dataset in JSONL format. */
|
|
6238
6442
|
gcsUri?: string;
|
|
6443
|
+
/** The resource name of the Vertex Multimodal Dataset that is used as training dataset. Example: 'projects/my-project-id-or-number/locations/my-location/datasets/my-dataset-id'. */
|
|
6444
|
+
vertexDatasetResource?: string;
|
|
6239
6445
|
}
|
|
6240
6446
|
|
|
6241
6447
|
/** Options about which input is included in the user's turn. */
|
|
@@ -6309,6 +6515,9 @@ declare namespace types {
|
|
|
6309
6515
|
HarmBlockThreshold,
|
|
6310
6516
|
Mode,
|
|
6311
6517
|
AuthType,
|
|
6518
|
+
ApiSpec,
|
|
6519
|
+
Environment,
|
|
6520
|
+
UrlRetrievalStatus,
|
|
6312
6521
|
FinishReason,
|
|
6313
6522
|
HarmProbability,
|
|
6314
6523
|
HarmSeverity,
|
|
@@ -6322,7 +6531,6 @@ declare namespace types {
|
|
|
6322
6531
|
Behavior,
|
|
6323
6532
|
DynamicRetrievalConfigMode,
|
|
6324
6533
|
FunctionCallingConfigMode,
|
|
6325
|
-
UrlRetrievalStatus,
|
|
6326
6534
|
SafetyFilterLevel,
|
|
6327
6535
|
PersonGeneration,
|
|
6328
6536
|
ImagePromptLanguage,
|
|
@@ -6368,6 +6576,11 @@ declare namespace types {
|
|
|
6368
6576
|
AuthConfig,
|
|
6369
6577
|
GoogleMaps,
|
|
6370
6578
|
UrlContext,
|
|
6579
|
+
ApiAuthApiKeyConfig,
|
|
6580
|
+
ApiAuth,
|
|
6581
|
+
ExternalApiElasticSearchParams,
|
|
6582
|
+
ExternalApiSimpleSearchParams,
|
|
6583
|
+
ExternalApi,
|
|
6371
6584
|
VertexAISearchDataStoreSpec,
|
|
6372
6585
|
VertexAISearch,
|
|
6373
6586
|
VertexRagStoreRagResource,
|
|
@@ -6380,6 +6593,7 @@ declare namespace types {
|
|
|
6380
6593
|
VertexRagStore,
|
|
6381
6594
|
Retrieval,
|
|
6382
6595
|
ToolCodeExecution,
|
|
6596
|
+
ToolComputerUse,
|
|
6383
6597
|
Tool,
|
|
6384
6598
|
FunctionCallingConfig,
|
|
6385
6599
|
LatLng,
|
|
@@ -6544,6 +6758,9 @@ declare namespace types {
|
|
|
6544
6758
|
ListBatchJobsConfig,
|
|
6545
6759
|
ListBatchJobsParameters,
|
|
6546
6760
|
ListBatchJobsResponse,
|
|
6761
|
+
DeleteBatchJobConfig,
|
|
6762
|
+
DeleteBatchJobParameters,
|
|
6763
|
+
DeleteResourceJob,
|
|
6547
6764
|
GetOperationConfig,
|
|
6548
6765
|
GetOperationParameters,
|
|
6549
6766
|
FetchPredictOperationConfig,
|
|
@@ -6892,7 +7109,8 @@ export declare interface VertexRagStoreRagResource {
|
|
|
6892
7109
|
export declare interface Video {
|
|
6893
7110
|
/** Path to another storage. */
|
|
6894
7111
|
uri?: string;
|
|
6895
|
-
/** Video bytes.
|
|
7112
|
+
/** Video bytes.
|
|
7113
|
+
* @remarks Encoded as base64 string. */
|
|
6896
7114
|
videoBytes?: string;
|
|
6897
7115
|
/** Video encoding, for example "video/mp4". */
|
|
6898
7116
|
mimeType?: string;
|