@google/genai 1.26.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.
@@ -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;
@@ -673,11 +674,11 @@ export declare enum BlockedReason {
673
674
  */
674
675
  IMAGE_SAFETY = "IMAGE_SAFETY",
675
676
  /**
676
- * The prompt was blocked by Model Armor.
677
+ * The prompt was blocked by Model Armor. This enum value is not supported in Gemini API.
677
678
  */
678
679
  MODEL_ARMOR = "MODEL_ARMOR",
679
680
  /**
680
- * The prompt was blocked as a jailbreak attempt.
681
+ * The prompt was blocked as a jailbreak attempt. This enum value is not supported in Gemini API.
681
682
  */
682
683
  JAILBREAK = "JAILBREAK"
683
684
  }
@@ -702,15 +703,15 @@ export declare interface CachedContent {
702
703
 
703
704
  /** Metadata on the usage of the cached content. */
704
705
  export declare interface CachedContentUsageMetadata {
705
- /** Duration of audio in seconds. */
706
+ /** Duration of audio in seconds. This field is not supported in Gemini API. */
706
707
  audioDurationSeconds?: number;
707
- /** Number of images. */
708
+ /** Number of images. This field is not supported in Gemini API. */
708
709
  imageCount?: number;
709
- /** Number of text characters. */
710
+ /** Number of text characters. This field is not supported in Gemini API. */
710
711
  textCount?: number;
711
712
  /** Total number of tokens that the cached content consumes. */
712
713
  totalTokenCount?: number;
713
- /** Duration of video in seconds. */
714
+ /** Duration of video in seconds. This field is not supported in Gemini API. */
714
715
  videoDurationSeconds?: number;
715
716
  }
716
717
 
@@ -1041,7 +1042,7 @@ export declare interface Checkpoint {
1041
1042
  step?: string;
1042
1043
  }
1043
1044
 
1044
- /** Source attributions for content. */
1045
+ /** Source attributions for content. This data type is not supported in Gemini API. */
1045
1046
  export declare interface Citation {
1046
1047
  /** Output only. End index into the content. */
1047
1048
  endIndex?: number;
@@ -1538,7 +1539,7 @@ export declare interface CreateTuningJobConfig {
1538
1539
  be charged usage for any applicable operations.
1539
1540
  */
1540
1541
  abortSignal?: AbortSignal;
1541
- /** Cloud Storage path to file containing training dataset for tuning. The dataset must be formatted as a JSONL file. */
1542
+ /** Validation dataset for tuning. The dataset must be formatted as a JSONL file. */
1542
1543
  validationDataset?: TuningValidationDataset;
1543
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. */
1544
1545
  tunedModelDisplayName?: string;
@@ -1589,7 +1590,7 @@ export declare interface CreateTuningJobParametersPrivate {
1589
1590
  */
1590
1591
  export declare function createUserContent(partOrString: PartListUnion | string): Content;
1591
1592
 
1592
- /** Distribution computed over a tuning dataset. */
1593
+ /** Distribution computed over a tuning dataset. This data type is not supported in Gemini API. */
1593
1594
  export declare interface DatasetDistribution {
1594
1595
  /** Output only. Defines the histogram bucket. */
1595
1596
  buckets?: DatasetDistributionDistributionBucket[];
@@ -1609,7 +1610,7 @@ export declare interface DatasetDistribution {
1609
1610
  sum?: number;
1610
1611
  }
1611
1612
 
1612
- /** 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. */
1613
1614
  export declare interface DatasetDistributionDistributionBucket {
1614
1615
  /** Output only. Number of values in the bucket. */
1615
1616
  count?: string;
@@ -1619,7 +1620,7 @@ export declare interface DatasetDistributionDistributionBucket {
1619
1620
  right?: number;
1620
1621
  }
1621
1622
 
1622
- /** Statistics computed over a tuning dataset. */
1623
+ /** Statistics computed over a tuning dataset. This data type is not supported in Gemini API. */
1623
1624
  export declare interface DatasetStats {
1624
1625
  /** Output only. Number of billable characters in the tuning dataset. */
1625
1626
  totalBillableCharacterCount?: string;
@@ -1753,7 +1754,7 @@ export declare interface DeleteResourceJob {
1753
1754
  error?: JobError;
1754
1755
  }
1755
1756
 
1756
- /** Statistics computed for datasets used for distillation. */
1757
+ /** Statistics computed for datasets used for distillation. This data type is not supported in Gemini API. */
1757
1758
  export declare interface DistillationDataStats {
1758
1759
  /** Output only. Statistics computed for the training dataset. */
1759
1760
  trainingDatasetStats?: DatasetStats;
@@ -1990,7 +1991,7 @@ export declare interface EmbeddingsBatchJobSource {
1990
1991
  inlinedRequests?: EmbedContentBatch;
1991
1992
  }
1992
1993
 
1993
- /** 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. */
1994
1995
  export declare interface EncryptionSpec {
1995
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. */
1996
1997
  kmsKeyName?: string;
@@ -2054,7 +2055,7 @@ export declare interface ExecutableCode {
2054
2055
  language?: Language;
2055
2056
  }
2056
2057
 
2057
- /** 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. */
2058
2059
  export declare interface ExternalApi {
2059
2060
  /** The authentication config to access the API. Deprecated. Please use auth_config instead. */
2060
2061
  apiAuth?: ApiAuth;
@@ -2070,7 +2071,7 @@ export declare interface ExternalApi {
2070
2071
  simpleSearchParams?: ExternalApiSimpleSearchParams;
2071
2072
  }
2072
2073
 
2073
- /** 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. */
2074
2075
  export declare interface ExternalApiElasticSearchParams {
2075
2076
  /** The ElasticSearch index to use. */
2076
2077
  index?: string;
@@ -2080,7 +2081,7 @@ export declare interface ExternalApiElasticSearchParams {
2080
2081
  searchTemplate?: string;
2081
2082
  }
2082
2083
 
2083
- /** 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. */
2084
2085
  export declare interface ExternalApiSimpleSearchParams {
2085
2086
  }
2086
2087
 
@@ -2517,7 +2518,7 @@ export declare enum FunctionResponseScheduling {
2517
2518
  INTERRUPT = "INTERRUPT"
2518
2519
  }
2519
2520
 
2520
- /** Input example for preference optimization. */
2521
+ /** Input example for preference optimization. This data type is not supported in Gemini API. */
2521
2522
  export declare interface GeminiPreferenceExample {
2522
2523
  /** List of completions for a given prompt. */
2523
2524
  completions?: GeminiPreferenceExampleCompletion[];
@@ -2525,7 +2526,7 @@ export declare interface GeminiPreferenceExample {
2525
2526
  contents?: Content[];
2526
2527
  }
2527
2528
 
2528
- /** Completion and its preference score. */
2529
+ /** Completion and its preference score. This data type is not supported in Gemini API. */
2529
2530
  export declare interface GeminiPreferenceExampleCompletion {
2530
2531
  /** Single turn completion for the given prompt. */
2531
2532
  completion?: Content;
@@ -2851,13 +2852,13 @@ export declare class GenerateContentResponse {
2851
2852
  export declare class GenerateContentResponsePromptFeedback {
2852
2853
  /** Output only. The reason why the prompt was blocked. */
2853
2854
  blockReason?: BlockedReason;
2854
- /** Output only. A readable message that explains the reason why the prompt was blocked. */
2855
+ /** Output only. A readable message that explains the reason why the prompt was blocked. This field is not supported in Gemini API. */
2855
2856
  blockReasonMessage?: string;
2856
2857
  /** Output only. A list of safety ratings for the prompt. There is one rating per category. */
2857
2858
  safetyRatings?: SafetyRating[];
2858
2859
  }
2859
2860
 
2860
- /** Usage metadata about response(s). */
2861
+ /** Usage metadata about response(s). This data type is not supported in Gemini API. */
2861
2862
  export declare class GenerateContentResponseUsageMetadata {
2862
2863
  /** Output only. List of modalities of the cached content in the request input. */
2863
2864
  cacheTokensDetails?: ModalityTokenCount[];
@@ -3117,11 +3118,11 @@ export declare interface GenerateVideosSource {
3117
3118
  export declare interface GenerationConfig {
3118
3119
  /** Optional. Config for model selection. */
3119
3120
  modelSelectionConfig?: ModelSelectionConfig;
3120
- /** 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. */
3121
3122
  audioTimestamp?: boolean;
3122
3123
  /** Optional. Number of candidates to generate. */
3123
3124
  candidateCount?: number;
3124
- /** 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. */
3125
3126
  enableAffectiveDialog?: boolean;
3126
3127
  /** Optional. Frequency penalties. */
3127
3128
  frequencyPenalty?: number;
@@ -3143,7 +3144,7 @@ export declare interface GenerationConfig {
3143
3144
  responseModalities?: Modality[];
3144
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. */
3145
3146
  responseSchema?: Schema;
3146
- /** Optional. Routing configuration. */
3147
+ /** Optional. Routing configuration. This field is not supported in Gemini API. */
3147
3148
  routingConfig?: GenerationConfigRoutingConfig;
3148
3149
  /** Optional. Seed. */
3149
3150
  seed?: number;
@@ -3159,11 +3160,11 @@ export declare interface GenerationConfig {
3159
3160
  topK?: number;
3160
3161
  /** Optional. If specified, nucleus sampling will be used. */
3161
3162
  topP?: number;
3162
- /** Optional. Enables enhanced civic answers. It may not be available for all models. */
3163
+ /** Optional. Enables enhanced civic answers. It may not be available for all models. This field is not supported in Vertex AI. */
3163
3164
  enableEnhancedCivicAnswers?: boolean;
3164
3165
  }
3165
3166
 
3166
- /** 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. */
3167
3168
  export declare interface GenerationConfigRoutingConfig {
3168
3169
  /** Automated routing. */
3169
3170
  autoMode?: GenerationConfigRoutingConfigAutoRoutingMode;
@@ -3171,13 +3172,13 @@ export declare interface GenerationConfigRoutingConfig {
3171
3172
  manualMode?: GenerationConfigRoutingConfigManualRoutingMode;
3172
3173
  }
3173
3174
 
3174
- /** 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. */
3175
3176
  export declare interface GenerationConfigRoutingConfigAutoRoutingMode {
3176
3177
  /** The model routing preference. */
3177
3178
  modelRoutingPreference?: 'UNKNOWN' | 'PRIORITIZE_QUALITY' | 'BALANCED' | 'PRIORITIZE_COST';
3178
3179
  }
3179
3180
 
3180
- /** 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. */
3181
3182
  export declare interface GenerationConfigRoutingConfigManualRoutingMode {
3182
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). */
3183
3184
  modelName?: string;
@@ -3448,7 +3449,7 @@ export declare interface GoogleMaps {
3448
3449
  enableWidget?: boolean;
3449
3450
  }
3450
3451
 
3451
- /** 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. */
3452
3453
  export declare interface GoogleRpcStatus {
3453
3454
  /** The status code, which should be an enum value of google.rpc.Code. */
3454
3455
  code?: number;
@@ -3464,7 +3465,7 @@ export declare interface GoogleSearch {
3464
3465
  If customers set a start time, they must set an end time (and vice versa).
3465
3466
  */
3466
3467
  timeRangeFilter?: Interval;
3467
- /** Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. */
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. */
3468
3469
  excludeDomains?: string[];
3469
3470
  }
3470
3471
 
@@ -3474,7 +3475,7 @@ export declare interface GoogleSearchRetrieval {
3474
3475
  dynamicRetrievalConfig?: DynamicRetrievalConfig;
3475
3476
  }
3476
3477
 
3477
- /** 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. */
3478
3479
  export declare interface GoogleTypeDate {
3479
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. */
3480
3481
  day?: number;
@@ -3486,15 +3487,15 @@ export declare interface GoogleTypeDate {
3486
3487
 
3487
3488
  /** Grounding chunk. */
3488
3489
  export declare interface GroundingChunk {
3489
- /** Grounding chunk from Google Maps. */
3490
+ /** Grounding chunk from Google Maps. This field is not supported in Gemini API. */
3490
3491
  maps?: GroundingChunkMaps;
3491
- /** 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. */
3492
3493
  retrievedContext?: GroundingChunkRetrievedContext;
3493
3494
  /** Grounding chunk from the web. */
3494
3495
  web?: GroundingChunkWeb;
3495
3496
  }
3496
3497
 
3497
- /** Chunk from Google Maps. */
3498
+ /** Chunk from Google Maps. This data type is not supported in Gemini API. */
3498
3499
  export declare interface GroundingChunkMaps {
3499
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. */
3500
3501
  placeAnswerSources?: GroundingChunkMapsPlaceAnswerSources;
@@ -3508,7 +3509,7 @@ export declare interface GroundingChunkMaps {
3508
3509
  uri?: string;
3509
3510
  }
3510
3511
 
3511
- /** Sources used to generate the place answer. */
3512
+ /** Sources used to generate the place answer. This data type is not supported in Gemini API. */
3512
3513
  export declare interface GroundingChunkMapsPlaceAnswerSources {
3513
3514
  /** A link where users can flag a problem with the generated answer. */
3514
3515
  flagContentUri?: string;
@@ -3516,7 +3517,7 @@ export declare interface GroundingChunkMapsPlaceAnswerSources {
3516
3517
  reviewSnippets?: GroundingChunkMapsPlaceAnswerSourcesReviewSnippet[];
3517
3518
  }
3518
3519
 
3519
- /** Author attribution for a photo or review. */
3520
+ /** Author attribution for a photo or review. This data type is not supported in Gemini API. */
3520
3521
  export declare interface GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution {
3521
3522
  /** Name of the author of the Photo or Review. */
3522
3523
  displayName?: string;
@@ -3526,7 +3527,7 @@ export declare interface GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution {
3526
3527
  uri?: string;
3527
3528
  }
3528
3529
 
3529
- /** Encapsulates a review snippet. */
3530
+ /** Encapsulates a review snippet. This data type is not supported in Gemini API. */
3530
3531
  export declare interface GroundingChunkMapsPlaceAnswerSourcesReviewSnippet {
3531
3532
  /** This review's author. */
3532
3533
  authorAttribution?: GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution;
@@ -3544,7 +3545,7 @@ export declare interface GroundingChunkMapsPlaceAnswerSourcesReviewSnippet {
3544
3545
  title?: string;
3545
3546
  }
3546
3547
 
3547
- /** 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. */
3548
3549
  export declare interface GroundingChunkRetrievedContext {
3549
3550
  /** Output only. The full document name for the referenced Vertex AI Search document. */
3550
3551
  documentName?: string;
@@ -3560,7 +3561,7 @@ export declare interface GroundingChunkRetrievedContext {
3560
3561
 
3561
3562
  /** Chunk from the web. */
3562
3563
  export declare interface GroundingChunkWeb {
3563
- /** Domain of the (original) URI. */
3564
+ /** Domain of the (original) URI. This field is not supported in Gemini API. */
3564
3565
  domain?: string;
3565
3566
  /** Title of the chunk. */
3566
3567
  title?: string;
@@ -3570,7 +3571,7 @@ export declare interface GroundingChunkWeb {
3570
3571
 
3571
3572
  /** Metadata returned to client when grounding is enabled. */
3572
3573
  export declare interface GroundingMetadata {
3573
- /** 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. */
3574
3575
  googleMapsWidgetContextToken?: string;
3575
3576
  /** List of supporting references retrieved from specified grounding source. */
3576
3577
  groundingChunks?: GroundingChunk[];
@@ -3578,17 +3579,17 @@ export declare interface GroundingMetadata {
3578
3579
  groundingSupports?: GroundingSupport[];
3579
3580
  /** Optional. Output only. Retrieval metadata. */
3580
3581
  retrievalMetadata?: RetrievalMetadata;
3581
- /** Optional. Queries executed by the retrieval tools. */
3582
+ /** Optional. Queries executed by the retrieval tools. This field is not supported in Gemini API. */
3582
3583
  retrievalQueries?: string[];
3583
3584
  /** Optional. Google search entry for the following-up web searches. */
3584
3585
  searchEntryPoint?: SearchEntryPoint;
3585
- /** 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. */
3586
3587
  sourceFlaggingUris?: GroundingMetadataSourceFlaggingUri[];
3587
3588
  /** Optional. Web search queries for the following-up web search. */
3588
3589
  webSearchQueries?: string[];
3589
3590
  }
3590
3591
 
3591
- /** 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. */
3592
3593
  export declare interface GroundingMetadataSourceFlaggingUri {
3593
3594
  /** A link where users can flag a problem with the source (place or review). */
3594
3595
  flagContentUri?: string;
@@ -3677,23 +3678,23 @@ export declare enum HarmCategory {
3677
3678
  */
3678
3679
  HARM_CATEGORY_CIVIC_INTEGRITY = "HARM_CATEGORY_CIVIC_INTEGRITY",
3679
3680
  /**
3680
- * The harm category is image hate.
3681
+ * The harm category is image hate. This enum value is not supported in Gemini API.
3681
3682
  */
3682
3683
  HARM_CATEGORY_IMAGE_HATE = "HARM_CATEGORY_IMAGE_HATE",
3683
3684
  /**
3684
- * The harm category is image dangerous content.
3685
+ * The harm category is image dangerous content. This enum value is not supported in Gemini API.
3685
3686
  */
3686
3687
  HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT = "HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT",
3687
3688
  /**
3688
- * The harm category is image harassment.
3689
+ * The harm category is image harassment. This enum value is not supported in Gemini API.
3689
3690
  */
3690
3691
  HARM_CATEGORY_IMAGE_HARASSMENT = "HARM_CATEGORY_IMAGE_HARASSMENT",
3691
3692
  /**
3692
- * 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.
3693
3694
  */
3694
3695
  HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT = "HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT",
3695
3696
  /**
3696
- * The harm category is for jailbreak prompts.
3697
+ * The harm category is for jailbreak prompts. This enum value is not supported in Gemini API.
3697
3698
  */
3698
3699
  HARM_CATEGORY_JAILBREAK = "HARM_CATEGORY_JAILBREAK"
3699
3700
  }
@@ -5763,7 +5764,7 @@ export declare interface Part {
5763
5764
 
5764
5765
  export declare type PartListUnion = PartUnion[] | PartUnion;
5765
5766
 
5766
- /** Tuning spec for Partner models. */
5767
+ /** Tuning spec for Partner models. This data type is not supported in Gemini API. */
5767
5768
  export declare interface PartnerModelTuningSpec {
5768
5769
  /** Hyperparameters for tuning. The accepted hyper_parameters and their valid range of values will differ depending on the base model. */
5769
5770
  hyperParameters?: Record<string, unknown>;
@@ -5797,7 +5798,7 @@ export declare interface PrebuiltVoiceConfig {
5797
5798
  voiceName?: string;
5798
5799
  }
5799
5800
 
5800
- /** 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. */
5801
5802
  export declare interface PreferenceOptimizationDataStats {
5802
5803
  /** Output only. Dataset distributions for scores variance per example. */
5803
5804
  scoreVariancePerExampleDistribution?: DatasetDistribution;
@@ -5817,7 +5818,7 @@ export declare interface PreferenceOptimizationDataStats {
5817
5818
  userOutputTokenDistribution?: DatasetDistribution;
5818
5819
  }
5819
5820
 
5820
- /** A pre-tuned model for continuous tuning. */
5821
+ /** A pre-tuned model for continuous tuning. This data type is not supported in Gemini API. */
5821
5822
  export declare interface PreTunedModel {
5822
5823
  /** Output only. The name of the base model this PreTunedModel was tuned from. */
5823
5824
  baseModel?: string;
@@ -5841,7 +5842,7 @@ export declare interface ProductImage {
5841
5842
  productImage?: Image_2;
5842
5843
  }
5843
5844
 
5844
- /** 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. */
5845
5846
  export declare interface RagChunk {
5846
5847
  /** If populated, represents where the chunk starts and ends in the document. */
5847
5848
  pageSpan?: RagChunkPageSpan;
@@ -5849,7 +5850,7 @@ export declare interface RagChunk {
5849
5850
  text?: string;
5850
5851
  }
5851
5852
 
5852
- /** 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. */
5853
5854
  export declare interface RagChunkPageSpan {
5854
5855
  /** Page where chunk starts in the document. Inclusive. 1-indexed. */
5855
5856
  firstPage?: number;
@@ -5857,7 +5858,7 @@ export declare interface RagChunkPageSpan {
5857
5858
  lastPage?: number;
5858
5859
  }
5859
5860
 
5860
- /** Specifies the context retrieval config. */
5861
+ /** Specifies the context retrieval config. This data type is not supported in Gemini API. */
5861
5862
  export declare interface RagRetrievalConfig {
5862
5863
  /** Optional. Config for filters. */
5863
5864
  filter?: RagRetrievalConfigFilter;
@@ -5869,7 +5870,7 @@ export declare interface RagRetrievalConfig {
5869
5870
  topK?: number;
5870
5871
  }
5871
5872
 
5872
- /** Config for filters. */
5873
+ /** Config for filters. This data type is not supported in Gemini API. */
5873
5874
  export declare interface RagRetrievalConfigFilter {
5874
5875
  /** Optional. String for metadata filtering. */
5875
5876
  metadataFilter?: string;
@@ -5879,13 +5880,13 @@ export declare interface RagRetrievalConfigFilter {
5879
5880
  vectorSimilarityThreshold?: number;
5880
5881
  }
5881
5882
 
5882
- /** Config for Hybrid Search. */
5883
+ /** Config for Hybrid Search. This data type is not supported in Gemini API. */
5883
5884
  export declare interface RagRetrievalConfigHybridSearch {
5884
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. */
5885
5886
  alpha?: number;
5886
5887
  }
5887
5888
 
5888
- /** Config for ranking and reranking. */
5889
+ /** Config for ranking and reranking. This data type is not supported in Gemini API. */
5889
5890
  export declare interface RagRetrievalConfigRanking {
5890
5891
  /** Optional. Config for LlmRanker. */
5891
5892
  llmRanker?: RagRetrievalConfigRankingLlmRanker;
@@ -5893,13 +5894,13 @@ export declare interface RagRetrievalConfigRanking {
5893
5894
  rankService?: RagRetrievalConfigRankingRankService;
5894
5895
  }
5895
5896
 
5896
- /** Config for LlmRanker. */
5897
+ /** Config for LlmRanker. This data type is not supported in Gemini API. */
5897
5898
  export declare interface RagRetrievalConfigRankingLlmRanker {
5898
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). */
5899
5900
  modelName?: string;
5900
5901
  }
5901
5902
 
5902
- /** Config for Rank Service. */
5903
+ /** Config for Rank Service. This data type is not supported in Gemini API. */
5903
5904
  export declare interface RagRetrievalConfigRankingRankService {
5904
5905
  /** Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` */
5905
5906
  modelName?: string;
@@ -6049,7 +6050,7 @@ export declare class ReplayResponse {
6049
6050
  sdkResponseSegments?: Record<string, unknown>[];
6050
6051
  }
6051
6052
 
6052
- /** 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. */
6053
6054
  export declare interface Retrieval {
6054
6055
  /** Optional. Deprecated. This option is no longer supported. */
6055
6056
  disableAttribution?: boolean;
@@ -6104,11 +6105,11 @@ export declare interface SafetyRating {
6104
6105
  overwrittenThreshold?: HarmBlockThreshold;
6105
6106
  /** Output only. Harm probability levels in the content. */
6106
6107
  probability?: HarmProbability;
6107
- /** Output only. Harm probability score. */
6108
+ /** Output only. Harm probability score. This field is not supported in Gemini API. */
6108
6109
  probabilityScore?: number;
6109
6110
  /** Output only. Harm severity levels in the content. */
6110
6111
  severity?: HarmSeverity;
6111
- /** Output only. Harm severity score. */
6112
+ /** Output only. Harm severity score. This field is not supported in Gemini API. */
6112
6113
  severityScore?: number;
6113
6114
  }
6114
6115
 
@@ -6635,7 +6636,7 @@ export declare enum SubjectReferenceType {
6635
6636
  SUBJECT_TYPE_PRODUCT = "SUBJECT_TYPE_PRODUCT"
6636
6637
  }
6637
6638
 
6638
- /** Hyperparameters for SFT. */
6639
+ /** Hyperparameters for SFT. This data type is not supported in Gemini API. */
6639
6640
  export declare interface SupervisedHyperParameters {
6640
6641
  /** Optional. Adapter size for tuning. */
6641
6642
  adapterSize?: AdapterSize;
@@ -6649,7 +6650,7 @@ export declare interface SupervisedHyperParameters {
6649
6650
  learningRateMultiplier?: number;
6650
6651
  }
6651
6652
 
6652
- /** Dataset distribution for Supervised Tuning. */
6653
+ /** Dataset distribution for Supervised Tuning. This data type is not supported in Gemini API. */
6653
6654
  export declare interface SupervisedTuningDatasetDistribution {
6654
6655
  /** Output only. Sum of a given population of values that are billable. */
6655
6656
  billableSum?: string;
@@ -6671,7 +6672,7 @@ export declare interface SupervisedTuningDatasetDistribution {
6671
6672
  sum?: string;
6672
6673
  }
6673
6674
 
6674
- /** 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. */
6675
6676
  export declare interface SupervisedTuningDatasetDistributionDatasetBucket {
6676
6677
  /** Output only. Number of values in the bucket. */
6677
6678
  count?: number;
@@ -6681,7 +6682,7 @@ export declare interface SupervisedTuningDatasetDistributionDatasetBucket {
6681
6682
  right?: number;
6682
6683
  }
6683
6684
 
6684
- /** Tuning data statistics for Supervised Tuning. */
6685
+ /** Tuning data statistics for Supervised Tuning. This data type is not supported in Gemini API. */
6685
6686
  export declare interface SupervisedTuningDataStats {
6686
6687
  /** Output only. For each index in `truncated_example_indices`, the user-facing reason why the example was dropped. */
6687
6688
  droppedExampleReasons?: string[];
@@ -6709,7 +6710,7 @@ export declare interface SupervisedTuningDataStats {
6709
6710
  userOutputTokenDistribution?: SupervisedTuningDatasetDistribution;
6710
6711
  }
6711
6712
 
6712
- /** 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. */
6713
6714
  export declare interface SupervisedTuningSpec {
6714
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. */
6715
6716
  exportLastCheckpointOnly?: boolean;
@@ -6863,7 +6864,7 @@ export declare interface TokensInfo {
6863
6864
  export declare interface Tool {
6864
6865
  /** List of function declarations that the tool supports. */
6865
6866
  functionDeclarations?: FunctionDeclaration[];
6866
- /** 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. */
6867
6868
  retrieval?: Retrieval;
6868
6869
  /** Optional. Google Search tool type. Specialized retrieval tool
6869
6870
  that is powered by Google Search. */
@@ -6886,7 +6887,7 @@ export declare interface Tool {
6886
6887
  codeExecution?: ToolCodeExecution;
6887
6888
  }
6888
6889
 
6889
- /** 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. */
6890
6891
  export declare interface ToolCodeExecution {
6891
6892
  }
6892
6893
 
@@ -6986,7 +6987,7 @@ export declare interface TuningDataset {
6986
6987
  examples?: TuningExample[];
6987
6988
  }
6988
6989
 
6989
- /** The tuning data statistic values for TuningJob. */
6990
+ /** The tuning data statistic values for TuningJob. This data type is not supported in Gemini API. */
6990
6991
  export declare interface TuningDataStats {
6991
6992
  /** Output only. Statistics for distillation. */
6992
6993
  distillationDataStats?: DistillationDataStats;
@@ -6996,7 +6997,7 @@ export declare interface TuningDataStats {
6996
6997
  supervisedTuningDataStats?: SupervisedTuningDataStats;
6997
6998
  }
6998
6999
 
6999
- /** A single example for tuning. */
7000
+ /** A single example for tuning. This data type is not supported in Vertex AI. */
7000
7001
  export declare interface TuningExample {
7001
7002
  /** Required. The expected model output. */
7002
7003
  output?: string;
@@ -7156,7 +7157,7 @@ export declare enum TuningTask {
7156
7157
  export declare interface TuningValidationDataset {
7157
7158
  /** GCS URI of the file containing validation dataset in JSONL format. */
7158
7159
  gcsUri?: string;
7159
- /** The resource name of the Vertex Multimodal Dataset that is used as training dataset. Example: 'projects/my-project-id-or-number/locations/my-location/datasets/my-dataset-id'. */
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'. */
7160
7161
  vertexDatasetResource?: string;
7161
7162
  }
7162
7163
 
@@ -7858,7 +7859,7 @@ export declare interface UsageMetadata {
7858
7859
  trafficType?: TrafficType;
7859
7860
  }
7860
7861
 
7861
- /** Hyperparameters for Veo. */
7862
+ /** Hyperparameters for Veo. This data type is not supported in Gemini API. */
7862
7863
  export declare interface VeoHyperParameters {
7863
7864
  /** Optional. Number of complete passes the model makes over the entire training dataset during training. */
7864
7865
  epochCount?: string;
@@ -7868,7 +7869,7 @@ export declare interface VeoHyperParameters {
7868
7869
  tuningTask?: TuningTask;
7869
7870
  }
7870
7871
 
7871
- /** Tuning Spec for Veo Model Tuning. */
7872
+ /** Tuning Spec for Veo Model Tuning. This data type is not supported in Gemini API. */
7872
7873
  export declare interface VeoTuningSpec {
7873
7874
  /** Optional. Hyperparameters for Veo. */
7874
7875
  hyperParameters?: VeoHyperParameters;
@@ -7878,7 +7879,7 @@ export declare interface VeoTuningSpec {
7878
7879
  validationDatasetUri?: string;
7879
7880
  }
7880
7881
 
7881
- /** 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. */
7882
7883
  export declare interface VertexAISearch {
7883
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. */
7884
7885
  dataStoreSpecs?: VertexAISearchDataStoreSpec[];
@@ -7892,7 +7893,7 @@ export declare interface VertexAISearch {
7892
7893
  maxResults?: number;
7893
7894
  }
7894
7895
 
7895
- /** 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. */
7896
7897
  export declare interface VertexAISearchDataStoreSpec {
7897
7898
  /** Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` */
7898
7899
  dataStore?: string;
@@ -7900,7 +7901,7 @@ export declare interface VertexAISearchDataStoreSpec {
7900
7901
  filter?: string;
7901
7902
  }
7902
7903
 
7903
- /** Retrieve from Vertex RAG Store for grounding. */
7904
+ /** Retrieve from Vertex RAG Store for grounding. This data type is not supported in Gemini API. */
7904
7905
  export declare interface VertexRagStore {
7905
7906
  /** Optional. Deprecated. Please use rag_resources instead. */
7906
7907
  ragCorpora?: string[];
@@ -7916,7 +7917,7 @@ export declare interface VertexRagStore {
7916
7917
  vectorDistanceThreshold?: number;
7917
7918
  }
7918
7919
 
7919
- /** The definition of the Rag resource. */
7920
+ /** The definition of the Rag resource. This data type is not supported in Gemini API. */
7920
7921
  export declare interface VertexRagStoreRagResource {
7921
7922
  /** Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` */
7922
7923
  ragCorpus?: string;