google-api-python-client 2.175.0__py3-none-any.whl → 2.177.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 (143) hide show
  1. {google_api_python_client-2.175.0.dist-info → google_api_python_client-2.177.0.dist-info}/METADATA +1 -1
  2. {google_api_python_client-2.175.0.dist-info → google_api_python_client-2.177.0.dist-info}/RECORD +143 -142
  3. googleapiclient/discovery_cache/documents/admin.datatransfer_v1.json +4 -4
  4. googleapiclient/discovery_cache/documents/admin.datatransferv1.json +4 -4
  5. googleapiclient/discovery_cache/documents/admin.directory_v1.json +86 -86
  6. googleapiclient/discovery_cache/documents/admin.directoryv1.json +86 -86
  7. googleapiclient/discovery_cache/documents/admin.reports_v1.json +31 -3
  8. googleapiclient/discovery_cache/documents/admin.reportsv1.json +31 -3
  9. googleapiclient/discovery_cache/documents/adsenseplatform.v1alpha.json +42 -6
  10. googleapiclient/discovery_cache/documents/aiplatform.v1.json +29 -8
  11. googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +65 -10
  12. googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json +1 -245
  13. googleapiclient/discovery_cache/documents/androidmanagement.v1.json +5 -5
  14. googleapiclient/discovery_cache/documents/androidpublisher.v3.json +231 -1
  15. googleapiclient/discovery_cache/documents/apigee.v1.json +6 -1
  16. googleapiclient/discovery_cache/documents/apihub.v1.json +115 -1
  17. googleapiclient/discovery_cache/documents/apphub.v1alpha.json +1 -68
  18. googleapiclient/discovery_cache/documents/artifactregistry.v1.json +7 -7
  19. googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json +6 -6
  20. googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json +6 -6
  21. googleapiclient/discovery_cache/documents/backupdr.v1.json +485 -9
  22. googleapiclient/discovery_cache/documents/beyondcorp.v1.json +53 -1
  23. googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json +53 -1
  24. googleapiclient/discovery_cache/documents/chat.v1.json +12 -8
  25. googleapiclient/discovery_cache/documents/chromemanagement.v1.json +241 -1
  26. googleapiclient/discovery_cache/documents/civicinfo.v2.json +7 -1
  27. googleapiclient/discovery_cache/documents/cloudasset.v1.json +32 -2
  28. googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json +2 -2
  29. googleapiclient/discovery_cache/documents/cloudbilling.v1beta.json +9 -1168
  30. googleapiclient/discovery_cache/documents/cloudidentity.v1.json +2 -2
  31. googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json +2 -2
  32. googleapiclient/discovery_cache/documents/composer.v1.json +21 -11
  33. googleapiclient/discovery_cache/documents/composer.v1beta1.json +21 -11
  34. googleapiclient/discovery_cache/documents/compute.alpha.json +174 -1
  35. googleapiclient/discovery_cache/documents/compute.beta.json +221 -1
  36. googleapiclient/discovery_cache/documents/compute.v1.json +225 -1
  37. googleapiclient/discovery_cache/documents/connectors.v1.json +24 -1
  38. googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json +6 -1
  39. googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json +53 -2
  40. googleapiclient/discovery_cache/documents/container.v1.json +206 -2
  41. googleapiclient/discovery_cache/documents/container.v1beta1.json +207 -3
  42. googleapiclient/discovery_cache/documents/containeranalysis.v1.json +2 -2
  43. googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json +2 -2
  44. googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json +2 -2
  45. googleapiclient/discovery_cache/documents/dataflow.v1b3.json +43 -36
  46. googleapiclient/discovery_cache/documents/dataform.v1beta1.json +35 -1
  47. googleapiclient/discovery_cache/documents/datalineage.v1.json +6 -1
  48. googleapiclient/discovery_cache/documents/datamigration.v1.json +21 -1
  49. googleapiclient/discovery_cache/documents/dataplex.v1.json +30 -30
  50. googleapiclient/discovery_cache/documents/dataportability.v1.json +1 -10
  51. googleapiclient/discovery_cache/documents/dataportability.v1beta.json +1 -10
  52. googleapiclient/discovery_cache/documents/dataproc.v1.json +30 -1
  53. googleapiclient/discovery_cache/documents/datastream.v1.json +17 -1
  54. googleapiclient/discovery_cache/documents/developerconnect.v1.json +2 -2
  55. googleapiclient/discovery_cache/documents/dialogflow.v2.json +289 -4
  56. googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json +8 -12
  57. googleapiclient/discovery_cache/documents/dialogflow.v3.json +12 -8
  58. googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json +12 -8
  59. googleapiclient/discovery_cache/documents/discoveryengine.v1.json +1077 -121
  60. googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +661 -32
  61. googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +582 -34
  62. googleapiclient/discovery_cache/documents/displayvideo.v2.json +24 -1
  63. googleapiclient/discovery_cache/documents/displayvideo.v3.json +24 -1
  64. googleapiclient/discovery_cache/documents/displayvideo.v4.json +24 -1
  65. googleapiclient/discovery_cache/documents/dlp.v2.json +81 -2
  66. googleapiclient/discovery_cache/documents/documentai.v1.json +15 -8
  67. googleapiclient/discovery_cache/documents/documentai.v1beta3.json +15 -8
  68. googleapiclient/discovery_cache/documents/drive.v3.json +32 -1
  69. googleapiclient/discovery_cache/documents/firebaseapphosting.v1beta.json +5 -1
  70. googleapiclient/discovery_cache/documents/firebasedataconnect.v1.json +6 -2
  71. googleapiclient/discovery_cache/documents/firebasedataconnect.v1beta.json +6 -2
  72. googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +54 -2
  73. googleapiclient/discovery_cache/documents/gkehub.v1.json +18 -3
  74. googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +18 -3
  75. googleapiclient/discovery_cache/documents/gkehub.v1beta.json +18 -3
  76. googleapiclient/discovery_cache/documents/gkehub.v1beta1.json +14 -1
  77. googleapiclient/discovery_cache/documents/gkehub.v2.json +5 -3
  78. googleapiclient/discovery_cache/documents/gkehub.v2alpha.json +5 -3
  79. googleapiclient/discovery_cache/documents/gkehub.v2beta.json +5 -3
  80. googleapiclient/discovery_cache/documents/gmail.v1.json +2 -2
  81. googleapiclient/discovery_cache/documents/healthcare.v1.json +58 -2
  82. googleapiclient/discovery_cache/documents/healthcare.v1beta1.json +20 -2
  83. googleapiclient/discovery_cache/documents/iam.v1.json +1 -126
  84. googleapiclient/discovery_cache/documents/logging.v2.json +11 -1
  85. googleapiclient/discovery_cache/documents/managedkafka.v1.json +11 -1
  86. googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json +386 -5
  87. googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json +2 -3
  88. googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json +15 -7
  89. googleapiclient/discovery_cache/documents/merchantapi.promotions_v1beta.json +1 -2
  90. googleapiclient/discovery_cache/documents/merchantapi.reviews_v1beta.json +17 -9
  91. googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json +5 -1
  92. googleapiclient/discovery_cache/documents/netapp.v1beta1.json +51 -1
  93. googleapiclient/discovery_cache/documents/networkconnectivity.v1.json +4 -4
  94. googleapiclient/discovery_cache/documents/networkmanagement.v1.json +966 -23
  95. googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +30 -25
  96. googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json +39 -5
  97. googleapiclient/discovery_cache/documents/networkservices.v1.json +3 -3
  98. googleapiclient/discovery_cache/documents/networkservices.v1beta1.json +4 -4
  99. googleapiclient/discovery_cache/documents/notebooks.v2.json +131 -1
  100. googleapiclient/discovery_cache/documents/oracledatabase.v1.json +478 -1
  101. googleapiclient/discovery_cache/documents/parametermanager.v1.json +982 -0
  102. googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json +5 -5
  103. googleapiclient/discovery_cache/documents/places.v1.json +4 -4
  104. googleapiclient/discovery_cache/documents/policysimulator.v1.json +100 -1
  105. googleapiclient/discovery_cache/documents/policysimulator.v1alpha.json +100 -1
  106. googleapiclient/discovery_cache/documents/policysimulator.v1beta.json +100 -1
  107. googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json +41 -5
  108. googleapiclient/discovery_cache/documents/redis.v1.json +78 -12
  109. googleapiclient/discovery_cache/documents/redis.v1beta1.json +78 -12
  110. googleapiclient/discovery_cache/documents/retail.v2.json +73 -1
  111. googleapiclient/discovery_cache/documents/retail.v2alpha.json +53 -8
  112. googleapiclient/discovery_cache/documents/retail.v2beta.json +73 -7
  113. googleapiclient/discovery_cache/documents/run.v1.json +2 -2
  114. googleapiclient/discovery_cache/documents/run.v2.json +16 -8
  115. googleapiclient/discovery_cache/documents/script.v1.json +2 -2
  116. googleapiclient/discovery_cache/documents/searchconsole.v1.json +20 -1
  117. googleapiclient/discovery_cache/documents/secretmanager.v1.json +79 -49
  118. googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json +79 -49
  119. googleapiclient/discovery_cache/documents/secretmanager.v1beta2.json +79 -49
  120. googleapiclient/discovery_cache/documents/securitycenter.v1.json +29 -11
  121. googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json +26 -8
  122. googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json +26 -8
  123. googleapiclient/discovery_cache/documents/servicenetworking.v1.json +12 -3
  124. googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json +11 -2
  125. googleapiclient/discovery_cache/documents/spanner.v1.json +305 -5
  126. googleapiclient/discovery_cache/documents/storage.v1.json +42 -2
  127. googleapiclient/discovery_cache/documents/tpu.v2alpha1.json +2 -2
  128. googleapiclient/discovery_cache/documents/transcoder.v1.json +5 -1
  129. googleapiclient/discovery_cache/documents/videointelligence.v1.json +1 -156
  130. googleapiclient/discovery_cache/documents/videointelligence.v1beta2.json +1 -156
  131. googleapiclient/discovery_cache/documents/videointelligence.v1p1beta1.json +1 -156
  132. googleapiclient/discovery_cache/documents/videointelligence.v1p2beta1.json +1 -156
  133. googleapiclient/discovery_cache/documents/videointelligence.v1p3beta1.json +1 -156
  134. googleapiclient/discovery_cache/documents/vmmigration.v1.json +7 -2
  135. googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json +7 -2
  136. googleapiclient/discovery_cache/documents/workloadmanager.v1.json +17 -225
  137. googleapiclient/discovery_cache/documents/workspaceevents.v1.json +5 -5
  138. googleapiclient/discovery_cache/documents/workstations.v1beta.json +43 -1
  139. googleapiclient/discovery_cache/documents/youtube.v3.json +67 -1
  140. googleapiclient/version.py +1 -1
  141. {google_api_python_client-2.175.0.dist-info → google_api_python_client-2.177.0.dist-info}/WHEEL +0 -0
  142. {google_api_python_client-2.175.0.dist-info → google_api_python_client-2.177.0.dist-info}/licenses/LICENSE +0 -0
  143. {google_api_python_client-2.175.0.dist-info → google_api_python_client-2.177.0.dist-info}/top_level.txt +0 -0
