@google/genai 1.25.0 → 1.27.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 +139 -116
- package/dist/index.cjs +96 -115
- package/dist/index.mjs +96 -115
- package/dist/index.mjs.map +1 -1
- package/dist/node/index.cjs +100 -120
- package/dist/node/index.mjs +100 -120
- package/dist/node/index.mjs.map +1 -1
- package/dist/node/node.d.ts +139 -116
- package/dist/web/index.mjs +96 -115
- package/dist/web/index.mjs.map +1 -1
- package/dist/web/web.d.ts +139 -116
- package/package.json +13 -12
package/dist/node/node.d.ts
CHANGED
|
@@ -64,13 +64,13 @@ export declare enum AdapterSize {
|
|
|
64
64
|
ADAPTER_SIZE_THIRTY_TWO = "ADAPTER_SIZE_THIRTY_TWO"
|
|
65
65
|
}
|
|
66
66
|
|
|
67
|
-
/** The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. */
|
|
67
|
+
/** The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. This data type is not supported in Gemini API. */
|
|
68
68
|
export declare interface ApiAuth {
|
|
69
69
|
/** The API secret. */
|
|
70
70
|
apiKeyConfig?: ApiAuthApiKeyConfig;
|
|
71
71
|
}
|
|
72
72
|
|
|
73
|
-
/** The API secret. */
|
|
73
|
+
/** The API secret. This data type is not supported in Gemini API. */
|
|
74
74
|
export declare interface ApiAuthApiKeyConfig {
|
|
75
75
|
/** Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} */
|
|
76
76
|
apiKeySecretVersion?: string;
|
|
@@ -278,8 +278,9 @@ declare interface Auth {
|
|
|
278
278
|
* Sets the headers needed to authenticate with the API service.
|
|
279
279
|
*
|
|
280
280
|
* @param headers - The Headers object that will be updated with the authentication headers.
|
|
281
|
+
* @param url - The URL of the request.
|
|
281
282
|
*/
|
|
282
|
-
addAuthHeaders(headers: Headers): Promise<void>;
|
|
283
|
+
addAuthHeaders(headers: Headers, url?: string): Promise<void>;
|
|
283
284
|
}
|
|
284
285
|
|
|
285
286
|
/** Auth configuration to run the extension. */
|
|
@@ -298,19 +299,19 @@ export declare interface AuthConfig {
|
|
|
298
299
|
oidcConfig?: AuthConfigOidcConfig;
|
|
299
300
|
}
|
|
300
301
|
|
|
301
|
-
/** Config for Google Service Account Authentication. */
|
|
302
|
+
/** Config for Google Service Account Authentication. This data type is not supported in Gemini API. */
|
|
302
303
|
export declare interface AuthConfigGoogleServiceAccountConfig {
|
|
303
304
|
/** Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. */
|
|
304
305
|
serviceAccount?: string;
|
|
305
306
|
}
|
|
306
307
|
|
|
307
|
-
/** Config for HTTP Basic Authentication. */
|
|
308
|
+
/** Config for HTTP Basic Authentication. This data type is not supported in Gemini API. */
|
|
308
309
|
export declare interface AuthConfigHttpBasicAuthConfig {
|
|
309
310
|
/** Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. */
|
|
310
311
|
credentialSecret?: string;
|
|
311
312
|
}
|
|
312
313
|
|
|
313
|
-
/** Config for user oauth. */
|
|
314
|
+
/** Config for user oauth. This data type is not supported in Gemini API. */
|
|
314
315
|
export declare interface AuthConfigOauthConfig {
|
|
315
316
|
/** Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. */
|
|
316
317
|
accessToken?: string;
|
|
@@ -318,7 +319,7 @@ export declare interface AuthConfigOauthConfig {
|
|
|
318
319
|
serviceAccount?: string;
|
|
319
320
|
}
|
|
320
321
|
|
|
321
|
-
/** Config for user OIDC auth. */
|
|
322
|
+
/** Config for user OIDC auth. This data type is not supported in Gemini API. */
|
|
322
323
|
export declare interface AuthConfigOidcConfig {
|
|
323
324
|
/** OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. */
|
|
324
325
|
idToken?: string;
|
|
@@ -646,32 +647,40 @@ export { Blob_2 as Blob }
|
|
|
646
647
|
|
|
647
648
|
export declare type BlobImageUnion = Blob_2;
|
|
648
649
|
|
|
649
|
-
/** Output only.
|
|
650
|
+
/** Output only. The reason why the prompt was blocked. */
|
|
650
651
|
export declare enum BlockedReason {
|
|
651
652
|
/**
|
|
652
|
-
*
|
|
653
|
+
* The blocked reason is unspecified.
|
|
653
654
|
*/
|
|
654
655
|
BLOCKED_REASON_UNSPECIFIED = "BLOCKED_REASON_UNSPECIFIED",
|
|
655
656
|
/**
|
|
656
|
-
*
|
|
657
|
+
* The prompt was blocked for safety reasons.
|
|
657
658
|
*/
|
|
658
659
|
SAFETY = "SAFETY",
|
|
659
660
|
/**
|
|
660
|
-
*
|
|
661
|
+
* The prompt was blocked for other reasons. For example, it may be due to the prompt's language, or because it contains other harmful content.
|
|
661
662
|
*/
|
|
662
663
|
OTHER = "OTHER",
|
|
663
664
|
/**
|
|
664
|
-
*
|
|
665
|
+
* The prompt was blocked because it contains a term from the terminology blocklist.
|
|
665
666
|
*/
|
|
666
667
|
BLOCKLIST = "BLOCKLIST",
|
|
667
668
|
/**
|
|
668
|
-
*
|
|
669
|
+
* The prompt was blocked because it contains prohibited content.
|
|
669
670
|
*/
|
|
670
671
|
PROHIBITED_CONTENT = "PROHIBITED_CONTENT",
|
|
671
672
|
/**
|
|
672
|
-
*
|
|
673
|
+
* The prompt was blocked because it contains content that is unsafe for image generation.
|
|
673
674
|
*/
|
|
674
|
-
IMAGE_SAFETY = "IMAGE_SAFETY"
|
|
675
|
+
IMAGE_SAFETY = "IMAGE_SAFETY",
|
|
676
|
+
/**
|
|
677
|
+
* The prompt was blocked by Model Armor. This enum value is not supported in Gemini API.
|
|
678
|
+
*/
|
|
679
|
+
MODEL_ARMOR = "MODEL_ARMOR",
|
|
680
|
+
/**
|
|
681
|
+
* The prompt was blocked as a jailbreak attempt. This enum value is not supported in Gemini API.
|
|
682
|
+
*/
|
|
683
|
+
JAILBREAK = "JAILBREAK"
|
|
675
684
|
}
|
|
676
685
|
|
|
677
686
|
/** A resource used in LLM queries for users to explicitly specify what to cache. */
|
|
@@ -694,15 +703,15 @@ export declare interface CachedContent {
|
|
|
694
703
|
|
|
695
704
|
/** Metadata on the usage of the cached content. */
|
|
696
705
|
export declare interface CachedContentUsageMetadata {
|
|
697
|
-
/** Duration of audio in seconds. */
|
|
706
|
+
/** Duration of audio in seconds. This field is not supported in Gemini API. */
|
|
698
707
|
audioDurationSeconds?: number;
|
|
699
|
-
/** Number of images. */
|
|
708
|
+
/** Number of images. This field is not supported in Gemini API. */
|
|
700
709
|
imageCount?: number;
|
|
701
|
-
/** Number of text characters. */
|
|
710
|
+
/** Number of text characters. This field is not supported in Gemini API. */
|
|
702
711
|
textCount?: number;
|
|
703
712
|
/** Total number of tokens that the cached content consumes. */
|
|
704
713
|
totalTokenCount?: number;
|
|
705
|
-
/** Duration of video in seconds. */
|
|
714
|
+
/** Duration of video in seconds. This field is not supported in Gemini API. */
|
|
706
715
|
videoDurationSeconds?: number;
|
|
707
716
|
}
|
|
708
717
|
|
|
@@ -1033,7 +1042,7 @@ export declare interface Checkpoint {
|
|
|
1033
1042
|
step?: string;
|
|
1034
1043
|
}
|
|
1035
1044
|
|
|
1036
|
-
/** Source attributions for content. */
|
|
1045
|
+
/** Source attributions for content. This data type is not supported in Gemini API. */
|
|
1037
1046
|
export declare interface Citation {
|
|
1038
1047
|
/** Output only. End index into the content. */
|
|
1039
1048
|
endIndex?: number;
|
|
@@ -1530,7 +1539,7 @@ export declare interface CreateTuningJobConfig {
|
|
|
1530
1539
|
be charged usage for any applicable operations.
|
|
1531
1540
|
*/
|
|
1532
1541
|
abortSignal?: AbortSignal;
|
|
1533
|
-
/**
|
|
1542
|
+
/** Validation dataset for tuning. The dataset must be formatted as a JSONL file. */
|
|
1534
1543
|
validationDataset?: TuningValidationDataset;
|
|
1535
1544
|
/** The display name of the tuned Model. The name can be up to 128 characters long and can consist of any UTF-8 characters. */
|
|
1536
1545
|
tunedModelDisplayName?: string;
|
|
@@ -1581,7 +1590,7 @@ export declare interface CreateTuningJobParametersPrivate {
|
|
|
1581
1590
|
*/
|
|
1582
1591
|
export declare function createUserContent(partOrString: PartListUnion | string): Content;
|
|
1583
1592
|
|
|
1584
|
-
/** Distribution computed over a tuning dataset. */
|
|
1593
|
+
/** Distribution computed over a tuning dataset. This data type is not supported in Gemini API. */
|
|
1585
1594
|
export declare interface DatasetDistribution {
|
|
1586
1595
|
/** Output only. Defines the histogram bucket. */
|
|
1587
1596
|
buckets?: DatasetDistributionDistributionBucket[];
|
|
@@ -1601,7 +1610,7 @@ export declare interface DatasetDistribution {
|
|
|
1601
1610
|
sum?: number;
|
|
1602
1611
|
}
|
|
1603
1612
|
|
|
1604
|
-
/** Dataset bucket used to create a histogram for the distribution given a population of values. */
|
|
1613
|
+
/** Dataset bucket used to create a histogram for the distribution given a population of values. This data type is not supported in Gemini API. */
|
|
1605
1614
|
export declare interface DatasetDistributionDistributionBucket {
|
|
1606
1615
|
/** Output only. Number of values in the bucket. */
|
|
1607
1616
|
count?: string;
|
|
@@ -1611,7 +1620,7 @@ export declare interface DatasetDistributionDistributionBucket {
|
|
|
1611
1620
|
right?: number;
|
|
1612
1621
|
}
|
|
1613
1622
|
|
|
1614
|
-
/** Statistics computed over a tuning dataset. */
|
|
1623
|
+
/** Statistics computed over a tuning dataset. This data type is not supported in Gemini API. */
|
|
1615
1624
|
export declare interface DatasetStats {
|
|
1616
1625
|
/** Output only. Number of billable characters in the tuning dataset. */
|
|
1617
1626
|
totalBillableCharacterCount?: string;
|
|
@@ -1745,7 +1754,7 @@ export declare interface DeleteResourceJob {
|
|
|
1745
1754
|
error?: JobError;
|
|
1746
1755
|
}
|
|
1747
1756
|
|
|
1748
|
-
/** Statistics computed for datasets used for distillation. */
|
|
1757
|
+
/** Statistics computed for datasets used for distillation. This data type is not supported in Gemini API. */
|
|
1749
1758
|
export declare interface DistillationDataStats {
|
|
1750
1759
|
/** Output only. Statistics computed for the training dataset. */
|
|
1751
1760
|
trainingDatasetStats?: DatasetStats;
|
|
@@ -1982,7 +1991,7 @@ export declare interface EmbeddingsBatchJobSource {
|
|
|
1982
1991
|
inlinedRequests?: EmbedContentBatch;
|
|
1983
1992
|
}
|
|
1984
1993
|
|
|
1985
|
-
/** Represents a customer-managed encryption key spec that can be applied to a top-level resource. */
|
|
1994
|
+
/** Represents a customer-managed encryption key spec that can be applied to a top-level resource. This data type is not supported in Gemini API. */
|
|
1986
1995
|
export declare interface EncryptionSpec {
|
|
1987
1996
|
/** Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created. */
|
|
1988
1997
|
kmsKeyName?: string;
|
|
@@ -2046,7 +2055,7 @@ export declare interface ExecutableCode {
|
|
|
2046
2055
|
language?: Language;
|
|
2047
2056
|
}
|
|
2048
2057
|
|
|
2049
|
-
/** 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. */
|
|
2058
|
+
/** 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. This data type is not supported in Gemini API. */
|
|
2050
2059
|
export declare interface ExternalApi {
|
|
2051
2060
|
/** The authentication config to access the API. Deprecated. Please use auth_config instead. */
|
|
2052
2061
|
apiAuth?: ApiAuth;
|
|
@@ -2062,7 +2071,7 @@ export declare interface ExternalApi {
|
|
|
2062
2071
|
simpleSearchParams?: ExternalApiSimpleSearchParams;
|
|
2063
2072
|
}
|
|
2064
2073
|
|
|
2065
|
-
/** The search parameters to use for the ELASTIC_SEARCH spec. */
|
|
2074
|
+
/** The search parameters to use for the ELASTIC_SEARCH spec. This data type is not supported in Gemini API. */
|
|
2066
2075
|
export declare interface ExternalApiElasticSearchParams {
|
|
2067
2076
|
/** The ElasticSearch index to use. */
|
|
2068
2077
|
index?: string;
|
|
@@ -2072,7 +2081,7 @@ export declare interface ExternalApiElasticSearchParams {
|
|
|
2072
2081
|
searchTemplate?: string;
|
|
2073
2082
|
}
|
|
2074
2083
|
|
|
2075
|
-
/** The search parameters to use for SIMPLE_SEARCH spec. */
|
|
2084
|
+
/** The search parameters to use for SIMPLE_SEARCH spec. This data type is not supported in Gemini API. */
|
|
2076
2085
|
export declare interface ExternalApiSimpleSearchParams {
|
|
2077
2086
|
}
|
|
2078
2087
|
|
|
@@ -2509,7 +2518,7 @@ export declare enum FunctionResponseScheduling {
|
|
|
2509
2518
|
INTERRUPT = "INTERRUPT"
|
|
2510
2519
|
}
|
|
2511
2520
|
|
|
2512
|
-
/** Input example for preference optimization. */
|
|
2521
|
+
/** Input example for preference optimization. This data type is not supported in Gemini API. */
|
|
2513
2522
|
export declare interface GeminiPreferenceExample {
|
|
2514
2523
|
/** List of completions for a given prompt. */
|
|
2515
2524
|
completions?: GeminiPreferenceExampleCompletion[];
|
|
@@ -2517,7 +2526,7 @@ export declare interface GeminiPreferenceExample {
|
|
|
2517
2526
|
contents?: Content[];
|
|
2518
2527
|
}
|
|
2519
2528
|
|
|
2520
|
-
/** Completion and its preference score. */
|
|
2529
|
+
/** Completion and its preference score. This data type is not supported in Gemini API. */
|
|
2521
2530
|
export declare interface GeminiPreferenceExampleCompletion {
|
|
2522
2531
|
/** Single turn completion for the given prompt. */
|
|
2523
2532
|
completion?: Content;
|
|
@@ -2839,17 +2848,17 @@ export declare class GenerateContentResponse {
|
|
|
2839
2848
|
get codeExecutionResult(): string | undefined;
|
|
2840
2849
|
}
|
|
2841
2850
|
|
|
2842
|
-
/** Content filter results for a prompt sent in the request. */
|
|
2851
|
+
/** Content filter results for a prompt sent in the request. Note: This is sent only in the first stream chunk and only if no candidates were generated due to content violations. */
|
|
2843
2852
|
export declare class GenerateContentResponsePromptFeedback {
|
|
2844
|
-
/** Output only.
|
|
2853
|
+
/** Output only. The reason why the prompt was blocked. */
|
|
2845
2854
|
blockReason?: BlockedReason;
|
|
2846
|
-
/** Output only. A readable
|
|
2855
|
+
/** Output only. A readable message that explains the reason why the prompt was blocked. This field is not supported in Gemini API. */
|
|
2847
2856
|
blockReasonMessage?: string;
|
|
2848
|
-
/** Output only.
|
|
2857
|
+
/** Output only. A list of safety ratings for the prompt. There is one rating per category. */
|
|
2849
2858
|
safetyRatings?: SafetyRating[];
|
|
2850
2859
|
}
|
|
2851
2860
|
|
|
2852
|
-
/** Usage metadata about response(s). */
|
|
2861
|
+
/** Usage metadata about response(s). This data type is not supported in Gemini API. */
|
|
2853
2862
|
export declare class GenerateContentResponseUsageMetadata {
|
|
2854
2863
|
/** Output only. List of modalities of the cached content in the request input. */
|
|
2855
2864
|
cacheTokensDetails?: ModalityTokenCount[];
|
|
@@ -3109,11 +3118,11 @@ export declare interface GenerateVideosSource {
|
|
|
3109
3118
|
export declare interface GenerationConfig {
|
|
3110
3119
|
/** Optional. Config for model selection. */
|
|
3111
3120
|
modelSelectionConfig?: ModelSelectionConfig;
|
|
3112
|
-
/** Optional. If enabled, audio timestamp will be included in the request to the model. */
|
|
3121
|
+
/** Optional. If enabled, audio timestamp will be included in the request to the model. This field is not supported in Gemini API. */
|
|
3113
3122
|
audioTimestamp?: boolean;
|
|
3114
3123
|
/** Optional. Number of candidates to generate. */
|
|
3115
3124
|
candidateCount?: number;
|
|
3116
|
-
/** Optional. If enabled, the model will detect emotions and adapt its responses accordingly. */
|
|
3125
|
+
/** Optional. If enabled, the model will detect emotions and adapt its responses accordingly. This field is not supported in Gemini API. */
|
|
3117
3126
|
enableAffectiveDialog?: boolean;
|
|
3118
3127
|
/** Optional. Frequency penalties. */
|
|
3119
3128
|
frequencyPenalty?: number;
|
|
@@ -3135,7 +3144,7 @@ export declare interface GenerationConfig {
|
|
|
3135
3144
|
responseModalities?: Modality[];
|
|
3136
3145
|
/** 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. */
|
|
3137
3146
|
responseSchema?: Schema;
|
|
3138
|
-
/** Optional. Routing configuration. */
|
|
3147
|
+
/** Optional. Routing configuration. This field is not supported in Gemini API. */
|
|
3139
3148
|
routingConfig?: GenerationConfigRoutingConfig;
|
|
3140
3149
|
/** Optional. Seed. */
|
|
3141
3150
|
seed?: number;
|
|
@@ -3146,14 +3155,16 @@ export declare interface GenerationConfig {
|
|
|
3146
3155
|
/** Optional. Controls the randomness of predictions. */
|
|
3147
3156
|
temperature?: number;
|
|
3148
3157
|
/** Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. */
|
|
3149
|
-
thinkingConfig?:
|
|
3158
|
+
thinkingConfig?: ThinkingConfig;
|
|
3150
3159
|
/** Optional. If specified, top-k sampling will be used. */
|
|
3151
3160
|
topK?: number;
|
|
3152
3161
|
/** Optional. If specified, nucleus sampling will be used. */
|
|
3153
3162
|
topP?: number;
|
|
3163
|
+
/** Optional. Enables enhanced civic answers. It may not be available for all models. This field is not supported in Vertex AI. */
|
|
3164
|
+
enableEnhancedCivicAnswers?: boolean;
|
|
3154
3165
|
}
|
|
3155
3166
|
|
|
3156
|
-
/** The configuration for routing the request to a specific model. */
|
|
3167
|
+
/** The configuration for routing the request to a specific model. This data type is not supported in Gemini API. */
|
|
3157
3168
|
export declare interface GenerationConfigRoutingConfig {
|
|
3158
3169
|
/** Automated routing. */
|
|
3159
3170
|
autoMode?: GenerationConfigRoutingConfigAutoRoutingMode;
|
|
@@ -3161,24 +3172,24 @@ export declare interface GenerationConfigRoutingConfig {
|
|
|
3161
3172
|
manualMode?: GenerationConfigRoutingConfigManualRoutingMode;
|
|
3162
3173
|
}
|
|
3163
3174
|
|
|
3164
|
-
/** When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. */
|
|
3175
|
+
/** When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. This data type is not supported in Gemini API. */
|
|
3165
3176
|
export declare interface GenerationConfigRoutingConfigAutoRoutingMode {
|
|
3166
3177
|
/** The model routing preference. */
|
|
3167
3178
|
modelRoutingPreference?: 'UNKNOWN' | 'PRIORITIZE_QUALITY' | 'BALANCED' | 'PRIORITIZE_COST';
|
|
3168
3179
|
}
|
|
3169
3180
|
|
|
3170
|
-
/** When manual routing is set, the specified model will be used directly. */
|
|
3181
|
+
/** When manual routing is set, the specified model will be used directly. This data type is not supported in Gemini API. */
|
|
3171
3182
|
export declare interface GenerationConfigRoutingConfigManualRoutingMode {
|
|
3172
3183
|
/** The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). */
|
|
3173
3184
|
modelName?: string;
|
|
3174
3185
|
}
|
|
3175
3186
|
|
|
3176
|
-
/**
|
|
3177
|
-
|
|
3178
|
-
|
|
3179
|
-
|
|
3180
|
-
|
|
3181
|
-
|
|
3187
|
+
/**
|
|
3188
|
+
* Config for thinking feature.
|
|
3189
|
+
*
|
|
3190
|
+
* @deprecated This interface will be deprecated. Please use `ThinkingConfig` instead.
|
|
3191
|
+
*/
|
|
3192
|
+
export declare interface GenerationConfigThinkingConfig extends ThinkingConfig {
|
|
3182
3193
|
}
|
|
3183
3194
|
|
|
3184
3195
|
/** Optional parameters. */
|
|
@@ -3438,7 +3449,7 @@ export declare interface GoogleMaps {
|
|
|
3438
3449
|
enableWidget?: boolean;
|
|
3439
3450
|
}
|
|
3440
3451
|
|
|
3441
|
-
/** The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */
|
|
3452
|
+
/** The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). This data type is not supported in Gemini API. */
|
|
3442
3453
|
export declare interface GoogleRpcStatus {
|
|
3443
3454
|
/** The status code, which should be an enum value of google.rpc.Code. */
|
|
3444
3455
|
code?: number;
|
|
@@ -3454,8 +3465,7 @@ export declare interface GoogleSearch {
|
|
|
3454
3465
|
If customers set a start time, they must set an end time (and vice versa).
|
|
3455
3466
|
*/
|
|
3456
3467
|
timeRangeFilter?: Interval;
|
|
3457
|
-
/** Optional. List of domains to be excluded from the search results.
|
|
3458
|
-
The default limit is 2000 domains. */
|
|
3468
|
+
/** Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. This field is not supported in Gemini API. */
|
|
3459
3469
|
excludeDomains?: string[];
|
|
3460
3470
|
}
|
|
3461
3471
|
|
|
@@ -3465,7 +3475,7 @@ export declare interface GoogleSearchRetrieval {
|
|
|
3465
3475
|
dynamicRetrievalConfig?: DynamicRetrievalConfig;
|
|
3466
3476
|
}
|
|
3467
3477
|
|
|
3468
|
-
/** Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp */
|
|
3478
|
+
/** Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp. This data type is not supported in Gemini API. */
|
|
3469
3479
|
export declare interface GoogleTypeDate {
|
|
3470
3480
|
/** Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. */
|
|
3471
3481
|
day?: number;
|
|
@@ -3477,15 +3487,15 @@ export declare interface GoogleTypeDate {
|
|
|
3477
3487
|
|
|
3478
3488
|
/** Grounding chunk. */
|
|
3479
3489
|
export declare interface GroundingChunk {
|
|
3480
|
-
/** Grounding chunk from Google Maps. */
|
|
3490
|
+
/** Grounding chunk from Google Maps. This field is not supported in Gemini API. */
|
|
3481
3491
|
maps?: GroundingChunkMaps;
|
|
3482
|
-
/** Grounding chunk from context retrieved by the retrieval tools. */
|
|
3492
|
+
/** Grounding chunk from context retrieved by the retrieval tools. This field is not supported in Gemini API. */
|
|
3483
3493
|
retrievedContext?: GroundingChunkRetrievedContext;
|
|
3484
3494
|
/** Grounding chunk from the web. */
|
|
3485
3495
|
web?: GroundingChunkWeb;
|
|
3486
3496
|
}
|
|
3487
3497
|
|
|
3488
|
-
/** Chunk from Google Maps. */
|
|
3498
|
+
/** Chunk from Google Maps. This data type is not supported in Gemini API. */
|
|
3489
3499
|
export declare interface GroundingChunkMaps {
|
|
3490
3500
|
/** Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content. */
|
|
3491
3501
|
placeAnswerSources?: GroundingChunkMapsPlaceAnswerSources;
|
|
@@ -3499,7 +3509,7 @@ export declare interface GroundingChunkMaps {
|
|
|
3499
3509
|
uri?: string;
|
|
3500
3510
|
}
|
|
3501
3511
|
|
|
3502
|
-
/** Sources used to generate the place answer. */
|
|
3512
|
+
/** Sources used to generate the place answer. This data type is not supported in Gemini API. */
|
|
3503
3513
|
export declare interface GroundingChunkMapsPlaceAnswerSources {
|
|
3504
3514
|
/** A link where users can flag a problem with the generated answer. */
|
|
3505
3515
|
flagContentUri?: string;
|
|
@@ -3507,7 +3517,7 @@ export declare interface GroundingChunkMapsPlaceAnswerSources {
|
|
|
3507
3517
|
reviewSnippets?: GroundingChunkMapsPlaceAnswerSourcesReviewSnippet[];
|
|
3508
3518
|
}
|
|
3509
3519
|
|
|
3510
|
-
/** Author attribution for a photo or review. */
|
|
3520
|
+
/** Author attribution for a photo or review. This data type is not supported in Gemini API. */
|
|
3511
3521
|
export declare interface GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution {
|
|
3512
3522
|
/** Name of the author of the Photo or Review. */
|
|
3513
3523
|
displayName?: string;
|
|
@@ -3517,7 +3527,7 @@ export declare interface GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution {
|
|
|
3517
3527
|
uri?: string;
|
|
3518
3528
|
}
|
|
3519
3529
|
|
|
3520
|
-
/** Encapsulates a review snippet. */
|
|
3530
|
+
/** Encapsulates a review snippet. This data type is not supported in Gemini API. */
|
|
3521
3531
|
export declare interface GroundingChunkMapsPlaceAnswerSourcesReviewSnippet {
|
|
3522
3532
|
/** This review's author. */
|
|
3523
3533
|
authorAttribution?: GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution;
|
|
@@ -3535,7 +3545,7 @@ export declare interface GroundingChunkMapsPlaceAnswerSourcesReviewSnippet {
|
|
|
3535
3545
|
title?: string;
|
|
3536
3546
|
}
|
|
3537
3547
|
|
|
3538
|
-
/** Chunk from context retrieved by the retrieval tools. */
|
|
3548
|
+
/** Chunk from context retrieved by the retrieval tools. This data type is not supported in Gemini API. */
|
|
3539
3549
|
export declare interface GroundingChunkRetrievedContext {
|
|
3540
3550
|
/** Output only. The full document name for the referenced Vertex AI Search document. */
|
|
3541
3551
|
documentName?: string;
|
|
@@ -3551,7 +3561,7 @@ export declare interface GroundingChunkRetrievedContext {
|
|
|
3551
3561
|
|
|
3552
3562
|
/** Chunk from the web. */
|
|
3553
3563
|
export declare interface GroundingChunkWeb {
|
|
3554
|
-
/** Domain of the (original) URI. */
|
|
3564
|
+
/** Domain of the (original) URI. This field is not supported in Gemini API. */
|
|
3555
3565
|
domain?: string;
|
|
3556
3566
|
/** Title of the chunk. */
|
|
3557
3567
|
title?: string;
|
|
@@ -3561,7 +3571,7 @@ export declare interface GroundingChunkWeb {
|
|
|
3561
3571
|
|
|
3562
3572
|
/** Metadata returned to client when grounding is enabled. */
|
|
3563
3573
|
export declare interface GroundingMetadata {
|
|
3564
|
-
/** Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding. */
|
|
3574
|
+
/** Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding. This field is not supported in Gemini API. */
|
|
3565
3575
|
googleMapsWidgetContextToken?: string;
|
|
3566
3576
|
/** List of supporting references retrieved from specified grounding source. */
|
|
3567
3577
|
groundingChunks?: GroundingChunk[];
|
|
@@ -3569,17 +3579,17 @@ export declare interface GroundingMetadata {
|
|
|
3569
3579
|
groundingSupports?: GroundingSupport[];
|
|
3570
3580
|
/** Optional. Output only. Retrieval metadata. */
|
|
3571
3581
|
retrievalMetadata?: RetrievalMetadata;
|
|
3572
|
-
/** Optional. Queries executed by the retrieval tools. */
|
|
3582
|
+
/** Optional. Queries executed by the retrieval tools. This field is not supported in Gemini API. */
|
|
3573
3583
|
retrievalQueries?: string[];
|
|
3574
3584
|
/** Optional. Google search entry for the following-up web searches. */
|
|
3575
3585
|
searchEntryPoint?: SearchEntryPoint;
|
|
3576
|
-
/** Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. */
|
|
3586
|
+
/** Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. This field is not supported in Gemini API. */
|
|
3577
3587
|
sourceFlaggingUris?: GroundingMetadataSourceFlaggingUri[];
|
|
3578
3588
|
/** Optional. Web search queries for the following-up web search. */
|
|
3579
3589
|
webSearchQueries?: string[];
|
|
3580
3590
|
}
|
|
3581
3591
|
|
|
3582
|
-
/** Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. */
|
|
3592
|
+
/** Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. This data type is not supported in Gemini API. */
|
|
3583
3593
|
export declare interface GroundingMetadataSourceFlaggingUri {
|
|
3584
3594
|
/** A link where users can flag a problem with the source (place or review). */
|
|
3585
3595
|
flagContentUri?: string;
|
|
@@ -3647,42 +3657,46 @@ export declare enum HarmCategory {
|
|
|
3647
3657
|
* The harm category is unspecified.
|
|
3648
3658
|
*/
|
|
3649
3659
|
HARM_CATEGORY_UNSPECIFIED = "HARM_CATEGORY_UNSPECIFIED",
|
|
3650
|
-
/**
|
|
3651
|
-
* The harm category is hate speech.
|
|
3652
|
-
*/
|
|
3653
|
-
HARM_CATEGORY_HATE_SPEECH = "HARM_CATEGORY_HATE_SPEECH",
|
|
3654
|
-
/**
|
|
3655
|
-
* The harm category is dangerous content.
|
|
3656
|
-
*/
|
|
3657
|
-
HARM_CATEGORY_DANGEROUS_CONTENT = "HARM_CATEGORY_DANGEROUS_CONTENT",
|
|
3658
3660
|
/**
|
|
3659
3661
|
* The harm category is harassment.
|
|
3660
3662
|
*/
|
|
3661
3663
|
HARM_CATEGORY_HARASSMENT = "HARM_CATEGORY_HARASSMENT",
|
|
3664
|
+
/**
|
|
3665
|
+
* The harm category is hate speech.
|
|
3666
|
+
*/
|
|
3667
|
+
HARM_CATEGORY_HATE_SPEECH = "HARM_CATEGORY_HATE_SPEECH",
|
|
3662
3668
|
/**
|
|
3663
3669
|
* The harm category is sexually explicit content.
|
|
3664
3670
|
*/
|
|
3665
3671
|
HARM_CATEGORY_SEXUALLY_EXPLICIT = "HARM_CATEGORY_SEXUALLY_EXPLICIT",
|
|
3672
|
+
/**
|
|
3673
|
+
* The harm category is dangerous content.
|
|
3674
|
+
*/
|
|
3675
|
+
HARM_CATEGORY_DANGEROUS_CONTENT = "HARM_CATEGORY_DANGEROUS_CONTENT",
|
|
3666
3676
|
/**
|
|
3667
3677
|
* Deprecated: Election filter is not longer supported. The harm category is civic integrity.
|
|
3668
3678
|
*/
|
|
3669
3679
|
HARM_CATEGORY_CIVIC_INTEGRITY = "HARM_CATEGORY_CIVIC_INTEGRITY",
|
|
3670
3680
|
/**
|
|
3671
|
-
* The harm category is image hate.
|
|
3681
|
+
* The harm category is image hate. This enum value is not supported in Gemini API.
|
|
3672
3682
|
*/
|
|
3673
3683
|
HARM_CATEGORY_IMAGE_HATE = "HARM_CATEGORY_IMAGE_HATE",
|
|
3674
3684
|
/**
|
|
3675
|
-
* The harm category is image dangerous content.
|
|
3685
|
+
* The harm category is image dangerous content. This enum value is not supported in Gemini API.
|
|
3676
3686
|
*/
|
|
3677
3687
|
HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT = "HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT",
|
|
3678
3688
|
/**
|
|
3679
|
-
* The harm category is image harassment.
|
|
3689
|
+
* The harm category is image harassment. This enum value is not supported in Gemini API.
|
|
3680
3690
|
*/
|
|
3681
3691
|
HARM_CATEGORY_IMAGE_HARASSMENT = "HARM_CATEGORY_IMAGE_HARASSMENT",
|
|
3682
3692
|
/**
|
|
3683
|
-
* The harm category is image sexually explicit content.
|
|
3693
|
+
* The harm category is image sexually explicit content. This enum value is not supported in Gemini API.
|
|
3694
|
+
*/
|
|
3695
|
+
HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT = "HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT",
|
|
3696
|
+
/**
|
|
3697
|
+
* The harm category is for jailbreak prompts. This enum value is not supported in Gemini API.
|
|
3684
3698
|
*/
|
|
3685
|
-
|
|
3699
|
+
HARM_CATEGORY_JAILBREAK = "HARM_CATEGORY_JAILBREAK"
|
|
3686
3700
|
}
|
|
3687
3701
|
|
|
3688
3702
|
/** Output only. Harm probability levels in the content. */
|
|
@@ -4088,9 +4102,9 @@ export declare interface ListFilesParameters {
|
|
|
4088
4102
|
export declare class ListFilesResponse {
|
|
4089
4103
|
/** Used to retain the full HTTP response. */
|
|
4090
4104
|
sdkHttpResponse?: HttpResponse;
|
|
4091
|
-
/** A token
|
|
4105
|
+
/** A token that can be sent as a `page_token` into a subsequent `ListFiles` call. */
|
|
4092
4106
|
nextPageToken?: string;
|
|
4093
|
-
/** The list of
|
|
4107
|
+
/** The list of `File`s. */
|
|
4094
4108
|
files?: File_2[];
|
|
4095
4109
|
}
|
|
4096
4110
|
|
|
@@ -5750,7 +5764,7 @@ export declare interface Part {
|
|
|
5750
5764
|
|
|
5751
5765
|
export declare type PartListUnion = PartUnion[] | PartUnion;
|
|
5752
5766
|
|
|
5753
|
-
/** Tuning spec for Partner models. */
|
|
5767
|
+
/** Tuning spec for Partner models. This data type is not supported in Gemini API. */
|
|
5754
5768
|
export declare interface PartnerModelTuningSpec {
|
|
5755
5769
|
/** Hyperparameters for tuning. The accepted hyper_parameters and their valid range of values will differ depending on the base model. */
|
|
5756
5770
|
hyperParameters?: Record<string, unknown>;
|
|
@@ -5784,7 +5798,7 @@ export declare interface PrebuiltVoiceConfig {
|
|
|
5784
5798
|
voiceName?: string;
|
|
5785
5799
|
}
|
|
5786
5800
|
|
|
5787
|
-
/** Statistics computed for datasets used for preference optimization. */
|
|
5801
|
+
/** Statistics computed for datasets used for preference optimization. This data type is not supported in Gemini API. */
|
|
5788
5802
|
export declare interface PreferenceOptimizationDataStats {
|
|
5789
5803
|
/** Output only. Dataset distributions for scores variance per example. */
|
|
5790
5804
|
scoreVariancePerExampleDistribution?: DatasetDistribution;
|
|
@@ -5804,7 +5818,7 @@ export declare interface PreferenceOptimizationDataStats {
|
|
|
5804
5818
|
userOutputTokenDistribution?: DatasetDistribution;
|
|
5805
5819
|
}
|
|
5806
5820
|
|
|
5807
|
-
/** A pre-tuned model for continuous tuning. */
|
|
5821
|
+
/** A pre-tuned model for continuous tuning. This data type is not supported in Gemini API. */
|
|
5808
5822
|
export declare interface PreTunedModel {
|
|
5809
5823
|
/** Output only. The name of the base model this PreTunedModel was tuned from. */
|
|
5810
5824
|
baseModel?: string;
|
|
@@ -5828,7 +5842,7 @@ export declare interface ProductImage {
|
|
|
5828
5842
|
productImage?: Image_2;
|
|
5829
5843
|
}
|
|
5830
5844
|
|
|
5831
|
-
/** A RagChunk includes the content of a chunk of a RagFile, and associated metadata. */
|
|
5845
|
+
/** A RagChunk includes the content of a chunk of a RagFile, and associated metadata. This data type is not supported in Gemini API. */
|
|
5832
5846
|
export declare interface RagChunk {
|
|
5833
5847
|
/** If populated, represents where the chunk starts and ends in the document. */
|
|
5834
5848
|
pageSpan?: RagChunkPageSpan;
|
|
@@ -5836,7 +5850,7 @@ export declare interface RagChunk {
|
|
|
5836
5850
|
text?: string;
|
|
5837
5851
|
}
|
|
5838
5852
|
|
|
5839
|
-
/** Represents where the chunk starts and ends in the document. */
|
|
5853
|
+
/** Represents where the chunk starts and ends in the document. This data type is not supported in Gemini API. */
|
|
5840
5854
|
export declare interface RagChunkPageSpan {
|
|
5841
5855
|
/** Page where chunk starts in the document. Inclusive. 1-indexed. */
|
|
5842
5856
|
firstPage?: number;
|
|
@@ -5844,7 +5858,7 @@ export declare interface RagChunkPageSpan {
|
|
|
5844
5858
|
lastPage?: number;
|
|
5845
5859
|
}
|
|
5846
5860
|
|
|
5847
|
-
/** Specifies the context retrieval config. */
|
|
5861
|
+
/** Specifies the context retrieval config. This data type is not supported in Gemini API. */
|
|
5848
5862
|
export declare interface RagRetrievalConfig {
|
|
5849
5863
|
/** Optional. Config for filters. */
|
|
5850
5864
|
filter?: RagRetrievalConfigFilter;
|
|
@@ -5856,7 +5870,7 @@ export declare interface RagRetrievalConfig {
|
|
|
5856
5870
|
topK?: number;
|
|
5857
5871
|
}
|
|
5858
5872
|
|
|
5859
|
-
/** Config for filters. */
|
|
5873
|
+
/** Config for filters. This data type is not supported in Gemini API. */
|
|
5860
5874
|
export declare interface RagRetrievalConfigFilter {
|
|
5861
5875
|
/** Optional. String for metadata filtering. */
|
|
5862
5876
|
metadataFilter?: string;
|
|
@@ -5866,13 +5880,13 @@ export declare interface RagRetrievalConfigFilter {
|
|
|
5866
5880
|
vectorSimilarityThreshold?: number;
|
|
5867
5881
|
}
|
|
5868
5882
|
|
|
5869
|
-
/** Config for Hybrid Search. */
|
|
5883
|
+
/** Config for Hybrid Search. This data type is not supported in Gemini API. */
|
|
5870
5884
|
export declare interface RagRetrievalConfigHybridSearch {
|
|
5871
5885
|
/** Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally. */
|
|
5872
5886
|
alpha?: number;
|
|
5873
5887
|
}
|
|
5874
5888
|
|
|
5875
|
-
/** Config for ranking and reranking. */
|
|
5889
|
+
/** Config for ranking and reranking. This data type is not supported in Gemini API. */
|
|
5876
5890
|
export declare interface RagRetrievalConfigRanking {
|
|
5877
5891
|
/** Optional. Config for LlmRanker. */
|
|
5878
5892
|
llmRanker?: RagRetrievalConfigRankingLlmRanker;
|
|
@@ -5880,13 +5894,13 @@ export declare interface RagRetrievalConfigRanking {
|
|
|
5880
5894
|
rankService?: RagRetrievalConfigRankingRankService;
|
|
5881
5895
|
}
|
|
5882
5896
|
|
|
5883
|
-
/** Config for LlmRanker. */
|
|
5897
|
+
/** Config for LlmRanker. This data type is not supported in Gemini API. */
|
|
5884
5898
|
export declare interface RagRetrievalConfigRankingLlmRanker {
|
|
5885
5899
|
/** Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). */
|
|
5886
5900
|
modelName?: string;
|
|
5887
5901
|
}
|
|
5888
5902
|
|
|
5889
|
-
/** Config for Rank Service. */
|
|
5903
|
+
/** Config for Rank Service. This data type is not supported in Gemini API. */
|
|
5890
5904
|
export declare interface RagRetrievalConfigRankingRankService {
|
|
5891
5905
|
/** Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` */
|
|
5892
5906
|
modelName?: string;
|
|
@@ -6036,7 +6050,7 @@ export declare class ReplayResponse {
|
|
|
6036
6050
|
sdkResponseSegments?: Record<string, unknown>[];
|
|
6037
6051
|
}
|
|
6038
6052
|
|
|
6039
|
-
/** Defines a retrieval tool that model can call to access external knowledge. */
|
|
6053
|
+
/** Defines a retrieval tool that model can call to access external knowledge. This data type is not supported in Gemini API. */
|
|
6040
6054
|
export declare interface Retrieval {
|
|
6041
6055
|
/** Optional. Deprecated. This option is no longer supported. */
|
|
6042
6056
|
disableAttribution?: boolean;
|
|
@@ -6091,11 +6105,11 @@ export declare interface SafetyRating {
|
|
|
6091
6105
|
overwrittenThreshold?: HarmBlockThreshold;
|
|
6092
6106
|
/** Output only. Harm probability levels in the content. */
|
|
6093
6107
|
probability?: HarmProbability;
|
|
6094
|
-
/** Output only. Harm probability score. */
|
|
6108
|
+
/** Output only. Harm probability score. This field is not supported in Gemini API. */
|
|
6095
6109
|
probabilityScore?: number;
|
|
6096
6110
|
/** Output only. Harm severity levels in the content. */
|
|
6097
6111
|
severity?: HarmSeverity;
|
|
6098
|
-
/** Output only. Harm severity score. */
|
|
6112
|
+
/** Output only. Harm severity score. This field is not supported in Gemini API. */
|
|
6099
6113
|
severityScore?: number;
|
|
6100
6114
|
}
|
|
6101
6115
|
|
|
@@ -6622,7 +6636,7 @@ export declare enum SubjectReferenceType {
|
|
|
6622
6636
|
SUBJECT_TYPE_PRODUCT = "SUBJECT_TYPE_PRODUCT"
|
|
6623
6637
|
}
|
|
6624
6638
|
|
|
6625
|
-
/** Hyperparameters for SFT. */
|
|
6639
|
+
/** Hyperparameters for SFT. This data type is not supported in Gemini API. */
|
|
6626
6640
|
export declare interface SupervisedHyperParameters {
|
|
6627
6641
|
/** Optional. Adapter size for tuning. */
|
|
6628
6642
|
adapterSize?: AdapterSize;
|
|
@@ -6636,7 +6650,7 @@ export declare interface SupervisedHyperParameters {
|
|
|
6636
6650
|
learningRateMultiplier?: number;
|
|
6637
6651
|
}
|
|
6638
6652
|
|
|
6639
|
-
/** Dataset distribution for Supervised Tuning. */
|
|
6653
|
+
/** Dataset distribution for Supervised Tuning. This data type is not supported in Gemini API. */
|
|
6640
6654
|
export declare interface SupervisedTuningDatasetDistribution {
|
|
6641
6655
|
/** Output only. Sum of a given population of values that are billable. */
|
|
6642
6656
|
billableSum?: string;
|
|
@@ -6658,7 +6672,7 @@ export declare interface SupervisedTuningDatasetDistribution {
|
|
|
6658
6672
|
sum?: string;
|
|
6659
6673
|
}
|
|
6660
6674
|
|
|
6661
|
-
/** Dataset bucket used to create a histogram for the distribution given a population of values. */
|
|
6675
|
+
/** Dataset bucket used to create a histogram for the distribution given a population of values. This data type is not supported in Gemini API. */
|
|
6662
6676
|
export declare interface SupervisedTuningDatasetDistributionDatasetBucket {
|
|
6663
6677
|
/** Output only. Number of values in the bucket. */
|
|
6664
6678
|
count?: number;
|
|
@@ -6668,7 +6682,7 @@ export declare interface SupervisedTuningDatasetDistributionDatasetBucket {
|
|
|
6668
6682
|
right?: number;
|
|
6669
6683
|
}
|
|
6670
6684
|
|
|
6671
|
-
/** Tuning data statistics for Supervised Tuning. */
|
|
6685
|
+
/** Tuning data statistics for Supervised Tuning. This data type is not supported in Gemini API. */
|
|
6672
6686
|
export declare interface SupervisedTuningDataStats {
|
|
6673
6687
|
/** Output only. For each index in `truncated_example_indices`, the user-facing reason why the example was dropped. */
|
|
6674
6688
|
droppedExampleReasons?: string[];
|
|
@@ -6696,7 +6710,7 @@ export declare interface SupervisedTuningDataStats {
|
|
|
6696
6710
|
userOutputTokenDistribution?: SupervisedTuningDatasetDistribution;
|
|
6697
6711
|
}
|
|
6698
6712
|
|
|
6699
|
-
/** Tuning Spec for Supervised Tuning for first party models. */
|
|
6713
|
+
/** Tuning Spec for Supervised Tuning for first party models. This data type is not supported in Gemini API. */
|
|
6700
6714
|
export declare interface SupervisedTuningSpec {
|
|
6701
6715
|
/** Optional. If set to true, disable intermediate checkpoints for SFT and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for SFT. Default is false. */
|
|
6702
6716
|
exportLastCheckpointOnly?: boolean;
|
|
@@ -6850,7 +6864,7 @@ export declare interface TokensInfo {
|
|
|
6850
6864
|
export declare interface Tool {
|
|
6851
6865
|
/** List of function declarations that the tool supports. */
|
|
6852
6866
|
functionDeclarations?: FunctionDeclaration[];
|
|
6853
|
-
/** Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. */
|
|
6867
|
+
/** Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. This field is not supported in Gemini API. */
|
|
6854
6868
|
retrieval?: Retrieval;
|
|
6855
6869
|
/** Optional. Google Search tool type. Specialized retrieval tool
|
|
6856
6870
|
that is powered by Google Search. */
|
|
@@ -6873,7 +6887,7 @@ export declare interface Tool {
|
|
|
6873
6887
|
codeExecution?: ToolCodeExecution;
|
|
6874
6888
|
}
|
|
6875
6889
|
|
|
6876
|
-
/** 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. */
|
|
6890
|
+
/** 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. */
|
|
6877
6891
|
export declare interface ToolCodeExecution {
|
|
6878
6892
|
}
|
|
6879
6893
|
|
|
@@ -6917,10 +6931,18 @@ export declare interface Transcription {
|
|
|
6917
6931
|
finished?: boolean;
|
|
6918
6932
|
}
|
|
6919
6933
|
|
|
6934
|
+
/** TunedModel for the Tuned Model of a Tuning Job. */
|
|
6920
6935
|
export declare interface TunedModel {
|
|
6921
|
-
/** Output only. The resource name of the TunedModel.
|
|
6936
|
+
/** Output only. The resource name of the TunedModel.
|
|
6937
|
+
Format: `projects/{project}/locations/{location}/models/{model}@{version_id}`
|
|
6938
|
+
When tuning from a base model, the version_id will be 1.
|
|
6939
|
+
For continuous tuning, the version id will be incremented by 1 from the
|
|
6940
|
+
last version id in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}`
|
|
6941
|
+
*/
|
|
6922
6942
|
model?: string;
|
|
6923
|
-
/** Output only. A resource name of an Endpoint.
|
|
6943
|
+
/** Output only. A resource name of an Endpoint.
|
|
6944
|
+
Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.
|
|
6945
|
+
*/
|
|
6924
6946
|
endpoint?: string;
|
|
6925
6947
|
/** The checkpoints associated with this TunedModel.
|
|
6926
6948
|
This field is only populated for tuning jobs that enable intermediate
|
|
@@ -6965,7 +6987,7 @@ export declare interface TuningDataset {
|
|
|
6965
6987
|
examples?: TuningExample[];
|
|
6966
6988
|
}
|
|
6967
6989
|
|
|
6968
|
-
/** The tuning data statistic values for TuningJob. */
|
|
6990
|
+
/** The tuning data statistic values for TuningJob. This data type is not supported in Gemini API. */
|
|
6969
6991
|
export declare interface TuningDataStats {
|
|
6970
6992
|
/** Output only. Statistics for distillation. */
|
|
6971
6993
|
distillationDataStats?: DistillationDataStats;
|
|
@@ -6975,11 +6997,12 @@ export declare interface TuningDataStats {
|
|
|
6975
6997
|
supervisedTuningDataStats?: SupervisedTuningDataStats;
|
|
6976
6998
|
}
|
|
6977
6999
|
|
|
7000
|
+
/** A single example for tuning. This data type is not supported in Vertex AI. */
|
|
6978
7001
|
export declare interface TuningExample {
|
|
6979
|
-
/**
|
|
6980
|
-
textInput?: string;
|
|
6981
|
-
/** The expected model output. */
|
|
7002
|
+
/** Required. The expected model output. */
|
|
6982
7003
|
output?: string;
|
|
7004
|
+
/** Optional. Text model input. */
|
|
7005
|
+
textInput?: string;
|
|
6983
7006
|
}
|
|
6984
7007
|
|
|
6985
7008
|
/** A tuning job. */
|
|
@@ -7134,7 +7157,7 @@ export declare enum TuningTask {
|
|
|
7134
7157
|
export declare interface TuningValidationDataset {
|
|
7135
7158
|
/** GCS URI of the file containing validation dataset in JSONL format. */
|
|
7136
7159
|
gcsUri?: string;
|
|
7137
|
-
/** The resource name of the Vertex Multimodal Dataset that is used as
|
|
7160
|
+
/** The resource name of the Vertex Multimodal Dataset that is used as validation dataset. Example: 'projects/my-project-id-or-number/locations/my-location/datasets/my-dataset-id'. */
|
|
7138
7161
|
vertexDatasetResource?: string;
|
|
7139
7162
|
}
|
|
7140
7163
|
|
|
@@ -7225,6 +7248,7 @@ declare namespace types {
|
|
|
7225
7248
|
createModelContent,
|
|
7226
7249
|
Outcome,
|
|
7227
7250
|
Language,
|
|
7251
|
+
FunctionResponseScheduling,
|
|
7228
7252
|
Type,
|
|
7229
7253
|
HarmCategory,
|
|
7230
7254
|
HarmBlockMethod,
|
|
@@ -7268,7 +7292,6 @@ declare namespace types {
|
|
|
7268
7292
|
EndSensitivity,
|
|
7269
7293
|
ActivityHandling,
|
|
7270
7294
|
TurnCoverage,
|
|
7271
|
-
FunctionResponseScheduling,
|
|
7272
7295
|
Scale,
|
|
7273
7296
|
MusicGenerationMode,
|
|
7274
7297
|
LiveMusicPlaybackControl,
|
|
@@ -7416,7 +7439,6 @@ declare namespace types {
|
|
|
7416
7439
|
DeleteModelConfig,
|
|
7417
7440
|
DeleteModelParameters,
|
|
7418
7441
|
DeleteModelResponse,
|
|
7419
|
-
GenerationConfigThinkingConfig,
|
|
7420
7442
|
GenerationConfig,
|
|
7421
7443
|
CountTokensConfig,
|
|
7422
7444
|
CountTokensParameters,
|
|
@@ -7552,6 +7574,7 @@ declare namespace types {
|
|
|
7552
7574
|
LiveServerSessionResumptionUpdate,
|
|
7553
7575
|
LiveServerMessage,
|
|
7554
7576
|
OperationFromAPIResponseParameters,
|
|
7577
|
+
GenerationConfigThinkingConfig,
|
|
7555
7578
|
AutomaticActivityDetection,
|
|
7556
7579
|
RealtimeInputConfig,
|
|
7557
7580
|
SessionResumptionConfig,
|
|
@@ -7836,7 +7859,7 @@ export declare interface UsageMetadata {
|
|
|
7836
7859
|
trafficType?: TrafficType;
|
|
7837
7860
|
}
|
|
7838
7861
|
|
|
7839
|
-
/** Hyperparameters for Veo. */
|
|
7862
|
+
/** Hyperparameters for Veo. This data type is not supported in Gemini API. */
|
|
7840
7863
|
export declare interface VeoHyperParameters {
|
|
7841
7864
|
/** Optional. Number of complete passes the model makes over the entire training dataset during training. */
|
|
7842
7865
|
epochCount?: string;
|
|
@@ -7846,7 +7869,7 @@ export declare interface VeoHyperParameters {
|
|
|
7846
7869
|
tuningTask?: TuningTask;
|
|
7847
7870
|
}
|
|
7848
7871
|
|
|
7849
|
-
/** Tuning Spec for Veo Model Tuning. */
|
|
7872
|
+
/** Tuning Spec for Veo Model Tuning. This data type is not supported in Gemini API. */
|
|
7850
7873
|
export declare interface VeoTuningSpec {
|
|
7851
7874
|
/** Optional. Hyperparameters for Veo. */
|
|
7852
7875
|
hyperParameters?: VeoHyperParameters;
|
|
@@ -7856,7 +7879,7 @@ export declare interface VeoTuningSpec {
|
|
|
7856
7879
|
validationDatasetUri?: string;
|
|
7857
7880
|
}
|
|
7858
7881
|
|
|
7859
|
-
/** Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder */
|
|
7882
|
+
/** Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder. This data type is not supported in Gemini API. */
|
|
7860
7883
|
export declare interface VertexAISearch {
|
|
7861
7884
|
/** 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. */
|
|
7862
7885
|
dataStoreSpecs?: VertexAISearchDataStoreSpec[];
|
|
@@ -7870,7 +7893,7 @@ export declare interface VertexAISearch {
|
|
|
7870
7893
|
maxResults?: number;
|
|
7871
7894
|
}
|
|
7872
7895
|
|
|
7873
|
-
/** Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec */
|
|
7896
|
+
/** Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec. This data type is not supported in Gemini API. */
|
|
7874
7897
|
export declare interface VertexAISearchDataStoreSpec {
|
|
7875
7898
|
/** Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` */
|
|
7876
7899
|
dataStore?: string;
|
|
@@ -7878,7 +7901,7 @@ export declare interface VertexAISearchDataStoreSpec {
|
|
|
7878
7901
|
filter?: string;
|
|
7879
7902
|
}
|
|
7880
7903
|
|
|
7881
|
-
/** Retrieve from Vertex RAG Store for grounding. */
|
|
7904
|
+
/** Retrieve from Vertex RAG Store for grounding. This data type is not supported in Gemini API. */
|
|
7882
7905
|
export declare interface VertexRagStore {
|
|
7883
7906
|
/** Optional. Deprecated. Please use rag_resources instead. */
|
|
7884
7907
|
ragCorpora?: string[];
|
|
@@ -7894,7 +7917,7 @@ export declare interface VertexRagStore {
|
|
|
7894
7917
|
vectorDistanceThreshold?: number;
|
|
7895
7918
|
}
|
|
7896
7919
|
|
|
7897
|
-
/** The definition of the Rag resource. */
|
|
7920
|
+
/** The definition of the Rag resource. This data type is not supported in Gemini API. */
|
|
7898
7921
|
export declare interface VertexRagStoreRagResource {
|
|
7899
7922
|
/** Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` */
|
|
7900
7923
|
ragCorpus?: string;
|