google-apis-discoveryengine_v1beta 0.28.0 → 0.30.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -130,6 +130,18 @@ module Google
130
130
  include Google::Apis::Core::JsonObjectSupport
131
131
  end
132
132
 
133
+ class GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata
134
+ class Representation < Google::Apis::Core::JsonRepresentation; end
135
+
136
+ include Google::Apis::Core::JsonObjectSupport
137
+ end
138
+
139
+ class GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse
140
+ class Representation < Google::Apis::Core::JsonRepresentation; end
141
+
142
+ include Google::Apis::Core::JsonObjectSupport
143
+ end
144
+
133
145
  class GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata
134
146
  class Representation < Google::Apis::Core::JsonRepresentation; end
135
147
 
@@ -148,6 +160,12 @@ module Google
148
160
  include Google::Apis::Core::JsonObjectSupport
149
161
  end
150
162
 
163
+ class GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata
164
+ class Representation < Google::Apis::Core::JsonRepresentation; end
165
+
166
+ include Google::Apis::Core::JsonObjectSupport
167
+ end
168
+
151
169
  class GoogleCloudDiscoveryengineV1alphaDataStore
152
170
  class Representation < Google::Apis::Core::JsonRepresentation; end
153
171
 
@@ -172,6 +190,36 @@ module Google
172
190
  include Google::Apis::Core::JsonObjectSupport
173
191
  end
174
192
 
193
+ class GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata
194
+ class Representation < Google::Apis::Core::JsonRepresentation; end
195
+
196
+ include Google::Apis::Core::JsonObjectSupport
197
+ end
198
+
199
+ class GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata
200
+ class Representation < Google::Apis::Core::JsonRepresentation; end
201
+
202
+ include Google::Apis::Core::JsonObjectSupport
203
+ end
204
+
205
+ class GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse
206
+ class Representation < Google::Apis::Core::JsonRepresentation; end
207
+
208
+ include Google::Apis::Core::JsonObjectSupport
209
+ end
210
+
211
+ class GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata
212
+ class Representation < Google::Apis::Core::JsonRepresentation; end
213
+
214
+ include Google::Apis::Core::JsonObjectSupport
215
+ end
216
+
217
+ class GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse
218
+ class Representation < Google::Apis::Core::JsonRepresentation; end
219
+
220
+ include Google::Apis::Core::JsonObjectSupport
221
+ end
222
+
175
223
  class GoogleCloudDiscoveryengineV1alphaEngine
176
224
  class Representation < Google::Apis::Core::JsonRepresentation; end
177
225
 
@@ -232,6 +280,18 @@ module Google
232
280
  include Google::Apis::Core::JsonObjectSupport
233
281
  end
234
282
 
283
+ class GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata
284
+ class Representation < Google::Apis::Core::JsonRepresentation; end
285
+
286
+ include Google::Apis::Core::JsonObjectSupport
287
+ end
288
+
289
+ class GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse
290
+ class Representation < Google::Apis::Core::JsonRepresentation; end
291
+
292
+ include Google::Apis::Core::JsonObjectSupport
293
+ end
294
+
235
295
  class GoogleCloudDiscoveryengineV1alphaFieldConfig
236
296
  class Representation < Google::Apis::Core::JsonRepresentation; end
237
297
 
@@ -346,6 +406,18 @@ module Google
346
406
  include Google::Apis::Core::JsonObjectSupport
347
407
  end
348
408
 
409
+ class GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata
410
+ class Representation < Google::Apis::Core::JsonRepresentation; end
411
+
412
+ include Google::Apis::Core::JsonObjectSupport
413
+ end
414
+
415
+ class GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse
416
+ class Representation < Google::Apis::Core::JsonRepresentation; end
417
+
418
+ include Google::Apis::Core::JsonObjectSupport
419
+ end
420
+
349
421
  class GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata
350
422
  class Representation < Google::Apis::Core::JsonRepresentation; end
351
423
 