@@ -4,6 +4,9 @@
4
4
  "scopes": {
5
5
  "https://www.googleapis.com/auth/cloud-platform": {
6
6
  "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
7
+ },
8
+ "https://www.googleapis.com/auth/cloud_search.query": {
9
+ "description": "Search your organization's data in the Cloud Search index"
7
10
  }
8
11
  }
9
12
  }
@@ -35,6 +38,11 @@
35
38
  "description": "Regional Endpoint",
36
39
  "endpointUrl": "https://discoveryengine.eu.rep.googleapis.com/",
37
40
  "location": "eu"
41
+ },
42
+ {
43
+ "description": "Regional Endpoint",
44
+ "endpointUrl": "https://discoveryengine.in.rep.googleapis.com/",
45
+ "location": "in"
38
46
  }
39
47
  ],
40
48
  "fullyEncodeReservedExpansion": true,
@@ -1048,6 +1056,39 @@
1048
1056
  }
1049
1057
  }
1050
1058
  },
1059
+ "completionConfig": {
1060
+ "methods": {
1061
+ "completeQuery": {
1062
+ "description": "Completes the user input with advanced keyword suggestions.",
1063
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/completionConfig:completeQuery",
1064
+ "httpMethod": "POST",
1065
+ "id": "discoveryengine.projects.locations.collections.dataStores.completionConfig.completeQuery",
1066
+ "parameterOrder": [
1067
+ "completionConfig"
1068
+ ],
1069
+ "parameters": {
1070
+ "completionConfig": {
1071
+ "description": "Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as `projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig` `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`.",
1072
+ "location": "path",
1073
+ "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/completionConfig$",
1074
+ "required": true,
1075
+ "type": "string"
1076
+ }
1077
+ },
1078
+ "path": "v1/{+completionConfig}:completeQuery",
1079
+ "request": {
1080
+ "$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest"
1081
+ },
1082
+ "response": {
1083
+ "$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponse"
1084
+ },
1085
+ "scopes": [
1086
+ "https://www.googleapis.com/auth/cloud-platform",
1087
+ "https://www.googleapis.com/auth/cloud_search.query"
1088
+ ]
1089
+ }
1090
+ }
1091
+ },
1051
1092
  "completionSuggestions": {
1052
1093
  "methods": {
1053
1094
  "import": {
@@ -2134,7 +2175,7 @@
2134
2175
  ],
2135
2176
  "parameters": {
2136
2177
  "filter": {
2137
- "description": "A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: \"user_pseudo_id = some_id\"",
2178
+ "description": "A filter to apply on the list results. The supported features are: user_pseudo_id, state, starred. Examples: \"user_pseudo_id = some_id\" \"starred = true\"",
2138
2179
  "location": "query",
2139
2180
  "type": "string"
2140
2181
  },
@@ -3153,6 +3194,71 @@
3153
3194
  }
3154
3195
  },
3155
3196
  "resources": {
3197
+ "assistants": {
3198
+ "methods": {
3199
+ "streamAssist": {
3200
+ "description": "Assists the user with a query in a streaming fashion.",
3201
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}:streamAssist",
3202
+ "httpMethod": "POST",
3203
+ "id": "discoveryengine.projects.locations.collections.engines.assistants.streamAssist",
3204
+ "parameterOrder": [
3205
+ "name"
3206
+ ],
3207
+ "parameters": {
3208
+ "name": {
3209
+ "description": "Required. The resource name of the Assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`",
3210
+ "location": "path",
3211
+ "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+$",
3212
+ "required": true,
3213
+ "type": "string"
3214
+ }
3215
+ },
3216
+ "path": "v1/{+name}:streamAssist",
3217
+ "request": {
3218
+ "$ref": "GoogleCloudDiscoveryengineV1StreamAssistRequest"
3219
+ },
3220
+ "response": {
3221
+ "$ref": "GoogleCloudDiscoveryengineV1StreamAssistResponse"
3222
+ },
3223
+ "scopes": [
3224
+ "https://www.googleapis.com/auth/cloud-platform"
3225
+ ]
3226
+ }
3227
+ }
3228
+ },
3229
+ "completionConfig": {
3230
+ "methods": {
3231
+ "completeQuery": {
3232
+ "description": "Completes the user input with advanced keyword suggestions.",
3233
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/completionConfig:completeQuery",
3234
+ "httpMethod": "POST",
3235
+ "id": "discoveryengine.projects.locations.collections.engines.completionConfig.completeQuery",
3236
+ "parameterOrder": [
3237
+ "completionConfig"
3238
+ ],
3239
+ "parameters": {
3240
+ "completionConfig": {
3241
+ "description": "Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as `projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig` `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`.",
3242
+ "location": "path",
3243
+ "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/completionConfig$",
3244
+ "required": true,
3245
+ "type": "string"
3246
+ }
3247
+ },
3248
+ "path": "v1/{+completionConfig}:completeQuery",
3249
+ "request": {
3250
+ "$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest"
3251
+ },
3252
+ "response": {
3253
+ "$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponse"
3254
+ },
3255
+ "scopes": [
3256
+ "https://www.googleapis.com/auth/cloud-platform",
3257
+ "https://www.googleapis.com/auth/cloud_search.query"
3258
+ ]
3259
+ }
3260
+ }
3261
+ },
3156
3262
  "controls": {
3157
3263
  "methods": {
3158
3264
  "create": {
@@ -3876,7 +3982,7 @@
3876
3982
  ],
3877
3983
  "parameters": {
3878
3984
  "filter": {
3879
- "description": "A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: \"user_pseudo_id = some_id\"",
3985
+ "description": "A filter to apply on the list results. The supported features are: user_pseudo_id, state, starred. Examples: \"user_pseudo_id = some_id\" \"starred = true\"",
3880
3986
  "location": "query",
3881
3987
  "type": "string"
3882
3988
  },
@@ -4664,6 +4770,39 @@
4664
4770
  }
4665
4771
  }
4666
4772
  },
4773
+ "completionConfig": {
4774
+ "methods": {
4775
+ "completeQuery": {
4776
+ "description": "Completes the user input with advanced keyword suggestions.",
4777
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/completionConfig:completeQuery",
4778
+ "httpMethod": "POST",
4779
+ "id": "discoveryengine.projects.locations.dataStores.completionConfig.completeQuery",
4780
+ "parameterOrder": [
4781
+ "completionConfig"
4782
+ ],
4783
+ "parameters": {
4784
+ "completionConfig": {
4785
+ "description": "Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as `projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig` `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`.",
4786
+ "location": "path",
4787
+ "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/completionConfig$",
4788
+ "required": true,
4789
+ "type": "string"
4790
+ }
4791
+ },
4792
+ "path": "v1/{+completionConfig}:completeQuery",
4793
+ "request": {
4794
+ "$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest"
4795
+ },
4796
+ "response": {
4797
+ "$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponse"
4798
+ },
4799
+ "scopes": [
4800
+ "https://www.googleapis.com/auth/cloud-platform",
4801
+ "https://www.googleapis.com/auth/cloud_search.query"
4802
+ ]
4803
+ }
4804
+ }
4805
+ },
4667
4806
  "completionSuggestions": {
4668
4807
  "methods": {
4669
4808
  "import": {
@@ -5649,7 +5788,7 @@
5649
5788
  ],
5650
5789
  "parameters": {
5651
5790
  "filter": {
5652
- "description": "A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: \"user_pseudo_id = some_id\"",
5791
+ "description": "A filter to apply on the list results. The supported features are: user_pseudo_id, state, starred. Examples: \"user_pseudo_id = some_id\" \"starred = true\"",
5653
5792
  "location": "query",
5654
5793
  "type": "string"
5655
5794
  },
@@ -7052,7 +7191,7 @@
7052
7191
  }
7053
7192
  }
7054
7193
  },
7055
- "revision": "20250619",
7194
+ "revision": "20250716",
7056
7195
  "rootUrl": "https://discoveryengine.googleapis.com/",
7057
7196
  "schemas": {
7058
7197
  "GoogleApiDistribution": {
@@ -7468,6 +7607,318 @@
7468
7607
  },
7469
7608
  "type": "object"
7470
7609
  },
7610
+ "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest": {
7611
+ "description": "Request message for CompletionService.AdvancedCompleteQuery method. .",
7612
+ "id": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest",
7613
+ "properties": {
7614
+ "boostSpec": {
7615
+ "$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpec",
7616
+ "description": "Optional. Specification to boost suggestions matching the condition."
7617
+ },
7618
+ "experimentIds": {
7619
+ "description": "Optional. Experiment ids for this request.",
7620
+ "items": {
7621
+ "type": "string"
7622
+ },
7623
+ "type": "array"
7624
+ },
7625
+ "includeTailSuggestions": {
7626
+ "description": "Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned.",
7627
+ "type": "boolean"
7628
+ },
7629
+ "query": {
7630
+ "description": "Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. The query can not be empty for most of the suggestion types. If it is empty, an `INVALID_ARGUMENT` error is returned. The exception is when the suggestion_types contains only the type `RECENT_SEARCH`, the query can be an empty string. The is called \"zero prefix\" feature, which returns user's recently searched queries given the empty query.",
7631
+ "type": "string"
7632
+ },
7633
+ "queryModel": {
7634
+ "description": "Specifies the autocomplete query model, which only applies to the QUERY SuggestionType. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.",
7635
+ "type": "string"
7636
+ },
7637
+ "suggestionTypeSpecs": {
7638
+ "description": "Optional. Specification of each suggestion type.",
7639
+ "items": {
7640
+ "$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestSuggestionTypeSpec"
7641
+ },
7642
+ "type": "array"
7643
+ },
7644
+ "suggestionTypes": {
7645
+ "description": "Optional. Suggestion types to return. If empty or unspecified, query suggestions are returned. Only one suggestion type is supported at the moment.",
7646
+ "items": {
7647
+ "enum": [
7648
+ "SUGGESTION_TYPE_UNSPECIFIED",
7649
+ "QUERY",
7650
+ "PEOPLE",
7651
+ "CONTENT",
7652
+ "RECENT_SEARCH",
7653
+ "GOOGLE_WORKSPACE"
7654
+ ],
7655
+ "enumDescriptions": [
7656
+ "Default value.",
7657
+ "Returns query suggestions.",
7658
+ "Returns people suggestions.",
7659
+ "Returns content suggestions.",
7660
+ "Returns recent search suggestions.",
7661
+ "Returns Google Workspace suggestions."
7662
+ ],
7663
+ "type": "string"
7664
+ },
7665
+ "type": "array"
7666
+ },
7667
+ "userInfo": {
7668
+ "$ref": "GoogleCloudDiscoveryengineV1UserInfo",
7669
+ "description": "Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info."
7670
+ },
7671
+ "userPseudoId": {
7672
+ "description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128",
7673
+ "type": "string"
7674
+ }
7675
+ },
7676
+ "type": "object"
7677
+ },
7678
+ "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpec": {
7679
+ "description": "Specification to boost suggestions based on the condtion of the suggestion.",
7680
+ "id": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpec",
7681
+ "properties": {
7682
+ "conditionBoostSpecs": {
7683
+ "description": "Condition boost specifications. If a suggestion matches multiple conditions in the specifications, boost values from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. Note: Currently only support language condition boost.",
7684
+ "items": {
7685
+ "$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpecConditionBoostSpec"
7686
+ },
7687
+ "type": "array"
7688
+ }
7689
+ },
7690
+ "type": "object"
7691
+ },
7692
+ "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpecConditionBoostSpec": {
7693
+ "description": "Boost applies to suggestions which match a condition.",
7694
+ "id": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpecConditionBoostSpec",
7695
+ "properties": {
7696
+ "boost": {
7697
+ "description": "Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the suggestions a big promotion. However, it does not necessarily mean that the top result will be a boosted suggestion. Setting to -1.0 gives the suggestions a big demotion. However, other suggestions that are relevant might still be shown. Setting to 0.0 means no boost applied. The boosting condition is ignored.",
7698
+ "format": "float",
7699
+ "type": "number"
7700
+ },
7701
+ "condition": {
7702
+ "description": "An expression which specifies a boost condition. The syntax is the same as [filter expression syntax](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax). Currently, the only supported condition is a list of BCP-47 lang codes. Example: * To boost suggestions in languages `en` or `fr`: `(lang_code: ANY(\"en\", \"fr\"))`",
7703
+ "type": "string"
7704
+ }
7705
+ },
7706
+ "type": "object"
7707
+ },
7708
+ "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestSuggestionTypeSpec": {
7709
+ "description": "Specification of each suggestion type.",
7710
+ "id": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestSuggestionTypeSpec",
7711
+ "properties": {
7712
+ "maxSuggestions": {
7713
+ "description": "Optional. Maximum number of suggestions to return for each suggestion type.",
7714
+ "format": "int32",
7715
+ "type": "integer"
7716
+ },
7717
+ "suggestionType": {
7718
+ "description": "Optional. Suggestion type.",
7719
+ "enum": [
7720
+ "SUGGESTION_TYPE_UNSPECIFIED",
7721
+ "QUERY",
7722
+ "PEOPLE",
7723
+ "CONTENT",
7724
+ "RECENT_SEARCH",
7725
+ "GOOGLE_WORKSPACE"
7726
+ ],
7727
+ "enumDescriptions": [
7728
+ "Default value.",
7729
+ "Returns query suggestions.",
7730
+ "Returns people suggestions.",
7731
+ "Returns content suggestions.",
7732
+ "Returns recent search suggestions.",
7733
+ "Returns Google Workspace suggestions."
7734
+ ],
7735
+ "type": "string"
7736
+ }
7737
+ },
7738
+ "type": "object"
7739
+ },
7740
+ "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponse": {
7741
+ "description": "Response message for CompletionService.AdvancedCompleteQuery method.",
7742
+ "id": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponse",
7743
+ "properties": {
7744
+ "contentSuggestions": {
7745
+ "description": "Results of the matched content suggestions. The result list is ordered and the first result is the top suggestion.",
7746
+ "items": {
7747
+ "$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseContentSuggestion"
7748
+ },
7749
+ "type": "array"
7750
+ },
7751
+ "peopleSuggestions": {
7752
+ "description": "Results of the matched people suggestions. The result list is ordered and the first result is the top suggestion.",
7753
+ "items": {
7754
+ "$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponsePersonSuggestion"
7755
+ },
7756
+ "type": "array"
7757
+ },
7758
+ "querySuggestions": {
7759
+ "description": "Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion.",
7760
+ "items": {
7761
+ "$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseQuerySuggestion"
7762
+ },
7763
+ "type": "array"
7764
+ },
7765
+ "recentSearchSuggestions": {
7766
+ "description": "Results of the matched \"recent search\" suggestions. The result list is ordered and the first result is the top suggestion.",
7767
+ "items": {
7768
+ "$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseRecentSearchSuggestion"
7769
+ },
7770
+ "type": "array"
7771
+ },
7772
+ "tailMatchTriggered": {
7773
+ "description": "True if the returned suggestions are all tail suggestions. For tail matching to be triggered, include_tail_suggestions in the request must be true and there must be no suggestions that match the full query.",
7774
+ "type": "boolean"
7775
+ }
7776
+ },
7777
+ "type": "object"
7778
+ },
7779
+ "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseContentSuggestion": {
7780
+ "description": "Suggestions as content.",
7781
+ "id": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseContentSuggestion",
7782
+ "properties": {
7783
+ "contentType": {
7784
+ "description": "The type of the content suggestion.",
7785
+ "enum": [
7786
+ "CONTENT_TYPE_UNSPECIFIED",
7787
+ "GOOGLE_WORKSPACE",
7788
+ "THIRD_PARTY"
7789
+ ],
7790
+ "enumDescriptions": [
7791
+ "Default value.",
7792
+ "The suggestion is from a Google Workspace source.",
7793
+ "The suggestion is from a third party source."
7794
+ ],
7795
+ "type": "string"
7796
+ },
7797
+ "dataStore": {
7798
+ "description": "The name of the dataStore that this suggestion belongs to.",
7799
+ "type": "string"
7800
+ },
7801
+ "destinationUri": {
7802
+ "description": "The destination uri of the content suggestion.",
7803
+ "type": "string"
7804
+ },
7805
+ "document": {
7806
+ "$ref": "GoogleCloudDiscoveryengineV1Document",
7807
+ "description": "The document data snippet in the suggestion. Only a subset of fields will be populated."
7808
+ },
7809
+ "iconUri": {
7810
+ "description": "The icon uri of the content suggestion.",
7811
+ "type": "string"
7812
+ },
7813
+ "score": {
7814
+ "description": "The score of each suggestion. The score is in the range of [0, 1].",
7815
+ "format": "double",
7816
+ "type": "number"
7817
+ },
7818
+ "suggestion": {
7819
+ "description": "The suggestion for the query.",
7820
+ "type": "string"
7821
+ }
7822
+ },
7823
+ "type": "object"
7824
+ },
7825
+ "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponsePersonSuggestion": {
7826
+ "description": "Suggestions as people.",
7827
+ "id": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponsePersonSuggestion",
7828
+ "properties": {
7829
+ "dataStore": {
7830
+ "description": "The name of the dataStore that this suggestion belongs to.",
7831
+ "type": "string"
7832
+ },
7833
+ "destinationUri": {
7834
+ "description": "The destination uri of the person suggestion.",
7835
+ "type": "string"
7836
+ },
7837
+ "displayPhotoUri": {
7838
+ "description": "The photo uri of the person suggestion.",
7839
+ "type": "string"
7840
+ },
7841
+ "document": {
7842
+ "$ref": "GoogleCloudDiscoveryengineV1Document",
7843
+ "description": "The document data snippet in the suggestion. Only a subset of fields is populated."
7844
+ },
7845
+ "personType": {
7846
+ "description": "The type of the person.",
7847
+ "enum": [
7848
+ "PERSON_TYPE_UNSPECIFIED",
7849
+ "CLOUD_IDENTITY",
7850
+ "THIRD_PARTY_IDENTITY"
7851
+ ],
7852
+ "enumDescriptions": [
7853
+ "Default value.",
7854
+ "The suggestion is from a GOOGLE_IDENTITY source.",
7855
+ "The suggestion is from a THIRD_PARTY_IDENTITY source."
7856
+ ],
7857
+ "type": "string"
7858
+ },
7859
+ "score": {
7860
+ "description": "The score of each suggestion. The score is in the range of [0, 1].",
7861
+ "format": "double",
7862
+ "type": "number"
7863
+ },
7864
+ "suggestion": {
7865
+ "description": "The suggestion for the query.",
7866
+ "type": "string"
7867
+ }
7868
+ },
7869
+ "type": "object"
7870
+ },
7871
+ "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseQuerySuggestion": {
7872
+ "description": "Suggestions as search queries.",
7873
+ "id": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseQuerySuggestion",
7874
+ "properties": {
7875
+ "completableFieldPaths": {
7876
+ "description": "The unique document field paths that serve as the source of this suggestion if it was generated from completable fields. This field is only populated for the document-completable model.",
7877
+ "items": {
7878
+ "type": "string"
7879
+ },
7880
+ "type": "array"
7881
+ },
7882
+ "dataStore": {
7883
+ "description": "The name of the dataStore that this suggestion belongs to.",
7884
+ "items": {
7885
+ "type": "string"
7886
+ },
7887
+ "type": "array"
7888
+ },
7889
+ "score": {
7890
+ "description": "The score of each suggestion. The score is in the range of [0, 1].",
7891
+ "format": "double",
7892
+ "type": "number"
7893
+ },
7894
+ "suggestion": {
7895
+ "description": "The suggestion for the query.",
7896
+ "type": "string"
7897
+ }
7898
+ },
7899
+ "type": "object"
7900
+ },
7901
+ "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseRecentSearchSuggestion": {
7902
+ "description": "Suggestions from recent search history.",
7903
+ "id": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseRecentSearchSuggestion",
7904
+ "properties": {
7905
+ "recentSearchTime": {
7906
+ "description": "The time when this recent rearch happened.",
7907
+ "format": "google-datetime",
7908
+ "type": "string"
7909
+ },
7910
+ "score": {
7911
+ "description": "The score of each suggestion. The score is in the range of [0, 1].",
7912
+ "format": "double",
7913
+ "type": "number"
7914
+ },
7915
+ "suggestion": {
7916
+ "description": "The suggestion for the query.",
7917
+ "type": "string"
7918
+ }
7919
+ },
7920
+ "type": "object"
7921
+ },
7471
7922
  "GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig": {
7472
7923
  "description": "Configuration data for advance site search.",
7473
7924
  "id": "GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig",
@@ -8559,154 +9010,445 @@
8559
9010
  },
8560
9011
  "type": "object"
8561
9012
  },
