google-cloud-discovery_engine-v1 1.0.2 → 1.2.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 (89) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/discovery_engine/v1/completion_service/rest/operations.rb +14 -0
  3. data/lib/google/cloud/discovery_engine/v1/control_service/client.rb +6 -6
  4. data/lib/google/cloud/discovery_engine/v1/control_service/rest/client.rb +6 -6
  5. data/lib/google/cloud/discovery_engine/v1/conversational_search_service/client.rb +15 -12
  6. data/lib/google/cloud/discovery_engine/v1/conversational_search_service/rest/client.rb +15 -12
  7. data/lib/google/cloud/discovery_engine/v1/data_store_service/client.rb +10 -1
  8. data/lib/google/cloud/discovery_engine/v1/data_store_service/rest/client.rb +10 -1
  9. data/lib/google/cloud/discovery_engine/v1/data_store_service/rest/operations.rb +14 -0
  10. data/lib/google/cloud/discovery_engine/v1/document_service/client.rb +109 -1
  11. data/lib/google/cloud/discovery_engine/v1/document_service/paths.rb +25 -0
  12. data/lib/google/cloud/discovery_engine/v1/document_service/rest/client.rb +102 -1
  13. data/lib/google/cloud/discovery_engine/v1/document_service/rest/operations.rb +14 -0
  14. data/lib/google/cloud/discovery_engine/v1/document_service/rest/service_stub.rb +66 -0
  15. data/lib/google/cloud/discovery_engine/v1/engine_service/rest/operations.rb +14 -0
  16. data/lib/google/cloud/discovery_engine/v1/grounded_generation_service/client.rb +219 -3
  17. data/lib/google/cloud/discovery_engine/v1/grounded_generation_service/paths.rb +85 -0
  18. data/lib/google/cloud/discovery_engine/v1/grounded_generation_service/rest/client.rb +126 -3
  19. data/lib/google/cloud/discovery_engine/v1/grounded_generation_service/rest/service_stub.rb +60 -0
  20. data/lib/google/cloud/discovery_engine/v1/project_service/rest/operations.rb +14 -0
  21. data/lib/google/cloud/discovery_engine/v1/rank_service/client.rb +1 -1
  22. data/lib/google/cloud/discovery_engine/v1/rank_service/rest/client.rb +1 -1
  23. data/lib/google/cloud/discovery_engine/v1/recommendation_service/client.rb +2 -1
  24. data/lib/google/cloud/discovery_engine/v1/recommendation_service/rest/client.rb +2 -1
  25. data/lib/google/cloud/discovery_engine/v1/rest.rb +1 -0
  26. data/lib/google/cloud/discovery_engine/v1/schema_service/rest/operations.rb +14 -0
  27. data/lib/google/cloud/discovery_engine/v1/search_service/client.rb +11 -4
  28. data/lib/google/cloud/discovery_engine/v1/search_service/rest/client.rb +11 -4
  29. data/lib/google/cloud/discovery_engine/v1/search_tuning_service/client.rb +571 -0
  30. data/lib/google/cloud/discovery_engine/v1/search_tuning_service/credentials.rb +47 -0
  31. data/lib/google/cloud/discovery_engine/v1/search_tuning_service/operations.rb +809 -0
  32. data/lib/google/cloud/discovery_engine/v1/search_tuning_service/paths.rb +78 -0
  33. data/lib/google/cloud/discovery_engine/v1/search_tuning_service/rest/client.rb +531 -0
  34. data/lib/google/cloud/discovery_engine/v1/search_tuning_service/rest/operations.rb +1128 -0
  35. data/lib/google/cloud/discovery_engine/v1/search_tuning_service/rest/service_stub.rb +188 -0
  36. data/lib/google/cloud/discovery_engine/v1/search_tuning_service/rest.rb +53 -0
  37. data/lib/google/cloud/discovery_engine/v1/search_tuning_service.rb +56 -0
  38. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/client.rb +5 -1
  39. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/rest/client.rb +5 -1
  40. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/rest/operations.rb +14 -0
  41. data/lib/google/cloud/discovery_engine/v1/user_event_service/client.rb +139 -0
  42. data/lib/google/cloud/discovery_engine/v1/user_event_service/rest/client.rb +132 -0
  43. data/lib/google/cloud/discovery_engine/v1/user_event_service/rest/operations.rb +14 -0
  44. data/lib/google/cloud/discovery_engine/v1/user_event_service/rest/service_stub.rb +68 -0
  45. data/lib/google/cloud/discovery_engine/v1/version.rb +1 -1
  46. data/lib/google/cloud/discovery_engine/v1.rb +1 -0
  47. data/lib/google/cloud/discoveryengine/v1/answer_pb.rb +2 -1
  48. data/lib/google/cloud/discoveryengine/v1/common_pb.rb +1 -1
  49. data/lib/google/cloud/discoveryengine/v1/conversational_search_service_pb.rb +2 -1
  50. data/lib/google/cloud/discoveryengine/v1/custom_tuning_model_pb.rb +48 -0
  51. data/lib/google/cloud/discoveryengine/v1/data_store_pb.rb +4 -1
  52. data/lib/google/cloud/discoveryengine/v1/data_store_service_pb.rb +1 -1
  53. data/lib/google/cloud/discoveryengine/v1/document_pb.rb +4 -1
  54. data/lib/google/cloud/discoveryengine/v1/document_service_pb.rb +11 -1
  55. data/lib/google/cloud/discoveryengine/v1/document_service_services_pb.rb +4 -0
  56. data/lib/google/cloud/discoveryengine/v1/engine_pb.rb +1 -1
  57. data/lib/google/cloud/discoveryengine/v1/grounded_generation_service_pb.rb +23 -1
  58. data/lib/google/cloud/discoveryengine/v1/grounded_generation_service_services_pb.rb +4 -0
  59. data/lib/google/cloud/discoveryengine/v1/import_config_pb.rb +1 -1
  60. data/lib/google/cloud/discoveryengine/v1/purge_config_pb.rb +8 -1
  61. data/lib/google/cloud/discoveryengine/v1/search_service_pb.rb +5 -1
  62. data/lib/google/cloud/discoveryengine/v1/search_tuning_service_pb.rb +61 -0
  63. data/lib/google/cloud/discoveryengine/v1/search_tuning_service_services_pb.rb +47 -0
  64. data/lib/google/cloud/discoveryengine/v1/site_search_engine_service_pb.rb +1 -1
  65. data/lib/google/cloud/discoveryengine/v1/user_event_pb.rb +1 -1
  66. data/lib/google/cloud/discoveryengine/v1/user_event_service_pb.rb +2 -1
  67. data/lib/google/cloud/discoveryengine/v1/user_event_service_services_pb.rb +5 -0
  68. data/proto_docs/google/cloud/discoveryengine/v1/answer.rb +62 -7
  69. data/proto_docs/google/cloud/discoveryengine/v1/control.rb +6 -4
  70. data/proto_docs/google/cloud/discoveryengine/v1/control_service.rb +6 -6
  71. data/proto_docs/google/cloud/discoveryengine/v1/conversational_search_service.rb +68 -24
  72. data/proto_docs/google/cloud/discoveryengine/v1/custom_tuning_model.rb +99 -0
  73. data/proto_docs/google/cloud/discoveryengine/v1/data_store.rb +88 -0
  74. data/proto_docs/google/cloud/discoveryengine/v1/data_store_service.rb +10 -0
  75. data/proto_docs/google/cloud/discoveryengine/v1/document.rb +22 -0
  76. data/proto_docs/google/cloud/discoveryengine/v1/document_processing_config.rb +9 -5
  77. data/proto_docs/google/cloud/discoveryengine/v1/document_service.rb +120 -0
  78. data/proto_docs/google/cloud/discoveryengine/v1/engine.rb +5 -1
  79. data/proto_docs/google/cloud/discoveryengine/v1/grounded_generation_service.rb +385 -1
  80. data/proto_docs/google/cloud/discoveryengine/v1/import_config.rb +13 -7
  81. data/proto_docs/google/cloud/discoveryengine/v1/project.rb +1 -1
  82. data/proto_docs/google/cloud/discoveryengine/v1/purge_config.rb +115 -0
  83. data/proto_docs/google/cloud/discoveryengine/v1/rank_service.rb +1 -1
  84. data/proto_docs/google/cloud/discoveryengine/v1/recommendation_service.rb +2 -1
  85. data/proto_docs/google/cloud/discoveryengine/v1/search_service.rb +156 -16
  86. data/proto_docs/google/cloud/discoveryengine/v1/search_tuning_service.rb +172 -0
  87. data/proto_docs/google/cloud/discoveryengine/v1/site_search_engine_service.rb +5 -0
  88. data/proto_docs/google/cloud/discoveryengine/v1/user_event.rb +5 -1
  89. metadata +17 -3
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e2aaaa9034d9cfb9b02b0176e4d01a23240f53f1eaa447e949474b25ca91d868
4
- data.tar.gz: cc0a1d4705dd11d556c764d63f4753d0a7e03dd4c6142db2c90650982d978df5
3
+ metadata.gz: ee9651b0bccb269cc71b7ffbe3eb9fe3b7387001a04c24f295ad5746e38a3435
4
+ data.tar.gz: a52cfe415c14bfb5046b20d211d328defcacadd1ec51b8c8631b23f4c8cb9ce2
5
5
  SHA512:
6
- metadata.gz: 2390029b416984cbbb947c917f3dcc8e618a1b536310acb8ab743b0dfbfa4ad9d0dee4e0b431be56d8a0f1327cd59d5bd8ba2a6ce28f8f7ddb3476f1937d492c
7
- data.tar.gz: f2ccde8c6f36205d2678309ea77d156b39761c9243694361d69d479b6666cfdee6255b23520ecb61c6a8e2c8848103d68e01280172b504ceca11269545e88478
6
+ metadata.gz: 592eacda5b2029f59b7e128c81ed2e8ddde6cf46531956d802a1203fa6d4ccd5f67351b866e3b34c8d476b087d895cd9b18d346918ab587ba6784572934ce6db
7
+ data.tar.gz: ec0a35b20d61d0ef7c6997916877e11e94e1c69fe379ce52163ff4c01d26274526485a720354a5f5229069970a1b04e1924e7fd0f65a45bffa28ba7be2a9ee6b
@@ -911,6 +911,13 @@ module Google
911
911
  ["name", %r{^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/?$}, false]
912
912
  ]
913
913
  )
914
+ .with_bindings(
915
+ uri_method: :get,
916
+ uri_template: "/v1/{name}/operations",
917
+ matches: [
918
+ ["name", %r{^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+/?$}, false]
919
+ ]
920
+ )
914
921
  .with_bindings(
915
922
  uri_method: :get,
916
923
  uri_template: "/v1/{name}/operations",
@@ -1030,6 +1037,13 @@ module Google
1030
1037
  ["name", %r{^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/operations/[^/]+/?$}, false]
1031
1038
  ]