@@ -364,6 +436,12 @@ module Google
364
436
  include Google::Apis::Core::JsonObjectSupport
365
437
  end
366
438
 
439
+ class GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata
440
+ class Representation < Google::Apis::Core::JsonRepresentation; end
441
+
442
+ include Google::Apis::Core::JsonObjectSupport
443
+ end
444
+
367
445
  class GoogleCloudDiscoveryengineV1betaBigQuerySource
368
446
  class Representation < Google::Apis::Core::JsonRepresentation; end
369
447
 
@@ -664,6 +742,18 @@ module Google
664
742
  include Google::Apis::Core::JsonObjectSupport
665
743
  end
666
744
 
745
+ class GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec
746
+ class Representation < Google::Apis::Core::JsonRepresentation; end
747
+
748
+ include Google::Apis::Core::JsonObjectSupport
749
+ end
750
+
751
+ class GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec
752
+ class Representation < Google::Apis::Core::JsonRepresentation; end
753
+
754
+ include Google::Apis::Core::JsonObjectSupport
755
+ end
756
+
667
757
  class GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec
668
758
  class Representation < Google::Apis::Core::JsonRepresentation; end
669
759
 
@@ -760,12 +850,42 @@ module Google
760
850
  include Google::Apis::Core::JsonObjectSupport
761
851
  end
762
852
 
853
+ class GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitation
854
+ class Representation < Google::Apis::Core::JsonRepresentation; end
855
+
856
+ include Google::Apis::Core::JsonObjectSupport
857
+ end
858
+
859
+ class GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationMetadata
860
+ class Representation < Google::Apis::Core::JsonRepresentation; end
861
+
862
+ include Google::Apis::Core::JsonObjectSupport
863
+ end
864
+
865
+ class GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationSource
866
+ class Representation < Google::Apis::Core::JsonRepresentation; end
867
+
868
+ include Google::Apis::Core::JsonObjectSupport
869
+ end
870
+
871
+ class GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReference
872
+ class Representation < Google::Apis::Core::JsonRepresentation; end
873
+
874
+ include Google::Apis::Core::JsonObjectSupport
875
+ end
876
+
763
877
  class GoogleCloudDiscoveryengineV1betaSearchResponseSummarySafetyAttributes
764
878
  class Representation < Google::Apis::Core::JsonRepresentation; end
765
879
 
766
880
  include Google::Apis::Core::JsonObjectSupport
767
881
  end
768
882
 
883
+ class GoogleCloudDiscoveryengineV1betaSearchResponseSummarySummaryWithMetadata
884
+ class Representation < Google::Apis::Core::JsonRepresentation; end
885
+
886
+ include Google::Apis::Core::JsonObjectSupport
887
+ end
888
+
769
889
  class GoogleCloudDiscoveryengineV1betaTextInput
770
890
  class Representation < Google::Apis::Core::JsonRepresentation; end
771
891
 
@@ -994,6 +1114,22 @@ module Google
994
1114
  end
995
1115
  end
996
1116
 
1117
+ class GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata
1118
+ # @private
1119
+ class Representation < Google::Apis::Core::JsonRepresentation
1120
+ property :create_time, as: 'createTime'
1121
+ property :update_time, as: 'updateTime'
1122
+ end
1123
+ end
1124
+
1125
+ class GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse
1126
+ # @private
1127
+ class Representation < Google::Apis::Core::JsonRepresentation
1128
+ collection :target_sites, as: 'targetSites', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaTargetSite, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaTargetSite::Representation
1129
+
1130
+ end
1131
+ end
1132
+
997
1133
  class GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata
998
1134
  # @private
999
1135
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1018,6 +1154,14 @@ module Google
1018
1154
  end
1019
1155
  end
1020
1156
 
1157
+ class GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata
1158
+ # @private
1159
+ class Representation < Google::Apis::Core::JsonRepresentation
1160
+ property :create_time, as: 'createTime'
1161
+ property :update_time, as: 'updateTime'
1162
+ end
1163
+ end
1164
+
1021
1165
  class GoogleCloudDiscoveryengineV1alphaDataStore
