google-cloud-discovery_engine-v1beta 0.20.0 → 0.21.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.
Files changed (31) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/discovery_engine/v1beta/completion_service/client.rb +5 -5
  3. data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/client.rb +5 -5
  4. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/client.rb +27 -7
  5. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest/client.rb +27 -7
  6. data/lib/google/cloud/discovery_engine/v1beta/document_service/client.rb +11 -11
  7. data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/client.rb +11 -11
  8. data/lib/google/cloud/discovery_engine/v1beta/rest.rb +1 -0
  9. data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/client.rb +3 -3
  10. data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/rest/client.rb +3 -3
  11. data/lib/google/cloud/discovery_engine/v1beta/search_service/client.rb +16 -28
  12. data/lib/google/cloud/discovery_engine/v1beta/search_service/rest/client.rb +16 -28
  13. data/lib/google/cloud/discovery_engine/v1beta/session_service/client.rb +920 -0
  14. data/lib/google/cloud/discovery_engine/v1beta/session_service/credentials.rb +47 -0
  15. data/lib/google/cloud/discovery_engine/v1beta/session_service/paths.rb +330 -0
  16. data/lib/google/cloud/discovery_engine/v1beta/session_service/rest/client.rb +859 -0
  17. data/lib/google/cloud/discovery_engine/v1beta/session_service/rest/service_stub.rb +462 -0
  18. data/lib/google/cloud/discovery_engine/v1beta/session_service/rest.rb +52 -0
  19. data/lib/google/cloud/discovery_engine/v1beta/session_service.rb +55 -0
  20. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/client.rb +3 -3
  21. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/client.rb +3 -3
  22. data/lib/google/cloud/discovery_engine/v1beta/version.rb +1 -1
  23. data/lib/google/cloud/discovery_engine/v1beta.rb +1 -0
  24. data/lib/google/cloud/discoveryengine/v1beta/conversational_search_service_pb.rb +1 -1
  25. data/lib/google/cloud/discoveryengine/v1beta/session_pb.rb +3 -1
  26. data/lib/google/cloud/discoveryengine/v1beta/session_service_pb.rb +49 -0
  27. data/lib/google/cloud/discoveryengine/v1beta/session_service_services_pb.rb +64 -0
  28. data/proto_docs/google/cloud/discoveryengine/v1beta/conversational_search_service.rb +26 -5
  29. data/proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb +8 -14
  30. data/proto_docs/google/cloud/discoveryengine/v1beta/session.rb +38 -4
  31. metadata +11 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e93cc2b4fff63e48c92ac2e0cb86117c67deca0cb8d91582be9aea03e12b5add
4
- data.tar.gz: b7c4df4e706a225e07fc36150dfefbb1aeed18674844144d0eee359f0c4fc83c
3
+ metadata.gz: 225df45cd6bd848d2256f00fb2165e3be81bac5c084e28be3bb9688cb94eed82
4
+ data.tar.gz: 5527ba6246f256b79763414ae684f266f4f882dca319f33371bce5b269cbf20d
5
5
  SHA512:
6
- metadata.gz: 4517b3010eedc5de0475bdd4e74e494c4683068bce91b35e502da30c1254e45a0f512cd2af65348fe9690de9a64624a6718d34e4d0a079f71a172804ae7166f8
7
- data.tar.gz: fab89f1ac877ac5016416456dc48454847cd8c51f24eba6b33966dba60b16e11641b1b5e7c463ca635b004c8b6506b9a5ba39b1429a451ab0e8596eae3e33117
6
+ metadata.gz: f17a2e5602e3aff5c862f5595549b94e0ccb40d48157cd72efd63fbc6574d78a6cdeab2e859c58aa90b1d48d3c5d5daa1d2b808ba268fcd2329de6a1ee97dadd
7
+ data.tar.gz: 31aea61137e12ae88a0c64e6c0801025ffb7b13a4b992e06f690fcdd8e09078ea8b29aee7991360eda0d62bc5f389328c340bb196c858f37a580a97ef83e4b8d
@@ -516,7 +516,7 @@ module Google
516
516
  # @param inline_source [::Google::Cloud::DiscoveryEngine::V1beta::ImportSuggestionDenyListEntriesRequest::InlineSource, ::Hash]
517
517
  # The Inline source for the input content for suggestion deny list entries.
518
518
  #
519
- # Note: The following fields are mutually exclusive: `inline_source`, `gcs_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
519
+ # Note: The following parameters are mutually exclusive: `inline_source`, `gcs_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
520
520
  # @param gcs_source [::Google::Cloud::DiscoveryEngine::V1beta::GcsSource, ::Hash]
521
521
  # Cloud Storage location for the input content.
522
522
  #
@@ -527,7 +527,7 @@ module Google
527
527
  # * `suggestion_deny_list` (default): One JSON [SuggestionDenyListEntry]
528
528
  # per line.
529
529
  #
530
- # Note: The following fields are mutually exclusive: `gcs_source`, `inline_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
530
+ # Note: The following parameters are mutually exclusive: `gcs_source`, `inline_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
531
531
  # @param parent [::String]