1032
1039
  )
1040
+ .with_bindings(
1041
+ uri_method: :get,
1042
+ uri_template: "/v1/{name}",
1043
+ matches: [
1044
+ ["name", %r{^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+/operations/[^/]+/?$}, false]
1045
+ ]
1046
+ )
1033
1047
  .with_bindings(
1034
1048
  uri_method: :get,
1035
1049
  uri_template: "/v1/{name}",
@@ -211,9 +211,9 @@ module Google
211
211
  #
212
212
  # @param parent [::String]
213
213
  # Required. Full resource name of parent data store. Format:
214
- # `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`
214
+ # `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`
215
215
  # or
216
- # `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.
216
+ # `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
217
217
  # @param control [::Google::Cloud::DiscoveryEngine::V1::Control, ::Hash]
218
218
  # Required. The Control to create.
219
219
  # @param control_id [::String]
@@ -311,7 +311,7 @@ module Google
311
311
  #
312
312
  # @param name [::String]
313
313
  # Required. The resource name of the Control to delete. Format:
314
- # `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
314
+ # `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
315
315
  #
316
316
  # @yield [response, operation] Access the result along with the RPC operation
317
317
  # @yieldparam response [::Google::Protobuf::Empty]
@@ -497,7 +497,7 @@ module Google
497
497
  #
498
498
  # @param name [::String]
499
499
  # Required. The resource name of the Control to get. Format:
500
- # `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
500
+ # `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
501
501
  #
502
502
  # @yield [response, operation] Access the result along with the RPC operation
503
503
  # @yieldparam response [::Google::Cloud::DiscoveryEngine::V1::Control]
@@ -585,9 +585,9 @@ module Google
585
585
  #
586
586
  # @param parent [::String]
587
587
  # Required. The data store resource name. Format:
588
- # `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`
588
+ # `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`
589
589
  # or
590
- # `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.
590
+ # `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
591
591
  # @param page_size [::Integer]
592
592
  # Optional. Maximum number of results to return. If unspecified, defaults
593
593
  # to 50. Max allowed value is 1000.
@@ -204,9 +204,9 @@ module Google
204
204
  #
205
205
  # @param parent [::String]
206
206
  # Required. Full resource name of parent data store. Format:
207
- # `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`
207
+ # `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`
208
208
  # or
209
- # `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.
209
+ # `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
210
210
  # @param control [::Google::Cloud::DiscoveryEngine::V1::Control, ::Hash]
211
211
  # Required. The Control to create.
212
212
  # @param control_id [::String]
@@ -297,7 +297,7 @@ module Google
297
297
  #
298
298
  # @param name [::String]
299
299
  # Required. The resource name of the Control to delete. Format:
300
- # `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
300
+ # `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
301
301
  # @yield [result, operation] Access the result along with the TransportOperation object
302
302
  # @yieldparam result [::Google::Protobuf::Empty]
303
303
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -469,7 +469,7 @@ module Google
469
469
  #
470
470
  # @param name [::String]
471
471
  # Required. The resource name of the Control to get. Format:
472
- # `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
472
+ # `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
473
473
  # @yield [result, operation] Access the result along with the TransportOperation object
474
474
  # @yieldparam result [::Google::Cloud::DiscoveryEngine::V1::Control]
475
475
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -550,9 +550,9 @@ module Google
550
550
  #
551
551
  # @param parent [::String]
552
552
  # Required. The data store resource name. Format:
553
- # `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`
553
+ # `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`
554
554
  # or
555
- # `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.
555
+ # `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
556
556
  # @param page_size [::Integer]
557
557
  # Optional. Maximum number of results to return. If unspecified, defaults
558
558
  # to 50. Max allowed value is 1000.
@@ -203,16 +203,16 @@ module Google
203
203
  #
204
204
  # @param name [::String]
205
205
  # Required. The resource name of the Conversation to get. Format:
206
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`.
206
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`.
207
207
  # Use
208
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-`
208
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-`
209
209
  # to activate auto session mode, which automatically creates a new
210
210
  # conversation inside a ConverseConversation session.
211
211
  # @param query [::Google::Cloud::DiscoveryEngine::V1::TextInput, ::Hash]
212
212
  # Required. Current user input.
213
213
  # @param serving_config [::String]
214
214
  # The resource name of the Serving Config to use. Format:
215
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`
215
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`
216
216
  # If this is not set, the default serving config will be used.
217
217
  # @param conversation [::Google::Cloud::DiscoveryEngine::V1::Conversation, ::Hash]
218
218
  # The conversation to be used by auto session only. The name field will be
@@ -350,7 +350,7 @@ module Google
350
350
  #
351
351
  # @param parent [::String]
352
352
  # Required. Full resource name of parent data store. Format:
353
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
353
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
354
354
  # @param conversation [::Google::Cloud::DiscoveryEngine::V1::Conversation, ::Hash]
355
355
  # Required. The conversation to create.
356
356
  #
@@ -442,7 +442,7 @@ module Google
442
442
  #
443
443
  # @param name [::String]
444
444
  # Required. The resource name of the Conversation to delete. Format:
445
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
445
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
446
446
  #
447
447
  # @yield [response, operation] Access the result along with the RPC operation
448
448
  # @yieldparam response [::Google::Protobuf::Empty]
@@ -628,7 +628,7 @@ module Google
628
628
  #
629
629
  # @param name [::String]
630
630
  # Required. The resource name of the Conversation to get. Format:
631
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
631
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
632
632
  #
633
633
  # @yield [response, operation] Access the result along with the RPC operation
634
634
  # @yieldparam response [::Google::Cloud::DiscoveryEngine::V1::Conversation]
@@ -716,7 +716,7 @@ module Google
716
716
  #
717
717
  # @param parent [::String]
718
718
  # Required. The data store resource name. Format:
719
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
719
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
720
720
  # @param page_size [::Integer]
721
721
  # Maximum number of results to return. If unspecified, defaults
722
722
  # to 50. Max allowed value is 1000.
@@ -856,6 +856,9 @@ module Google
856
856
  # @param query_understanding_spec [::Google::Cloud::DiscoveryEngine::V1::AnswerQueryRequest::QueryUnderstandingSpec, ::Hash]
857
857
  # Query understanding specification.
858
858
  # @param asynchronous_mode [::Boolean]
859
+ # Deprecated: This field is deprecated. Streaming Answer API will be
860
+ # supported.
861
+ #
859
862
  # Asynchronous mode control.
860
863
  #
861
864
  # If enabled, the response will be returned with answer/session resource
@@ -979,7 +982,7 @@ module Google
979
982
  #
980
983
  # @param name [::String]
981
984
  # Required. The resource name of the Answer to get. Format:
982
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`
985
+ # `projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`
983
986
  #
984
987
  # @yield [response, operation] Access the result along with the RPC operation
985
988
  # @yieldparam response [::Google::Cloud::DiscoveryEngine::V1::Answer]
@@ -1069,7 +1072,7 @@ module Google
1069
1072
  #
1070
1073
  # @param parent [::String]
1071
1074
  # Required. Full resource name of parent data store. Format:
1072
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
1075
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
1073
1076
  # @param session [::Google::Cloud::DiscoveryEngine::V1::Session, ::Hash]
1074
1077
  # Required. The session to create.
1075
1078
  #
@@ -1161,7 +1164,7 @@ module Google
1161
1164
  #
1162
1165
  # @param name [::String]
1163
1166
  # Required. The resource name of the Session to delete. Format:
1164
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
1167
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
1165
1168
  #
1166
1169
  # @yield [response, operation] Access the result along with the RPC operation
1167
1170
  # @yieldparam response [::Google::Protobuf::Empty]
@@ -1346,7 +1349,7 @@ module Google
1346
1349
  #
1347
1350
  # @param name [::String]
1348
1351
  # Required. The resource name of the Session to get. Format:
1349
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
1352
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
1350
1353
  #
1351
1354
  # @yield [response, operation] Access the result along with the RPC operation
1352
1355
  # @yieldparam response [::Google::Cloud::DiscoveryEngine::V1::Session]
@@ -1434,7 +1437,7 @@ module Google
1434
1437
  #
1435
1438
  # @param parent [::String]
1436
1439
  # Required. The data store resource name. Format:
1437
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
1440
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
1438
1441
  # @param page_size [::Integer]
1439
1442
  # Maximum number of results to return. If unspecified, defaults
1440
1443
  # to 50. Max allowed value is 1000.
@@ -196,16 +196,16 @@ module Google
196
196
  #
197
197
  # @param name [::String]
198
198
  # Required. The resource name of the Conversation to get. Format:
199
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`.
199
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`.
200
200
  # Use
201
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-`
201
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-`
202
202
  # to activate auto session mode, which automatically creates a new
203
203
  # conversation inside a ConverseConversation session.
204
204
  # @param query [::Google::Cloud::DiscoveryEngine::V1::TextInput, ::Hash]
205
205
  # Required. Current user input.
206
206
  # @param serving_config [::String]
207
207
  # The resource name of the Serving Config to use. Format:
208
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`
208
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`
209
209
  # If this is not set, the default serving config will be used.
210
210
  # @param conversation [::Google::Cloud::DiscoveryEngine::V1::Conversation, ::Hash]
211
211
  # The conversation to be used by auto session only. The name field will be
@@ -336,7 +336,7 @@ module Google
336
336
  #
337
337
  # @param parent [::String]
338
338
  # Required. Full resource name of parent data store. Format:
339
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
339
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
340
340
  # @param conversation [::Google::Cloud::DiscoveryEngine::V1::Conversation, ::Hash]
341
341
  # Required. The conversation to create.
342
342
  # @yield [result, operation] Access the result along with the TransportOperation object
@@ -421,7 +421,7 @@ module Google
421
421
  #
422
422
  # @param name [::String]
423
423
  # Required. The resource name of the Conversation to delete. Format:
424
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
424
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
425
425
  # @yield [result, operation] Access the result along with the TransportOperation object
426
426
  # @yieldparam result [::Google::Protobuf::Empty]
427
427
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -593,7 +593,7 @@ module Google
593
593
  #
594
594
  # @param name [::String]
595
595
  # Required. The resource name of the Conversation to get. Format:
596
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
596
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
597
597
  # @yield [result, operation] Access the result along with the TransportOperation object
598
598
  # @yieldparam result [::Google::Cloud::DiscoveryEngine::V1::Conversation]
599
599
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -674,7 +674,7 @@ module Google
674
674
  #
675
675
  # @param parent [::String]
676
676
  # Required. The data store resource name. Format:
677
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
677
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
678
678
  # @param page_size [::Integer]
679
679
  # Maximum number of results to return. If unspecified, defaults
680
680
  # to 50. Max allowed value is 1000.
@@ -807,6 +807,9 @@ module Google
807
807
  # @param query_understanding_spec [::Google::Cloud::DiscoveryEngine::V1::AnswerQueryRequest::QueryUnderstandingSpec, ::Hash]
808
808
  # Query understanding specification.
809
809
  # @param asynchronous_mode [::Boolean]
810
+ # Deprecated: This field is deprecated. Streaming Answer API will be
811
+ # supported.
812
+ #
810
813
  # Asynchronous mode control.
811
814
  #
812
815
  # If enabled, the response will be returned with answer/session resource
@@ -923,7 +926,7 @@ module Google
923
926
  #
924
927
  # @param name [::String]
925
928
  # Required. The resource name of the Answer to get. Format:
926
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`
929
+ # `projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`
927
930
  # @yield [result, operation] Access the result along with the TransportOperation object
928
931
  # @yieldparam result [::Google::Cloud::DiscoveryEngine::V1::Answer]
929
932
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -1006,7 +1009,7 @@ module Google
1006
1009
  #
1007
1010
  # @param parent [::String]
1008
1011
  # Required. Full resource name of parent data store. Format:
1009
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
1012
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
1010
1013
  # @param session [::Google::Cloud::DiscoveryEngine::V1::Session, ::Hash]
1011
1014
  # Required. The session to create.
1012
1015
  # @yield [result, operation] Access the result along with the TransportOperation object
@@ -1091,7 +1094,7 @@ module Google
1091
1094
  #
1092
1095
  # @param name [::String]
1093
1096
  # Required. The resource name of the Session to delete. Format:
1094
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
1097
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
1095
1098
  # @yield [result, operation] Access the result along with the TransportOperation object
1096
1099
  # @yieldparam result [::Google::Protobuf::Empty]
1097
1100
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -1262,7 +1265,7 @@ module Google
1262
1265
  #
1263
1266
  # @param name [::String]
1264
1267
  # Required. The resource name of the Session to get. Format:
1265
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
1268
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
1266
1269
  # @yield [result, operation] Access the result along with the TransportOperation object
1267
1270
  # @yieldparam result [::Google::Cloud::DiscoveryEngine::V1::Session]
1268
1271
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -1343,7 +1346,7 @@ module Google
1343
1346
  #
1344
1347
  # @param parent [::String]
1345
1348
  # Required. The data store resource name. Format:
1346
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
1349
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
1347
1350
  # @param page_size [::Integer]
1348
1351
  # Maximum number of results to return. If unspecified, defaults
1349
1352
  # to 50. Max allowed value is 1000.
@@ -212,7 +212,7 @@ module Google
212
212
  # @param options [::Gapic::CallOptions, ::Hash]
213
213
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
214
214
  #
215
- # @overload create_data_store(parent: nil, data_store: nil, data_store_id: nil, create_advanced_site_search: nil)
215
+ # @overload create_data_store(parent: nil, data_store: nil, data_store_id: nil, create_advanced_site_search: nil, skip_default_schema_creation: nil)
216
216
  # Pass arguments to `create_data_store` via keyword arguments. Note that at
217
217
  # least one keyword argument is required. To specify no parameters, or to keep all
218
218
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -238,6 +238,15 @@ module Google
238
238
  # If the data store is not configured as site
239
239
  # search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will
240
240
  # be ignored.
241
+ # @param skip_default_schema_creation [::Boolean]
242
+ # A boolean flag indicating whether to skip the default schema creation for
243
+ # the data store. Only enable this flag if you are certain that the default
244
+ # schema is incompatible with your use case.
245
+ #
246
+ # If set to true, you must manually create a schema for the data store before
247
+ # any documents can be ingested.
248
+ #
249
+ # This flag cannot be specified if `data_store.starting_schema` is specified.
241
250
  #
242
251
  # @yield [response, operation] Access the result along with the RPC operation
243
252
  # @yieldparam response [::Gapic::Operation]
@@ -205,7 +205,7 @@ module Google
205
205
  # @param options [::Gapic::CallOptions, ::Hash]
206
206
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
207
207
  #
208
- # @overload create_data_store(parent: nil, data_store: nil, data_store_id: nil, create_advanced_site_search: nil)
208
+ # @overload create_data_store(parent: nil, data_store: nil, data_store_id: nil, create_advanced_site_search: nil, skip_default_schema_creation: nil)
209
209
  # Pass arguments to `create_data_store` via keyword arguments. Note that at
210
210
  # least one keyword argument is required. To specify no parameters, or to keep all
211
211
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -231,6 +231,15 @@ module Google
231
231
  # If the data store is not configured as site
232
232
  # search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will
233
233
  # be ignored.
234
+ # @param skip_default_schema_creation [::Boolean]
235
+ # A boolean flag indicating whether to skip the default schema creation for
236
+ # the data store. Only enable this flag if you are certain that the default
237
+ # schema is incompatible with your use case.
238
+ #
239
+ # If set to true, you must manually create a schema for the data store before
240
+ # any documents can be ingested.
241
+ #
242
+ # This flag cannot be specified if `data_store.starting_schema` is specified.
234
243
  # @yield [result, operation] Access the result along with the TransportOperation object
235
244
  # @yieldparam result [::Gapic::Operation]
236
245
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -911,6 +911,13 @@ module Google
911
911
  ["name", %r{^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/?$}, false]
912
912
  ]