1022
1166
  # @private
1023
1167
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1055,6 +1199,42 @@ module Google
1055
1199
  end
1056
1200
  end
1057
1201
 
1202
+ class GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata
1203
+ # @private
1204
+ class Representation < Google::Apis::Core::JsonRepresentation
1205
+ property :create_time, as: 'createTime'
1206
+ property :update_time, as: 'updateTime'
1207
+ end
1208
+ end
1209
+
1210
+ class GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata
1211
+ # @private
1212
+ class Representation < Google::Apis::Core::JsonRepresentation
1213
+ property :create_time, as: 'createTime'
1214
+ property :update_time, as: 'updateTime'
1215
+ end
1216
+ end
1217
+
1218
+ class GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse
1219
+ # @private
1220
+ class Representation < Google::Apis::Core::JsonRepresentation
1221
+ end
1222
+ end
1223
+
1224
+ class GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata
1225
+ # @private
1226
+ class Representation < Google::Apis::Core::JsonRepresentation
1227
+ property :create_time, as: 'createTime'
1228
+ property :update_time, as: 'updateTime'
1229
+ end
1230
+ end
1231
+
1232
+ class GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse
1233
+ # @private
1234
+ class Representation < Google::Apis::Core::JsonRepresentation
1235
+ end
1236
+ end
1237
+
1058
1238
  class GoogleCloudDiscoveryengineV1alphaEngine
1059
1239
  # @private
1060
1240
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1157,6 +1337,21 @@ module Google
1157
1337
  end
1158
1338
  end
1159
1339
 
1340
+ class GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata
1341
+ # @private
1342
+ class Representation < Google::Apis::Core::JsonRepresentation
1343
+ property :create_time, as: 'createTime'
1344
+ end
1345
+ end
1346
+
1347
+ class GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse
1348
+ # @private
1349
+ class Representation < Google::Apis::Core::JsonRepresentation
1350
+ property :data_size_bytes, :numeric_string => true, as: 'dataSizeBytes'
1351
+ property :document_count, :numeric_string => true, as: 'documentCount'
1352
+ end
1353
+ end
1354
+
1160
1355
  class GoogleCloudDiscoveryengineV1alphaFieldConfig
1161
1356
  # @private
1162
1357
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1345,6 +1540,25 @@ module Google
1345
1540
  end
1346
1541
  end
1347
1542
 
1543
+ class GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata
1544
+ # @private
1545
+ class Representation < Google::Apis::Core::JsonRepresentation
1546
+ property :create_time, as: 'createTime'
1547
+ property :update_time, as: 'updateTime'
1548
+ end
1549
+ end
1550
+
1551
+ class GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse
1552
+ # @private
1553
+ class Representation < Google::Apis::Core::JsonRepresentation
1554
+ property :error_config, as: 'errorConfig', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaImportErrorConfig, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaImportErrorConfig::Representation
1555
+
1556
+ collection :error_samples, as: 'errorSamples', class: Google::Apis::DiscoveryengineV1beta::GoogleRpcStatus, decorator: Google::Apis::DiscoveryengineV1beta::GoogleRpcStatus::Representation
1557
+
1558
+ property :model_status, as: 'modelStatus'
1559
+ end
1560
+ end
1561
+
1348
1562
  class GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata
1349
1563
  # @private
1350
1564
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1366,6 +1580,14 @@ module Google
1366
1580
  end
1367
1581
  end
1368
1582
 
1583
+ class GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata
1584
+ # @private
1585
+ class Representation < Google::Apis::Core::JsonRepresentation
1586
+ property :create_time, as: 'createTime'
1587
+ property :update_time, as: 'updateTime'
1588
+ end
1589
+ end
1590
+
1369
1591
  class GoogleCloudDiscoveryengineV1betaBigQuerySource
1370
1592
  # @private
1371
1593
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1441,6 +1663,7 @@ module Google
1441
1663
  class Representation < Google::Apis::Core::JsonRepresentation