532
532
  # Required. The parent data store resource name for which to import denylist
533
533
  # entries. Follows pattern projects/*/locations/*/collections/*/dataStores/*.
@@ -725,15 +725,15 @@ module Google
725
725
  # @param inline_source [::Google::Cloud::DiscoveryEngine::V1beta::ImportCompletionSuggestionsRequest::InlineSource, ::Hash]
726
726
  # The Inline source for suggestion entries.
727
727
  #
728
- # Note: The following fields are mutually exclusive: `inline_source`, `gcs_source`, `bigquery_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
728
+ # Note: The following parameters are mutually exclusive: `inline_source`, `gcs_source`, `bigquery_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
729
729
  # @param gcs_source [::Google::Cloud::DiscoveryEngine::V1beta::GcsSource, ::Hash]
730
730
  # Cloud Storage location for the input content.
731
731
  #
732
- # Note: The following fields are mutually exclusive: `gcs_source`, `inline_source`, `bigquery_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
732
+ # Note: The following parameters are mutually exclusive: `gcs_source`, `inline_source`, `bigquery_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
733
733
  # @param bigquery_source [::Google::Cloud::DiscoveryEngine::V1beta::BigQuerySource, ::Hash]
734
734
  # BigQuery input source.
735
735
  #
736
- # Note: The following fields are mutually exclusive: `bigquery_source`, `inline_source`, `gcs_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
736
+ # Note: The following parameters are mutually exclusive: `bigquery_source`, `inline_source`, `gcs_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
737
737
  # @param parent [::String]
738
738
  # Required. The parent data store resource name for which to import customer
739
739
  # autocomplete suggestions.
@@ -495,7 +495,7 @@ module Google
495
495
  # @param inline_source [::Google::Cloud::DiscoveryEngine::V1beta::ImportSuggestionDenyListEntriesRequest::InlineSource, ::Hash]
496
496
  # The Inline source for the input content for suggestion deny list entries.
497
497
  #
498
- # Note: The following fields are mutually exclusive: `inline_source`, `gcs_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
498
+ # Note: The following parameters are mutually exclusive: `inline_source`, `gcs_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
499
499
  # @param gcs_source [::Google::Cloud::DiscoveryEngine::V1beta::GcsSource, ::Hash]
500
500
  # Cloud Storage location for the input content.
501
501
  #
@@ -506,7 +506,7 @@ module Google
506
506
  # * `suggestion_deny_list` (default): One JSON [SuggestionDenyListEntry]
507
507
  # per line.
508
508
  #
509
- # Note: The following fields are mutually exclusive: `gcs_source`, `inline_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
509
+ # Note: The following parameters are mutually exclusive: `gcs_source`, `inline_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
510
510
  # @param parent [::String]
511
511
  # Required. The parent data store resource name for which to import denylist
512
512
  # entries. Follows pattern projects/*/locations/*/collections/*/dataStores/*.
@@ -690,15 +690,15 @@ module Google
690
690
  # @param inline_source [::Google::Cloud::DiscoveryEngine::V1beta::ImportCompletionSuggestionsRequest::InlineSource, ::Hash]
691
691
  # The Inline source for suggestion entries.
692
692
  #
693
- # Note: The following fields are mutually exclusive: `inline_source`, `gcs_source`, `bigquery_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
693
+ # Note: The following parameters are mutually exclusive: `inline_source`, `gcs_source`, `bigquery_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
694
694
  # @param gcs_source [::Google::Cloud::DiscoveryEngine::V1beta::GcsSource, ::Hash]
695
695
  # Cloud Storage location for the input content.
696
696
  #
697
- # Note: The following fields are mutually exclusive: `gcs_source`, `inline_source`, `bigquery_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
697
+ # Note: The following parameters are mutually exclusive: `gcs_source`, `inline_source`, `bigquery_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
698
698
  # @param bigquery_source [::Google::Cloud::DiscoveryEngine::V1beta::BigQuerySource, ::Hash]
699
699
  # BigQuery input source.
700
700
  #
701
- # Note: The following fields are mutually exclusive: `bigquery_source`, `inline_source`, `gcs_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
701
+ # Note: The following parameters are mutually exclusive: `bigquery_source`, `inline_source`, `gcs_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
702
702
  # @param parent [::String]
703
703
  # Required. The parent data store resource name for which to import customer
704
704
  # autocomplete suggestions.
@@ -1355,7 +1355,7 @@ module Google
1355
1355
  # @param options [::Gapic::CallOptions, ::Hash]
1356
1356
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1357
1357
  #
1358
- # @overload get_session(name: nil)
1358
+ # @overload get_session(name: nil, include_answer_details: nil)
1359
1359
  # Pass arguments to `get_session` via keyword arguments. Note that at
1360
1360
  # least one keyword argument is required. To specify no parameters, or to keep all
1361
1361
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -1363,6 +1363,9 @@ module Google
1363
1363
  # @param name [::String]
1364
1364
  # Required. The resource name of the Session to get. Format:
1365
1365
  # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
1366
+ # @param include_answer_details [::Boolean]
1367
+ # Optional. If set to true, the full session including all answer details
1368
+ # will be returned.
1366
1369
  #
1367
1370
  # @yield [response, operation] Access the result along with the RPC operation
1368
1371
  # @yieldparam response [::Google::Cloud::DiscoveryEngine::V1beta::Session]
@@ -1457,22 +1460,39 @@ module Google
1457
1460
  # A page token, received from a previous `ListSessions` call.
1458
1461
  # Provide this to retrieve the subsequent page.
1459
1462
  # @param filter [::String]
1460
- # A filter to apply on the list results. The supported features are:
1461
- # user_pseudo_id, state.
1462
- #
1463
- # Example:
1463
+ # A comma-separated list of fields to filter by, in EBNF grammar.
1464
+ # The supported fields are:
1465
+ # * `user_pseudo_id`
1466
+ # * `state`
1467
+ # * `display_name`
1468
+ # * `starred`
1469
+ # * `is_pinned`
1470
+ # * `labels`
1471
+ # * `create_time`
1472
+ # * `update_time`
1473
+ #
1474
+ # Examples:
1464
1475
  # "user_pseudo_id = some_id"
1476
+ # "display_name = \"some_name\""
1477
+ # "starred = true"
1478
+ # "is_pinned=true AND (NOT labels:hidden)"
1479
+ # "create_time > \"1970-01-01T12:00:00Z\""
1465
1480
  # @param order_by [::String]
1466
1481
  # A comma-separated list of fields to order by, sorted in ascending order.
1467
1482
  # Use "desc" after a field name for descending.
1468
1483
  # Supported fields:
1484
+ #
1469
1485
  # * `update_time`
1470
1486
  # * `create_time`
1471
1487
  # * `session_name`
1488
+ # * `is_pinned`
1472
1489
  #
1473
1490
  # Example:
1474
- # "update_time desc"
1475
- # "create_time"
1491
+ #
1492
+ # * "update_time desc"
1493
+ # * "create_time"
1494
+ # * "is_pinned desc,update_time desc": list sessions by is_pinned first, then
1495
+ # by update_time.
1476
1496
  #
1477
1497
  # @yield [response, operation] Access the result along with the RPC operation
1478
1498
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1beta::Session>]
@@ -1271,7 +1271,7 @@ module Google
1271
1271
  # @param options [::Gapic::CallOptions, ::Hash]
1272
1272
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
1273
1273
  #
1274
- # @overload get_session(name: nil)
1274
+ # @overload get_session(name: nil, include_answer_details: nil)
1275
1275
  # Pass arguments to `get_session` via keyword arguments. Note that at
1276
1276
  # least one keyword argument is required. To specify no parameters, or to keep all
1277
1277
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -1279,6 +1279,9 @@ module Google
1279
1279
  # @param name [::String]
1280
1280
  # Required. The resource name of the Session to get. Format:
1281
1281
  # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
1282
+ # @param include_answer_details [::Boolean]
1283
+ # Optional. If set to true, the full session including all answer details
1284
+ # will be returned.
1282
1285
  # @yield [result, operation] Access the result along with the TransportOperation object
1283
1286
  # @yieldparam result [::Google::Cloud::DiscoveryEngine::V1beta::Session]
1284
1287
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -1366,22 +1369,39 @@ module Google
1366
1369
  # A page token, received from a previous `ListSessions` call.
1367
1370
  # Provide this to retrieve the subsequent page.
1368
1371
  # @param filter [::String]
1369
- # A filter to apply on the list results. The supported features are:
1370
- # user_pseudo_id, state.
1371
- #
1372
- # Example:
1372
+ # A comma-separated list of fields to filter by, in EBNF grammar.
1373
+ # The supported fields are:
1374
+ # * `user_pseudo_id`
1375
+ # * `state`
1376
+ # * `display_name`
1377
+ # * `starred`
1378
+ # * `is_pinned`
1379
+ # * `labels`
1380
+ # * `create_time`
1381
+ # * `update_time`
1382
+ #
1383
+ # Examples:
1373
1384
  # "user_pseudo_id = some_id"
1385
+ # "display_name = \"some_name\""
1386
+ # "starred = true"
1387
+ # "is_pinned=true AND (NOT labels:hidden)"
1388
+ # "create_time > \"1970-01-01T12:00:00Z\""
1374
1389
  # @param order_by [::String]
1375
1390
  # A comma-separated list of fields to order by, sorted in ascending order.
1376
1391
  # Use "desc" after a field name for descending.
1377
1392
  # Supported fields:
1393
+ #
1378
1394
  # * `update_time`
1379
1395
  # * `create_time`
1380
1396
  # * `session_name`
1397
+ # * `is_pinned`
1381
1398
  #
1382
1399
  # Example:
1383
- # "update_time desc"
1384
- # "create_time"
1400
+ #
1401
+ # * "update_time desc"
1402
+ # * "create_time"
1403
+ # * "is_pinned desc,update_time desc": list sessions by is_pinned first, then
1404
+ # by update_time.
1385
1405
  # @yield [result, operation] Access the result along with the TransportOperation object
