@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/genai.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. */
|
|
@@ -3426,7 +3437,7 @@ export declare interface GoogleMaps {
|
|
|
3426
3437
|
enableWidget?: boolean;
|
|
3427
3438
|
}
|
|
3428
3439
|
|
|
3429
|
-
/** 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). */
|
|
3440
|
+
/** 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. */
|
|
3430
3441
|
export declare interface GoogleRpcStatus {
|
|
3431
3442
|
/** The status code, which should be an enum value of google.rpc.Code. */
|
|
3432
3443
|
code?: number;
|
|
@@ -3442,8 +3453,7 @@ export declare interface GoogleSearch {
|
|
|
3442
3453
|
If customers set a start time, they must set an end time (and vice versa).
|
|
3443
3454
|
*/
|
|
3444
3455
|
timeRangeFilter?: Interval;
|
|
3445
|
-
/** Optional. List of domains to be excluded from the search results.
|
|
3446
|
-
The default limit is 2000 domains. */
|
|
3456
|
+
/** 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. */
|
|
3447
3457
|
excludeDomains?: string[];
|
|
3448
3458
|
}
|
|
3449
3459
|
|
|
@@ -3453,7 +3463,7 @@ export declare interface GoogleSearchRetrieval {
|
|
|
3453
3463
|
dynamicRetrievalConfig?: DynamicRetrievalConfig;
|
|
3454
3464
|
}
|
|
3455
3465
|
|
|
3456
|
-
/** 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 */
|
|
3466
|
+
/** 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. */
|
|
3457
3467
|
export declare interface GoogleTypeDate {
|
|
3458
3468
|
/** 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. */
|
|
3459
3469
|
day?: number;
|
|
@@ -3465,15 +3475,15 @@ export declare interface GoogleTypeDate {
|
|
|
3465
3475
|
|
|
3466
3476
|
/** Grounding chunk. */
|
|
3467
3477
|
export declare interface GroundingChunk {
|
|
3468
|
-
/** Grounding chunk from Google Maps. */
|
|
3478
|
+
/** Grounding chunk from Google Maps. This field is not supported in Gemini API. */
|
|
3469
3479
|
maps?: GroundingChunkMaps;
|
|
3470
|
-
/** Grounding chunk from context retrieved by the retrieval tools. */
|
|
3480
|
+
/** Grounding chunk from context retrieved by the retrieval tools. This field is not supported in Gemini API. */
|
|
3471
3481
|
retrievedContext?: GroundingChunkRetrievedContext;
|
|
3472
3482
|
/** Grounding chunk from the web. */
|
|
3473
3483
|
web?: GroundingChunkWeb;
|
|
3474
3484
|
}
|
|
3475
3485
|
|
|
3476
|
-
/** Chunk from Google Maps. */
|
|
3486
|
+
/** Chunk from Google Maps. This data type is not supported in Gemini API. */
|
|
3477
3487
|
export declare interface GroundingChunkMaps {
|
|
3478
3488
|
/** 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. */
|
|
3479
3489
|
placeAnswerSources?: GroundingChunkMapsPlaceAnswerSources;
|
|
@@ -3487,7 +3497,7 @@ export declare interface GroundingChunkMaps {
|
|
|
3487
3497
|
uri?: string;
|
|
3488
3498
|
}
|
|
3489
3499
|
|
|
3490
|
-
/** Sources used to generate the place answer. */
|
|
3500
|
+
/** Sources used to generate the place answer. This data type is not supported in Gemini API. */
|
|
3491
3501
|
export declare interface GroundingChunkMapsPlaceAnswerSources {
|
|
3492
3502
|
/** A link where users can flag a problem with the generated answer. */
|
|
3493
3503
|
flagContentUri?: string;
|
|
@@ -3495,7 +3505,7 @@ export declare interface GroundingChunkMapsPlaceAnswerSources {
|
|
|
3495
3505
|
reviewSnippets?: GroundingChunkMapsPlaceAnswerSourcesReviewSnippet[];
|
|
3496
3506
|
}
|
|
3497
3507
|
|
|
3498
|
-
/** Author attribution for a photo or review. */
|
|
3508
|
+
/** Author attribution for a photo or review. This data type is not supported in Gemini API. */
|
|
3499
3509
|
export declare interface GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution {
|
|
3500
3510
|
/** Name of the author of the Photo or Review. */
|
|
3501
3511
|
displayName?: string;
|
|
@@ -3505,7 +3515,7 @@ export declare interface GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution {
|
|
|
3505
3515
|
uri?: string;
|
|
3506
3516
|
}
|
|
3507
3517
|
|
|
3508
|
-
/** Encapsulates a review snippet. */
|
|
3518
|
+
/** Encapsulates a review snippet. This data type is not supported in Gemini API. */
|
|
3509
3519
|
export declare interface GroundingChunkMapsPlaceAnswerSourcesReviewSnippet {
|
|
3510
3520
|
/** This review's author. */
|
|
3511
3521
|
authorAttribution?: GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution;
|
|
@@ -3523,7 +3533,7 @@ export declare interface GroundingChunkMapsPlaceAnswerSourcesReviewSnippet {
|
|
|
3523
3533
|
title?: string;
|
|
3524
3534
|
}
|
|
3525
3535
|
|
|
3526
|
-
/** Chunk from context retrieved by the retrieval tools. */
|
|
3536
|
+
/** Chunk from context retrieved by the retrieval tools. This data type is not supported in Gemini API. */
|
|
3527
3537
|
export declare interface GroundingChunkRetrievedContext {
|
|
3528
3538
|
/** Output only. The full document name for the referenced Vertex AI Search document. */
|
|
3529
3539
|
documentName?: string;
|
|
@@ -3539,7 +3549,7 @@ export declare interface GroundingChunkRetrievedContext {
|
|
|
3539
3549
|
|
|
3540
3550
|
/** Chunk from the web. */
|
|
3541
3551
|
export declare interface GroundingChunkWeb {
|
|
3542
|
-
/** Domain of the (original) URI. */
|
|
3552
|
+
/** Domain of the (original) URI. This field is not supported in Gemini API. */
|
|
3543
3553
|
domain?: string;
|
|
3544
3554
|
/** Title of the chunk. */
|
|
3545
3555
|
title?: string;
|
|
@@ -3549,7 +3559,7 @@ export declare interface GroundingChunkWeb {
|
|
|
3549
3559
|
|
|
3550
3560
|
/** Metadata returned to client when grounding is enabled. */
|
|
3551
3561
|
export declare interface GroundingMetadata {
|
|
3552
|
-
/** 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. */
|
|
3562
|
+
/** 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. */
|
|
3553
3563
|
googleMapsWidgetContextToken?: string;
|
|
3554
3564
|
/** List of supporting references retrieved from specified grounding source. */
|
|
3555
3565
|
groundingChunks?: GroundingChunk[];
|
|
@@ -3557,17 +3567,17 @@ export declare interface GroundingMetadata {
|
|
|
3557
3567
|
groundingSupports?: GroundingSupport[];
|
|
3558
3568
|
/** Optional. Output only. Retrieval metadata. */
|
|
3559
3569
|
retrievalMetadata?: RetrievalMetadata;
|
|
3560
|
-
/** Optional. Queries executed by the retrieval tools. */
|
|
3570
|
+
/** Optional. Queries executed by the retrieval tools. This field is not supported in Gemini API. */
|
|
3561
3571
|
retrievalQueries?: string[];
|
|
3562
3572
|
/** Optional. Google search entry for the following-up web searches. */
|
|
3563
3573
|
searchEntryPoint?: SearchEntryPoint;
|
|
3564
|
-
/** Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. */
|
|
3574
|
+
/** 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. */
|
|
3565
3575
|
sourceFlaggingUris?: GroundingMetadataSourceFlaggingUri[];
|
|
3566
3576
|
/** Optional. Web search queries for the following-up web search. */
|
|
3567
3577
|
webSearchQueries?: string[];
|
|
3568
3578
|
}
|
|
3569
3579
|
|
|
3570
|
-
/** Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. */
|
|
3580
|
+
/** 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. */
|
|
3571
3581
|
export declare interface GroundingMetadataSourceFlaggingUri {
|
|
3572
3582
|
/** A link where users can flag a problem with the source (place or review). */
|
|
3573
3583
|
flagContentUri?: string;
|
|
@@ -3635,42 +3645,46 @@ export declare enum HarmCategory {
|
|
|
3635
3645
|
* The harm category is unspecified.
|
|
3636
3646
|
*/
|
|
3637
3647
|
HARM_CATEGORY_UNSPECIFIED = "HARM_CATEGORY_UNSPECIFIED",
|
|
3638
|
-
/**
|
|
3639
|
-
* The harm category is hate speech.
|
|
3640
|
-
*/
|
|
3641
|
-
HARM_CATEGORY_HATE_SPEECH = "HARM_CATEGORY_HATE_SPEECH",
|
|
3642
|
-
/**
|
|
3643
|
-
* The harm category is dangerous content.
|
|
3644
|
-
*/
|
|
3645
|
-
HARM_CATEGORY_DANGEROUS_CONTENT = "HARM_CATEGORY_DANGEROUS_CONTENT",
|
|
3646
3648
|
/**
|
|
3647
3649
|
* The harm category is harassment.
|
|
3648
3650
|
*/
|
|
3649
3651
|
HARM_CATEGORY_HARASSMENT = "HARM_CATEGORY_HARASSMENT",
|
|
3652
|
+
/**
|
|
3653
|
+
* The harm category is hate speech.
|
|
3654
|
+
*/
|
|
3655
|
+
HARM_CATEGORY_HATE_SPEECH = "HARM_CATEGORY_HATE_SPEECH",
|
|
3650
3656
|
/**
|
|
3651
3657
|
* The harm category is sexually explicit content.
|
|
3652
3658
|
*/
|
|
3653
3659
|
HARM_CATEGORY_SEXUALLY_EXPLICIT = "HARM_CATEGORY_SEXUALLY_EXPLICIT",
|
|
3660
|
+
/**
|
|
3661
|
+
* The harm category is dangerous content.
|
|
3662
|
+
*/
|
|
3663
|
+
HARM_CATEGORY_DANGEROUS_CONTENT = "HARM_CATEGORY_DANGEROUS_CONTENT",
|
|
3654
3664
|
/**
|
|
3655
3665
|
* Deprecated: Election filter is not longer supported. The harm category is civic integrity.
|
|
3656
3666
|
*/
|
|
3657
3667
|
HARM_CATEGORY_CIVIC_INTEGRITY = "HARM_CATEGORY_CIVIC_INTEGRITY",
|
|
3658
3668
|
/**
|
|
3659
|
-
* The harm category is image hate.
|
|
3669
|
+
* The harm category is image hate. This enum value is not supported in Gemini API.
|
|
3660
3670
|
*/
|
|
3661
3671
|
HARM_CATEGORY_IMAGE_HATE = "HARM_CATEGORY_IMAGE_HATE",
|
|
3662
3672
|
/**
|
|
3663
|
-
* The harm category is image dangerous content.
|
|
3673
|
+
* The harm category is image dangerous content. This enum value is not supported in Gemini API.
|
|
3664
3674
|
*/
|
|
3665
3675
|
HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT = "HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT",
|
|
3666
3676
|
/**
|
|
3667
|
-
* The harm category is image harassment.
|
|
3677
|
+
* The harm category is image harassment. This enum value is not supported in Gemini API.
|
|
3668
3678
|
*/
|
|
3669
3679
|
HARM_CATEGORY_IMAGE_HARASSMENT = "HARM_CATEGORY_IMAGE_HARASSMENT",
|
|
3670
3680
|
/**
|
|
3671
|
-
* The harm category is image sexually explicit content.
|
|
3681
|
+
* The harm category is image sexually explicit content. This enum value is not supported in Gemini API.
|
|
3682
|
+
*/
|
|
3683
|
+
HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT = "HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT",
|
|
3684
|
+
/**
|
|
3685
|
+
* The harm category is for jailbreak prompts. This enum value is not supported in Gemini API.
|
|
3672
3686
|
*/
|
|
3673
|
-
|
|
3687
|
+
HARM_CATEGORY_JAILBREAK = "HARM_CATEGORY_JAILBREAK"
|
|
3674
3688
|
}
|
|
3675
3689
|
|
|
3676
3690
|
/** Output only. Harm probability levels in the content. */
|
|
@@ -4076,9 +4090,9 @@ export declare interface ListFilesParameters {
|
|
|
4076
4090
|
export declare class ListFilesResponse {
|
|
4077
4091
|
/** Used to retain the full HTTP response. */
|
|
4078
4092
|
sdkHttpResponse?: HttpResponse;
|
|
4079
|
-
/** A token
|
|
4093
|
+
/** A token that can be sent as a `page_token` into a subsequent `ListFiles` call. */
|
|
4080
4094
|
nextPageToken?: string;
|
|
4081
|
-
/** The list of
|
|
4095
|
+
/** The list of `File`s. */
|
|
4082
4096
|
files?: File_2[];
|
|
4083
4097
|
}
|
|
4084
4098
|
|
|
@@ -5738,7 +5752,7 @@ export declare interface Part {
|
|
|
5738
5752
|
|
|
5739
5753
|
export declare type PartListUnion = PartUnion[] | PartUnion;
|
|
5740
5754
|
|
|
5741
|
-
/** Tuning spec for Partner models. */
|
|
5755
|
+
/** Tuning spec for Partner models. This data type is not supported in Gemini API. */
|
|
5742
5756
|
export declare interface PartnerModelTuningSpec {
|
|
5743
5757
|
/** Hyperparameters for tuning. The accepted hyper_parameters and their valid range of values will differ depending on the base model. */
|
|
5744
5758
|
hyperParameters?: Record<string, unknown>;
|
|
@@ -5772,7 +5786,7 @@ export declare interface PrebuiltVoiceConfig {
|
|
|
5772
5786
|
voiceName?: string;
|
|
5773
5787
|
}
|
|
5774
5788
|
|
|
5775
|
-
/** Statistics computed for datasets used for preference optimization. */
|
|
5789
|
+
/** Statistics computed for datasets used for preference optimization. This data type is not supported in Gemini API. */
|
|
5776
5790
|
export declare interface PreferenceOptimizationDataStats {
|
|
5777
5791
|
/** Output only. Dataset distributions for scores variance per example. */
|
|
5778
5792
|
scoreVariancePerExampleDistribution?: DatasetDistribution;
|
|
@@ -5792,7 +5806,7 @@ export declare interface PreferenceOptimizationDataStats {
|
|
|
5792
5806
|
userOutputTokenDistribution?: DatasetDistribution;
|
|
5793
5807
|
}
|
|
5794
5808
|
|
|
5795
|
-
/** A pre-tuned model for continuous tuning. */
|
|
5809
|
+
/** A pre-tuned model for continuous tuning. This data type is not supported in Gemini API. */
|
|
5796
5810
|
export declare interface PreTunedModel {
|
|
5797
5811
|
/** Output only. The name of the base model this PreTunedModel was tuned from. */
|
|
5798
5812
|
baseModel?: string;
|
|
@@ -5816,7 +5830,7 @@ export declare interface ProductImage {
|
|
|
5816
5830
|
productImage?: Image_2;
|
|
5817
5831
|
}
|
|
5818
5832
|
|
|
5819
|
-
/** A RagChunk includes the content of a chunk of a RagFile, and associated metadata. */
|
|
5833
|
+
/** A RagChunk includes the content of a chunk of a RagFile, and associated metadata. This data type is not supported in Gemini API. */
|
|
5820
5834
|
export declare interface RagChunk {
|
|
5821
5835
|
/** If populated, represents where the chunk starts and ends in the document. */
|
|
5822
5836
|
pageSpan?: RagChunkPageSpan;
|
|
@@ -5824,7 +5838,7 @@ export declare interface RagChunk {
|
|
|
5824
5838
|
text?: string;
|
|
5825
5839
|
}
|
|
5826
5840
|
|
|
5827
|
-
/** Represents where the chunk starts and ends in the document. */
|
|
5841
|
+
/** Represents where the chunk starts and ends in the document. This data type is not supported in Gemini API. */
|
|
5828
5842
|
export declare interface RagChunkPageSpan {
|
|
5829
5843
|
/** Page where chunk starts in the document. Inclusive. 1-indexed. */
|
|
5830
5844
|
firstPage?: number;
|
|
@@ -5832,7 +5846,7 @@ export declare interface RagChunkPageSpan {
|
|
|
5832
5846
|
lastPage?: number;
|
|
5833
5847
|
}
|
|
5834
5848
|
|
|
5835
|
-
/** Specifies the context retrieval config. */
|
|
5849
|
+
/** Specifies the context retrieval config. This data type is not supported in Gemini API. */
|
|
5836
5850
|
export declare interface RagRetrievalConfig {
|
|
5837
5851
|
/** Optional. Config for filters. */
|
|
5838
5852
|
filter?: RagRetrievalConfigFilter;
|
|
@@ -5844,7 +5858,7 @@ export declare interface RagRetrievalConfig {
|
|
|
5844
5858
|
topK?: number;
|
|
5845
5859
|
}
|
|
5846
5860
|
|
|
5847
|
-
/** Config for filters. */
|
|
5861
|
+
/** Config for filters. This data type is not supported in Gemini API. */
|
|
5848
5862
|
export declare interface RagRetrievalConfigFilter {
|
|
5849
5863
|
/** Optional. String for metadata filtering. */
|
|
5850
5864
|
metadataFilter?: string;
|
|
@@ -5854,13 +5868,13 @@ export declare interface RagRetrievalConfigFilter {
|
|
|
5854
5868
|
vectorSimilarityThreshold?: number;
|
|
5855
5869
|
}
|
|
5856
5870
|
|
|
5857
|
-
/** Config for Hybrid Search. */
|
|
5871
|
+
/** Config for Hybrid Search. This data type is not supported in Gemini API. */
|
|
5858
5872
|
export declare interface RagRetrievalConfigHybridSearch {
|
|
5859
5873
|
/** 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. */
|
|
5860
5874
|
alpha?: number;
|
|
5861
5875
|
}
|
|
5862
5876
|
|
|
5863
|
-
/** Config for ranking and reranking. */
|
|
5877
|
+
/** Config for ranking and reranking. This data type is not supported in Gemini API. */
|
|
5864
5878
|
export declare interface RagRetrievalConfigRanking {
|
|
5865
5879
|
/** Optional. Config for LlmRanker. */
|
|
5866
5880
|
llmRanker?: RagRetrievalConfigRankingLlmRanker;
|
|
@@ -5868,13 +5882,13 @@ export declare interface RagRetrievalConfigRanking {
|
|
|
5868
5882
|
rankService?: RagRetrievalConfigRankingRankService;
|
|
5869
5883
|
}
|
|
5870
5884
|
|
|
5871
|
-
/** Config for LlmRanker. */
|
|
5885
|
+
/** Config for LlmRanker. This data type is not supported in Gemini API. */
|
|
5872
5886
|
export declare interface RagRetrievalConfigRankingLlmRanker {
|
|
5873
5887
|
/** Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). */
|
|
5874
5888
|
modelName?: string;
|
|
5875
5889
|
}
|
|
5876
5890
|
|
|
5877
|
-
/** Config for Rank Service. */
|
|
5891
|
+
/** Config for Rank Service. This data type is not supported in Gemini API. */
|
|
5878
5892
|
export declare interface RagRetrievalConfigRankingRankService {
|
|
5879
5893
|
/** Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` */
|
|
5880
5894
|
modelName?: string;
|
|
@@ -6024,7 +6038,7 @@ export declare class ReplayResponse {
|
|
|
6024
6038
|
sdkResponseSegments?: Record<string, unknown>[];
|
|
6025
6039
|
}
|
|
6026
6040
|
|
|
6027
|
-
/** Defines a retrieval tool that model can call to access external knowledge. */
|
|
6041
|
+
/** Defines a retrieval tool that model can call to access external knowledge. This data type is not supported in Gemini API. */
|
|
6028
6042
|
export declare interface Retrieval {
|
|
6029
6043
|
/** Optional. Deprecated. This option is no longer supported. */
|
|
6030
6044
|
disableAttribution?: boolean;
|
|
@@ -6079,11 +6093,11 @@ export declare interface SafetyRating {
|
|
|
6079
6093
|
overwrittenThreshold?: HarmBlockThreshold;
|
|
6080
6094
|
/** Output only. Harm probability levels in the content. */
|
|
6081
6095
|
probability?: HarmProbability;
|
|
6082
|
-
/** Output only. Harm probability score. */
|
|
6096
|
+
/** Output only. Harm probability score. This field is not supported in Gemini API. */
|
|
6083
6097
|
probabilityScore?: number;
|
|
6084
6098
|
/** Output only. Harm severity levels in the content. */
|
|
6085
6099
|
severity?: HarmSeverity;
|
|
6086
|
-
/** Output only. Harm severity score. */
|
|
6100
|
+
/** Output only. Harm severity score. This field is not supported in Gemini API. */
|
|
6087
6101
|
severityScore?: number;
|
|
6088
6102
|
}
|
|
6089
6103
|
|
|
@@ -6610,7 +6624,7 @@ export declare enum SubjectReferenceType {
|
|
|
6610
6624
|
SUBJECT_TYPE_PRODUCT = "SUBJECT_TYPE_PRODUCT"
|
|
6611
6625
|
}
|
|
6612
6626
|
|
|
6613
|
-
/** Hyperparameters for SFT. */
|
|
6627
|
+
/** Hyperparameters for SFT. This data type is not supported in Gemini API. */
|
|
6614
6628
|
export declare interface SupervisedHyperParameters {
|
|
6615
6629
|
/** Optional. Adapter size for tuning. */
|
|
6616
6630
|
adapterSize?: AdapterSize;
|
|
@@ -6624,7 +6638,7 @@ export declare interface SupervisedHyperParameters {
|
|
|
6624
6638
|
learningRateMultiplier?: number;
|
|
6625
6639
|
}
|
|
6626
6640
|
|
|
6627
|
-
/** Dataset distribution for Supervised Tuning. */
|
|
6641
|
+
/** Dataset distribution for Supervised Tuning. This data type is not supported in Gemini API. */
|
|
6628
6642
|
export declare interface SupervisedTuningDatasetDistribution {
|
|
6629
6643
|
/** Output only. Sum of a given population of values that are billable. */
|
|
6630
6644
|
billableSum?: string;
|
|
@@ -6646,7 +6660,7 @@ export declare interface SupervisedTuningDatasetDistribution {
|
|
|
6646
6660
|
sum?: string;
|
|
6647
6661
|
}
|
|
6648
6662
|
|
|
6649
|
-
/** Dataset bucket used to create a histogram for the distribution given a population of values. */
|
|
6663
|
+
/** Dataset bucket used to create a histogram for the distribution given a population of values. This data type is not supported in Gemini API. */
|
|
6650
6664
|
export declare interface SupervisedTuningDatasetDistributionDatasetBucket {
|
|
6651
6665
|
/** Output only. Number of values in the bucket. */
|
|
6652
6666
|
count?: number;
|
|
@@ -6656,7 +6670,7 @@ export declare interface SupervisedTuningDatasetDistributionDatasetBucket {
|
|
|
6656
6670
|
right?: number;
|
|
6657
6671
|
}
|
|
6658
6672
|
|
|
6659
|
-
/** Tuning data statistics for Supervised Tuning. */
|
|
6673
|
+
/** Tuning data statistics for Supervised Tuning. This data type is not supported in Gemini API. */
|
|
6660
6674
|
export declare interface SupervisedTuningDataStats {
|
|
6661
6675
|
/** Output only. For each index in `truncated_example_indices`, the user-facing reason why the example was dropped. */
|
|
6662
6676
|
droppedExampleReasons?: string[];
|
|
@@ -6684,7 +6698,7 @@ export declare interface SupervisedTuningDataStats {
|
|
|
6684
6698
|
userOutputTokenDistribution?: SupervisedTuningDatasetDistribution;
|
|
6685
6699
|
}
|
|
6686
6700
|
|
|
6687
|
-
/** Tuning Spec for Supervised Tuning for first party models. */
|
|
6701
|
+
/** Tuning Spec for Supervised Tuning for first party models. This data type is not supported in Gemini API. */
|
|
6688
6702
|
export declare interface SupervisedTuningSpec {
|
|
6689
6703
|
/** 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. */
|
|
6690
6704
|
exportLastCheckpointOnly?: boolean;
|
|
@@ -6838,7 +6852,7 @@ export declare interface TokensInfo {
|
|
|
6838
6852
|
export declare interface Tool {
|
|
6839
6853
|
/** List of function declarations that the tool supports. */
|
|
6840
6854
|
functionDeclarations?: FunctionDeclaration[];
|
|
6841
|
-
/** 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. */
|
|
6855
|
+
/** 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. */
|
|
6842
6856
|
retrieval?: Retrieval;
|
|
6843
6857
|
/** Optional. Google Search tool type. Specialized retrieval tool
|
|
6844
6858
|
that is powered by Google Search. */
|
|
@@ -6861,7 +6875,7 @@ export declare interface Tool {
|
|
|
6861
6875
|
codeExecution?: ToolCodeExecution;
|
|
6862
6876
|
}
|
|
6863
6877
|
|
|
6864
|
-
/** 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. */
|
|
6878
|
+
/** 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. */
|
|
6865
6879
|
export declare interface ToolCodeExecution {
|
|
6866
6880
|
}
|
|
6867
6881
|
|
|
@@ -6905,10 +6919,18 @@ export declare interface Transcription {
|
|
|
6905
6919
|
finished?: boolean;
|
|
6906
6920
|
}
|
|
6907
6921
|
|
|
6922
|
+
/** TunedModel for the Tuned Model of a Tuning Job. */
|
|
6908
6923
|
export declare interface TunedModel {
|
|
6909
|
-
/** Output only. The resource name of the TunedModel.
|
|
6924
|
+
/** Output only. The resource name of the TunedModel.
|
|
6925
|
+
Format: `projects/{project}/locations/{location}/models/{model}@{version_id}`
|
|
6926
|
+
When tuning from a base model, the version_id will be 1.
|
|
6927
|
+
For continuous tuning, the version id will be incremented by 1 from the
|
|
6928
|
+
last version id in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}`
|
|
6929
|
+
*/
|
|
6910
6930
|
model?: string;
|
|
6911
|
-
/** Output only. A resource name of an Endpoint.
|
|
6931
|
+
/** Output only. A resource name of an Endpoint.
|
|
6932
|
+
Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.
|
|
6933
|
+
*/
|
|
6912
6934
|
endpoint?: string;
|
|
6913
6935
|
/** The checkpoints associated with this TunedModel.
|
|
6914
6936
|
This field is only populated for tuning jobs that enable intermediate
|
|
@@ -6953,7 +6975,7 @@ export declare interface TuningDataset {
|
|
|
6953
6975
|
examples?: TuningExample[];
|
|
6954
6976
|
}
|
|
6955
6977
|
|
|
6956
|
-
/** The tuning data statistic values for TuningJob. */
|
|
6978
|
+
/** The tuning data statistic values for TuningJob. This data type is not supported in Gemini API. */
|
|
6957
6979
|
export declare interface TuningDataStats {
|
|
6958
6980
|
/** Output only. Statistics for distillation. */
|
|
6959
6981
|
distillationDataStats?: DistillationDataStats;
|
|
@@ -6963,11 +6985,12 @@ export declare interface TuningDataStats {
|
|
|
6963
6985
|
supervisedTuningDataStats?: SupervisedTuningDataStats;
|
|
6964
6986
|
}
|
|
6965
6987
|
|
|
6988
|
+
/** A single example for tuning. This data type is not supported in Vertex AI. */
|
|
6966
6989
|
export declare interface TuningExample {
|
|
6967
|
-
/**
|
|
6968
|
-
textInput?: string;
|
|
6969
|
-
/** The expected model output. */
|
|
6990
|
+
/** Required. The expected model output. */
|
|
6970
6991
|
output?: string;
|
|
6992
|
+
/** Optional. Text model input. */
|
|
6993
|
+
textInput?: string;
|
|
6971
6994
|
}
|
|
6972
6995
|
|
|
6973
6996
|
/** A tuning job. */
|
|
@@ -7122,7 +7145,7 @@ export declare enum TuningTask {
|
|
|
7122
7145
|
export declare interface TuningValidationDataset {
|
|
7123
7146
|
/** GCS URI of the file containing validation dataset in JSONL format. */
|
|
7124
7147
|
gcsUri?: string;
|
|
7125
|
-
/** The resource name of the Vertex Multimodal Dataset that is used as
|
|
7148
|
+
/** 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'. */
|
|
7126
7149
|
vertexDatasetResource?: string;
|
|
7127
7150
|
}
|
|
7128
7151
|
|
|
@@ -7213,6 +7236,7 @@ declare namespace types {
|
|
|
7213
7236
|
createModelContent,
|
|
7214
7237
|
Outcome,
|
|
7215
7238
|
Language,
|
|
7239
|
+
FunctionResponseScheduling,
|
|
7216
7240
|
Type,
|
|
7217
7241
|
HarmCategory,
|
|
7218
7242
|
HarmBlockMethod,
|
|
@@ -7256,7 +7280,6 @@ declare namespace types {
|
|
|
7256
7280
|
EndSensitivity,
|
|
7257
7281
|
ActivityHandling,
|
|
7258
7282
|
TurnCoverage,
|
|
7259
|
-
FunctionResponseScheduling,
|
|
7260
7283
|
Scale,
|
|
7261
7284
|
MusicGenerationMode,
|
|
7262
7285
|
LiveMusicPlaybackControl,
|
|
@@ -7404,7 +7427,6 @@ declare namespace types {
|
|
|
7404
7427
|
DeleteModelConfig,
|
|
7405
7428
|
DeleteModelParameters,
|
|
7406
7429
|
DeleteModelResponse,
|
|
7407
|
-
GenerationConfigThinkingConfig,
|
|
7408
7430
|
GenerationConfig,
|
|
7409
7431
|
CountTokensConfig,
|
|
7410
7432
|
CountTokensParameters,
|
|
@@ -7540,6 +7562,7 @@ declare namespace types {
|
|
|
7540
7562
|
LiveServerSessionResumptionUpdate,
|
|
7541
7563
|
LiveServerMessage,
|
|
7542
7564
|
OperationFromAPIResponseParameters,
|
|
7565
|
+
GenerationConfigThinkingConfig,
|
|
7543
7566
|
AutomaticActivityDetection,
|
|
7544
7567
|
RealtimeInputConfig,
|
|
7545
7568
|
SessionResumptionConfig,
|
|
@@ -7824,7 +7847,7 @@ export declare interface UsageMetadata {
|
|
|
7824
7847
|
trafficType?: TrafficType;
|
|
7825
7848
|
}
|
|
7826
7849
|
|
|
7827
|
-
/** Hyperparameters for Veo. */
|
|
7850
|
+
/** Hyperparameters for Veo. This data type is not supported in Gemini API. */
|
|
7828
7851
|
export declare interface VeoHyperParameters {
|
|
7829
7852
|
/** Optional. Number of complete passes the model makes over the entire training dataset during training. */
|
|
7830
7853
|
epochCount?: string;
|
|
@@ -7834,7 +7857,7 @@ export declare interface VeoHyperParameters {
|
|
|
7834
7857
|
tuningTask?: TuningTask;
|
|
7835
7858
|
}
|
|
7836
7859
|
|
|
7837
|
-
/** Tuning Spec for Veo Model Tuning. */
|
|
7860
|
+
/** Tuning Spec for Veo Model Tuning. This data type is not supported in Gemini API. */
|
|
7838
7861
|
export declare interface VeoTuningSpec {
|
|
7839
7862
|
/** Optional. Hyperparameters for Veo. */
|
|
7840
7863
|
hyperParameters?: VeoHyperParameters;
|
|
@@ -7844,7 +7867,7 @@ export declare interface VeoTuningSpec {
|
|
|
7844
7867
|
validationDatasetUri?: string;
|
|
7845
7868
|
}
|
|
7846
7869
|
|
|
7847
|
-
/** Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder */
|
|
7870
|
+
/** 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. */
|
|
7848
7871
|
export declare interface VertexAISearch {
|
|
7849
7872
|
/** 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. */
|
|
7850
7873
|
dataStoreSpecs?: VertexAISearchDataStoreSpec[];
|
|
@@ -7858,7 +7881,7 @@ export declare interface VertexAISearch {
|
|
|
7858
7881
|
maxResults?: number;
|
|
7859
7882
|
}
|
|
7860
7883
|
|
|
7861
|
-
/** 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 */
|
|
7884
|
+
/** 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. */
|
|
7862
7885
|
export declare interface VertexAISearchDataStoreSpec {
|
|
7863
7886
|
/** Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` */
|
|
7864
7887
|
dataStore?: string;
|
|
@@ -7866,7 +7889,7 @@ export declare interface VertexAISearchDataStoreSpec {
|
|
|
7866
7889
|
filter?: string;
|
|
7867
7890
|
}
|
|
7868
7891
|
|
|
7869
|
-
/** Retrieve from Vertex RAG Store for grounding. */
|
|
7892
|
+
/** Retrieve from Vertex RAG Store for grounding. This data type is not supported in Gemini API. */
|
|
7870
7893
|
export declare interface VertexRagStore {
|
|
7871
7894
|
/** Optional. Deprecated. Please use rag_resources instead. */
|
|
7872
7895
|
ragCorpora?: string[];
|
|
@@ -7882,7 +7905,7 @@ export declare interface VertexRagStore {
|
|
|
7882
7905
|
vectorDistanceThreshold?: number;
|
|
7883
7906
|
}
|
|
7884
7907
|
|
|
7885
|
-
/** The definition of the Rag resource. */
|
|
7908
|
+
/** The definition of the Rag resource. This data type is not supported in Gemini API. */
|
|
7886
7909
|
export declare interface VertexRagStoreRagResource {
|
|
7887
7910
|
/** Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` */
|
|
7888
7911
|
ragCorpus?: string;
|