google-api-python-client 2.186.0__py3-none-any.whl → 2.187.0__py3-none-any.whl

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.
Files changed (178) hide show
  1. {google_api_python_client-2.186.0.dist-info → google_api_python_client-2.187.0.dist-info}/METADATA +1 -1
  2. {google_api_python_client-2.186.0.dist-info → google_api_python_client-2.187.0.dist-info}/RECORD +178 -177
  3. googleapiclient/discovery_cache/documents/admin.directory_v1.json +27 -1
  4. googleapiclient/discovery_cache/documents/admin.directoryv1.json +27 -1
  5. googleapiclient/discovery_cache/documents/aiplatform.v1.json +15863 -7693
  6. googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +21493 -10629
  7. googleapiclient/discovery_cache/documents/alloydb.v1.json +35 -10
  8. googleapiclient/discovery_cache/documents/alloydb.v1alpha.json +35 -10
  9. googleapiclient/discovery_cache/documents/alloydb.v1beta.json +35 -10
  10. googleapiclient/discovery_cache/documents/analyticshub.v1.json +39 -1
  11. googleapiclient/discovery_cache/documents/androidmanagement.v1.json +2 -2
  12. googleapiclient/discovery_cache/documents/androidpublisher.v3.json +31 -3
  13. googleapiclient/discovery_cache/documents/apigateway.v1.json +2 -2
  14. googleapiclient/discovery_cache/documents/apigateway.v1beta.json +2 -2
  15. googleapiclient/discovery_cache/documents/apigee.v1.json +162 -5
  16. googleapiclient/discovery_cache/documents/apihub.v1.json +17 -5
  17. googleapiclient/discovery_cache/documents/apim.v1alpha.json +2 -2
  18. googleapiclient/discovery_cache/documents/apphub.v1.json +34 -2
  19. googleapiclient/discovery_cache/documents/apphub.v1alpha.json +34 -2
  20. googleapiclient/discovery_cache/documents/artifactregistry.v1.json +100 -4
  21. googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json +31 -3
  22. googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1alpha.json +31 -3
  23. googleapiclient/discovery_cache/documents/backupdr.v1.json +202 -2
  24. googleapiclient/discovery_cache/documents/batch.v1.json +11 -5
  25. googleapiclient/discovery_cache/documents/biglake.v1.json +273 -1
  26. googleapiclient/discovery_cache/documents/bigquery.v2.json +5 -1
  27. googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json +15 -1
  28. googleapiclient/discovery_cache/documents/bigtableadmin.v2.json +3 -3
  29. googleapiclient/discovery_cache/documents/businessprofileperformance.v1.json +43 -1
  30. googleapiclient/discovery_cache/documents/chat.v1.json +12 -6
  31. googleapiclient/discovery_cache/documents/chromewebstore.v2.json +550 -0
  32. googleapiclient/discovery_cache/documents/cloudbuild.v2.json +2 -2
  33. googleapiclient/discovery_cache/documents/clouddeploy.v1.json +2 -2
  34. googleapiclient/discovery_cache/documents/cloudfunctions.v1.json +2 -2
  35. googleapiclient/discovery_cache/documents/cloudfunctions.v2.json +2 -2
  36. googleapiclient/discovery_cache/documents/cloudfunctions.v2alpha.json +45 -2
  37. googleapiclient/discovery_cache/documents/cloudfunctions.v2beta.json +45 -2
  38. googleapiclient/discovery_cache/documents/cloudidentity.v1.json +3 -3
  39. googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json +74 -3
  40. googleapiclient/discovery_cache/documents/cloudkms.v1.json +20 -65
  41. googleapiclient/discovery_cache/documents/cloudlocationfinder.v1.json +2 -2
  42. googleapiclient/discovery_cache/documents/cloudlocationfinder.v1alpha.json +2 -2
  43. googleapiclient/discovery_cache/documents/cloudscheduler.v1.json +81 -7
  44. googleapiclient/discovery_cache/documents/cloudscheduler.v1beta1.json +201 -7
  45. googleapiclient/discovery_cache/documents/cloudtasks.v2.json +2 -2
  46. googleapiclient/discovery_cache/documents/cloudtasks.v2beta2.json +2 -2
  47. googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json +2 -2
  48. googleapiclient/discovery_cache/documents/compute.alpha.json +1824 -199
  49. googleapiclient/discovery_cache/documents/compute.beta.json +1770 -260
  50. googleapiclient/discovery_cache/documents/compute.v1.json +397 -20
  51. googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json +2 -2
  52. googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json +231 -309
  53. googleapiclient/discovery_cache/documents/container.v1.json +219 -182
  54. googleapiclient/discovery_cache/documents/container.v1beta1.json +332 -183
  55. googleapiclient/discovery_cache/documents/dataflow.v1b3.json +76 -1
  56. googleapiclient/discovery_cache/documents/dataplex.v1.json +36 -6
  57. googleapiclient/discovery_cache/documents/dataproc.v1.json +3 -2
  58. googleapiclient/discovery_cache/documents/datastream.v1.json +31 -3
  59. googleapiclient/discovery_cache/documents/datastream.v1alpha1.json +13 -1
  60. googleapiclient/discovery_cache/documents/deploymentmanager.alpha.json +16 -7
  61. googleapiclient/discovery_cache/documents/deploymentmanager.v2.json +16 -7
  62. googleapiclient/discovery_cache/documents/deploymentmanager.v2beta.json +16 -7
  63. googleapiclient/discovery_cache/documents/developerconnect.v1.json +44 -1
  64. googleapiclient/discovery_cache/documents/dfareporting.v4.json +47 -6
  65. googleapiclient/discovery_cache/documents/dfareporting.v5.json +47 -6
  66. googleapiclient/discovery_cache/documents/dialogflow.v2.json +33 -3
  67. googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json +33 -3
  68. googleapiclient/discovery_cache/documents/dialogflow.v3.json +70 -2
  69. googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json +70 -2
  70. googleapiclient/discovery_cache/documents/discoveryengine.v1.json +534 -7
  71. googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +1861 -14
  72. googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +326 -6
  73. googleapiclient/discovery_cache/documents/displayvideo.v2.json +20 -9
  74. googleapiclient/discovery_cache/documents/displayvideo.v3.json +587 -15
  75. googleapiclient/discovery_cache/documents/displayvideo.v4.json +1741 -186
  76. googleapiclient/discovery_cache/documents/dlp.v2.json +4 -5
  77. googleapiclient/discovery_cache/documents/docs.v1.json +36 -36
  78. googleapiclient/discovery_cache/documents/documentai.v1.json +2462 -423
  79. googleapiclient/discovery_cache/documents/documentai.v1beta3.json +1557 -129
  80. googleapiclient/discovery_cache/documents/drive.v3.json +27 -1
  81. googleapiclient/discovery_cache/documents/eventarc.v1.json +2 -2
  82. googleapiclient/discovery_cache/documents/file.v1.json +54 -1
  83. googleapiclient/discovery_cache/documents/file.v1beta1.json +13 -1
  84. googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json +66 -1
  85. googleapiclient/discovery_cache/documents/firebaseapphosting.v1.json +14 -2
  86. googleapiclient/discovery_cache/documents/firebaseapphosting.v1beta.json +14 -2
  87. googleapiclient/discovery_cache/documents/firebasedataconnect.v1.json +59 -7
  88. googleapiclient/discovery_cache/documents/firebasedataconnect.v1beta.json +59 -7
  89. googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +234 -234
  90. googleapiclient/discovery_cache/documents/firestore.v1.json +2 -2
  91. googleapiclient/discovery_cache/documents/gkehub.v1.json +2 -2
  92. googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +2 -2
  93. googleapiclient/discovery_cache/documents/gkehub.v1beta.json +2 -2
  94. googleapiclient/discovery_cache/documents/gkehub.v1beta1.json +2 -2
  95. googleapiclient/discovery_cache/documents/gkehub.v2.json +2 -2
  96. googleapiclient/discovery_cache/documents/gkehub.v2alpha.json +2 -2
  97. googleapiclient/discovery_cache/documents/gkehub.v2beta.json +2 -2
  98. googleapiclient/discovery_cache/documents/gkeonprem.v1.json +44 -2
  99. googleapiclient/discovery_cache/documents/healthcare.v1.json +7 -2
  100. googleapiclient/discovery_cache/documents/healthcare.v1beta1.json +7 -2
  101. googleapiclient/discovery_cache/documents/iamcredentials.v1.json +1 -143
  102. googleapiclient/discovery_cache/documents/identitytoolkit.v1.json +5 -5
  103. googleapiclient/discovery_cache/documents/ids.v1.json +14 -2
  104. googleapiclient/discovery_cache/documents/language.v1.json +170 -4
  105. googleapiclient/discovery_cache/documents/language.v1beta2.json +170 -4
  106. googleapiclient/discovery_cache/documents/language.v2.json +170 -4
  107. googleapiclient/discovery_cache/documents/logging.v2.json +33 -1
  108. googleapiclient/discovery_cache/documents/looker.v1.json +28 -2
  109. googleapiclient/discovery_cache/documents/managedkafka.v1.json +14 -5
  110. googleapiclient/discovery_cache/documents/marketingplatformadmin.v1alpha.json +304 -1
  111. googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json +17 -17
  112. googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json +17 -17
  113. googleapiclient/discovery_cache/documents/metastore.v1.json +2 -2
  114. googleapiclient/discovery_cache/documents/metastore.v1alpha.json +2 -2
  115. googleapiclient/discovery_cache/documents/metastore.v1beta.json +2 -2
  116. googleapiclient/discovery_cache/documents/migrationcenter.v1.json +2 -2
  117. googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json +48 -9
  118. googleapiclient/discovery_cache/documents/mybusinessplaceactions.v1.json +9 -5
  119. googleapiclient/discovery_cache/documents/netapp.v1.json +3 -3
  120. googleapiclient/discovery_cache/documents/netapp.v1beta1.json +3 -3
  121. googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json +2 -2
  122. googleapiclient/discovery_cache/documents/networkmanagement.v1.json +3 -3
  123. googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +3 -3
  124. googleapiclient/discovery_cache/documents/networkservices.v1.json +316 -9
  125. googleapiclient/discovery_cache/documents/networkservices.v1beta1.json +21 -11
  126. googleapiclient/discovery_cache/documents/notebooks.v2.json +6 -1
  127. googleapiclient/discovery_cache/documents/observability.v1.json +2 -2
  128. googleapiclient/discovery_cache/documents/oracledatabase.v1.json +2 -2
  129. googleapiclient/discovery_cache/documents/parallelstore.v1.json +2 -2
  130. googleapiclient/discovery_cache/documents/parallelstore.v1beta.json +2 -2
  131. googleapiclient/discovery_cache/documents/parametermanager.v1.json +12 -2
  132. googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json +20 -1
  133. googleapiclient/discovery_cache/documents/places.v1.json +11 -3
  134. googleapiclient/discovery_cache/documents/privateca.v1.json +2 -2
  135. googleapiclient/discovery_cache/documents/privateca.v1beta1.json +2 -2
  136. googleapiclient/discovery_cache/documents/pubsub.v1.json +22 -1
  137. googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json +6 -6
  138. googleapiclient/discovery_cache/documents/recommender.v1beta1.json +5 -5
  139. googleapiclient/discovery_cache/documents/redis.v1.json +24 -33
  140. googleapiclient/discovery_cache/documents/redis.v1beta1.json +24 -33
  141. googleapiclient/discovery_cache/documents/retail.v2alpha.json +3 -2
  142. googleapiclient/discovery_cache/documents/retail.v2beta.json +3 -2
  143. googleapiclient/discovery_cache/documents/run.v1.json +2 -2
  144. googleapiclient/discovery_cache/documents/run.v2.json +1 -1
  145. googleapiclient/discovery_cache/documents/securitycenter.v1.json +103 -1
  146. googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json +103 -1
  147. googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json +102 -1
  148. googleapiclient/discovery_cache/documents/securityposture.v1.json +13 -1
  149. googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json +17 -1
  150. googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json +5 -1
  151. googleapiclient/discovery_cache/documents/servicedirectory.v1.json +2 -2
  152. googleapiclient/discovery_cache/documents/servicedirectory.v1beta1.json +2 -2
  153. googleapiclient/discovery_cache/documents/servicemanagement.v1.json +2 -2
  154. googleapiclient/discovery_cache/documents/servicenetworking.v1.json +2 -2
  155. googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json +2 -2
  156. googleapiclient/discovery_cache/documents/serviceusage.v1.json +35 -12
  157. googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json +35 -12
  158. googleapiclient/discovery_cache/documents/solar.v1.json +6 -1
  159. googleapiclient/discovery_cache/documents/spanner.v1.json +6 -4
  160. googleapiclient/discovery_cache/documents/sqladmin.v1.json +19 -5
  161. googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json +21 -7
  162. googleapiclient/discovery_cache/documents/storagebatchoperations.v1.json +2 -2
  163. googleapiclient/discovery_cache/documents/storagetransfer.v1.json +14 -2
  164. googleapiclient/discovery_cache/documents/trafficdirector.v2.json +228 -1
  165. googleapiclient/discovery_cache/documents/trafficdirector.v3.json +228 -1
  166. googleapiclient/discovery_cache/documents/travelimpactmodel.v1.json +6 -6
  167. googleapiclient/discovery_cache/documents/vmmigration.v1.json +11 -3
  168. googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json +2 -2
  169. googleapiclient/discovery_cache/documents/vmwareengine.v1.json +13 -1
  170. googleapiclient/discovery_cache/documents/vpcaccess.v1.json +14 -2
  171. googleapiclient/discovery_cache/documents/vpcaccess.v1beta1.json +14 -2
  172. googleapiclient/discovery_cache/documents/workflows.v1.json +13 -1
  173. googleapiclient/discovery_cache/documents/workflows.v1beta.json +13 -1
  174. googleapiclient/discovery_cache/documents/workloadmanager.v1.json +3 -3
  175. googleapiclient/version.py +1 -1
  176. {google_api_python_client-2.186.0.dist-info → google_api_python_client-2.187.0.dist-info}/WHEEL +0 -0
  177. {google_api_python_client-2.186.0.dist-info → google_api_python_client-2.187.0.dist-info}/licenses/LICENSE +0 -0
  178. {google_api_python_client-2.186.0.dist-info → google_api_python_client-2.187.0.dist-info}/top_level.txt +0 -0