1386
1406
  # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1beta::Session>]
1387
1407
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -764,39 +764,39 @@ module Google
764
764
  # @param inline_source [::Google::Cloud::DiscoveryEngine::V1beta::ImportDocumentsRequest::InlineSource, ::Hash]
765
765
  # The Inline source for the input content for documents.
766
766
  #
767
- # Note: The following fields are mutually exclusive: `inline_source`, `gcs_source`, `bigquery_source`, `fhir_store_source`, `spanner_source`, `cloud_sql_source`, `firestore_source`, `alloy_db_source`, `bigtable_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
767
+ # Note: The following parameters are mutually exclusive: `inline_source`, `gcs_source`, `bigquery_source`, `fhir_store_source`, `spanner_source`, `cloud_sql_source`, `firestore_source`, `alloy_db_source`, `bigtable_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
768
768
  # @param gcs_source [::Google::Cloud::DiscoveryEngine::V1beta::GcsSource, ::Hash]
769
769
  # Cloud Storage location for the input content.
770
770
  #
771
- # Note: The following fields are mutually exclusive: `gcs_source`, `inline_source`, `bigquery_source`, `fhir_store_source`, `spanner_source`, `cloud_sql_source`, `firestore_source`, `alloy_db_source`, `bigtable_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
771
+ # Note: The following parameters are mutually exclusive: `gcs_source`, `inline_source`, `bigquery_source`, `fhir_store_source`, `spanner_source`, `cloud_sql_source`, `firestore_source`, `alloy_db_source`, `bigtable_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
772
772
  # @param bigquery_source [::Google::Cloud::DiscoveryEngine::V1beta::BigQuerySource, ::Hash]
773
773
  # BigQuery input source.
774
774
  #
775
- # Note: The following fields are mutually exclusive: `bigquery_source`, `inline_source`, `gcs_source`, `fhir_store_source`, `spanner_source`, `cloud_sql_source`, `firestore_source`, `alloy_db_source`, `bigtable_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
775
+ # Note: The following parameters are mutually exclusive: `bigquery_source`, `inline_source`, `gcs_source`, `fhir_store_source`, `spanner_source`, `cloud_sql_source`, `firestore_source`, `alloy_db_source`, `bigtable_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
776
776
  # @param fhir_store_source [::Google::Cloud::DiscoveryEngine::V1beta::FhirStoreSource, ::Hash]
777
777
  # FhirStore input source.
778
778
  #
779
- # Note: The following fields are mutually exclusive: `fhir_store_source`, `inline_source`, `gcs_source`, `bigquery_source`, `spanner_source`, `cloud_sql_source`, `firestore_source`, `alloy_db_source`, `bigtable_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
779
+ # Note: The following parameters are mutually exclusive: `fhir_store_source`, `inline_source`, `gcs_source`, `bigquery_source`, `spanner_source`, `cloud_sql_source`, `firestore_source`, `alloy_db_source`, `bigtable_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
780
780
  # @param spanner_source [::Google::Cloud::DiscoveryEngine::V1beta::SpannerSource, ::Hash]
781
781
  # Spanner input source.
782
782
  #
783
- # Note: The following fields are mutually exclusive: `spanner_source`, `inline_source`, `gcs_source`, `bigquery_source`, `fhir_store_source`, `cloud_sql_source`, `firestore_source`, `alloy_db_source`, `bigtable_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
783
+ # Note: The following parameters are mutually exclusive: `spanner_source`, `inline_source`, `gcs_source`, `bigquery_source`, `fhir_store_source`, `cloud_sql_source`, `firestore_source`, `alloy_db_source`, `bigtable_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
784
784
  # @param cloud_sql_source [::Google::Cloud::DiscoveryEngine::V1beta::CloudSqlSource, ::Hash]
785
785
  # Cloud SQL input source.
786
786
  #
787
- # Note: The following fields are mutually exclusive: `cloud_sql_source`, `inline_source`, `gcs_source`, `bigquery_source`, `fhir_store_source`, `spanner_source`, `firestore_source`, `alloy_db_source`, `bigtable_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
787
+ # Note: The following parameters are mutually exclusive: `cloud_sql_source`, `inline_source`, `gcs_source`, `bigquery_source`, `fhir_store_source`, `spanner_source`, `firestore_source`, `alloy_db_source`, `bigtable_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
788
788
  # @param firestore_source [::Google::Cloud::DiscoveryEngine::V1beta::FirestoreSource, ::Hash]
789
789
  # Firestore input source.
790
790
  #
791
- # Note: The following fields are mutually exclusive: `firestore_source`, `inline_source`, `gcs_source`, `bigquery_source`, `fhir_store_source`, `spanner_source`, `cloud_sql_source`, `alloy_db_source`, `bigtable_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
791
+ # Note: The following parameters are mutually exclusive: `firestore_source`, `inline_source`, `gcs_source`, `bigquery_source`, `fhir_store_source`, `spanner_source`, `cloud_sql_source`, `alloy_db_source`, `bigtable_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
792
792
  # @param alloy_db_source [::Google::Cloud::DiscoveryEngine::V1beta::AlloyDbSource, ::Hash]