1442
1664
  property :conversation, as: 'conversation', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation::Representation
1443
1665
 
1666
+ property :filter, as: 'filter'
1444
1667
  property :query, as: 'query', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaTextInput, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaTextInput::Representation
1445
1668
 
1446
1669
  property :safe_search, as: 'safeSearch'
@@ -1887,10 +2110,28 @@ module Google
1887
2110
  property :ignore_non_summary_seeking_query, as: 'ignoreNonSummarySeekingQuery'
1888
2111
  property :include_citations, as: 'includeCitations'
1889
2112
  property :language_code, as: 'languageCode'
2113
+ property :model_prompt_spec, as: 'modelPromptSpec', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec::Representation
2114
+
2115
+ property :model_spec, as: 'modelSpec', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec::Representation
2116
+
1890
2117
  property :summary_result_count, as: 'summaryResultCount'
1891
2118
  end
1892
2119
  end
1893
2120
 
2121
+ class GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec
2122
+ # @private
2123
+ class Representation < Google::Apis::Core::JsonRepresentation
2124
+ property :preamble, as: 'preamble'
2125
+ end
2126
+ end
2127
+
2128
+ class GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec
2129
+ # @private
2130
+ class Representation < Google::Apis::Core::JsonRepresentation
2131
+ property :version, as: 'version'
2132
+ end
2133
+ end
2134
+
1894
2135
  class GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec
1895
2136
  # @private
1896
2137
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2049,6 +2290,42 @@ module Google
2049
2290
 
2050
2291
  collection :summary_skipped_reasons, as: 'summarySkippedReasons'
2051
2292
  property :summary_text, as: 'summaryText'
2293
+ property :summary_with_metadata, as: 'summaryWithMetadata', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseSummarySummaryWithMetadata, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseSummarySummaryWithMetadata::Representation
2294
+
2295
+ end
2296
+ end
2297
+
2298
+ class GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitation
2299
+ # @private
2300
+ class Representation < Google::Apis::Core::JsonRepresentation
2301
+ property :end_index, :numeric_string => true, as: 'endIndex'
2302
+ collection :sources, as: 'sources', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationSource, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationSource::Representation
2303
+
2304
+ property :start_index, :numeric_string => true, as: 'startIndex'
2305
+ end
2306
+ end
2307
+
2308
+ class GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationMetadata
2309
+ # @private
2310
+ class Representation < Google::Apis::Core::JsonRepresentation
2311
+ collection :citations, as: 'citations', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitation, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitation::Representation
2312
+
2313
+ end
2314
+ end
2315
+
2316
+ class GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationSource
2317
+ # @private
2318
+ class Representation < Google::Apis::Core::JsonRepresentation
2319
+ property :reference_index, :numeric_string => true, as: 'referenceIndex'
2320
+ end
2321
+ end
2322
+
2323
+ class GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReference
2324
+ # @private
2325
+ class Representation < Google::Apis::Core::JsonRepresentation
2326
+ property :document, as: 'document'
2327
+ property :title, as: 'title'
2328
+ property :uri, as: 'uri'
2052
2329
  end
2053
2330
  end
2054
2331
 
@@ -2060,6 +2337,17 @@ module Google
2060
2337
  end
2061
2338
  end
2062
2339
 
2340
+ class GoogleCloudDiscoveryengineV1betaSearchResponseSummarySummaryWithMetadata
2341
+ # @private
2342
+ class Representation < Google::Apis::Core::JsonRepresentation
2343
+ property :citation_metadata, as: 'citationMetadata', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationMetadata, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationMetadata::Representation
2344
+
2345
+ collection :references, as: 'references', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReference, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReference::Representation
2346
+
2347
+ property :summary, as: 'summary'
2348
+ end
2349
+ end
2350
+
2063
2351
  class GoogleCloudDiscoveryengineV1betaTextInput
2064
2352
  # @private