@@ -206,7 +206,7 @@
206
206
  }
207
207
  }
208
208
  },
209
- "revision": "20251013",
209
+ "revision": "20251022",
210
210
  "rootUrl": "https://firebaseml.googleapis.com/",
211
211
  "schemas": {
212
212
  "Date": {
@@ -398,16 +398,16 @@
398
398
  "type": "object"
399
399
  },
400
400
  "GoogleCloudAiplatformV1beta1Blob": {
401
- "description": "Content blob.",
401
+ "description": "A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video.",
402
402
  "id": "GoogleCloudAiplatformV1beta1Blob",
403
403
  "properties": {
404
404
  "data": {
405
- "description": "Required. Raw bytes.",
405
+ "description": "Required. The raw bytes of the data.",
406
406
  "format": "byte",
407
407
  "type": "string"
408
408
  },
409
409
  "displayName": {
410
- "description": "Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.",
410
+ "description": "Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.",
411
411
  "type": "string"
412
412
  },
413
413
  "mimeType": {
@@ -422,28 +422,28 @@
422
422
  "id": "GoogleCloudAiplatformV1beta1Candidate",
423
423
  "properties": {
424
424
  "avgLogprobs": {
425
- "description": "Output only. Average log probability score of the candidate.",
425
+ "description": "Output only. The average log probability of the tokens in this candidate. This is a length-normalized score that can be used to compare the quality of candidates of different lengths. A higher average log probability suggests a more confident and coherent response.",
426
426
  "format": "double",
427
427
  "readOnly": true,
428
428
  "type": "number"
429
429
  },
430
430
  "citationMetadata": {
431
431
  "$ref": "GoogleCloudAiplatformV1beta1CitationMetadata",
432
- "description": "Output only. Source attribution of the generated content.",
432
+ "description": "Output only. A collection of citations that apply to the generated content.",
433
433
  "readOnly": true
434
434
  },
435
435
  "content": {
436
436
  "$ref": "GoogleCloudAiplatformV1beta1Content",
437
- "description": "Output only. Content parts of the candidate.",
437
+ "description": "Output only. The content of the candidate.",
438
438
  "readOnly": true
439
439
  },
440
440
  "finishMessage": {
441
- "description": "Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set.",
441
+ "description": "Output only. Describes the reason the model stopped generating tokens in more detail. This field is returned only when `finish_reason` is set.",
442
442
  "readOnly": true,
443
443
  "type": "string"
444
444
  },
445
445
  "finishReason": {
446
- "description": "Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens.",
446
+ "description": "Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating.",
447
447
  "enum": [
448
448
  "FINISH_REASON_UNSPECIFIED",
449
449
  "STOP",
@@ -465,44 +465,44 @@
465
465
  ],
466
466
  "enumDescriptions": [
467
467
  "The finish reason is unspecified.",
468
- "Token generation reached a natural stopping point or a configured stop sequence.",
469
- "Token generation reached the configured maximum output tokens.",
470
- "Token generation stopped because the content potentially contains safety violations. NOTE: When streaming, content is empty if content filters blocks the output.",
471
- "The token generation stopped because of potential recitation.",
472
- "All other reasons that stopped the token generation.",
473
- "Token generation stopped because the content contains forbidden terms.",
474
- "Token generation stopped for potentially containing prohibited content.",
475
- "Token generation stopped because the content potentially contains Sensitive Personally Identifiable Information (SPII).",
476
- "The function call generated by the model is syntaxtically invalid (e.g. the function call generated is not parsable).",
468
+ "The model reached a natural stopping point or a configured stop sequence.",
469
+ "The model generated the maximum number of tokens allowed by the `max_output_tokens` parameter.",
470
+ "The model stopped generating because the content potentially violates safety policies. NOTE: When streaming, the `content` field is empty if content filters block the output.",
471
+ "The model stopped generating because the content may be a recitation from a source.",
472
+ "The model stopped generating for a reason not otherwise specified.",
473
+ "The model stopped generating because the content contains a term from a configured blocklist.",
474
+ "The model stopped generating because the content may be prohibited.",
475
+ "The model stopped generating because the content may contain sensitive personally identifiable information (SPII).",
476
+ "The model generated a function call that is syntactically invalid and can't be parsed.",
477
477
  "The model response was blocked by Model Armor.",
478
- "Token generation stopped because generated images has safety violations.",
479
- "Image generation stopped because generated images has other prohibited content.",
480
- "Image generation stopped due to recitation.",
481
- "Image generation stopped because of other miscellaneous issue.",
482
- "The function call generated by the model is semantically invalid (e.g. a function call is generated when function calling is not enabled or the function is not in the function declaration).",
483
- "The model was expected to generate an image, but none was generated."
478
+ "The generated image potentially violates safety policies.",
479
+ "The generated image may contain prohibited content.",
480
+ "The generated image may be a recitation from a source.",
481
+ "The image generation stopped for a reason not otherwise specified.",
482
+ "The model generated a function call that is semantically invalid. This can happen, for example, if function calling is not enabled or the generated function is not in the function declaration.",
483
+ "The model was expected to generate an image, but didn't."
484
484
  ],
485
485
  "readOnly": true,
486
486
  "type": "string"
487
487
  },
488
488
  "groundingMetadata": {
489
489
  "$ref": "GoogleCloudAiplatformV1beta1GroundingMetadata",
490
- "description": "Output only. Metadata specifies sources used to ground generated content.",
490
+ "description": "Output only. Metadata returned when grounding is enabled. It contains the sources used to ground the generated content.",
491
491
  "readOnly": true
492
492
  },
493
493
  "index": {
494
- "description": "Output only. Index of the candidate.",
494
+ "description": "Output only. The 0-based index of this candidate in the list of generated responses. This is useful for distinguishing between multiple candidates when `candidate_count` > 1.",
495
495
  "format": "int32",
496
496
  "readOnly": true,
497
497
  "type": "integer"
498
498
  },
499
499
  "logprobsResult": {
500
500
  "$ref": "GoogleCloudAiplatformV1beta1LogprobsResult",
501
- "description": "Output only. Log-likelihood scores for the response tokens and top tokens",
501
+ "description": "Output only. The detailed log probability information for the tokens in this candidate. This is useful for debugging, understanding model uncertainty, and identifying potential \"hallucinations\".",
502
502
  "readOnly": true
503
503
  },
504
504
  "safetyRatings": {
505
- "description": "Output only. List of ratings for the safety of a response candidate. There is at most one rating per category.",
505
+ "description": "Output only. A list of ratings for the safety of a response candidate. There is at most one rating per category.",
506
506
  "items": {
507
507
  "$ref": "GoogleCloudAiplatformV1beta1SafetyRating"
508
508
  },
@@ -511,45 +511,45 @@
511
511
  },
512
512
  "urlContextMetadata": {
513
513
  "$ref": "GoogleCloudAiplatformV1beta1UrlContextMetadata",
514
- "description": "Output only. Metadata related to url context retrieval tool.",
514
+ "description": "Output only. Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL.",
515
515
  "readOnly": true
516
516
  }
517
517
  },
518
518
  "type": "object"
519
519
  },
520
520
  "GoogleCloudAiplatformV1beta1Citation": {
521
- "description": "Source attributions for content.",
521
+ "description": "A citation for a piece of generatedcontent.",
522
522
  "id": "GoogleCloudAiplatformV1beta1Citation",
523
523
  "properties": {
524
524
  "endIndex": {
525
- "description": "Output only. End index into the content.",
525
+ "description": "Output only. The end index of the citation in the content.",
526
526
  "format": "int32",
527
527
  "readOnly": true,
528
528
  "type": "integer"
529
529
  },
530
530
  "license": {
531
- "description": "Output only. License of the attribution.",
531
+ "description": "Output only. The license of the source of the citation.",
532
532
  "readOnly": true,
533
533
  "type": "string"
534
534
  },
535
535
  "publicationDate": {
536
536
  "$ref": "Date",
537
- "description": "Output only. Publication date of the attribution.",
537
+ "description": "Output only. The publication date of the source of the citation.",
538
538
  "readOnly": true
539
539
  },
540
540
  "startIndex": {
541
- "description": "Output only. Start index into the content.",
541
+ "description": "Output only. The start index of the citation in the content.",
542
542
  "format": "int32",
543
543
  "readOnly": true,
544
544
  "type": "integer"
545
545
  },
546
546
  "title": {
547
- "description": "Output only. Title of the attribution.",
547
+ "description": "Output only. The title of the source of the citation.",
548
548
  "readOnly": true,
549
549
  "type": "string"
550
550
  },
551
551
  "uri": {
552
- "description": "Output only. Url reference of the attribution.",
552
+ "description": "Output only. The URI of the source of the citation.",
553
553
  "readOnly": true,
554
554
  "type": "string"
555
555
  }
@@ -557,11 +557,11 @@
557
557
  "type": "object"
558
558
  },
559
559
  "GoogleCloudAiplatformV1beta1CitationMetadata": {
560
- "description": "A collection of source attributions for a piece of content.",
560
+ "description": "A collection of citations that apply to a piece of generated content.",
561
561
  "id": "GoogleCloudAiplatformV1beta1CitationMetadata",
562
562
  "properties": {
563
563
  "citations": {
564
- "description": "Output only. List of citations.",
564
+ "description": "Output only. A list of citations for the content.",
565
565
  "items": {
566
566
  "$ref": "GoogleCloudAiplatformV1beta1Citation"
567
567
  },
@@ -599,18 +599,18 @@
599
599
  "type": "object"
600
600
  },
601
601
  "GoogleCloudAiplatformV1beta1Content": {
602
- "description": "The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.",
602
+ "description": "The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message.",
603
603
  "id": "GoogleCloudAiplatformV1beta1Content",
604
604
  "properties": {
605
605
  "parts": {
606
- "description": "Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.",
606
+ "description": "Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.",
607
607
  "items": {
608
608
  "$ref": "GoogleCloudAiplatformV1beta1Part"
609
609
  },
610
610
  "type": "array"
611
611
  },
612
612
  "role": {
613
- "description": "Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.",
613
+ "description": "Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.",
614
614
  "type": "string"
615
615
  }
616
616
  },
@@ -833,15 +833,15 @@
833
833
  "type": "object"
834
834
  },
835
835
  "GoogleCloudAiplatformV1beta1FileData": {
836
- "description": "URI based data.",
836
+ "description": "URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage.",
837
837
  "id": "GoogleCloudAiplatformV1beta1FileData",
838
838
  "properties": {
839
839
  "displayName": {
840
- "description": "Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.",
840
+ "description": "Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.",
841
841
  "type": "string"
842
842
  },
843
843
  "fileUri": {
844
- "description": "Required. URI.",
844
+ "description": "Required. The URI of the file in Google Cloud Storage.",
845
845
  "type": "string"
846
846
  },
847
847
  "mimeType": {
@@ -1249,24 +1249,24 @@
1249
1249
  "type": "object"
1250
1250
  },
1251
1251
  "GoogleCloudAiplatformV1beta1GenerationConfig": {
1252
- "description": "Generation config.",
1252
+ "description": "Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output.",
1253
1253
  "id": "GoogleCloudAiplatformV1beta1GenerationConfig",
1254
1254
  "properties": {
1255
1255
  "audioTimestamp": {
1256
- "description": "Optional. If enabled, audio timestamp will be included in the request to the model.",
1256
+ "description": "Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response.",
1257
1257
  "type": "boolean"
1258
1258
  },
1259
1259
  "candidateCount": {
1260
- "description": "Optional. Number of candidates to generate.",
1260
+ "description": "Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one.",
1261
1261
  "format": "int32",
1262
1262
  "type": "integer"
1263
1263
  },
1264
1264
  "enableAffectiveDialog": {
1265
- "description": "Optional. If enabled, the model will detect emotions and adapt its responses accordingly.",
1265
+ "description": "Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response.",
1266
1266
  "type": "boolean"
1267
1267
  },
1268
1268
  "frequencyPenalty": {
1269
- "description": "Optional. Frequency penalties.",
1269
+ "description": "Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0].",
1270
1270
  "format": "float",
1271
1271
  "type": "number"
1272
1272
  },
@@ -1275,17 +1275,17 @@
1275
1275
  "description": "Optional. Config for image generation features."
1276
1276
  },
1277
1277
  "logprobs": {
1278
- "description": "Optional. Logit probabilities.",
1278
+ "description": "Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response.",
1279
1279
  "format": "int32",
1280
1280
  "type": "integer"
1281
1281
  },
1282
1282
  "maxOutputTokens": {
1283
- "description": "Optional. The maximum number of output tokens to generate per message.",
1283
+ "description": "Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses.",
1284
1284
  "format": "int32",
1285
1285
  "type": "integer"
1286
1286
  },
1287
1287
  "mediaResolution": {
1288
- "description": "Optional. If specified, the media resolution specified will be used.",
1288
+ "description": "Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model.",
1289
1289
  "enum": [
1290
1290
  "MEDIA_RESOLUTION_UNSPECIFIED",
1291
1291
  "MEDIA_RESOLUTION_LOW",
@@ -1306,24 +1306,24 @@
1306
1306
  "description": "Optional. Config for model selection."
1307
1307
  },
1308
1308
  "presencePenalty": {
1309
- "description": "Optional. Positive penalties.",
1309
+ "description": "Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0].",
1310
1310
  "format": "float",
1311
1311
  "type": "number"
1312
1312
  },
1313
1313
  "responseJsonSchema": {
1314
- "description": "Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.",
1314
+ "description": "Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`.",
1315
1315
  "type": "any"
1316
1316
  },
1317
1317
  "responseLogprobs": {
1318
- "description": "Optional. If true, export the logprobs results in response.",
1318
+ "description": "Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging.",
1319
1319
  "type": "boolean"
1320
1320
  },
1321
1321
  "responseMimeType": {
1322
- "description": "Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.",
1322
+ "description": "Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.",
1323
1323
  "type": "string"
1324
1324
  },
1325
1325
  "responseModalities": {
1326
- "description": "Optional. The modalities of the response.",
1326
+ "description": "Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image.",
1327
1327
  "items": {
1328
1328
  "enum": [
1329
1329
  "MODALITY_UNSPECIFIED",
@@ -1343,14 +1343,14 @@
1343
1343
  },
1344
1344
  "responseSchema": {
1345
1345
  "$ref": "GoogleCloudAiplatformV1beta1Schema",
1346
- "description": "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."
1346
+ "description": "Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`."
1347
1347
  },
1348
1348
  "routingConfig": {
1349
1349
  "$ref": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig",
1350
1350
  "description": "Optional. Routing configuration."
1351
1351
  },
1352
1352
  "seed": {
1353
- "description": "Optional. Seed.",
1353
+ "description": "Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the \"random\" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results.",
1354
1354
  "format": "int32",
1355
1355
  "type": "integer"
1356
1356
  },
@@ -1359,28 +1359,28 @@
1359
1359
  "description": "Optional. The speech generation config."
1360
1360
  },
1361
1361
  "stopSequences": {
1362
- "description": "Optional. Stop sequences.",
1362
+ "description": "Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use [\"\\n\", \"###\"] to stop generation at a new line or a specific marker.",
1363
1363
  "items": {
1364
1364
  "type": "string"
1365
1365
  },
1366
1366
  "type": "array"
1367
1367
  },
1368
1368
  "temperature": {
1369
- "description": "Optional. Controls the randomness of predictions.",
1369
+ "description": "Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0].",
1370
1370
  "format": "float",
1371
1371
  "type": "number"
1372
1372
  },
1373
1373
  "thinkingConfig": {
1374
1374
  "$ref": "GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig",
1375
- "description": "Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking."
1375
+ "description": "Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking."
1376
1376
  },
1377
1377
  "topK": {
1378
- "description": "Optional. If specified, top-k sampling will be used.",
1378
+ "description": "Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words.",
1379
1379
  "format": "float",
1380
1380
  "type": "number"
1381
1381
  },
1382
1382
  "topP": {
1383
- "description": "Optional. If specified, nucleus sampling will be used.",
1383
+ "description": "Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both.",
1384
1384
  "format": "float",
1385
1385
  "type": "number"
1386
1386
  }
@@ -1411,22 +1411,22 @@
1411
1411
  "type": "object"
1412
1412
  },
1413
1413
  "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig": {
1414
- "description": "The configuration for routing the request to a specific model.",
1414
+ "description": "The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name.",
1415
1415
  "id": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig",
1416
1416
  "properties": {
1417
1417
  "autoMode": {
1418
1418
  "$ref": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode",
1419
- "description": "Automated routing."
1419
+ "description": "In this mode, the model is selected automatically based on the content of the request."
1420
1420
  },
1421
1421
  "manualMode": {
1422
1422
  "$ref": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode",
1423
- "description": "Manual routing."
1423
+ "description": "In this mode, the model is specified manually."
1424
1424
  }
1425
1425
  },
1426
1426
  "type": "object"
1427
1427
  },
1428
1428
  "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode": {
1429
- "description": "When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference.",
1429
+ "description": "The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference.",
1430
1430
  "id": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode",
1431
1431
  "properties": {
1432
1432
  "modelRoutingPreference": {
@@ -1439,9 +1439,9 @@
1439
1439
  ],
1440
1440
  "enumDescriptions": [
1441
1441
  "Unspecified model routing preference.",
1442
- "Prefer higher quality over low cost.",
1443
- "Balanced model routing preference.",
1444
- "Prefer lower cost over higher quality."
1442
+ "The model will be selected to prioritize the quality of the response.",
1443
+ "The model will be selected to balance quality and cost.",
1444
+ "The model will be selected to prioritize the cost of the request."
1445
1445
  ],
1446
1446
  "type": "string"
1447
1447
  }
@@ -1449,26 +1449,26 @@
1449
1449
  "type": "object"
1450
1450
  },
1451
1451
  "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode": {
1452
- "description": "When manual routing is set, the specified model will be used directly.",
1452
+ "description": "The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided.",
1453
1453
  "id": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode",
1454
1454
  "properties": {
1455
1455
  "modelName": {
1456
- "description": "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).",
1456
+ "description": "The name of the model to use. Only public LLM models are accepted.",
1457
1457
  "type": "string"
1458
1458
  }
1459
1459
  },
1460
1460
  "type": "object"
1461
1461
  },
1462
1462
  "GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig": {
1463
- "description": "Config for thinking features.",
1463
+ "description": "Configuration for the model's thinking features. \"Thinking\" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response.",
1464
1464
  "id": "GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig",
1465
1465
  "properties": {
1466
1466
  "includeThoughts": {
1467
- "description": "Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.",
1467
+ "description": "Optional. If true, the model will include its thoughts in the response. \"Thoughts\" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available.",
1468
1468
  "type": "boolean"
1469
1469
  },
1470
1470
  "thinkingBudget": {
1471
- "description": "Optional. Indicates the thinking budget in tokens.",
1471
+ "description": "Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency.",
1472
1472
  "format": "int32",
1473
1473
  "type": "integer"
1474
1474
  }
@@ -1498,57 +1498,57 @@
1498
1498
  "type": "object"
1499
1499
  },
1500
1500
  "GoogleCloudAiplatformV1beta1GroundingChunk": {
1501
- "description": "Grounding chunk.",
1501
+ "description": "A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information.",
1502
1502
  "id": "GoogleCloudAiplatformV1beta1GroundingChunk",
1503
1503
  "properties": {
1504
1504
  "maps": {
1505
1505
  "$ref": "GoogleCloudAiplatformV1beta1GroundingChunkMaps",
1506
- "description": "Grounding chunk from Google Maps."
1506
+ "description": "A grounding chunk from Google Maps. See the `Maps` message for details."
1507
1507
  },
1508
1508
  "retrievedContext": {
1509
1509
  "$ref": "GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext",
1510
- "description": "Grounding chunk from context retrieved by the retrieval tools."
1510
+ "description": "A grounding chunk from a data source retrieved by a retrieval tool, such as Vertex AI Search. See the `RetrievedContext` message for details"
1511
1511
  },
1512
1512
  "web": {
1513
1513
  "$ref": "GoogleCloudAiplatformV1beta1GroundingChunkWeb",
1514
- "description": "Grounding chunk from the web."
1514
+ "description": "A grounding chunk from a web page, typically from Google Search. See the `Web` message for details."
1515
1515
  }
1516
1516
  },
1517
1517
  "type": "object"
1518
1518
  },
1519
1519
  "GoogleCloudAiplatformV1beta1GroundingChunkMaps": {
1520
- "description": "Chunk from Google Maps.",
1520
+ "description": "A `Maps` chunk is a piece of evidence that comes from Google Maps. It contains information about a place, such as its name, address, and reviews. This is used to provide the user with rich, location-based information.",
1521
1521
  "id": "GoogleCloudAiplatformV1beta1GroundingChunkMaps",
1522
1522
  "properties": {
1523
1523
  "placeAnswerSources": {
1524
1524
  "$ref": "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSources",
1525
- "description": "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."
1525
+ "description": "The sources that were 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."
1526
1526
  },
1527
1527
  "placeId": {
1528
- "description": "This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place.",
1528
+ "description": "This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API.",
1529
1529
  "type": "string"
1530
1530
  },
1531
1531
  "text": {
1532
- "description": "Text of the place answer.",
1532
+ "description": "The text of the place answer.",
1533
1533
  "type": "string"
1534
1534
  },
1535
1535
  "title": {
1536
- "description": "Title of the place.",
1536
+ "description": "The title of the place.",
1537
1537
  "type": "string"
1538
1538
  },
1539
1539
  "uri": {
1540
- "description": "URI reference of the place.",
1540
+ "description": "The URI of the place.",
1541
1541
  "type": "string"
1542
1542
  }
1543
1543
  },
1544
1544
  "type": "object"
1545
1545
  },
1546
1546
  "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSources": {
1547
- "description": "Sources used to generate the place answer.",
1547
+ "description": "The sources that were 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.",
1548
1548
  "id": "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSources",
1549
1549
  "properties": {
1550
1550
  "reviewSnippets": {
1551
- "description": "Snippets of reviews that are used to generate the answer.",
1551
+ "description": "Snippets of reviews that were used to generate the answer.",
1552
1552
  "items": {
1553
1553
  "$ref": "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet"
1554
1554
  },
@@ -1558,7 +1558,7 @@
1558
1558
  "type": "object"
1559
1559
  },
1560
1560
  "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet": {
1561
- "description": "Encapsulates a review snippet.",
1561
+ "description": "A review snippet that is used to generate the answer.",
1562
1562
  "id": "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet",
1563
1563
  "properties": {
1564
1564
  "googleMapsUri": {
@@ -1566,81 +1566,81 @@
1566
1566
  "type": "string"
1567
1567
  },
1568
1568
  "reviewId": {
1569
- "description": "Id of the review referencing the place.",
1569
+ "description": "The ID of the review that is being referenced.",
1570
1570
  "type": "string"
1571
1571
  },
1572
1572
  "title": {
1573
- "description": "Title of the review.",
1573
+ "description": "The title of the review.",
1574
1574
  "type": "string"
1575
1575
  }
1576
1576
  },
1577
1577
  "type": "object"
1578
1578
  },
1579
1579
  "GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext": {
1580
- "description": "Chunk from context retrieved by the retrieval tools.",
1580
+ "description": "Context retrieved from a data source to ground the model's response. This is used when a retrieval tool fetches information from a user-provided corpus or a public dataset.",
1581
1581
  "id": "GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext",
1582
1582
  "properties": {
1583
1583
  "documentName": {
1584
- "description": "Output only. The full document name for the referenced Vertex AI Search document.",
1584
+ "description": "Output only. The full resource name of the referenced Vertex AI Search document. This is used to identify the specific document that was retrieved. The format is `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.",
1585
1585
  "readOnly": true,
1586
1586
  "type": "string"
1587
1587
  },
1588
1588
  "ragChunk": {
1589
1589
  "$ref": "GoogleCloudAiplatformV1beta1RagChunk",
1590
- "description": "Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool."
1590
+ "description": "Additional context for a Retrieval-Augmented Generation (RAG) retrieval result. This is populated only when the RAG retrieval tool is used."
1591
1591
  },
1592
1592
  "text": {
1593
- "description": "Text of the attribution.",
1593
+ "description": "The content of the retrieved data source.",
1594
1594
  "type": "string"
1595
1595
  },
1596
1596
  "title": {
1597
- "description": "Title of the attribution.",
1597
+ "description": "The title of the retrieved data source.",
1598
1598
  "type": "string"
1599
1599
  },
1600
1600
  "uri": {
1601
- "description": "URI reference of the attribution.",
1601
+ "description": "The URI of the retrieved data source.",
1602
1602
  "type": "string"
1603
1603
  }
1604
1604
  },
1605
1605
  "type": "object"
1606
1606
  },
1607
1607
  "GoogleCloudAiplatformV1beta1GroundingChunkWeb": {
1608
- "description": "Chunk from the web.",
1608
+ "description": "A `Web` chunk is a piece of evidence that comes from a web page. It contains the URI of the web page, the title of the page, and the domain of the page. This is used to provide the user with a link to the source of the information.",
1609
1609
  "id": "GoogleCloudAiplatformV1beta1GroundingChunkWeb",
1610
1610
  "properties": {
1611
1611
  "domain": {
1612
- "description": "Domain of the (original) URI.",
1612
+ "description": "The domain of the web page that contains the evidence. This can be used to filter out low-quality sources.",
1613
1613
  "type": "string"
1614
1614
  },
1615
1615
  "title": {
1616
- "description": "Title of the chunk.",
1616
+ "description": "The title of the web page that contains the evidence.",
1617
1617
  "type": "string"
1618
1618
  },
1619
1619
  "uri": {
1620
- "description": "URI reference of the chunk.",
1620
+ "description": "The URI of the web page that contains the evidence.",
1621
1621
  "type": "string"
1622
1622
  }
1623
1623
  },
1624
1624
  "type": "object"
1625
1625
  },
1626
1626
  "GoogleCloudAiplatformV1beta1GroundingMetadata": {
1627
- "description": "Metadata returned to client when grounding is enabled.",
1627
+ "description": "Information about the sources that support the content of a response. When grounding is enabled, the model returns citations for claims in the response. This object contains the retrieved sources.",
1628
1628
  "id": "GoogleCloudAiplatformV1beta1GroundingMetadata",
1629
1629
  "properties": {
1630
1630
  "googleMapsWidgetContextToken": {
1631
- "description": "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.",
1631
+ "description": "Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps.",
1632
1632
  "readOnly": true,
1633
1633
  "type": "string"
1634
1634
  },
1635
1635
  "groundingChunks": {
1636
- "description": "List of supporting references retrieved from specified grounding source.",
1636
+ "description": "A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps.",
1637
1637
  "items": {
1638
1638
  "$ref": "GoogleCloudAiplatformV1beta1GroundingChunk"
1639
1639
  },
1640
1640
  "type": "array"
1641
1641
  },
1642
1642
  "groundingSupports": {
1643
- "description": "Optional. List of grounding support.",
1643
+ "description": "Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search.",
1644
1644
  "items": {
1645
1645
  "$ref": "GoogleCloudAiplatformV1beta1GroundingSupport"
1646
1646
  },
@@ -1648,11 +1648,11 @@
1648
1648
  },
1649
1649
  "retrievalMetadata": {
1650
1650
  "$ref": "GoogleCloudAiplatformV1beta1RetrievalMetadata",
1651
- "description": "Optional. Output only. Retrieval metadata.",
1651
+ "description": "Optional. Output only. Metadata related to the retrieval grounding source.",
1652
1652
  "readOnly": true
1653
1653
  },
1654
1654
  "retrievalQueries": {
1655
- "description": "Optional. Queries executed by the retrieval tools.",
1655
+ "description": "Optional. The queries that were executed by the retrieval tools. This field is populated only when the grounding source is a retrieval tool, such as Vertex AI Search.",
1656
1656
  "items": {
1657
1657
  "type": "string"
1658
1658
  },
@@ -1660,10 +1660,10 @@
1660
1660
  },
1661
1661
  "searchEntryPoint": {
1662
1662
  "$ref": "GoogleCloudAiplatformV1beta1SearchEntryPoint",
1663
- "description": "Optional. Google search entry for the following-up web searches."
1663
+ "description": "Optional. A web search entry point that can be used to display search results. This field is populated only when the grounding source is Google Search."
1664
1664
  },
1665
1665
  "sourceFlaggingUris": {
1666
- "description": "Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding.",
1666
+ "description": "Optional. Output only. A list of URIs that can be used to flag a place or review for inappropriate content. This field is populated only when the grounding source is Google Maps.",
1667
1667
  "items": {
1668
1668
  "$ref": "GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri"
1669
1669
  },
@@ -1671,7 +1671,7 @@
1671
1671
  "type": "array"
1672
1672
  },
1673
1673
  "webSearchQueries": {
1674
- "description": "Optional. Web search queries for the following-up web search.",
1674
+ "description": "Optional. The web search queries that were used to generate the content. This field is populated only when the grounding source is Google Search.",
1675
1675
  "items": {
1676
1676
  "type": "string"
1677
1677
  },
@@ -1681,26 +1681,26 @@
1681
1681
  "type": "object"
1682
1682
  },
1683
1683
  "GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri": {
1684
- "description": "Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding.",
1684
+ "description": "A URI that can be used to flag a place or review for inappropriate content. This is populated only when the grounding source is Google Maps.",
1685
1685
  "id": "GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri",
1686
1686
  "properties": {
1687
1687
  "flagContentUri": {
1688
- "description": "A link where users can flag a problem with the source (place or review).",
1688
+ "description": "The URI that can be used to flag the content.",
1689
1689
  "type": "string"
1690
1690
  },
1691
1691
  "sourceId": {
1692
- "description": "Id of the place or review.",
1692
+ "description": "The ID of the place or review.",
1693
1693
  "type": "string"
1694
1694
  }
1695
1695
  },
1696
1696
  "type": "object"
1697
1697
  },
1698
1698
  "GoogleCloudAiplatformV1beta1GroundingSupport": {
1699
- "description": "Grounding support.",
1699
+ "description": "A collection of supporting references for a segment of the model's response.",
1700
1700
  "id": "GoogleCloudAiplatformV1beta1GroundingSupport",
1701
1701
  "properties": {
1702
1702
  "confidenceScores": {
1703
- "description": "Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. For Gemini 2.0 and before, this list must have the same size as the grounding_chunk_indices. For Gemini 2.5 and after, this list will be empty and should be ignored.",
1703
+ "description": "The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored.",
1704
1704
  "items": {
1705
1705
  "format": "float",
1706
1706
  "type": "number"
@@ -1708,7 +1708,7 @@
1708
1708
  "type": "array"
1709
1709
  },
1710
1710
  "groundingChunkIndices": {
1711
- "description": "A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim.",
1711
+ "description": "A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment.",
1712
1712
  "items": {
1713
1713
  "format": "int32",
1714
1714
  "type": "integer"
@@ -1717,13 +1717,13 @@
1717
1717
  },
1718
1718
  "segment": {
1719
1719
  "$ref": "GoogleCloudAiplatformV1beta1Segment",
1720
- "description": "Segment of the content this support belongs to."
1720
+ "description": "The content segment that this support message applies to."
1721
1721
  }
1722
1722
  },
1723
1723
  "type": "object"
1724
1724
  },
1725
1725
  "GoogleCloudAiplatformV1beta1ImageConfig": {
1726
- "description": "Config for image generation features.",
1726
+ "description": "Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people.",
1727
1727
  "id": "GoogleCloudAiplatformV1beta1ImageConfig",
1728
1728
  "properties": {
1729
1729
  "aspectRatio": {
@@ -1743,10 +1743,10 @@
1743
1743
  "ALLOW_NONE"
1744
1744
  ],
1745
1745
  "enumDescriptions": [
1746
- "Generation images of people unspecified.",
1747
- "Generate images that include adults and children.",
1748
- "Generate images of adults, but not children.",
1749
- "Block generation of images of people."
1746
+ "The default behavior is unspecified. The model will decide whether to generate images of people.",
1747
+ "Allows the model to generate images of people, including adults and children.",
1748
+ "Allows the model to generate images of adults, but not children.",
1749
+ "Prevents the model from generating images of people."
1750
1750
  ],
1751
1751
  "type": "string"
1752
1752
  }
@@ -1770,18 +1770,18 @@
1770
1770
  "type": "object"
1771
1771
  },
1772
1772
  "GoogleCloudAiplatformV1beta1LogprobsResult": {
1773
- "description": "Logprobs Result",
1773
+ "description": "The log probabilities of the tokens generated by the model. This is useful for understanding the model's confidence in its predictions and for debugging. For example, you can use log probabilities to identify when the model is making a less confident prediction or to explore alternative responses that the model considered. A low log probability can also indicate that the model is \"hallucinating\" or generating factually incorrect information.",
1774
1774
  "id": "GoogleCloudAiplatformV1beta1LogprobsResult",
1775
1775
  "properties": {
1776
1776
  "chosenCandidates": {
1777
- "description": "Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates.",
1777
+ "description": "A list of the chosen candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. Note that the chosen candidate might not be in `top_candidates`.",
1778
1778
  "items": {
1779
1779
  "$ref": "GoogleCloudAiplatformV1beta1LogprobsResultCandidate"
1780
1780
  },
1781
1781
  "type": "array"
1782
1782
  },
1783
1783
  "topCandidates": {
1784
- "description": "Length = total number of decoding steps.",
1784
+ "description": "A list of the top candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps.",
1785
1785
  "items": {
1786
1786
  "$ref": "GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates"
1787
1787
  },
@@ -1791,20 +1791,20 @@
1791
1791
  "type": "object"
1792
1792
  },
1793
1793
  "GoogleCloudAiplatformV1beta1LogprobsResultCandidate": {
1794
- "description": "Candidate for the logprobs token and score.",
1794
+ "description": "A single token and its associated log probability.",
1795
1795
  "id": "GoogleCloudAiplatformV1beta1LogprobsResultCandidate",
1796
1796
  "properties": {
1797
1797
  "logProbability": {
1798
- "description": "The candidate's log probability.",
1798
+ "description": "The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain.",
1799
1799
  "format": "float",
1800
1800
  "type": "number"
1801
1801
  },
1802
1802
  "token": {
1803
- "description": "The candidate's token string value.",
1803
+ "description": "The token's string representation.",
1804
1804
  "type": "string"
1805
1805
  },
1806
1806
  "tokenId": {
1807
- "description": "The candidate's token id value.",
1807
+ "description": "The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary.",
1808
1808
  "format": "int32",
1809
1809
  "type": "integer"
1810
1810
  }
@@ -1812,11 +1812,11 @@
1812
1812
  "type": "object"
1813
1813
  },
1814
1814
  "GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates": {
1815
- "description": "Candidates with top log probabilities at each decoding step.",
1815
+ "description": "A list of the top candidate tokens and their log probabilities at each decoding step. This can be used to see what other tokens the model considered.",
1816
1816
  "id": "GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates",
1817
1817
  "properties": {
1818
1818
  "candidates": {
1819
- "description": "Sorted by log probability in descending order.",
1819
+ "description": "The list of candidate tokens, sorted by log probability in descending order.",
1820
1820
  "items": {
1821
1821
  "$ref": "GoogleCloudAiplatformV1beta1LogprobsResultCandidate"
1822
1822
  },
@@ -1826,11 +1826,11 @@
1826
1826
  "type": "object"
1827
1827
  },
1828
1828
  "GoogleCloudAiplatformV1beta1ModalityTokenCount": {
1829
- "description": "Represents token counting info for a single modality.",
1829
+ "description": "Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes.",
1830
1830
  "id": "GoogleCloudAiplatformV1beta1ModalityTokenCount",
1831
1831
  "properties": {
1832
1832
  "modality": {
1833
- "description": "The modality associated with this token count.",
1833
+ "description": "The modality that this token count applies to.",
1834
1834
  "enum": [
1835
1835
  "MODALITY_UNSPECIFIED",
1836
1836
  "TEXT",
@@ -1840,17 +1840,17 @@
1840
1840
  "DOCUMENT"
1841
1841
  ],
1842
1842
  "enumDescriptions": [
1843
- "Unspecified modality.",
1844
- "Plain text.",
1845
- "Image.",
1846
- "Video.",
1847
- "Audio.",
1848
- "Document, e.g. PDF."
1843
+ "When a modality is not specified, it is treated as `TEXT`.",
1844
+ "The `Part` contains plain text.",
1845
+ "The `Part` contains an image.",
1846
+ "The `Part` contains a video.",
1847
+ "The `Part` contains audio.",
1848
+ "The `Part` contains a document, such as a PDF."
1849
1849
  ],
1850
1850
  "type": "string"
1851
1851
  },
1852
1852
  "tokenCount": {
1853
- "description": "Number of tokens.",
1853
+ "description": "The number of tokens counted for this modality.",
1854
1854
  "format": "int32",
1855
1855
  "type": "integer"
1856
1856
  }
@@ -1858,22 +1858,22 @@
1858
1858
  "type": "object"
1859
1859
  },
1860
1860
  "GoogleCloudAiplatformV1beta1ModelArmorConfig": {
1861
- "description": "Configuration for Model Armor integrations of prompt and responses.",
1861
+ "description": "Configuration for Model Armor. Model Armor is a Google Cloud service that provides safety and security filtering for prompts and responses. It helps protect your AI applications from risks such as harmful content, sensitive data leakage, and prompt injection attacks.",
1862
1862
  "id": "GoogleCloudAiplatformV1beta1ModelArmorConfig",
1863
1863
  "properties": {
1864
1864
  "promptTemplateName": {
1865
- "description": "Optional. The name of the Model Armor template to use for prompt sanitization.",
1865
+ "description": "Optional. The resource name of the Model Armor template to use for prompt screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the user's prompt for safety and security risks before it is sent to the model. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`.",
1866
1866
  "type": "string"
1867
1867
  },
1868
1868
  "responseTemplateName": {
1869
- "description": "Optional. The name of the Model Armor template to use for response sanitization.",
1869
+ "description": "Optional. The resource name of the Model Armor template to use for response screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the model's response for safety and security risks before it is returned to the user. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`.",
1870
1870
  "type": "string"
1871
1871
  }
1872
1872
  },
1873
1873
  "type": "object"
1874
1874
  },
1875
1875
  "GoogleCloudAiplatformV1beta1MultiSpeakerVoiceConfig": {
1876
- "description": "Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request.",
1876
+ "description": "Configuration for a multi-speaker text-to-speech request.",
1877
1877
  "id": "GoogleCloudAiplatformV1beta1MultiSpeakerVoiceConfig",
1878
1878
  "properties": {
1879
1879
  "speakerVoiceConfigs": {
@@ -1887,39 +1887,39 @@
1887
1887
  "type": "object"
1888
1888
  },
1889
1889
  "GoogleCloudAiplatformV1beta1Part": {
1890
- "description": "A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.",
1890
+ "description": "A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.",
1891
1891
  "id": "GoogleCloudAiplatformV1beta1Part",
1892
1892
  "properties": {
1893
1893
  "codeExecutionResult": {
1894
1894
  "$ref": "GoogleCloudAiplatformV1beta1CodeExecutionResult",
1895
- "description": "Optional. Result of executing the [ExecutableCode]."
1895
+ "description": "Optional. The result of executing the ExecutableCode."
1896
1896
  },
1897
1897
  "executableCode": {
1898
1898
  "$ref": "GoogleCloudAiplatformV1beta1ExecutableCode",
1899
- "description": "Optional. Code generated by the model that is meant to be executed."
1899
+ "description": "Optional. Code generated by the model that is intended to be executed."
1900
1900
  },
1901
1901
  "fileData": {
1902
1902
  "$ref": "GoogleCloudAiplatformV1beta1FileData",
1903
- "description": "Optional. URI based data."
1903
+ "description": "Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage."
1904
1904
  },
1905
1905
  "functionCall": {
1906
1906
  "$ref": "GoogleCloudAiplatformV1beta1FunctionCall",
1907
- "description": "Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values."
1907
+ "description": "Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function."
1908
1908
  },
1909
1909
  "functionResponse": {
1910
1910
  "$ref": "GoogleCloudAiplatformV1beta1FunctionResponse",
1911
- "description": "Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model."
1911
+ "description": "Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted."
1912
1912
  },
1913
1913
  "inlineData": {
1914
1914
  "$ref": "GoogleCloudAiplatformV1beta1Blob",
1915
- "description": "Optional. Inlined bytes data."
1915
+ "description": "Optional. The inline data content of the part. This can be used to include images, audio, or video in a request."
1916
1916
  },
1917
1917
  "text": {
1918
- "description": "Optional. Text part (can be code).",
1918
+ "description": "Optional. The text content of the part.",
1919
1919
  "type": "string"
1920
1920
  },
1921
1921
  "thought": {
1922
- "description": "Optional. Indicates if the part is thought from the model.",
1922
+ "description": "Optional. Indicates whether the `part` represents the model's thought process or reasoning.",
1923
1923
  "type": "boolean"
1924
1924
  },
1925
1925
  "thoughtSignature": {
@@ -1935,11 +1935,11 @@
1935
1935
  "type": "object"
1936
1936
  },
1937
1937
  "GoogleCloudAiplatformV1beta1PrebuiltVoiceConfig": {
1938
- "description": "The configuration for the prebuilt speaker to use.",
1938
+ "description": "Configuration for a prebuilt voice.",
1939
1939
  "id": "GoogleCloudAiplatformV1beta1PrebuiltVoiceConfig",
1940
1940
  "properties": {
1941
1941
  "voiceName": {
1942
- "description": "The name of the preset voice to use.",
1942
+ "description": "The name of the prebuilt voice to use.",
1943
1943
  "type": "string"
1944
1944
  }
1945
1945
  },
@@ -2111,11 +2111,11 @@
2111
2111
  "type": "object"
2112
2112
  },
2113
2113
  "GoogleCloudAiplatformV1beta1RetrievalMetadata": {
2114
- "description": "Metadata related to retrieval in the grounding flow.",
2114
+ "description": "Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled.",
2115
2115
  "id": "GoogleCloudAiplatformV1beta1RetrievalMetadata",
2116
2116
  "properties": {
2117
2117
  "googleSearchDynamicRetrievalScore": {
2118
- "description": "Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search.",
2118
+ "description": "Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search.",
2119
2119
  "format": "float",
2120
2120
  "type": "number"
2121
2121
  }
@@ -2123,16 +2123,16 @@
2123
2123
  "type": "object"
2124
2124
  },
2125
2125
  "GoogleCloudAiplatformV1beta1SafetyRating": {
2126
- "description": "Safety rating corresponding to the generated content.",
2126
+ "description": "A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level.",
2127
2127
  "id": "GoogleCloudAiplatformV1beta1SafetyRating",
2128
2128
  "properties": {
2129
2129
  "blocked": {
2130
- "description": "Output only. Indicates whether the content was filtered out because of this rating.",
2130
+ "description": "Output only. Indicates whether the content was blocked because of this rating.",
2131
2131
  "readOnly": true,
2132
2132
  "type": "boolean"
2133
2133
  },
2134
2134
  "category": {
2135
- "description": "Output only. Harm category.",
2135
+ "description": "Output only. The harm category of this rating.",
2136
2136
  "enum": [
2137
2137
  "HARM_CATEGORY_UNSPECIFIED",
2138
2138
  "HARM_CATEGORY_HATE_SPEECH",
@@ -2160,17 +2160,17 @@ false,
2160
2160
  false
2161
2161
  ],
2162
2162
  "enumDescriptions": [
2163
- "The harm category is unspecified.",
2164
- "The harm category is hate speech.",
2165
- "The harm category is dangerous content.",
2166
- "The harm category is harassment.",
2167
- "The harm category is sexually explicit content.",
2163
+ "Default value. This value is unused.",
2164
+ "Content that promotes violence or incites hatred against individuals or groups based on certain attributes.",
2165
+ "Content that promotes, facilitates, or enables dangerous activities.",
2166
+ "Abusive, threatening, or content intended to bully, torment, or ridicule.",
2167
+ "Content that contains sexually explicit material.",
2168
2168
  "Deprecated: Election filter is not longer supported. The harm category is civic integrity.",
2169
- "The harm category is image hate.",
2170
- "The harm category is image dangerous content.",
2171
- "The harm category is image harassment.",
2172
- "The harm category is image sexually explicit content.",
2173
- "The harm category is for jailbreak prompts."
2169
+ "Images that contain hate speech.",
2170
+ "Images that contain dangerous content.",
2171
+ "Images that contain harassment.",
2172
+ "Images that contain sexually explicit content.",
2173
+ "Prompts designed to bypass safety filters."
2174
2174
  ],
2175
2175
  "readOnly": true,
2176
2176
  "type": "string"
@@ -2186,18 +2186,18 @@ false
2186
2186
  "OFF"
2187
2187
  ],
2188
2188
  "enumDescriptions": [
2189
- "Unspecified harm block threshold.",
2190
- "Block low threshold and above (i.e. block more).",
2191
- "Block medium threshold and above.",
2192
- "Block only high threshold (i.e. block less).",
2193
- "Block none.",
2194
- "Turn off the safety filter."
2189
+ "The harm block threshold is unspecified.",
2190
+ "Block content with a low harm probability or higher.",
2191
+ "Block content with a medium harm probability or higher.",
2192
+ "Block content with a high harm probability.",
2193
+ "Do not block any content, regardless of its harm probability.",
2194
+ "Turn off the safety filter entirely."
2195
2195
  ],
2196
2196
  "readOnly": true,
2197
2197
  "type": "string"
2198
2198
  },
2199
2199
  "probability": {
2200
- "description": "Output only. Harm probability levels in the content.",
2200
+ "description": "Output only. The probability of harm for this category.",
2201
2201
  "enum": [
2202
2202
  "HARM_PROBABILITY_UNSPECIFIED",
2203
2203
  "NEGLIGIBLE",
@@ -2206,23 +2206,23 @@ false
2206
2206
  "HIGH"
2207
2207
  ],
2208
2208
  "enumDescriptions": [
2209
- "Harm probability unspecified.",
2210
- "Negligible level of harm.",
2211
- "Low level of harm.",
2212
- "Medium level of harm.",
2213
- "High level of harm."
2209
+ "The harm probability is unspecified.",
2210
+ "The harm probability is negligible.",
2211
+ "The harm probability is low.",
2212
+ "The harm probability is medium.",
2213
+ "The harm probability is high."
2214
2214
  ],
2215
2215
  "readOnly": true,
2216
2216
  "type": "string"
2217
2217
  },
2218
2218
  "probabilityScore": {
2219
- "description": "Output only. Harm probability score.",
2219
+ "description": "Output only. The probability score of harm for this category.",
2220
2220
  "format": "float",
2221
2221
  "readOnly": true,
2222
2222
  "type": "number"
2223
2223
  },
2224
2224
  "severity": {
2225
- "description": "Output only. Harm severity levels in the content.",
2225
+ "description": "Output only. The severity of harm for this category.",
2226
2226
  "enum": [
2227
2227
  "HARM_SEVERITY_UNSPECIFIED",
2228
2228
  "HARM_SEVERITY_NEGLIGIBLE",
@@ -2231,17 +2231,17 @@ false
2231
2231
  "HARM_SEVERITY_HIGH"
2232
2232
  ],
2233
2233
  "enumDescriptions": [
2234
- "Harm severity unspecified.",
2235
- "Negligible level of harm severity.",
2236
- "Low level of harm severity.",
2237
- "Medium level of harm severity.",
2238
- "High level of harm severity."
2234
+ "The harm severity is unspecified.",
2235
+ "The harm severity is negligible.",
2236
+ "The harm severity is low.",
2237
+ "The harm severity is medium.",
2238
+ "The harm severity is high."
2239
2239
  ],
2240
2240
  "readOnly": true,
2241
2241
  "type": "string"
2242
2242
  },
2243
2243
  "severityScore": {
2244
- "description": "Output only. Harm severity score.",
2244
+ "description": "Output only. The severity score of harm for this category.",
2245
2245
  "format": "float",
2246
2246
  "readOnly": true,
2247
2247
  "type": "number"
@@ -2250,11 +2250,11 @@ false
2250
2250
  "type": "object"
2251
2251
  },
2252
2252
  "GoogleCloudAiplatformV1beta1SafetySetting": {
2253
- "description": "Safety settings.",
2253
+ "description": "A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category.",
2254
2254
  "id": "GoogleCloudAiplatformV1beta1SafetySetting",
2255
2255
  "properties": {
2256
2256
  "category": {
2257
- "description": "Required. Harm category.",
2257
+ "description": "Required. The harm category to be blocked.",
2258
2258
  "enum": [
2259
2259
  "HARM_CATEGORY_UNSPECIFIED",
2260
2260
  "HARM_CATEGORY_HATE_SPEECH",
@@ -2282,22 +2282,22 @@ false,
2282
2282
  false
2283
2283
  ],
2284
2284
  "enumDescriptions": [
2285
- "The harm category is unspecified.",
2286
- "The harm category is hate speech.",
2287
- "The harm category is dangerous content.",
2288
- "The harm category is harassment.",
2289
- "The harm category is sexually explicit content.",
2285
+ "Default value. This value is unused.",
2286
+ "Content that promotes violence or incites hatred against individuals or groups based on certain attributes.",
2287
+ "Content that promotes, facilitates, or enables dangerous activities.",
2288
+ "Abusive, threatening, or content intended to bully, torment, or ridicule.",
2289
+ "Content that contains sexually explicit material.",
2290
2290
  "Deprecated: Election filter is not longer supported. The harm category is civic integrity.",
2291
- "The harm category is image hate.",
2292
- "The harm category is image dangerous content.",
2293
- "The harm category is image harassment.",
2294
- "The harm category is image sexually explicit content.",
2295
- "The harm category is for jailbreak prompts."
2291
+ "Images that contain hate speech.",
2292
+ "Images that contain dangerous content.",
2293
+ "Images that contain harassment.",
2294
+ "Images that contain sexually explicit content.",
2295
+ "Prompts designed to bypass safety filters."
2296
2296
  ],
2297
2297
  "type": "string"
2298
2298
  },
2299
2299
  "method": {
2300
- "description": "Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score.",
2300
+ "description": "Optional. The method for blocking content. If not specified, the default behavior is to use the probability score.",
2301
2301
  "enum": [
2302
2302
  "HARM_BLOCK_METHOD_UNSPECIFIED",
2303
2303
  "SEVERITY",
@@ -2311,7 +2311,7 @@ false
2311
2311
  "type": "string"
2312
2312
  },
2313
2313
  "threshold": {
2314
- "description": "Required. The harm block threshold.",
2314
+ "description": "Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked.",
2315
2315
  "enum": [
2316
2316
  "HARM_BLOCK_THRESHOLD_UNSPECIFIED",
2317
2317
  "BLOCK_LOW_AND_ABOVE",
@@ -2321,12 +2321,12 @@ false
2321
2321
  "OFF"
2322
2322
  ],
2323
2323
  "enumDescriptions": [
2324
- "Unspecified harm block threshold.",
2325
- "Block low threshold and above (i.e. block more).",
2326
- "Block medium threshold and above.",
2327
- "Block only high threshold (i.e. block less).",
2328
- "Block none.",
2329
- "Turn off the safety filter."
2324
+ "The harm block threshold is unspecified.",
2325
+ "Block content with a low harm probability or higher.",
2326
+ "Block content with a medium harm probability or higher.",
2327
+ "Block content with a high harm probability.",
2328
+ "Do not block any content, regardless of its harm probability.",
2329
+ "Turn off the safety filter entirely."
2330
2330
  ],
2331
2331
  "type": "string"
2332
2332
  }
@@ -2487,15 +2487,15 @@ false
2487
2487
  "type": "object"
2488
2488
  },
2489
2489
  "GoogleCloudAiplatformV1beta1SearchEntryPoint": {
2490
- "description": "Google search entry point.",
2490
+ "description": "An entry point for displaying Google Search results. A `SearchEntryPoint` is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application.",
2491
2491
  "id": "GoogleCloudAiplatformV1beta1SearchEntryPoint",
2492
2492
  "properties": {
2493
2493
  "renderedContent": {
2494
- "description": "Optional. Web content snippet that can be embedded in a web page or an app webview.",
2494
+ "description": "Optional. An HTML snippet that can be embedded in a web page or an application's webview. This snippet displays a search result, including the title, URL, and a brief description of the search result.",
2495
2495
  "type": "string"
2496
2496
  },
2497
2497
  "sdkBlob": {
2498
- "description": "Optional. Base64 encoded JSON representing array of tuple.",
2498
+ "description": "Optional. A base64-encoded JSON object that contains a list of search queries and their corresponding search URLs. This information can be used to build a custom search UI.",
2499
2499
  "format": "byte",
2500
2500
  "type": "string"
2501
2501
  }
@@ -2503,29 +2503,29 @@ false
2503
2503
  "type": "object"
2504
2504
  },
2505
2505
  "GoogleCloudAiplatformV1beta1Segment": {
2506
- "description": "Segment of the content.",
2506
+ "description": "A segment of the content.",
2507
2507
  "id": "GoogleCloudAiplatformV1beta1Segment",
2508
2508
  "properties": {
2509
2509
  "endIndex": {
2510
- "description": "Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero.",
2510
+ "description": "Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index.",
2511
2511
  "format": "int32",
2512
2512
  "readOnly": true,
2513
2513
  "type": "integer"
2514
2514
  },
2515
2515
  "partIndex": {
2516
- "description": "Output only. The index of a Part object within its parent Content object.",
2516
+ "description": "Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content.",
2517
2517
  "format": "int32",
2518
2518
  "readOnly": true,
2519
2519
  "type": "integer"
2520
2520
  },
2521
2521
  "startIndex": {
2522
- "description": "Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero.",
2522
+ "description": "Output only. The start index of the segment in the `Part`, measured in bytes. This marks the beginning of the segment and is inclusive, meaning the byte at this index is the first byte of the segment.",
2523
2523
  "format": "int32",
2524
2524
  "readOnly": true,
2525
2525
  "type": "integer"
2526
2526
  },
2527
2527
  "text": {
2528
- "description": "Output only. The text corresponding to the segment from the response.",
2528
+ "description": "Output only. The text of the segment.",
2529
2529
  "readOnly": true,
2530
2530
  "type": "string"
2531
2531
  }
@@ -2533,7 +2533,7 @@ false
2533
2533
  "type": "object"
2534
2534
  },
2535
2535
  "GoogleCloudAiplatformV1beta1SpeakerVoiceConfig": {
2536
- "description": "Configuration for a single speaker in a multi speaker setup.",
2536
+ "description": "Configuration for a single speaker in a multi-speaker setup.",
2537
2537
  "id": "GoogleCloudAiplatformV1beta1SpeakerVoiceConfig",
2538
2538
  "properties": {
2539
2539
  "speaker": {
@@ -2548,11 +2548,11 @@ false
2548
2548
  "type": "object"
2549
2549
  },
2550
2550
  "GoogleCloudAiplatformV1beta1SpeechConfig": {
2551
- "description": "The speech generation config.",
2551
+ "description": "Configuration for speech generation.",
2552
2552
  "id": "GoogleCloudAiplatformV1beta1SpeechConfig",
2553
2553
  "properties": {
2554
2554
  "languageCode": {
2555
- "description": "Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.",
2555
+ "description": "Optional. The language code (ISO 639-1) for the speech synthesis.",
2556
2556
  "type": "string"
2557
2557
  },
2558
2558
  "multiSpeakerVoiceConfig": {
@@ -2561,7 +2561,7 @@ false
2561
2561
  },
2562
2562
  "voiceConfig": {
2563
2563
  "$ref": "GoogleCloudAiplatformV1beta1VoiceConfig",
2564
- "description": "The configuration for the speaker to use."
2564
+ "description": "The configuration for the voice to use."
2565
2565
  }
2566
2566
  },
2567
2567
  "type": "object"
@@ -2636,7 +2636,7 @@ false
2636
2636
  "type": "string"
2637
2637
  },
2638
2638
  "excludedPredefinedFunctions": {
2639
- "description": "Optional. By default, predefined functions are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions.",
2639
+ "description": "Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions.",
2640
2640
  "items": {
2641
2641
  "type": "string"
2642
2642
  },
@@ -2703,11 +2703,11 @@ false
2703
2703
  "type": "object"
2704
2704
  },
2705
2705
  "GoogleCloudAiplatformV1beta1UrlContextMetadata": {
2706
- "description": "Metadata related to url context retrieval tool.",
2706
+ "description": "Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL.",
2707
2707
  "id": "GoogleCloudAiplatformV1beta1UrlContextMetadata",
2708
2708
  "properties": {
2709
2709
  "urlMetadata": {
2710
- "description": "Output only. List of url context.",
2710
+ "description": "Output only. A list of URL metadata, with one entry for each URL retrieved by the tool.",
2711
2711
  "items": {
2712
2712
  "$ref": "GoogleCloudAiplatformV1beta1UrlMetadata"
2713
2713
  },
@@ -2718,15 +2718,15 @@ false
2718
2718
  "type": "object"
2719
2719
  },
2720
2720
  "GoogleCloudAiplatformV1beta1UrlMetadata": {
2721
- "description": "Context of the a single url retrieval.",
2721
+ "description": "The metadata for a single URL retrieval.",
2722
2722
  "id": "GoogleCloudAiplatformV1beta1UrlMetadata",
2723
2723
  "properties": {
2724
2724
  "retrievedUrl": {
2725
- "description": "Retrieved url by the tool.",
2725
+ "description": "The URL retrieved by the tool.",
2726
2726
  "type": "string"
2727
2727
  },
2728
2728
  "urlRetrievalStatus": {
2729
- "description": "Status of the url retrieval.",
2729
+ "description": "The status of the URL retrieval.",
2730
2730
  "enum": [
2731
2731
  "URL_RETRIEVAL_STATUS_UNSPECIFIED",
2732
2732
  "URL_RETRIEVAL_STATUS_SUCCESS",
@@ -2734,8 +2734,8 @@ false
2734
2734
  ],
2735
2735
  "enumDescriptions": [
2736
2736
  "Default value. This value is unused.",
2737
- "Url retrieval is successful.",
2738
- "Url retrieval is failed due to error."
2737
+ "The URL was retrieved successfully.",
2738
+ "The URL retrieval failed."
2739
2739
  ],
2740
2740
  "type": "string"
2741
2741
  }
@@ -2849,7 +2849,7 @@ false
2849
2849
  "type": "object"
2850
2850
  },
2851
2851
  "GoogleCloudAiplatformV1beta1VideoMetadata": {
2852
- "description": "Metadata describes the input video content.",
2852
+ "description": "Provides metadata for a video, including the start and end offsets for clipping and the frame rate.",
2853
2853
  "id": "GoogleCloudAiplatformV1beta1VideoMetadata",
2854
2854
  "properties": {
2855
2855
  "endOffset": {
@@ -2858,7 +2858,7 @@ false
2858
2858
  "type": "string"
2859
2859
  },
2860
2860
  "fps": {
2861
- "description": "Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].",
2861
+ "description": "Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].",
2862
2862
  "format": "double",
2863
2863
  "type": "number"
2864
2864
  },
@@ -2871,12 +2871,12 @@ false
2871
2871
  "type": "object"
2872
2872
  },
2873
2873
  "GoogleCloudAiplatformV1beta1VoiceConfig": {
2874
- "description": "The configuration for the voice to use.",
2874
+ "description": "Configuration for a voice.",
2875
2875
  "id": "GoogleCloudAiplatformV1beta1VoiceConfig",
2876
2876
  "properties": {
2877
2877
  "prebuiltVoiceConfig": {
2878
2878
  "$ref": "GoogleCloudAiplatformV1beta1PrebuiltVoiceConfig",
2879
- "description": "The configuration for the prebuilt voice to use."
2879
+ "description": "The configuration for a prebuilt voice."
2880
2880
  }
2881
2881
  },
2882
2882
  "type": "object"