793
793
  # AlloyDB input source.
794
794
  #
795
- # Note: The following fields are mutually exclusive: `alloy_db_source`, `inline_source`, `gcs_source`, `bigquery_source`, `fhir_store_source`, `spanner_source`, `cloud_sql_source`, `firestore_source`, `bigtable_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
795
+ # Note: The following parameters are mutually exclusive: `alloy_db_source`, `inline_source`, `gcs_source`, `bigquery_source`, `fhir_store_source`, `spanner_source`, `cloud_sql_source`, `firestore_source`, `bigtable_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
796
796
  # @param bigtable_source [::Google::Cloud::DiscoveryEngine::V1beta::BigtableSource, ::Hash]
797
797
  # Cloud Bigtable input source.
798
798
  #
799
- # Note: The following fields are mutually exclusive: `bigtable_source`, `inline_source`, `gcs_source`, `bigquery_source`, `fhir_store_source`, `spanner_source`, `cloud_sql_source`, `firestore_source`, `alloy_db_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
799
+ # Note: The following parameters are mutually exclusive: `bigtable_source`, `inline_source`, `gcs_source`, `bigquery_source`, `fhir_store_source`, `spanner_source`, `cloud_sql_source`, `firestore_source`, `alloy_db_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
800
800
  # @param parent [::String]
801
801
  # Required. The parent branch resource name, such as
802
802
  # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
@@ -985,11 +985,11 @@ module Google
985
985
  # * `document_id`: One valid
986
986
  # {::Google::Cloud::DiscoveryEngine::V1beta::Document#id Document.id} per line.
987
987
  #
988
- # Note: The following fields are mutually exclusive: `gcs_source`, `inline_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
988
+ # Note: The following parameters are mutually exclusive: `gcs_source`, `inline_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
989
989
  # @param inline_source [::Google::Cloud::DiscoveryEngine::V1beta::PurgeDocumentsRequest::InlineSource, ::Hash]
990
990
  # Inline source for the input content for purge.
991
991
  #
992
- # Note: The following fields are mutually exclusive: `inline_source`, `gcs_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
992
+ # Note: The following parameters are mutually exclusive: `inline_source`, `gcs_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
993
993
  # @param parent [::String]
994
994
  # Required. The parent resource name, such as
995
995
  # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
@@ -722,39 +722,39 @@ module Google
722
722
  # @param inline_source [::Google::Cloud::DiscoveryEngine::V1beta::ImportDocumentsRequest::InlineSource, ::Hash]
723
723
  # The Inline source for the input content for documents.
724
724
  #
725
- # Note: The following fields are mutually exclusive: `inline_source`, `gcs_source`, `bigquery_source`, `fhir_store_source`, `spanner_source`, `cloud_sql_source`, `firestore_source`, `alloy_db_source`, `bigtable_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
725
+ # Note: The following parameters are mutually exclusive: `inline_source`, `gcs_source`, `bigquery_source`, `fhir_store_source`, `spanner_source`, `cloud_sql_source`, `firestore_source`, `alloy_db_source`, `bigtable_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
726
726
  # @param gcs_source [::Google::Cloud::DiscoveryEngine::V1beta::GcsSource, ::Hash]
727
727
  # Cloud Storage location for the input content.
728
728
  #
729
- # Note: The following fields are mutually exclusive: `gcs_source`, `inline_source`, `bigquery_source`, `fhir_store_source`, `spanner_source`, `cloud_sql_source`, `firestore_source`, `alloy_db_source`, `bigtable_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
729
+ # Note: The following parameters are mutually exclusive: `gcs_source`, `inline_source`, `bigquery_source`, `fhir_store_source`, `spanner_source`, `cloud_sql_source`, `firestore_source`, `alloy_db_source`, `bigtable_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
730
730
  # @param bigquery_source [::Google::Cloud::DiscoveryEngine::V1beta::BigQuerySource, ::Hash]
731
731
  # BigQuery input source.
732
732
  #
733
- # Note: The following fields are mutually exclusive: `bigquery_source`, `inline_source`, `gcs_source`, `fhir_store_source`, `spanner_source`, `cloud_sql_source`, `firestore_source`, `alloy_db_source`, `bigtable_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
733
+ # Note: The following parameters are mutually exclusive: `bigquery_source`, `inline_source`, `gcs_source`, `fhir_store_source`, `spanner_source`, `cloud_sql_source`, `firestore_source`, `alloy_db_source`, `bigtable_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
734
734
  # @param fhir_store_source [::Google::Cloud::DiscoveryEngine::V1beta::FhirStoreSource, ::Hash]
735
735
  # FhirStore input source.
736
736
  #