2065
2353
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -720,7 +720,8 @@ module Google
720
720
  # Conversation to update does not exist, a NOT_FOUND error is returned.
721
721
  # @param [String] name
722
722
  # Immutable. Fully qualified name `project/*/locations/global/collections/`
723
- # collection`/dataStore/*/conversations/*`
723
+ # collection`/dataStore/*/conversations/*` or `project/*/locations/global/
724
+ # collections/`collection`/engines/*/conversations/*`.
724
725
  # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation] google_cloud_discoveryengine_v1beta_conversation_object
725
726
  # @param [String] update_mask
726
727
  # Indicates which fields in the provided Conversation to update. The following
@@ -1496,6 +1497,234 @@ module Google
1496
1497
  execute_or_queue_command(command, &block)
1497
1498
  end
1498
1499
 
1500
+ # Converses a conversation.
1501
+ # @param [String] name
1502
+ # Required. The resource name of the Conversation to get. Format: `projects/`
1503
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
1504
+ # data_store_id`/conversations/`conversation_id``. Use `projects/`project_number`
1505
+ # /locations/`location_id`/collections/`collection`/dataStores/`data_store_id`/
1506
+ # conversations/-` to activate auto session mode, which automatically creates a
1507
+ # new conversation inside a ConverseConversation session.
1508
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConverseConversationRequest] google_cloud_discoveryengine_v1beta_converse_conversation_request_object
1509
+ # @param [String] fields
1510
+ # Selector specifying which fields to include in a partial response.
1511
+ # @param [String] quota_user
1512
+ # Available to use for quota purposes for server-side applications. Can be any
1513
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1514
+ # @param [Google::Apis::RequestOptions] options
1515
+ # Request-specific options
1516
+ #
1517
+ # @yield [result, err] Result & error if block supplied
1518
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConverseConversationResponse] parsed result object
1519
+ # @yieldparam err [StandardError] error object if request failed
1520
+ #
1521
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConverseConversationResponse]
1522
+ #
1523
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1524
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1525
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1526
+ def converse_project_location_collection_engine_conversation(name, google_cloud_discoveryengine_v1beta_converse_conversation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1527
+ command = make_simple_command(:post, 'v1beta/{+name}:converse', options)
1528
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConverseConversationRequest::Representation
1529
+ command.request_object = google_cloud_discoveryengine_v1beta_converse_conversation_request_object
1530
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConverseConversationResponse::Representation
1531
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConverseConversationResponse
1532
+ command.params['name'] = name unless name.nil?
1533
+ command.query['fields'] = fields unless fields.nil?
1534
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1535
+ execute_or_queue_command(command, &block)
1536
+ end
1537
+
1538
+ # Creates a Conversation. If the Conversation to create already exists, an
1539
+ # ALREADY_EXISTS error is returned.
1540
+ # @param [String] parent
1541
+ # Required. Full resource name of parent data store. Format: `projects/`
1542
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
1543
+ # data_store_id``
1544
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation] google_cloud_discoveryengine_v1beta_conversation_object
1545
+ # @param [String] fields
1546
+ # Selector specifying which fields to include in a partial response.
1547
+ # @param [String] quota_user
1548
+ # Available to use for quota purposes for server-side applications. Can be any
1549
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1550
+ # @param [Google::Apis::RequestOptions] options
1551
+ # Request-specific options
1552
+ #
1553
+ # @yield [result, err] Result & error if block supplied
1554
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation] parsed result object
1555
+ # @yieldparam err [StandardError] error object if request failed
1556
+ #
1557
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation]
1558
+ #
1559
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1560
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1561
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1562
+ def create_project_location_collection_engine_conversation(parent, google_cloud_discoveryengine_v1beta_conversation_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1563
+ command = make_simple_command(:post, 'v1beta/{+parent}/conversations', options)
1564
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation::Representation
1565
+ command.request_object = google_cloud_discoveryengine_v1beta_conversation_object
1566
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation::Representation
1567
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation
1568
+ command.params['parent'] = parent unless parent.nil?
1569
+ command.query['fields'] = fields unless fields.nil?
1570
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1571
+ execute_or_queue_command(command, &block)
1572
+ end
1573
+
1574
+ # Deletes a Conversation. If the Conversation to delete does not exist, a
1575
+ # NOT_FOUND error is returned.
1576
+ # @param [String] name
1577
+ # Required. The resource name of the Conversation to delete. Format: `projects/`
1578
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
1579
+ # data_store_id`/conversations/`conversation_id``
1580
+ # @param [String] fields
1581
+ # Selector specifying which fields to include in a partial response.
1582
+ # @param [String] quota_user
1583
+ # Available to use for quota purposes for server-side applications. Can be any
1584
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1585
+ # @param [Google::Apis::RequestOptions] options
1586
+ # Request-specific options
1587
+ #
1588
+ # @yield [result, err] Result & error if block supplied
1589
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty] parsed result object
1590
+ # @yieldparam err [StandardError] error object if request failed
1591
+ #
1592
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty]
1593
+ #
1594
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1595
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1596
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1597
+ def delete_project_location_collection_engine_conversation(name, fields: nil, quota_user: nil, options: nil, &block)
1598
+ command = make_simple_command(:delete, 'v1beta/{+name}', options)
1599
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty::Representation
1600
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty
1601
+ command.params['name'] = name unless name.nil?
1602
+ command.query['fields'] = fields unless fields.nil?
1603
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1604
+ execute_or_queue_command(command, &block)
1605
+ end
1606
+
1607
+ # Gets a Conversation.
1608
+ # @param [String] name
1609
+ # Required. The resource name of the Conversation to get. Format: `projects/`
1610
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
1611
+ # data_store_id`/conversations/`conversation_id``
1612
+ # @param [String] fields
1613
+ # Selector specifying which fields to include in a partial response.
1614
+ # @param [String] quota_user
1615
+ # Available to use for quota purposes for server-side applications. Can be any
1616
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1617
+ # @param [Google::Apis::RequestOptions] options
1618
+ # Request-specific options
1619
+ #
1620
+ # @yield [result, err] Result & error if block supplied
1621
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation] parsed result object
1622
+ # @yieldparam err [StandardError] error object if request failed
1623
+ #
1624
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation]
1625
+ #
1626
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1627
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1628
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1629
+ def get_project_location_collection_engine_conversation(name, fields: nil, quota_user: nil, options: nil, &block)
1630
+ command = make_simple_command(:get, 'v1beta/{+name}', options)
1631
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation::Representation
1632
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation
1633
+ command.params['name'] = name unless name.nil?
1634
+ command.query['fields'] = fields unless fields.nil?
1635
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1636
+ execute_or_queue_command(command, &block)
1637
+ end
1638
+
1639
+ # Lists all Conversations by their parent DataStore.
1640
+ # @param [String] parent
1641
+ # Required. The data store resource name. Format: `projects/`project_number`/
1642
+ # locations/`location_id`/collections/`collection`/dataStores/`data_store_id``
1643
+ # @param [String] filter
1644
+ # A filter to apply on the list results. The supported features are:
1645
+ # user_pseudo_id, state. Example: "user_pseudo_id = some_id"
1646
+ # @param [String] order_by
1647
+ # A comma-separated list of fields to order by, sorted in ascending order. Use "
1648
+ # desc" after a field name for descending. Supported fields: * `update_time` * `
1649
+ # create_time` * `conversation_name` Example: "update_time desc" "create_time"
1650
+ # @param [Fixnum] page_size
1651
+ # Maximum number of results to return. If unspecified, defaults to 50. Max
1652
+ # allowed value is 1000.
1653
+ # @param [String] page_token
1654
+ # A page token, received from a previous `ListConversations` call. Provide this
1655
+ # to retrieve the subsequent page.
1656
+ # @param [String] fields
1657
+ # Selector specifying which fields to include in a partial response.
1658
+ # @param [String] quota_user
1659
+ # Available to use for quota purposes for server-side applications. Can be any
1660
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1661
+ # @param [Google::Apis::RequestOptions] options
1662
+ # Request-specific options
1663
+ #
1664
+ # @yield [result, err] Result & error if block supplied
1665
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListConversationsResponse] parsed result object
1666
+ # @yieldparam err [StandardError] error object if request failed
1667
+ #
1668
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListConversationsResponse]
1669
+ #
1670
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1671
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1672
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1673
+ def list_project_location_collection_engine_conversations(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1674
+ command = make_simple_command(:get, 'v1beta/{+parent}/conversations', options)
1675
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListConversationsResponse::Representation
1676
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListConversationsResponse
1677
+ command.params['parent'] = parent unless parent.nil?
1678
+ command.query['filter'] = filter unless filter.nil?
1679
+ command.query['orderBy'] = order_by unless order_by.nil?
1680
+ command.query['pageSize'] = page_size unless page_size.nil?
1681
+ command.query['pageToken'] = page_token unless page_token.nil?
1682
+ command.query['fields'] = fields unless fields.nil?
1683
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1684
+ execute_or_queue_command(command, &block)
1685
+ end
1686
+
1687
+ # Updates a Conversation. Conversation action type cannot be changed. If the
1688
+ # Conversation to update does not exist, a NOT_FOUND error is returned.
1689
+ # @param [String] name
1690
+ # Immutable. Fully qualified name `project/*/locations/global/collections/`
1691
+ # collection`/dataStore/*/conversations/*` or `project/*/locations/global/
1692
+ # collections/`collection`/engines/*/conversations/*`.
1693
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation] google_cloud_discoveryengine_v1beta_conversation_object
1694
+ # @param [String] update_mask
1695
+ # Indicates which fields in the provided Conversation to update. The following
1696
+ # are NOT supported: * conversation.name If not set or empty, all supported
1697
+ # fields are updated.
1698
+ # @param [String] fields
1699
+ # Selector specifying which fields to include in a partial response.
1700
+ # @param [String] quota_user
1701
+ # Available to use for quota purposes for server-side applications. Can be any
1702
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1703
+ # @param [Google::Apis::RequestOptions] options
1704
+ # Request-specific options
1705
+ #
1706
+ # @yield [result, err] Result & error if block supplied
1707
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation] parsed result object
1708
+ # @yieldparam err [StandardError] error object if request failed
1709
+ #
1710
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation]
1711
+ #
1712
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1713
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1714
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1715
+ def patch_project_location_collection_engine_conversation(name, google_cloud_discoveryengine_v1beta_conversation_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
1716
+ command = make_simple_command(:patch, 'v1beta/{+name}', options)
1717
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation::Representation
1718
+ command.request_object = google_cloud_discoveryengine_v1beta_conversation_object
1719
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation::Representation
1720
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation
1721
+ command.params['name'] = name unless name.nil?
1722
+ command.query['updateMask'] = update_mask unless update_mask.nil?
1723
+ command.query['fields'] = fields unless fields.nil?
1724
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1725
+ execute_or_queue_command(command, &block)
1726
+ end
1727
+
1499
1728
  # Gets the latest state of a long-running operation. Clients can use this method
1500
1729
  # to poll the operation result at intervals as recommended by the API service.
1501
1730
  # @param [String] name
@@ -2316,7 +2545,8 @@ module Google
2316
2545
  # Conversation to update does not exist, a NOT_FOUND error is returned.
2317
2546
  # @param [String] name
2318
2547
  # Immutable. Fully qualified name `project/*/locations/global/collections/`
2319
- # collection`/dataStore/*/conversations/*`
2548
+ # collection`/dataStore/*/conversations/*` or `project/*/locations/global/
2549
+ # collections/`collection`/engines/*/conversations/*`.
2320
2550
  # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation] google_cloud_discoveryengine_v1beta_conversation_object
2321
2551
  # @param [String] update_mask
2322
2552
  # Indicates which fields in the provided Conversation to update. The following