8562
- "GoogleCloudDiscoveryengineV1AnswerStep": {
8563
- "description": "Step information.",
8564
- "id": "GoogleCloudDiscoveryengineV1AnswerStep",
9013
+ "GoogleCloudDiscoveryengineV1AnswerStep": {
9014
+ "description": "Step information.",
9015
+ "id": "GoogleCloudDiscoveryengineV1AnswerStep",
9016
+ "properties": {
9017
+ "actions": {
9018
+ "description": "Actions.",
9019
+ "items": {
9020
+ "$ref": "GoogleCloudDiscoveryengineV1AnswerStepAction"
9021
+ },
9022
+ "type": "array"
9023
+ },
9024
+ "description": {
9025
+ "description": "The description of the step.",
9026
+ "type": "string"
9027
+ },
9028
+ "state": {
9029
+ "description": "The state of the step.",
9030
+ "enum": [
9031
+ "STATE_UNSPECIFIED",
9032
+ "IN_PROGRESS",
9033
+ "FAILED",
9034
+ "SUCCEEDED"
9035
+ ],
9036
+ "enumDescriptions": [
9037
+ "Unknown.",
9038
+ "Step is currently in progress.",
9039
+ "Step currently failed.",
9040
+ "Step has succeeded."
9041
+ ],
9042
+ "type": "string"
9043
+ },
9044
+ "thought": {
9045
+ "description": "The thought of the step.",
9046
+ "type": "string"
9047
+ }
9048
+ },
9049
+ "type": "object"
9050
+ },
9051
+ "GoogleCloudDiscoveryengineV1AnswerStepAction": {
9052
+ "description": "Action.",
9053
+ "id": "GoogleCloudDiscoveryengineV1AnswerStepAction",
9054
+ "properties": {
9055
+ "observation": {
9056
+ "$ref": "GoogleCloudDiscoveryengineV1AnswerStepActionObservation",
9057
+ "description": "Observation."
9058
+ },
9059
+ "searchAction": {
9060
+ "$ref": "GoogleCloudDiscoveryengineV1AnswerStepActionSearchAction",
9061
+ "description": "Search action."
9062
+ }
9063
+ },
9064
+ "type": "object"
9065
+ },
9066
+ "GoogleCloudDiscoveryengineV1AnswerStepActionObservation": {
9067
+ "description": "Observation.",
9068
+ "id": "GoogleCloudDiscoveryengineV1AnswerStepActionObservation",
9069
+ "properties": {
9070
+ "searchResults": {
9071
+ "description": "Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user.",
9072
+ "items": {
9073
+ "$ref": "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResult"
9074
+ },
9075
+ "type": "array"
9076
+ }
9077
+ },
9078
+ "type": "object"
9079
+ },
9080
+ "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResult": {
9081
+ "id": "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResult",
9082
+ "properties": {
9083
+ "chunkInfo": {
9084
+ "description": "If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.",
9085
+ "items": {
9086
+ "$ref": "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultChunkInfo"
9087
+ },
9088
+ "type": "array"
9089
+ },
9090
+ "document": {
9091
+ "description": "Document resource name.",
9092
+ "type": "string"
9093
+ },
9094
+ "snippetInfo": {
9095
+ "description": "If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.",
9096
+ "items": {
9097
+ "$ref": "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo"
9098
+ },
9099
+ "type": "array"
9100
+ },
9101
+ "structData": {
9102
+ "additionalProperties": {
9103
+ "description": "Properties of the object.",
9104
+ "type": "any"
9105
+ },
9106
+ "description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result.",
9107
+ "type": "object"
9108
+ },
9109
+ "title": {
9110
+ "description": "Title.",
9111
+ "type": "string"
9112
+ },
9113
+ "uri": {
9114
+ "description": "URI for the document.",
9115
+ "type": "string"
9116
+ }
9117
+ },
9118
+ "type": "object"
9119
+ },
9120
+ "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultChunkInfo": {
9121
+ "description": "Chunk information.",
9122
+ "id": "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultChunkInfo",
9123
+ "properties": {
9124
+ "chunk": {
9125
+ "description": "Chunk resource name.",
9126
+ "type": "string"
9127
+ },
9128
+ "content": {
9129
+ "description": "Chunk textual content.",
9130
+ "type": "string"
9131
+ },
9132
+ "relevanceScore": {
9133
+ "description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.",
9134
+ "format": "float",
9135
+ "type": "number"
9136
+ }
9137
+ },
9138
+ "type": "object"
9139
+ },
9140
+ "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo": {
9141
+ "description": "Snippet information.",
9142
+ "id": "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo",
9143
+ "properties": {
9144
+ "snippet": {
9145
+ "description": "Snippet content.",
9146
+ "type": "string"
9147
+ },
9148
+ "snippetStatus": {
9149
+ "description": "Status of the snippet defined by the search team.",
9150
+ "type": "string"
9151
+ }
9152
+ },
9153
+ "type": "object"
9154
+ },
9155
+ "GoogleCloudDiscoveryengineV1AnswerStepActionSearchAction": {
9156
+ "description": "Search action.",
9157
+ "id": "GoogleCloudDiscoveryengineV1AnswerStepActionSearchAction",
9158
+ "properties": {
9159
+ "query": {
9160
+ "description": "The query to search.",
9161
+ "type": "string"
9162
+ }
9163
+ },
9164
+ "type": "object"
9165
+ },
9166
+ "GoogleCloudDiscoveryengineV1AssistAnswer": {
9167
+ "description": "AssistAnswer resource, main part of AssistResponse.",
9168
+ "id": "GoogleCloudDiscoveryengineV1AssistAnswer",
9169
+ "properties": {
9170
+ "assistSkippedReasons": {
9171
+ "description": "Reasons for not answering the assist call.",
9172
+ "items": {
9173
+ "enum": [
9174
+ "ASSIST_SKIPPED_REASON_UNSPECIFIED",
9175
+ "NON_ASSIST_SEEKING_QUERY_IGNORED",
9176
+ "CUSTOMER_POLICY_VIOLATION"
9177
+ ],
9178
+ "enumDescriptions": [
9179
+ "Default value. Skip reason is not specified.",
9180
+ "The assistant ignored the query, because it did not appear to be answer-seeking.",
9181
+ "The assistant ignored the query or refused to answer because of a customer policy violation (e.g., the query or the answer contained a banned phrase)."
9182
+ ],
9183
+ "type": "string"
9184
+ },
9185
+ "type": "array"
9186
+ },
9187
+ "replies": {
9188
+ "description": "Replies of the assistant.",
9189
+ "items": {
9190
+ "$ref": "GoogleCloudDiscoveryengineV1AssistAnswerReply"
9191
+ },
9192
+ "type": "array"
9193
+ },
9194
+ "state": {
9195
+ "description": "State of the answer generation.",
9196
+ "enum": [
9197
+ "STATE_UNSPECIFIED",
9198
+ "IN_PROGRESS",
9199
+ "FAILED",
9200
+ "SUCCEEDED",
9201
+ "SKIPPED"
9202
+ ],
9203
+ "enumDescriptions": [
9204
+ "Unknown.",
9205
+ "Assist operation is currently in progress.",
9206
+ "Assist operation has failed.",
9207
+ "Assist operation has succeeded.",
9208
+ "Assist operation has been skipped."
9209
+ ],
9210
+ "type": "string"
9211
+ }
9212
+ },
9213
+ "type": "object"
9214
+ },
9215
+ "GoogleCloudDiscoveryengineV1AssistAnswerReply": {
9216
+ "description": "One part of the multi-part response of the assist call.",
9217
+ "id": "GoogleCloudDiscoveryengineV1AssistAnswerReply",
9218
+ "properties": {
9219
+ "groundedContent": {
9220
+ "$ref": "GoogleCloudDiscoveryengineV1AssistantGroundedContent",
9221
+ "description": "Possibly grounded response text or media from the assistant."
9222
+ }
9223
+ },
9224
+ "type": "object"
9225
+ },
9226
+ "GoogleCloudDiscoveryengineV1AssistUserMetadata": {
9227
+ "description": "User metadata of the request.",
9228
+ "id": "GoogleCloudDiscoveryengineV1AssistUserMetadata",
9229
+ "properties": {
9230
+ "preferredLanguageCode": {
9231
+ "description": "Optional. Preferred language to be used for answering if language detection fails. Also used as the language of error messages created by actions, regardless of language detection results.",
9232
+ "type": "string"
9233
+ },
9234
+ "timeZone": {
9235
+ "description": "Optional. IANA time zone, e.g. Europe/Budapest.",
9236
+ "type": "string"
9237
+ }
9238
+ },
9239
+ "type": "object"
9240
+ },
9241
+ "GoogleCloudDiscoveryengineV1AssistantContent": {
9242
+ "description": "Multi-modal content.",
9243
+ "id": "GoogleCloudDiscoveryengineV1AssistantContent",
9244
+ "properties": {
9245
+ "codeExecutionResult": {
9246
+ "$ref": "GoogleCloudDiscoveryengineV1AssistantContentCodeExecutionResult",
9247
+ "description": "Result of executing an ExecutableCode."
9248
+ },
9249
+ "executableCode": {
9250
+ "$ref": "GoogleCloudDiscoveryengineV1AssistantContentExecutableCode",
9251
+ "description": "Code generated by the model that is meant to be executed."
9252
+ },
9253
+ "file": {
9254
+ "$ref": "GoogleCloudDiscoveryengineV1AssistantContentFile",
9255
+ "description": "A file, e.g., an audio summary."
9256
+ },
9257
+ "inlineData": {
9258
+ "$ref": "GoogleCloudDiscoveryengineV1AssistantContentBlob",
9259
+ "description": "Inline binary data."
9260
+ },
9261
+ "role": {
9262
+ "description": "The producer of the content. Can be \"model\" or \"user\".",
9263
+ "type": "string"
9264
+ },
9265
+ "text": {
9266
+ "description": "Inline text.",
9267
+ "type": "string"
9268
+ },
9269
+ "thought": {
9270
+ "description": "Optional. Indicates if the part is thought from the model.",
9271
+ "type": "boolean"
9272
+ }
9273
+ },
9274
+ "type": "object"
9275
+ },
9276
+ "GoogleCloudDiscoveryengineV1AssistantContentBlob": {
9277
+ "description": "Inline blob.",
9278
+ "id": "GoogleCloudDiscoveryengineV1AssistantContentBlob",
8565
9279
  "properties": {
8566
- "actions": {
8567
- "description": "Actions.",
8568
- "items": {
8569
- "$ref": "GoogleCloudDiscoveryengineV1AnswerStepAction"
8570
- },
8571
- "type": "array"
9280
+ "data": {
9281
+ "description": "Required. Raw bytes.",
9282
+ "format": "byte",
9283
+ "type": "string"
8572
9284
  },
8573
- "description": {
8574
- "description": "The description of the step.",
9285
+ "mimeType": {
9286
+ "description": "Required. The media type (MIME type) of the generated data.",
8575
9287
  "type": "string"
9288
+ }
8576
9289
  },
8577
- "state": {
8578
- "description": "The state of the step.",
9290
+ "type": "object"
9291
+ },
9292
+ "GoogleCloudDiscoveryengineV1AssistantContentCodeExecutionResult": {
9293
+ "description": "Result of executing ExecutableCode.",
9294
+ "id": "GoogleCloudDiscoveryengineV1AssistantContentCodeExecutionResult",
9295
+ "properties": {
9296
+ "outcome": {
9297
+ "description": "Required. Outcome of the code execution.",
8579
9298
  "enum": [
8580
- "STATE_UNSPECIFIED",
8581
- "IN_PROGRESS",
8582
- "FAILED",
8583
- "SUCCEEDED"
9299
+ "OUTCOME_UNSPECIFIED",
9300
+ "OUTCOME_OK",
9301
+ "OUTCOME_FAILED",
9302
+ "OUTCOME_DEADLINE_EXCEEDED"
8584
9303
  ],
8585
9304
  "enumDescriptions": [
8586
- "Unknown.",
8587
- "Step is currently in progress.",
8588
- "Step currently failed.",
8589
- "Step has succeeded."
9305
+ "Unspecified status. This value should not be used.",
9306
+ "Code execution completed successfully.",
9307
+ "Code execution finished but with a failure. `stderr` should contain the reason.",
9308
+ "Code execution ran for too long, and was cancelled. There may or may not be a partial output present."
8590
9309
  ],
8591
9310
  "type": "string"
8592
9311
  },
8593
- "thought": {
8594
- "description": "The thought of the step.",
9312
+ "output": {
9313
+ "description": "Optional. Contains stdout when code execution is successful, stderr or other description otherwise.",
8595
9314
  "type": "string"
8596
9315
  }
8597
9316
  },
8598
9317
  "type": "object"
8599
9318
  },
8600
- "GoogleCloudDiscoveryengineV1AnswerStepAction": {
8601
- "description": "Action.",
8602
- "id": "GoogleCloudDiscoveryengineV1AnswerStepAction",
9319
+ "GoogleCloudDiscoveryengineV1AssistantContentExecutableCode": {
9320
+ "description": "Code generated by the model that is meant to be executed by the model.",
9321
+ "id": "GoogleCloudDiscoveryengineV1AssistantContentExecutableCode",
8603
9322
  "properties": {
8604
- "observation": {
8605
- "$ref": "GoogleCloudDiscoveryengineV1AnswerStepActionObservation",
8606
- "description": "Observation."
9323
+ "code": {
9324
+ "description": "Required. The code content. Currently only supports Python.",
9325
+ "type": "string"
9326
+ }
8607
9327
  },
8608
- "searchAction": {
8609
- "$ref": "GoogleCloudDiscoveryengineV1AnswerStepActionSearchAction",
8610
- "description": "Search action."
9328
+ "type": "object"
9329
+ },
9330
+ "GoogleCloudDiscoveryengineV1AssistantContentFile": {
9331
+ "description": "A file, e.g., an audio summary.",
9332
+ "id": "GoogleCloudDiscoveryengineV1AssistantContentFile",
9333
+ "properties": {
9334
+ "fileId": {
9335
+ "description": "Required. The file ID.",
9336
+ "type": "string"
9337
+ },
9338
+ "mimeType": {
9339
+ "description": "Required. The media type (MIME type) of the file.",
9340
+ "type": "string"
8611
9341
  }
8612
9342
  },
8613
9343
  "type": "object"
8614
9344
  },
8615
- "GoogleCloudDiscoveryengineV1AnswerStepActionObservation": {
8616
- "description": "Observation.",
8617
- "id": "GoogleCloudDiscoveryengineV1AnswerStepActionObservation",
9345
+ "GoogleCloudDiscoveryengineV1AssistantGroundedContent": {
9346
+ "description": "A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like \"Of course, I will gladly search it for you.\" do not need grounding.",
9347
+ "id": "GoogleCloudDiscoveryengineV1AssistantGroundedContent",
8618
9348
  "properties": {
8619
- "searchResults": {
8620
- "description": "Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user.",
8621
- "items": {
8622
- "$ref": "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResult"
9349
+ "content": {
9350
+ "$ref": "GoogleCloudDiscoveryengineV1AssistantContent",
9351
+ "description": "The content."
8623
9352
  },
8624
- "type": "array"
9353
+ "textGroundingMetadata": {
9354
+ "$ref": "GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadata",
9355
+ "description": "Metadata for grounding based on text sources."
8625
9356
  }
8626
9357
  },
8627
9358
  "type": "object"
8628
9359
  },
8629
- "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResult": {
8630
- "id": "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResult",
9360
+ "GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadata": {
9361
+ "description": "Grounding details for text sources.",
9362
+ "id": "GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadata",
8631
9363
  "properties": {
8632
- "chunkInfo": {
8633
- "description": "If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.",
9364
+ "references": {
9365
+ "description": "References for the grounded text.",
8634
9366
  "items": {
8635
- "$ref": "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultChunkInfo"
9367
+ "$ref": "GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataReference"
8636
9368
  },
8637
9369
  "type": "array"
8638
9370
  },
8639
- "document": {
8640
- "description": "Document resource name.",
8641
- "type": "string"
8642
- },
8643
- "snippetInfo": {
8644
- "description": "If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.",
9371
+ "segments": {
9372
+ "description": "Grounding information for parts of the text.",
8645
9373
  "items": {
8646
- "$ref": "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo"
9374
+ "$ref": "GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataSegment"
8647
9375
  },
8648
9376
  "type": "array"
9377
+ }
8649
9378
  },
8650
- "structData": {
8651
- "additionalProperties": {
8652
- "description": "Properties of the object.",
8653
- "type": "any"
9379
+ "type": "object"
9380
+ },
9381
+ "GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataReference": {
9382
+ "description": "Referenced content and related document metadata.",
9383
+ "id": "GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataReference",
9384
+ "properties": {
9385
+ "content": {
9386
+ "description": "Referenced text content.",
9387
+ "type": "string"
9388
+ },
9389
+ "documentMetadata": {
9390
+ "$ref": "GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata",
9391
+ "description": "Document metadata."
9392
+ }
8654
9393
  },
8655
- "description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result.",
8656
9394
  "type": "object"
8657
9395
  },
9396
+ "GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata": {
9397
+ "description": "Document metadata.",
9398
+ "id": "GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata",
9399
+ "properties": {
9400
+ "document": {
9401
+ "description": "Document resource name.",
9402
+ "type": "string"
9403
+ },
9404
+ "domain": {
9405
+ "description": "Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site.",
9406
+ "type": "string"
9407
+ },
9408
+ "pageIdentifier": {
9409
+ "description": "Page identifier.",
9410
+ "type": "string"
9411
+ },
8658
9412
  "title": {
8659
9413
  "description": "Title.",
8660
9414
  "type": "string"
8661
9415
  },
8662
9416
  "uri": {
8663
- "description": "URI for the document.",
9417
+ "description": "URI for the document. It may contain a URL that redirects to the actual website.",
8664
9418
  "type": "string"
8665
9419
  }
8666
9420
  },
8667
9421
  "type": "object"
8668
9422
  },
8669
- "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultChunkInfo": {
8670
- "description": "Chunk information.",
8671
- "id": "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultChunkInfo",
9423
+ "GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataSegment": {
9424
+ "description": "Grounding information for a segment of the text.",
9425
+ "id": "GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataSegment",
8672
9426
  "properties": {
8673
- "chunk": {
8674
- "description": "Chunk resource name.",
8675
- "type": "string"
8676
- },
8677
- "content": {
8678
- "description": "Chunk textual content.",
9427
+ "endIndex": {
9428
+ "description": "End of the segment, exclusive.",
9429
+ "format": "int64",
8679
9430
  "type": "string"
8680
9431
  },
8681
- "relevanceScore": {
8682
- "description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.",
9432
+ "groundingScore": {
9433
+ "description": "Score for the segment.",
8683
9434
  "format": "float",
8684
9435
  "type": "number"
8685
- }
8686
9436
  },
8687
- "type": "object"
9437
+ "referenceIndices": {
9438
+ "description": "References for the segment.",
9439
+ "items": {
9440
+ "format": "int32",
9441
+ "type": "integer"
8688
9442
  },
8689
- "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo": {
8690
- "description": "Snippet information.",
8691
- "id": "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo",
8692
- "properties": {
8693
- "snippet": {
8694
- "description": "Snippet content.",
8695
- "type": "string"
9443
+ "type": "array"
8696
9444
  },
8697
- "snippetStatus": {
8698
- "description": "Status of the snippet defined by the search team.",
9445
+ "startIndex": {
9446
+ "description": "Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one).",
9447
+ "format": "int64",
8699
9448
  "type": "string"
8700
- }
8701
- },
8702
- "type": "object"
8703
9449
  },
8704
- "GoogleCloudDiscoveryengineV1AnswerStepActionSearchAction": {
8705
- "description": "Search action.",
8706
- "id": "GoogleCloudDiscoveryengineV1AnswerStepActionSearchAction",
8707
- "properties": {
8708
- "query": {
8709
- "description": "The query to search.",
9450
+ "text": {
9451
+ "description": "The text segment itself.",
8710
9452
  "type": "string"
8711
9453
  }
8712
9454
  },
@@ -10817,6 +11559,10 @@
10817
11559
  "description": "The layout parsing configurations for documents.",
10818
11560
  "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig",
10819
11561
  "properties": {
11562
+ "enableGetProcessedDocument": {
11563
+ "description": "Optional. If true, the processed document will be made available for the GetProcessedDocument API.",
11564
+ "type": "boolean"
11565
+ },
10820
11566
  "enableImageAnnotation": {
10821
11567
  "description": "Optional. If true, the LLM based annotation is added to the image during parsing.",
10822
11568
  "type": "boolean"
@@ -10971,7 +11717,7 @@
10971
11717
  ],
10972
11718
  "type": "string"
10973
11719
  },
10974
- "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing`",
11720
+ "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.",
10975
11721
  "type": "object"
10976
11722
  },
10977
11723
  "industryVertical": {
@@ -11627,7 +12373,7 @@
11627
12373
  "description": "Cloud Storage location for the input content."
11628
12374
  },
11629
12375
  "idField": {
11630
- "description": "The field indicates the ID field or column to be used as unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, `my_id` for JSON `{\"my_id\": \"some_uuid\"}`. For others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the Document.ids. The JSON field or the table column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when auto_generate_ids is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource.",
12376
+ "description": "The field indicates the ID field or column to be used as unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, `my_id` for JSON `{\"my_id\": \"some_uuid\"}`. For others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the Document.ids. The JSON field or the table column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when auto_generate_ids is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * BigtableSource.",
11631
12377
  "type": "string"
11632
12378
  },
11633
12379
  "inlineSource": {
@@ -13067,7 +13813,7 @@
13067
13813
  "description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical."
13068
13814
  },
13069
13815
  "session": {
13070
- "description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.",
13816
+ "description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.",
13071
13817
  "type": "string"
13072
13818
  },
13073
13819
  "sessionSpec": {
@@ -14294,6 +15040,148 @@
14294
15040
  },
14295
15041
  "type": "object"
14296
15042
  },
15043
+ "GoogleCloudDiscoveryengineV1StreamAssistRequest": {
15044
+ "description": "Request for the AssistantService.StreamAssist method.",
15045
+ "id": "GoogleCloudDiscoveryengineV1StreamAssistRequest",
15046
+ "properties": {
15047
+ "generationSpec": {
15048
+ "$ref": "GoogleCloudDiscoveryengineV1StreamAssistRequestGenerationSpec",
15049
+ "description": "Optional. Specification of the generation configuration for the request."
15050
+ },
15051
+ "query": {
15052
+ "$ref": "GoogleCloudDiscoveryengineV1Query",
15053
+ "description": "Optional. Current user query. Empty query is only supported if `file_ids` are provided. In this case, the answer will be generated based on those context files."
15054
+ },
15055
+ "session": {
15056
+ "description": "Optional. The session to use for the request. If specified, the assistant has access to the session history, and the query and the answer are stored there. If `-` is specified as the session ID, or it is left empty, then a new session is created with an automatically generated ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`",
15057
+ "type": "string"
15058
+ },
15059
+ "toolsSpec": {
15060
+ "$ref": "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpec",
15061
+ "description": "Optional. Specification of tools that are used to serve the request."
15062
+ },
15063
+ "userMetadata": {
15064
+ "$ref": "GoogleCloudDiscoveryengineV1AssistUserMetadata",
15065
+ "description": "Optional. Information about the user initiating the query."
15066
+ }
15067
+ },
15068
+ "type": "object"
15069
+ },
15070
+ "GoogleCloudDiscoveryengineV1StreamAssistRequestGenerationSpec": {
15071
+ "description": "Assistant generation specification for the request. This allows to override the default generation configuration at the engine level.",
15072
+ "id": "GoogleCloudDiscoveryengineV1StreamAssistRequestGenerationSpec",
15073
+ "properties": {
15074
+ "modelId": {
15075
+ "description": "Optional. The Vertex AI model_id used for the generative model. If not set, the default Assistant model will be used.",
15076
+ "type": "string"
15077
+ }
15078
+ },
15079
+ "type": "object"
15080
+ },
15081
+ "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpec": {
15082
+ "description": "Specification of tools that are used to serve the request.",
15083
+ "id": "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpec",
15084
+ "properties": {
15085
+ "imageGenerationSpec": {
15086
+ "$ref": "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecImageGenerationSpec",
15087
+ "description": "Optional. Specification of the image generation tool."
15088
+ },
15089
+ "toolRegistry": {
15090
+ "description": "Optional. The name of the tool registry to use. Format: `projects/{project}/locations/{location}/toolRegistries/{tool_registry}`",
15091
+ "type": "string"
15092
+ },
15093
+ "vertexAiSearchSpec": {
15094
+ "$ref": "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecVertexAiSearchSpec",
15095
+ "description": "Optional. Specification of the Vertex AI Search tool."
15096
+ },
15097
+ "videoGenerationSpec": {
15098
+ "$ref": "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecVideoGenerationSpec",
15099
+ "description": "Optional. Specification of the video generation tool."
15100
+ },
15101
+ "webGroundingSpec": {
15102
+ "$ref": "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecWebGroundingSpec",
15103
+ "description": "Optional. Specification of the web grounding tool. If field is present, enables grounding with web search. Works only if Assistant.web_grounding_type is WEB_GROUNDING_TYPE_GOOGLE_SEARCH or WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH."
15104
+ }
15105
+ },
15106
+ "type": "object"
15107
+ },
15108
+ "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecImageGenerationSpec": {
15109
+ "description": "Specification of the image generation tool.",
15110
+ "id": "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecImageGenerationSpec",
15111
+ "properties": {},
15112
+ "type": "object"
15113
+ },
15114
+ "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecVertexAiSearchSpec": {
15115
+ "description": "Specification of the Vertex AI Search tool.",
15116
+ "id": "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecVertexAiSearchSpec",
15117
+ "properties": {
15118
+ "dataStoreSpecs": {
15119
+ "description": "Optional. Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores.",
15120
+ "items": {
15121
+ "$ref": "GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec"
15122
+ },
15123
+ "type": "array"
15124
+ },
15125
+ "disabled": {
15126
+ "deprecated": true,
15127
+ "description": "Optional. Deprecated. Please refrain from using this field. Whether the Vertex AI Search tool is disabled. Default value is false, the tool is enabled by default.",
15128
+ "type": "boolean"
15129
+ },
15130
+ "filter": {
15131
+ "description": "Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY(\"king kong\")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)",
15132
+ "type": "string"
15133
+ }
15134
+ },
15135
+ "type": "object"
15136
+ },
15137
+ "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecVideoGenerationSpec": {
15138
+ "description": "Specification of the video generation tool.",
15139
+ "id": "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecVideoGenerationSpec",
15140
+ "properties": {},
15141
+ "type": "object"
15142
+ },
15143
+ "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecWebGroundingSpec": {
15144
+ "description": "Specification of the web grounding tool.",
15145
+ "id": "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecWebGroundingSpec",
15146
+ "properties": {
15147
+ "enabled": {
15148
+ "deprecated": true,
15149
+ "description": "Optional. Deprecated. Please refrain from using this field. Whether the web grounding tool is enabled.",
15150
+ "type": "boolean"
15151
+ }
15152
+ },
15153
+ "type": "object"
15154
+ },
15155
+ "GoogleCloudDiscoveryengineV1StreamAssistResponse": {
15156
+ "description": "Response for the AssistantService.StreamAssist method.",
15157
+ "id": "GoogleCloudDiscoveryengineV1StreamAssistResponse",
15158
+ "properties": {
15159
+ "answer": {
15160
+ "$ref": "GoogleCloudDiscoveryengineV1AssistAnswer",
15161
+ "description": "Assist answer resource object containing parts of the assistant's final answer for the user's query. Not present if the current response doesn't add anything to previously sent AssistAnswer.replies. Observe AssistAnswer.state to see if more parts are to be expected. While the state is `IN_PROGRESS`, the AssistAnswer.replies field in each response will contain replies (reply fragments) to be appended to the ones received in previous responses. AssistAnswer.name won't be filled. If the state is `SUCCEEDED`, `FAILED` or `SKIPPED`, the response is the last response and AssistAnswer.name will have a value."
15162
+ },
15163
+ "assistToken": {
15164
+ "description": "A global unique ID that identifies the current pair of request and stream of responses. Used for feedback and support.",
15165
+ "type": "string"
15166
+ },
15167
+ "sessionInfo": {
15168
+ "$ref": "GoogleCloudDiscoveryengineV1StreamAssistResponseSessionInfo",
15169
+ "description": "Session information."
15170
+ }
15171
+ },
15172
+ "type": "object"
15173
+ },
15174
+ "GoogleCloudDiscoveryengineV1StreamAssistResponseSessionInfo": {
15175
+ "description": "Information about the session.",
15176
+ "id": "GoogleCloudDiscoveryengineV1StreamAssistResponseSessionInfo",
15177
+ "properties": {
15178
+ "session": {
15179
+ "description": "Name of the newly generated or continued session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`.",
15180
+ "type": "string"
15181
+ }
15182
+ },
15183
+ "type": "object"
15184
+ },
14297
15185
  "GoogleCloudDiscoveryengineV1SuggestionDenyListEntry": {
14298
15186
  "description": "Suggestion deny list entry identifying the phrase to block from suggestions and the applied operation for the phrase.",
14299
15187
  "id": "GoogleCloudDiscoveryengineV1SuggestionDenyListEntry",
@@ -14776,14 +15664,16 @@
14776
15664
  "ASSIGNED",
14777
15665
  "UNASSIGNED",
14778
15666
  "NO_LICENSE",
14779
- "NO_LICENSE_ATTEMPTED_LOGIN"
15667
+ "NO_LICENSE_ATTEMPTED_LOGIN",
15668
+ "BLOCKED"
14780
15669
  ],
14781
15670
  "enumDescriptions": [
14782
15671
  "Default value.",
14783
15672
  "License assigned to the user.",
14784
15673
  "No license assigned to the user. Deprecated, translated to NO_LICENSE.",
14785
15674
  "No license assigned to the user.",
14786
- "User attempted to login but no license assigned to the user. This state is only used for no user first time login attempt but cannot get license assigned. Users already logged in but cannot get license assigned will be assigned NO_LICENSE state(License could be unassigned by admin)."
15675
+ "User attempted to login but no license assigned to the user. This state is only used for no user first time login attempt but cannot get license assigned. Users already logged in but cannot get license assigned will be assigned NO_LICENSE state(License could be unassigned by admin).",
15676
+ "User is blocked from assigning a license."
14787
15677
  ],
14788
15678
  "readOnly": true,
14789
15679
  "type": "string"
@@ -15945,7 +16835,7 @@
15945
16835
  "id": "GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun",
15946
16836
  "properties": {
15947
16837
  "deletedRecordCount": {
15948
- "description": "The number of documents deleted.",
16838
+ "description": "Optional. The number of documents deleted.",
15949
16839
  "format": "int64",
15950
16840
  "type": "string"
15951
16841
  },
@@ -15954,7 +16844,7 @@
15954
16844
  "type": "string"
15955
16845
  },
15956
16846
  "errorRecordCount": {
15957
- "description": "The total number of documents failed at sync at any stage (extraction, indexing, etc).",
16847
+ "description": "Optional. The total number of documents failed at sync at indexing stage.",
15958
16848
  "format": "int64",
15959
16849
  "type": "string"
15960
16850
  },
@@ -15966,12 +16856,12 @@
15966
16856
  "type": "array"
15967
16857
  },
15968
16858
  "extractedRecordCount": {
15969
- "description": "The number of documents extracted from connector source, ready to be ingested to VAIS.",
16859
+ "description": "Optional. The number of documents extracted from connector source, ready to be ingested to VAIS.",
15970
16860
  "format": "int64",
15971
16861
  "type": "string"
15972
16862
  },
15973
16863
  "indexedRecordCount": {
15974
- "description": "The number of documents indexed.",
16864
+ "description": "Optional. The number of documents indexed.",
15975
16865
  "format": "int64",
15976
16866
  "type": "string"
15977
16867
  },
@@ -15980,12 +16870,12 @@
15980
16870
  "description": "Metadata to generate the progress bar."
15981
16871
  },
15982
16872
  "scheduledRecordCount": {
15983
- "description": "The number of documents scheduled to be crawled/extracted from connector source. This only applies to third party connectors.",
16873
+ "description": "Optional. The number of documents scheduled to be crawled/extracted from connector source. This only applies to third party connectors.",
15984
16874
  "format": "int64",
15985
16875
  "type": "string"
15986
16876
  },
15987
16877
  "sourceApiRequestCount": {
15988
- "description": "The number of requests sent to 3p API.",
16878
+ "description": "Optional. The number of requests sent to 3p API.",
15989
16879
  "format": "int64",
15990
16880
  "type": "string"
15991
16881
  },
@@ -16517,7 +17407,8 @@
16517
17407
  "GOOGLE_DRIVE",
16518
17408
  "NATIVE_CLOUD_IDENTITY",
16519
17409
  "THIRD_PARTY_FEDERATED",
16520
- "THIRD_PARTY_EUA"
17410
+ "THIRD_PARTY_EUA",
17411
+ "GCNV"
16521
17412
  ],
16522
17413
  "enumDescriptions": [
16523
17414
  "Default value.",
@@ -16530,7 +17421,8 @@
16530
17421
  "Google Drive connector.",
16531
17422
  "Native Cloud Identity connector for people search powered by People API.",
16532
17423
  "Federated connector, it is a third party connector that doesn't ingestion data, and search is powered by third party application's API.",
16533
- "Connector utilized for End User Authentication features."
17424
+ "Connector utilized for End User Authentication features.",
17425
+ "Google Cloud NetApp Volumes connector."
16534
17426
  ],
16535
17427
  "readOnly": true,
16536
17428
  "type": "string"
@@ -16708,14 +17600,12 @@
16708
17600
  "enum": [
16709
17601
  "PERIODIC",
16710
17602
  "STREAMING",
16711
- "UNSPECIFIED",
16712
- "SCALA_SYNC"
17603
+ "UNSPECIFIED"
16713
17604
  ],
16714
17605
  "enumDescriptions": [
16715
17606
  "The connector will sync data periodically based on the refresh_interval. Use it with auto_run_disabled to pause the periodic sync, or indicate a one-time sync.",
16716
17607
  "The data will be synced in real time.",
16717
- "Connector that doesn't ingest data will have this value",
16718
- "The data will be synced with Scala Sync, a data ingestion solution."
17608
+ "Connector that doesn't ingest data will have this value"
16719
17609
  ],
16720
17610
  "type": "string"
16721
17611
  },
@@ -16747,6 +17637,10 @@
16747
17637
  },
16748
17638
  "description": "Optional. Any authentication parameters specific to EUA connectors.",
16749
17639
  "type": "object"
17640
+ },
17641
+ "tenant": {
17642
+ "$ref": "GoogleCloudDiscoveryengineV1alphaTenant",
17643
+ "description": "Optional. The tenant project the connector is connected to."
16750
17644
  }
16751
17645
  },
16752
17646
  "type": "object"
@@ -16759,6 +17653,10 @@
16759
17653
  "description": "Optional. The ID of the Secret Manager secret used for webhook secret.",
16760
17654
  "type": "string"
16761
17655
  },
17656
+ "streamingError": {
17657
+ "$ref": "GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfigStreamingError",
17658
+ "description": "Optional. Streaming error details."
17659
+ },
16762
17660
  "webhookUri": {
16763
17661
  "description": "Optional. Webhook url for the connector to specify additional params for realtime sync.",
16764
17662
  "type": "string"
@@ -16766,6 +17664,33 @@
16766
17664
  },
16767
17665
  "type": "object"
16768
17666
  },
17667
+ "GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfigStreamingError": {
17668
+ "description": "Streaming error details.",
17669
+ "id": "GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfigStreamingError",
17670
+ "properties": {
17671
+ "error": {
17672
+ "$ref": "GoogleRpcStatus",
17673
+ "description": "Optional. Error details."
17674
+ },
17675
+ "streamingErrorReason": {
17676
+ "description": "Optional. Streaming error.",
17677
+ "enum": [
17678
+ "STREAMING_ERROR_REASON_UNSPECIFIED",
17679
+ "STREAMING_SETUP_ERROR",
17680
+ "STREAMING_SYNC_ERROR",
17681
+ "INGRESS_ENDPOINT_REQUIRED"
17682
+ ],
17683
+ "enumDescriptions": [
17684
+ "Streaming error reason unspecified.",
17685
+ "Some error occurred while setting up resources for realtime sync.",
17686
+ "Some error was encountered while running realtime sync for the connector.",
17687
+ "Ingress endpoint is required when setting up realtime sync in private connectivity."
17688
+ ],
17689
+ "type": "string"
17690
+ }
17691
+ },
17692
+ "type": "object"
17693
+ },
16769
17694
  "GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity": {
16770
17695
  "description": "Represents an entity in the data source. For example, the `Account` object in Salesforce.",
16771
17696
  "id": "GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity",
@@ -17314,6 +18239,10 @@
17314
18239
  "description": "The layout parsing configurations for documents.",
17315
18240
  "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig",
17316
18241
  "properties": {
18242
+ "enableGetProcessedDocument": {
18243
+ "description": "Optional. If true, the processed document will be made available for the GetProcessedDocument API.",
18244
+ "type": "boolean"
18245
+ },
17317
18246
  "enableImageAnnotation": {
17318
18247
  "description": "Optional. If true, the LLM based annotation is added to the image during parsing.",
17319
18248
  "type": "boolean"
@@ -17447,7 +18376,7 @@
17447
18376
  ],
17448
18377
  "type": "string"
17449
18378
  },
17450
- "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing`",
18379
+ "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.",
17451
18380
  "type": "object"
17452
18381
  },
17453
18382
  "industryVertical": {
@@ -18489,7 +19418,7 @@
18489
19418
  "id": "GoogleCloudDiscoveryengineV1alphaListSessionsRequest",
18490
19419
  "properties": {
18491
19420
  "filter": {
18492
- "description": "A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: \"user_pseudo_id = some_id\"",
19421
+ "description": "A filter to apply on the list results. The supported features are: user_pseudo_id, state, starred. Examples: \"user_pseudo_id = some_id\" \"starred = true\"",
18493
19422
  "type": "string"
18494
19423
  },
18495
19424
  "orderBy": {
@@ -19340,7 +20269,7 @@
19340
20269
  "description": "The query expansion specification that specifies the conditions under which query expansion occurs."
19341
20270
  },
19342
20271
  "rankingExpression": {
19343
- "description": "Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result",
20272
+ "description": "Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result",
19344
20273
  "type": "string"
19345
20274
  },
19346
20275
  "rankingExpressionBackend": {
@@ -19407,7 +20336,7 @@ false
19407
20336
  "type": "string"
19408
20337
  },
19409
20338
  "session": {
19410
- "description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.",
20339
+ "description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.",
19411
20340
  "type": "string"
19412
20341
  },
19413
20342
  "sessionSpec": {
@@ -20365,6 +21294,25 @@ false
20365
21294
  },
20366
21295
  "type": "object"
20367
21296
  },
21297
+ "GoogleCloudDiscoveryengineV1alphaTenant": {
21298
+ "description": "Tenant information for a connector source. This includes some of the same information stored in the Credential message, but is limited to only what is needed to provide a list of accessible tenants to the user.",
21299
+ "id": "GoogleCloudDiscoveryengineV1alphaTenant",
21300
+ "properties": {
21301
+ "displayName": {
21302
+ "description": "Optional display name for the tenant, e.g. \"My Slack Team\".",
21303
+ "type": "string"
21304
+ },
21305
+ "id": {
21306
+ "description": "The tenant's instance ID. Examples: Jira (\"8594f221-9797-5f78-1fa4-485e198d7cd0\"), Slack (\"T123456\").",
21307
+ "type": "string"
21308
+ },
21309
+ "uri": {
21310
+ "description": "The URI of the tenant, if applicable. For example, the URI of a Jira instance is https://my-jira-instance.atlassian.net, and a Slack tenant does not have a URI.",
21311
+ "type": "string"
21312
+ }
21313
+ },
21314
+ "type": "object"
21315
+ },
20368
21316
  "GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata": {
20369
21317
  "description": "Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.",
20370
21318
  "id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata",
@@ -20559,14 +21507,16 @@ false
20559
21507
  "ASSIGNED",
20560
21508
  "UNASSIGNED",
20561
21509
  "NO_LICENSE",
20562
- "NO_LICENSE_ATTEMPTED_LOGIN"
21510
+ "NO_LICENSE_ATTEMPTED_LOGIN",
21511
+ "BLOCKED"
20563
21512
  ],
20564
21513
  "enumDescriptions": [
20565
21514
  "Default value.",
20566
21515
  "License assigned to the user.",
20567
21516
  "No license assigned to the user. Deprecated, translated to NO_LICENSE.",
20568
21517
  "No license assigned to the user.",
20569
- "User attempted to login but no license assigned to the user. This state is only used for no user first time login attempt but cannot get license assigned. Users already logged in but cannot get license assigned will be assigned NO_LICENSE state(License could be unassigned by admin)."
21518
+ "User attempted to login but no license assigned to the user. This state is only used for no user first time login attempt but cannot get license assigned. Users already logged in but cannot get license assigned will be assigned NO_LICENSE state(License could be unassigned by admin).",
21519
+ "User is blocked from assigning a license."
20570
21520
  ],
20571
21521
  "readOnly": true,
20572
21522
  "type": "string"
@@ -21618,6 +22568,10 @@ false
21618
22568
  "description": "The layout parsing configurations for documents.",
21619
22569
  "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig",
21620
22570
  "properties": {
22571
+ "enableGetProcessedDocument": {
22572
+ "description": "Optional. If true, the processed document will be made available for the GetProcessedDocument API.",
22573
+ "type": "boolean"
22574
+ },
21621
22575
  "enableImageAnnotation": {
21622
22576
  "description": "Optional. If true, the LLM based annotation is added to the image during parsing.",
21623
22577
  "type": "boolean"
@@ -21751,7 +22705,7 @@ false
21751
22705
  ],
21752
22706
  "type": "string"
21753
22707
  },
21754
- "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing`",
22708
+ "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.",
21755
22709
  "type": "object"
21756
22710
  },
21757
22711
  "industryVertical": {
@@ -22934,7 +23888,7 @@ false
22934
23888
  "description": "The query expansion specification that specifies the conditions under which query expansion occurs."
22935
23889
  },
22936
23890
  "rankingExpression": {
22937
- "description": "Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result",
23891
+ "description": "Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result",
22938
23892
  "type": "string"
22939
23893
  },
22940
23894
  "rankingExpressionBackend": {
@@ -23001,7 +23955,7 @@ false
23001
23955
  "type": "string"
23002
23956
  },
23003
23957
  "session": {
23004
- "description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.",
23958
+ "description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.",
23005
23959
  "type": "string"
23006
23960
  },
23007
23961
  "sessionSpec": {
@@ -23989,14 +24943,16 @@ false
23989
24943
  "ASSIGNED",
23990
24944
  "UNASSIGNED",
23991
24945
  "NO_LICENSE",
23992
- "NO_LICENSE_ATTEMPTED_LOGIN"
24946
+ "NO_LICENSE_ATTEMPTED_LOGIN",
24947
+ "BLOCKED"
23993
24948
  ],
23994
24949
  "enumDescriptions": [
23995
24950
  "Default value.",
23996
24951
  "License assigned to the user.",
23997
24952
  "No license assigned to the user. Deprecated, translated to NO_LICENSE.",
23998
24953
  "No license assigned to the user.",
23999
- "User attempted to login but no license assigned to the user. This state is only used for no user first time login attempt but cannot get license assigned. Users already logged in but cannot get license assigned will be assigned NO_LICENSE state(License could be unassigned by admin)."
24954
+ "User attempted to login but no license assigned to the user. This state is only used for no user first time login attempt but cannot get license assigned. Users already logged in but cannot get license assigned will be assigned NO_LICENSE state(License could be unassigned by admin).",
24955
+ "User is blocked from assigning a license."
24000
24956
  ],
24001
24957
  "readOnly": true,
24002
24958
  "type": "string"