737
- # Note: The following fields are mutually exclusive: `fhir_store_source`, `inline_source`, `gcs_source`, `bigquery_source`, `spanner_source`, `cloud_sql_source`, `firestore_source`, `alloy_db_source`, `bigtable_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
737
+ # Note: The following parameters are mutually exclusive: `fhir_store_source`, `inline_source`, `gcs_source`, `bigquery_source`, `spanner_source`, `cloud_sql_source`, `firestore_source`, `alloy_db_source`, `bigtable_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
738
738
  # @param spanner_source [::Google::Cloud::DiscoveryEngine::V1beta::SpannerSource, ::Hash]
739
739
  # Spanner input source.
740
740
  #
741
- # Note: The following fields are mutually exclusive: `spanner_source`, `inline_source`, `gcs_source`, `bigquery_source`, `fhir_store_source`, `cloud_sql_source`, `firestore_source`, `alloy_db_source`, `bigtable_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
741
+ # Note: The following parameters are mutually exclusive: `spanner_source`, `inline_source`, `gcs_source`, `bigquery_source`, `fhir_store_source`, `cloud_sql_source`, `firestore_source`, `alloy_db_source`, `bigtable_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
742
742
  # @param cloud_sql_source [::Google::Cloud::DiscoveryEngine::V1beta::CloudSqlSource, ::Hash]
743
743
  # Cloud SQL input source.
744
744
  #
745
- # Note: The following fields are mutually exclusive: `cloud_sql_source`, `inline_source`, `gcs_source`, `bigquery_source`, `fhir_store_source`, `spanner_source`, `firestore_source`, `alloy_db_source`, `bigtable_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
745
+ # Note: The following parameters are mutually exclusive: `cloud_sql_source`, `inline_source`, `gcs_source`, `bigquery_source`, `fhir_store_source`, `spanner_source`, `firestore_source`, `alloy_db_source`, `bigtable_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
746
746
  # @param firestore_source [::Google::Cloud::DiscoveryEngine::V1beta::FirestoreSource, ::Hash]
747
747
  # Firestore input source.
748
748
  #
749
- # Note: The following fields are mutually exclusive: `firestore_source`, `inline_source`, `gcs_source`, `bigquery_source`, `fhir_store_source`, `spanner_source`, `cloud_sql_source`, `alloy_db_source`, `bigtable_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
749
+ # Note: The following parameters are mutually exclusive: `firestore_source`, `inline_source`, `gcs_source`, `bigquery_source`, `fhir_store_source`, `spanner_source`, `cloud_sql_source`, `alloy_db_source`, `bigtable_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
750
750
  # @param alloy_db_source [::Google::Cloud::DiscoveryEngine::V1beta::AlloyDbSource, ::Hash]
751
751
  # AlloyDB input source.
752
752
  #
753
- # Note: The following fields are mutually exclusive: `alloy_db_source`, `inline_source`, `gcs_source`, `bigquery_source`, `fhir_store_source`, `spanner_source`, `cloud_sql_source`, `firestore_source`, `bigtable_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
753
+ # Note: The following parameters are mutually exclusive: `alloy_db_source`, `inline_source`, `gcs_source`, `bigquery_source`, `fhir_store_source`, `spanner_source`, `cloud_sql_source`, `firestore_source`, `bigtable_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
754
754
  # @param bigtable_source [::Google::Cloud::DiscoveryEngine::V1beta::BigtableSource, ::Hash]
755
755
  # Cloud Bigtable input source.
756
756
  #
757
- # Note: The following fields are mutually exclusive: `bigtable_source`, `inline_source`, `gcs_source`, `bigquery_source`, `fhir_store_source`, `spanner_source`, `cloud_sql_source`, `firestore_source`, `alloy_db_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
757
+ # Note: The following parameters are mutually exclusive: `bigtable_source`, `inline_source`, `gcs_source`, `bigquery_source`, `fhir_store_source`, `spanner_source`, `cloud_sql_source`, `firestore_source`, `alloy_db_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
758
758
  # @param parent [::String]
759
759
  # Required. The parent branch resource name, such as
760
760
  # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
@@ -936,11 +936,11 @@ module Google
936
936
  # * `document_id`: One valid
937
937
  # {::Google::Cloud::DiscoveryEngine::V1beta::Document#id Document.id} per line.
938
938
  #
939
- # Note: The following fields are mutually exclusive: `gcs_source`, `inline_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
939
+ # Note: The following parameters are mutually exclusive: `gcs_source`, `inline_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
940
940
  # @param inline_source [::Google::Cloud::DiscoveryEngine::V1beta::PurgeDocumentsRequest::InlineSource, ::Hash]
941
941
  # Inline source for the input content for purge.
942
942
  #
943
- # Note: The following fields are mutually exclusive: `inline_source`, `gcs_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
943
+ # Note: The following parameters are mutually exclusive: `inline_source`, `gcs_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
944
944
  # @param parent [::String]
945
945
  # Required. The parent resource name, such as
946
946
  # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
@@ -33,6 +33,7 @@ require "google/cloud/discovery_engine/v1beta/sample_query_set_service/rest"
33
33
  require "google/cloud/discovery_engine/v1beta/schema_service/rest"