913
913
  )
914
+ .with_bindings(
915
+ uri_method: :get,
916
+ uri_template: "/v1/{name}/operations",
917
+ matches: [
918
+ ["name", %r{^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+/?$}, false]
919
+ ]
920
+ )
914
921
  .with_bindings(
915
922
  uri_method: :get,
916
923
  uri_template: "/v1/{name}/operations",
@@ -1030,6 +1037,13 @@ module Google
1030
1037
  ["name", %r{^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/operations/[^/]+/?$}, false]
1031
1038
  ]
1032
1039
  )
1040
+ .with_bindings(
1041
+ uri_method: :get,
1042
+ uri_template: "/v1/{name}",
1043
+ matches: [
1044
+ ["name", %r{^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+/operations/[^/]+/?$}, false]
1045
+ ]
1046
+ )
1033
1047
  .with_bindings(
1034
1048
  uri_method: :get,
1035
1049
  uri_template: "/v1/{name}",
@@ -937,11 +937,18 @@ module Google
937
937
  # @param options [::Gapic::CallOptions, ::Hash]
938
938
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
939
939
  #
940
- # @overload purge_documents(parent: nil, filter: nil, force: nil)
940
+ # @overload purge_documents(gcs_source: nil, inline_source: nil, parent: nil, filter: nil, error_config: nil, force: nil)
941
941
  # Pass arguments to `purge_documents` via keyword arguments. Note that at
942
942
  # least one keyword argument is required. To specify no parameters, or to keep all
943
943
  # the default parameter values, pass an empty Hash as a request object (see above).
944
944
  #
945
+ # @param gcs_source [::Google::Cloud::DiscoveryEngine::V1::GcsSource, ::Hash]
946
+ # Cloud Storage location for the input content.
947
+ # Supported `data_schema`:
948
+ # * `document_id`: One valid
949
+ # {::Google::Cloud::DiscoveryEngine::V1::Document#id Document.id} per line.
950
+ # @param inline_source [::Google::Cloud::DiscoveryEngine::V1::PurgeDocumentsRequest::InlineSource, ::Hash]
951
+ # Inline source for the input content for purge.
945
952
  # @param parent [::String]
946
953
  # Required. The parent resource name, such as
947
954
  # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
@@ -949,6 +956,8 @@ module Google
949
956
  # Required. Filter matching documents to purge. Only currently supported
950
957
  # value is
951
958
  # `*` (all items).
959
+ # @param error_config [::Google::Cloud::DiscoveryEngine::V1::PurgeErrorConfig, ::Hash]
960
+ # The desired location of errors incurred during the purge.
952
961
  # @param force [::Boolean]
953
962
  # Actually performs the purge. If `force` is set to false, return the
954
963
  # expected purge count without deleting any documents.
@@ -1026,6 +1035,98 @@ module Google
1026
1035
  raise ::Google::Cloud::Error.from_error(e)
1027
1036
  end
1028
1037
 
1038
+ ##
1039
+ # Gets index freshness metadata for
1040
+ # {::Google::Cloud::DiscoveryEngine::V1::Document Document}s. Supported for
1041
+ # website search only.
1042
+ #
1043
+ # @overload batch_get_documents_metadata(request, options = nil)
1044
+ # Pass arguments to `batch_get_documents_metadata` via a request object, either of type
1045
+ # {::Google::Cloud::DiscoveryEngine::V1::BatchGetDocumentsMetadataRequest} or an equivalent Hash.
1046
+ #
1047
+ # @param request [::Google::Cloud::DiscoveryEngine::V1::BatchGetDocumentsMetadataRequest, ::Hash]
1048
+ # A request object representing the call parameters. Required. To specify no
1049
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1050
+ # @param options [::Gapic::CallOptions, ::Hash]
1051
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1052
+ #
1053
+ # @overload batch_get_documents_metadata(parent: nil, matcher: nil)
1054
+ # Pass arguments to `batch_get_documents_metadata` via keyword arguments. Note that at
1055
+ # least one keyword argument is required. To specify no parameters, or to keep all
1056
+ # the default parameter values, pass an empty Hash as a request object (see above).
1057
+ #
1058
+ # @param parent [::String]
1059
+ # Required. The parent branch resource name, such as
1060
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
1061
+ # @param matcher [::Google::Cloud::DiscoveryEngine::V1::BatchGetDocumentsMetadataRequest::Matcher, ::Hash]
1062
+ # Required. Matcher for the
1063
+ # {::Google::Cloud::DiscoveryEngine::V1::Document Document}s.
1064
+ #
1065
+ # @yield [response, operation] Access the result along with the RPC operation
1066
+ # @yieldparam response [::Google::Cloud::DiscoveryEngine::V1::BatchGetDocumentsMetadataResponse]
1067
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
1068
+ #
1069
+ # @return [::Google::Cloud::DiscoveryEngine::V1::BatchGetDocumentsMetadataResponse]
1070
+ #
1071
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
1072
+ #
1073
+ # @example Basic example
1074
+ # require "google/cloud/discovery_engine/v1"
1075
+ #
1076
+ # # Create a client object. The client can be reused for multiple calls.
1077
+ # client = Google::Cloud::DiscoveryEngine::V1::DocumentService::Client.new
1078
+ #
1079
+ # # Create a request. To set request fields, pass in keyword arguments.
1080
+ # request = Google::Cloud::DiscoveryEngine::V1::BatchGetDocumentsMetadataRequest.new
1081
+ #
1082
+ # # Call the batch_get_documents_metadata method.
1083
+ # result = client.batch_get_documents_metadata request
1084
+ #
1085
+ # # The returned object is of type Google::Cloud::DiscoveryEngine::V1::BatchGetDocumentsMetadataResponse.
1086
+ # p result
1087
+ #
1088
+ def batch_get_documents_metadata request, options = nil
1089
+ raise ::ArgumentError, "request must be provided" if request.nil?
1090
+
1091
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1::BatchGetDocumentsMetadataRequest
1092
+
1093
+ # Converts hash and nil to an options object
1094
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
1095
+
1096
+ # Customize the options with defaults
1097
+ metadata = @config.rpcs.batch_get_documents_metadata.metadata.to_h
1098
+
1099
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
1100
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1101
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
1102
+ gapic_version: ::Google::Cloud::DiscoveryEngine::V1::VERSION
1103
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
1104
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1105
+
1106
+ header_params = {}
1107
+ if request.parent
1108
+ header_params["parent"] = request.parent
1109
+ end
1110
+
1111
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1112
+ metadata[:"x-goog-request-params"] ||= request_params_header
1113
+
1114
+ options.apply_defaults timeout: @config.rpcs.batch_get_documents_metadata.timeout,
1115
+ metadata: metadata,
1116
+ retry_policy: @config.rpcs.batch_get_documents_metadata.retry_policy
1117
+
1118
+ options.apply_defaults timeout: @config.timeout,
1119
+ metadata: @config.metadata,
1120
+ retry_policy: @config.retry_policy
1121
+
1122
+ @document_service_stub.call_rpc :batch_get_documents_metadata, request, options: options do |response, operation|
1123
+ yield response, operation if block_given?
1124
+ return response
1125
+ end
1126
+ rescue ::GRPC::BadStatus => e
1127
+ raise ::Google::Cloud::Error.from_error(e)
1128
+ end
1129
+
1029
1130
  ##
1030
1131
  # Configuration class for the DocumentService API.
1031
1132
  #
@@ -1214,6 +1315,11 @@ module Google
1214
1315
  # @return [::Gapic::Config::Method]
1215
1316
  #
1216
1317
  attr_reader :purge_documents
1318
+ ##
1319
+ # RPC-specific configuration for `batch_get_documents_metadata`
1320
+ # @return [::Gapic::Config::Method]
1321
+ #
1322
+ attr_reader :batch_get_documents_metadata
1217
1323
 
1218
1324
  # @private
1219
1325
  def initialize parent_rpcs = nil
@@ -1231,6 +1337,8 @@ module Google
1231
1337
  @import_documents = ::Gapic::Config::Method.new import_documents_config
1232
1338
  purge_documents_config = parent_rpcs.purge_documents if parent_rpcs.respond_to? :purge_documents
1233
1339
  @purge_documents = ::Gapic::Config::Method.new purge_documents_config
1340
+ batch_get_documents_metadata_config = parent_rpcs.batch_get_documents_metadata if parent_rpcs.respond_to? :batch_get_documents_metadata
1341
+ @batch_get_documents_metadata = ::Gapic::Config::Method.new batch_get_documents_metadata_config
1234
1342
 
1235
1343
  yield self if block_given?
1236
1344
  end
@@ -126,6 +126,31 @@ module Google
126
126
  resource.call(**args)
127
127
  end
128
128
 
129
+ ##
130
+ # Create a fully-qualified FhirResource resource string.
131
+ #
132
+ # The resource will be in the following format:
133
+ #
134
+ # `projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}`
135
+ #
136
+ # @param project [String]
137
+ # @param location [String]
138
+ # @param dataset [String]
139
+ # @param fhir_store [String]
140
+ # @param resource_type [String]
141
+ # @param fhir_resource_id [String]
142
+ #
143
+ # @return [::String]
144
+ def fhir_resource_path project:, location:, dataset:, fhir_store:, resource_type:, fhir_resource_id:
145
+ raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
146
+ raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
147
+ raise ::ArgumentError, "dataset cannot contain /" if dataset.to_s.include? "/"
148
+ raise ::ArgumentError, "fhir_store cannot contain /" if fhir_store.to_s.include? "/"
149
+ raise ::ArgumentError, "resource_type cannot contain /" if resource_type.to_s.include? "/"
150
+
151
+ "projects/#{project}/locations/#{location}/datasets/#{dataset}/fhirStores/#{fhir_store}/fhir/#{resource_type}/#{fhir_resource_id}"
152
+ end
153
+
129
154
  ##
130
155
  # Create a fully-qualified FhirStore resource string.
131
156
  #