34
34
  require "google/cloud/discovery_engine/v1beta/search_tuning_service/rest"
35
35
  require "google/cloud/discovery_engine/v1beta/serving_config_service/rest"
36
+ require "google/cloud/discovery_engine/v1beta/session_service/rest"
36
37
  require "google/cloud/discovery_engine/v1beta/site_search_engine_service/rest"
37
38
  require "google/cloud/discovery_engine/v1beta/user_event_service/rest"
38
39
  require "google/cloud/discovery_engine/v1beta/version"
@@ -754,15 +754,15 @@ module Google
754
754
  # @param inline_source [::Google::Cloud::DiscoveryEngine::V1beta::ImportSampleQueriesRequest::InlineSource, ::Hash]
755
755
  # The Inline source for sample query entries.
756
756
  #
757
- # Note: The following fields are mutually exclusive: `inline_source`, `gcs_source`, `bigquery_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
757
+ # Note: The following parameters are mutually exclusive: `inline_source`, `gcs_source`, `bigquery_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
758
758
  # @param gcs_source [::Google::Cloud::DiscoveryEngine::V1beta::GcsSource, ::Hash]
759
759
  # Cloud Storage location for the input content.
760
760
  #
761
- # Note: The following fields are mutually exclusive: `gcs_source`, `inline_source`, `bigquery_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
761
+ # Note: The following parameters are mutually exclusive: `gcs_source`, `inline_source`, `bigquery_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
762
762
  # @param bigquery_source [::Google::Cloud::DiscoveryEngine::V1beta::BigQuerySource, ::Hash]
763
763
  # BigQuery input source.
764
764
  #
765
- # Note: The following fields are mutually exclusive: `bigquery_source`, `inline_source`, `gcs_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
765
+ # Note: The following parameters are mutually exclusive: `bigquery_source`, `inline_source`, `gcs_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
766
766
  # @param parent [::String]
767
767
  # Required. The parent sample query set resource name, such as
768
768
  # `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
@@ -712,15 +712,15 @@ module Google
712
712
  # @param inline_source [::Google::Cloud::DiscoveryEngine::V1beta::ImportSampleQueriesRequest::InlineSource, ::Hash]
713
713
  # The Inline source for sample query entries.
714
714
  #
715
- # Note: The following fields are mutually exclusive: `inline_source`, `gcs_source`, `bigquery_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
715
+ # Note: The following parameters are mutually exclusive: `inline_source`, `gcs_source`, `bigquery_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
716
716
  # @param gcs_source [::Google::Cloud::DiscoveryEngine::V1beta::GcsSource, ::Hash]
717
717
  # Cloud Storage location for the input content.
718
718
  #
719
- # Note: The following fields are mutually exclusive: `gcs_source`, `inline_source`, `bigquery_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
719
+ # Note: The following parameters are mutually exclusive: `gcs_source`, `inline_source`, `bigquery_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
720
720
  # @param bigquery_source [::Google::Cloud::DiscoveryEngine::V1beta::BigQuerySource, ::Hash]
721
721
  # BigQuery input source.
722
722
  #
723
- # Note: The following fields are mutually exclusive: `bigquery_source`, `inline_source`, `gcs_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
723
+ # Note: The following parameters are mutually exclusive: `bigquery_source`, `inline_source`, `gcs_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
724
724
  # @param parent [::String]
725
725
  # Required. The parent sample query set resource name, such as
726
726
  # `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
@@ -455,22 +455,16 @@ module Google
455
455
  # between /search API calls and /answer API calls.
456
456
  #
457
457
  # Example #1 (multi-turn /search API calls):
458
- # 1. Call /search API with the auto-session mode (see below).
459
- # 2. Call /search API with the session ID generated in the first call.
460
- # Here, the previous search query gets considered in query
461
- # standing. I.e., if the first query is "How did Alphabet do in 2022?"
462
- # and the current query is "How about 2023?", the current query will
463
- # be interpreted as "How did Alphabet do in 2023?".
458
+ # Call /search API with the session ID generated in the first call.
459
+ # Here, the previous search query gets considered in query
460
+ # standing. I.e., if the first query is "How did Alphabet do in 2022?"
461
+ # and the current query is "How about 2023?", the current query will
462
+ # be interpreted as "How did Alphabet do in 2023?".
464
463
  #
465
464
  # Example #2 (coordination between /search API calls and /answer API calls):
466
- # 1. Call /search API with the auto-session mode (see below).
467
- # 2. Call /answer API with the session ID generated in the first call.
468
- # Here, the answer generation happens in the context of the search
469
- # results from the first search call.
470
- #
471
- # Auto-session mode: when `projects/.../sessions/-` is used, a new session
472
- # gets automatically created. Otherwise, users can use the create-session API
473
- # to create a session manually.
465
+ # Call /answer API with the session ID generated in the first call.
466
+ # Here, the answer generation happens in the context of the search
467
+ # results from the first search call.
474
468
  #
475
469
  # Multi-turn Search feature is currently at private GA stage. Please use
476
470
  # v1alpha or v1beta version instead before we launch this feature to public
@@ -830,22 +824,16 @@ module Google
830
824
  # between /search API calls and /answer API calls.
831
825
  #
832
826
  # Example #1 (multi-turn /search API calls):
833
- # 1. Call /search API with the auto-session mode (see below).
834
- # 2. Call /search API with the session ID generated in the first call.
835
- # Here, the previous search query gets considered in query
836
- # standing. I.e., if the first query is "How did Alphabet do in 2022?"
837
- # and the current query is "How about 2023?", the current query will
838
- # be interpreted as "How did Alphabet do in 2023?".
827
+ # Call /search API with the session ID generated in the first call.
828
+ # Here, the previous search query gets considered in query
829
+ # standing. I.e., if the first query is "How did Alphabet do in 2022?"
830
+ # and the current query is "How about 2023?", the current query will
831
+ # be interpreted as "How did Alphabet do in 2023?".
839
832
  #
840
833
  # Example #2 (coordination between /search API calls and /answer API calls):
841
- # 1. Call /search API with the auto-session mode (see below).
842
- # 2. Call /answer API with the session ID generated in the first call.
843
- # Here, the answer generation happens in the context of the search
844
- # results from the first search call.
845
- #
846
- # Auto-session mode: when `projects/.../sessions/-` is used, a new session
847
- # gets automatically created. Otherwise, users can use the create-session API
848
- # to create a session manually.
834
+ # Call /answer API with the session ID generated in the first call.
835
+ # Here, the answer generation happens in the context of the search
836
+ # results from the first search call.
849
837
  #
850
838
  # Multi-turn Search feature is currently at private GA stage. Please use
851
839
  # v1alpha or v1beta version instead before we launch this feature to public
@@ -448,22 +448,16 @@ module Google
448
448
  # between /search API calls and /answer API calls.
449
449
  #
450
450
  # Example #1 (multi-turn /search API calls):
451
- # 1. Call /search API with the auto-session mode (see below).
452
- # 2. Call /search API with the session ID generated in the first call.
453
- # Here, the previous search query gets considered in query
454
- # standing. I.e., if the first query is "How did Alphabet do in 2022?"
455
- # and the current query is "How about 2023?", the current query will
456
- # be interpreted as "How did Alphabet do in 2023?".
451
+ # Call /search API with the session ID generated in the first call.
452
+ # Here, the previous search query gets considered in query
453
+ # standing. I.e., if the first query is "How did Alphabet do in 2022?"
454
+ # and the current query is "How about 2023?", the current query will
455
+ # be interpreted as "How did Alphabet do in 2023?".
457
456
  #
458
457
  # Example #2 (coordination between /search API calls and /answer API calls):
459
- # 1. Call /search API with the auto-session mode (see below).
460
- # 2. Call /answer API with the session ID generated in the first call.
461
- # Here, the answer generation happens in the context of the search
462
- # results from the first search call.
463
- #
464
- # Auto-session mode: when `projects/.../sessions/-` is used, a new session
465
- # gets automatically created. Otherwise, users can use the create-session API
466
- # to create a session manually.
458
+ # Call /answer API with the session ID generated in the first call.
459
+ # Here, the answer generation happens in the context of the search
460
+ # results from the first search call.
467
461
  #
468
462
  # Multi-turn Search feature is currently at private GA stage. Please use
469
463
  # v1alpha or v1beta version instead before we launch this feature to public
@@ -816,22 +810,16 @@ module Google
816
810
  # between /search API calls and /answer API calls.
817
811
  #
818
812
  # Example #1 (multi-turn /search API calls):
819
- # 1. Call /search API with the auto-session mode (see below).
820
- # 2. Call /search API with the session ID generated in the first call.
821
- # Here, the previous search query gets considered in query
822
- # standing. I.e., if the first query is "How did Alphabet do in 2022?"
823
- # and the current query is "How about 2023?", the current query will
824
- # be interpreted as "How did Alphabet do in 2023?".
813
+ # Call /search API with the session ID generated in the first call.
814
+ # Here, the previous search query gets considered in query
815
+ # standing. I.e., if the first query is "How did Alphabet do in 2022?"
816
+ # and the current query is "How about 2023?", the current query will
817
+ # be interpreted as "How did Alphabet do in 2023?".
825
818
  #
826
819
  # Example #2 (coordination between /search API calls and /answer API calls):
827
- # 1. Call /search API with the auto-session mode (see below).
828
- # 2. Call /answer API with the session ID generated in the first call.
829
- # Here, the answer generation happens in the context of the search
830
- # results from the first search call.
831
- #
832
- # Auto-session mode: when `projects/.../sessions/-` is used, a new session
833
- # gets automatically created. Otherwise, users can use the create-session API
834
- # to create a session manually.
820
+ # Call /answer API with the session ID generated in the first call.
821
+ # Here, the answer generation happens in the context of the search
822
+ # results from the first search call.
835
823
  #
836
824
  # Multi-turn Search feature is currently at private GA stage. Please use
837
825
  # v1alpha or v1beta version instead before we launch this feature to public