google-cloud-discovery_engine-v1beta 0.14.2 → 0.16.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (83) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/discovery_engine/v1beta/completion_service/client.rb +155 -0
  3. data/lib/google/cloud/discovery_engine/v1beta/completion_service/paths.rb +62 -0
  4. data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/client.rb +148 -0
  5. data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/service_stub.rb +76 -0
  6. data/lib/google/cloud/discovery_engine/v1beta/control_service/client.rb +6 -6
  7. data/lib/google/cloud/discovery_engine/v1beta/control_service/rest/client.rb +6 -6
  8. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/client.rb +18 -13
  9. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest/client.rb +18 -13
  10. data/lib/google/cloud/discovery_engine/v1beta/document_service/client.rb +109 -1
  11. data/lib/google/cloud/discovery_engine/v1beta/document_service/paths.rb +25 -0
  12. data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/client.rb +102 -1
  13. data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/service_stub.rb +66 -0
  14. data/lib/google/cloud/discovery_engine/v1beta/engine_service/client.rb +3 -3
  15. data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/client.rb +3 -3
  16. data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/client.rb +218 -4
  17. data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/paths.rb +85 -0
  18. data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/rest/client.rb +125 -4
  19. data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/rest/service_stub.rb +60 -0
  20. data/lib/google/cloud/discovery_engine/v1beta/rank_service/client.rb +1 -1
  21. data/lib/google/cloud/discovery_engine/v1beta/rank_service/rest/client.rb +1 -1
  22. data/lib/google/cloud/discovery_engine/v1beta/search_service/client.rb +410 -4
  23. data/lib/google/cloud/discovery_engine/v1beta/search_service/rest/client.rb +402 -4
  24. data/lib/google/cloud/discovery_engine/v1beta/search_service/rest/service_stub.rb +76 -0
  25. data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/client.rb +2 -2
  26. data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/rest/client.rb +2 -2
  27. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/client.rb +324 -1
  28. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/paths.rb +49 -0
  29. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/client.rb +303 -1
  30. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/service_stub.rb +193 -0
  31. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/client.rb +1 -1
  32. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/client.rb +1 -1
  33. data/lib/google/cloud/discovery_engine/v1beta/version.rb +1 -1
  34. data/lib/google/cloud/discoveryengine/v1beta/answer_pb.rb +2 -1
  35. data/lib/google/cloud/discoveryengine/v1beta/common_pb.rb +1 -1
  36. data/lib/google/cloud/discoveryengine/v1beta/completion_service_pb.rb +18 -1
  37. data/lib/google/cloud/discoveryengine/v1beta/completion_service_services_pb.rb +2 -0
  38. data/lib/google/cloud/discoveryengine/v1beta/control_pb.rb +1 -1
  39. data/lib/google/cloud/discoveryengine/v1beta/conversational_search_service_pb.rb +4 -1
  40. data/lib/google/cloud/discoveryengine/v1beta/custom_tuning_model_pb.rb +1 -1
  41. data/lib/google/cloud/discoveryengine/v1beta/data_store_pb.rb +7 -1
  42. data/lib/google/cloud/discoveryengine/v1beta/document_pb.rb +4 -1
  43. data/lib/google/cloud/discoveryengine/v1beta/document_service_pb.rb +11 -1
  44. data/lib/google/cloud/discoveryengine/v1beta/document_service_services_pb.rb +4 -0
  45. data/lib/google/cloud/discoveryengine/v1beta/engine_pb.rb +1 -1
  46. data/lib/google/cloud/discoveryengine/v1beta/grounded_generation_service_pb.rb +24 -1
  47. data/lib/google/cloud/discoveryengine/v1beta/grounded_generation_service_services_pb.rb +4 -0
  48. data/lib/google/cloud/discoveryengine/v1beta/grounding_pb.rb +2 -1
  49. data/lib/google/cloud/discoveryengine/v1beta/import_config_pb.rb +1 -1
  50. data/lib/google/cloud/discoveryengine/v1beta/purge_config_pb.rb +5 -1
  51. data/lib/google/cloud/discoveryengine/v1beta/search_service_pb.rb +6 -1
  52. data/lib/google/cloud/discoveryengine/v1beta/search_service_services_pb.rb +14 -0
  53. data/lib/google/cloud/discoveryengine/v1beta/serving_config_pb.rb +2 -2
  54. data/lib/google/cloud/discoveryengine/v1beta/site_search_engine_pb.rb +2 -1
  55. data/lib/google/cloud/discoveryengine/v1beta/site_search_engine_service_pb.rb +10 -1
  56. data/lib/google/cloud/discoveryengine/v1beta/site_search_engine_service_services_pb.rb +7 -0
  57. data/lib/google/cloud/discoveryengine/v1beta/user_event_pb.rb +1 -1
  58. data/proto_docs/google/api/client.rb +20 -0
  59. data/proto_docs/google/cloud/discoveryengine/v1beta/answer.rb +68 -8
  60. data/proto_docs/google/cloud/discoveryengine/v1beta/completion_service.rb +268 -0
  61. data/proto_docs/google/cloud/discoveryengine/v1beta/control.rb +10 -1
  62. data/proto_docs/google/cloud/discoveryengine/v1beta/control_service.rb +6 -6
  63. data/proto_docs/google/cloud/discoveryengine/v1beta/conversational_search_service.rb +98 -15
  64. data/proto_docs/google/cloud/discoveryengine/v1beta/custom_tuning_model.rb +11 -3
  65. data/proto_docs/google/cloud/discoveryengine/v1beta/data_store.rb +131 -0
  66. data/proto_docs/google/cloud/discoveryengine/v1beta/document.rb +22 -0
  67. data/proto_docs/google/cloud/discoveryengine/v1beta/document_processing_config.rb +9 -5
  68. data/proto_docs/google/cloud/discoveryengine/v1beta/document_service.rb +123 -0
  69. data/proto_docs/google/cloud/discoveryengine/v1beta/engine.rb +5 -1
  70. data/proto_docs/google/cloud/discoveryengine/v1beta/engine_service.rb +4 -4
  71. data/proto_docs/google/cloud/discoveryengine/v1beta/grounded_generation_service.rb +398 -2
  72. data/proto_docs/google/cloud/discoveryengine/v1beta/grounding.rb +10 -0
  73. data/proto_docs/google/cloud/discoveryengine/v1beta/import_config.rb +13 -7
  74. data/proto_docs/google/cloud/discoveryengine/v1beta/project.rb +1 -1
  75. data/proto_docs/google/cloud/discoveryengine/v1beta/purge_config.rb +39 -1
  76. data/proto_docs/google/cloud/discoveryengine/v1beta/rank_service.rb +1 -1
  77. data/proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb +175 -6
  78. data/proto_docs/google/cloud/discoveryengine/v1beta/serving_config.rb +16 -0
  79. data/proto_docs/google/cloud/discoveryengine/v1beta/serving_config_service.rb +2 -2
  80. data/proto_docs/google/cloud/discoveryengine/v1beta/site_search_engine.rb +17 -0
  81. data/proto_docs/google/cloud/discoveryengine/v1beta/site_search_engine_service.rb +147 -1
  82. data/proto_docs/google/cloud/discoveryengine/v1beta/user_event.rb +13 -1
  83. metadata +3 -3
@@ -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::V1beta::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::V1beta::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::V1beta::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::V1beta::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.
@@ -824,7 +824,7 @@ module Google
824
824
  # @param options [::Gapic::CallOptions, ::Hash]
825
825
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
826
826
  #
827
- # @overload answer_query(serving_config: nil, query: nil, session: nil, safety_spec: nil, related_questions_spec: nil, answer_generation_spec: nil, search_spec: nil, query_understanding_spec: nil, asynchronous_mode: nil, user_pseudo_id: nil, user_labels: nil)
827
+ # @overload answer_query(serving_config: nil, query: nil, session: nil, safety_spec: nil, related_questions_spec: nil, grounding_spec: nil, answer_generation_spec: nil, search_spec: nil, query_understanding_spec: nil, asynchronous_mode: nil, user_pseudo_id: nil, user_labels: nil)
828
828
  # Pass arguments to `answer_query` via keyword arguments. Note that at
829
829
  # least one keyword argument is required. To specify no parameters, or to keep all
830
830
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -849,6 +849,8 @@ module Google
849
849
  # Model specification.
850
850
  # @param related_questions_spec [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::RelatedQuestionsSpec, ::Hash]
851
851
  # Related questions specification.
852
+ # @param grounding_spec [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::GroundingSpec, ::Hash]
853
+ # Optional. Grounding specification.
852
854
  # @param answer_generation_spec [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::AnswerGenerationSpec, ::Hash]
853
855
  # Answer generation specification.
854
856
  # @param search_spec [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::SearchSpec, ::Hash]
@@ -856,6 +858,9 @@ module Google
856
858
  # @param query_understanding_spec [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::QueryUnderstandingSpec, ::Hash]
857
859
  # Query understanding specification.
858
860
  # @param asynchronous_mode [::Boolean]
861
+ # Deprecated: This field is deprecated. Streaming Answer API will be
862
+ # supported.
863
+ #
859
864
  # Asynchronous mode control.
860
865
  #
861
866
  # If enabled, the response will be returned with answer/session resource
@@ -979,7 +984,7 @@ module Google
979
984
  #
980
985
  # @param name [::String]
981
986
  # 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}`
987
+ # `projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`
983
988
  #
984
989
  # @yield [response, operation] Access the result along with the RPC operation
985
990
  # @yieldparam response [::Google::Cloud::DiscoveryEngine::V1beta::Answer]
@@ -1069,7 +1074,7 @@ module Google
1069
1074
  #
1070
1075
  # @param parent [::String]
1071
1076
  # Required. Full resource name of parent data store. Format:
1072
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
1077
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
1073
1078
  # @param session [::Google::Cloud::DiscoveryEngine::V1beta::Session, ::Hash]
1074
1079
  # Required. The session to create.
1075
1080
  #
@@ -1161,7 +1166,7 @@ module Google
1161
1166
  #
1162
1167
  # @param name [::String]
1163
1168
  # 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}`
1169
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
1165
1170
  #
1166
1171
  # @yield [response, operation] Access the result along with the RPC operation
1167
1172
  # @yieldparam response [::Google::Protobuf::Empty]
@@ -1346,7 +1351,7 @@ module Google
1346
1351
  #
1347
1352
  # @param name [::String]
1348
1353
  # 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}`
1354
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
1350
1355
  #
1351
1356
  # @yield [response, operation] Access the result along with the RPC operation
1352
1357
  # @yieldparam response [::Google::Cloud::DiscoveryEngine::V1beta::Session]
@@ -1434,7 +1439,7 @@ module Google
1434
1439
  #
1435
1440
  # @param parent [::String]
1436
1441
  # Required. The data store resource name. Format:
1437
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
1442
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
1438
1443
  # @param page_size [::Integer]
1439
1444
  # Maximum number of results to return. If unspecified, defaults
1440
1445
  # 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::V1beta::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::V1beta::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::V1beta::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::V1beta::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.
@@ -775,7 +775,7 @@ module Google
775
775
  # @param options [::Gapic::CallOptions, ::Hash]
776
776
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
777
777
  #
778
- # @overload answer_query(serving_config: nil, query: nil, session: nil, safety_spec: nil, related_questions_spec: nil, answer_generation_spec: nil, search_spec: nil, query_understanding_spec: nil, asynchronous_mode: nil, user_pseudo_id: nil, user_labels: nil)
778
+ # @overload answer_query(serving_config: nil, query: nil, session: nil, safety_spec: nil, related_questions_spec: nil, grounding_spec: nil, answer_generation_spec: nil, search_spec: nil, query_understanding_spec: nil, asynchronous_mode: nil, user_pseudo_id: nil, user_labels: nil)
779
779
  # Pass arguments to `answer_query` via keyword arguments. Note that at
780
780
  # least one keyword argument is required. To specify no parameters, or to keep all
781
781
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -800,6 +800,8 @@ module Google
800
800
  # Model specification.
801
801
  # @param related_questions_spec [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::RelatedQuestionsSpec, ::Hash]
802
802
  # Related questions specification.
803
+ # @param grounding_spec [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::GroundingSpec, ::Hash]
804
+ # Optional. Grounding specification.
803
805
  # @param answer_generation_spec [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::AnswerGenerationSpec, ::Hash]
804
806
  # Answer generation specification.
805
807
  # @param search_spec [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::SearchSpec, ::Hash]
@@ -807,6 +809,9 @@ module Google
807
809
  # @param query_understanding_spec [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::QueryUnderstandingSpec, ::Hash]
808
810
  # Query understanding specification.
809
811
  # @param asynchronous_mode [::Boolean]
812
+ # Deprecated: This field is deprecated. Streaming Answer API will be
813
+ # supported.
814
+ #
810
815
  # Asynchronous mode control.
811
816
  #
812
817
  # If enabled, the response will be returned with answer/session resource
@@ -923,7 +928,7 @@ module Google
923
928
  #
924
929
  # @param name [::String]
925
930
  # 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}`
931
+ # `projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`
927
932
  # @yield [result, operation] Access the result along with the TransportOperation object
928
933
  # @yieldparam result [::Google::Cloud::DiscoveryEngine::V1beta::Answer]
929
934
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -1006,7 +1011,7 @@ module Google
1006
1011
  #
1007
1012
  # @param parent [::String]
1008
1013
  # Required. Full resource name of parent data store. Format:
1009
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
1014
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
1010
1015
  # @param session [::Google::Cloud::DiscoveryEngine::V1beta::Session, ::Hash]
1011
1016
  # Required. The session to create.
1012
1017
  # @yield [result, operation] Access the result along with the TransportOperation object
@@ -1091,7 +1096,7 @@ module Google
1091
1096
  #
1092
1097
  # @param name [::String]
1093
1098
  # 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}`
1099
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
1095
1100
  # @yield [result, operation] Access the result along with the TransportOperation object
1096
1101
  # @yieldparam result [::Google::Protobuf::Empty]
1097
1102
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -1262,7 +1267,7 @@ module Google
1262
1267
  #
1263
1268
  # @param name [::String]
1264
1269
  # 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}`
1270
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
1266
1271
  # @yield [result, operation] Access the result along with the TransportOperation object
1267
1272
  # @yieldparam result [::Google::Cloud::DiscoveryEngine::V1beta::Session]
1268
1273
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -1343,7 +1348,7 @@ module Google
1343
1348
  #
1344
1349
  # @param parent [::String]
1345
1350
  # Required. The data store resource name. Format:
1346
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
1351
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
1347
1352
  # @param page_size [::Integer]
1348
1353
  # Maximum number of results to return. If unspecified, defaults
1349
1354
  # to 50. Max allowed value is 1000.
@@ -939,11 +939,18 @@ module Google
939
939
  # @param options [::Gapic::CallOptions, ::Hash]
940
940
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
941
941
  #
942
- # @overload purge_documents(parent: nil, filter: nil, force: nil)
942
+ # @overload purge_documents(gcs_source: nil, inline_source: nil, parent: nil, filter: nil, error_config: nil, force: nil)
943
943
  # Pass arguments to `purge_documents` via keyword arguments. Note that at
944
944
  # least one keyword argument is required. To specify no parameters, or to keep all
945
945
  # the default parameter values, pass an empty Hash as a request object (see above).
946
946
  #
947
+ # @param gcs_source [::Google::Cloud::DiscoveryEngine::V1beta::GcsSource, ::Hash]
948
+ # Cloud Storage location for the input content.
949
+ # Supported `data_schema`:
950
+ # * `document_id`: One valid
951
+ # {::Google::Cloud::DiscoveryEngine::V1beta::Document#id Document.id} per line.
952
+ # @param inline_source [::Google::Cloud::DiscoveryEngine::V1beta::PurgeDocumentsRequest::InlineSource, ::Hash]
953
+ # Inline source for the input content for purge.
947
954
  # @param parent [::String]
948
955
  # Required. The parent resource name, such as
949
956
  # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
@@ -951,6 +958,8 @@ module Google
951
958
  # Required. Filter matching documents to purge. Only currently supported
952
959
  # value is
953
960
  # `*` (all items).
961
+ # @param error_config [::Google::Cloud::DiscoveryEngine::V1beta::PurgeErrorConfig, ::Hash]
962
+ # The desired location of errors incurred during the purge.
954
963
  # @param force [::Boolean]
955
964
  # Actually performs the purge. If `force` is set to false, return the
956
965
  # expected purge count without deleting any documents.
@@ -1028,6 +1037,98 @@ module Google
1028
1037
  raise ::Google::Cloud::Error.from_error(e)
1029
1038
  end
1030
1039
 
1040
+ ##
1041
+ # Gets index freshness metadata for
1042
+ # {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}s. Supported for
1043
+ # website search only.
1044
+ #
1045
+ # @overload batch_get_documents_metadata(request, options = nil)
1046
+ # Pass arguments to `batch_get_documents_metadata` via a request object, either of type
1047
+ # {::Google::Cloud::DiscoveryEngine::V1beta::BatchGetDocumentsMetadataRequest} or an equivalent Hash.
1048
+ #
1049
+ # @param request [::Google::Cloud::DiscoveryEngine::V1beta::BatchGetDocumentsMetadataRequest, ::Hash]
1050
+ # A request object representing the call parameters. Required. To specify no
1051
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1052
+ # @param options [::Gapic::CallOptions, ::Hash]
1053
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1054
+ #
1055
+ # @overload batch_get_documents_metadata(parent: nil, matcher: nil)
1056
+ # Pass arguments to `batch_get_documents_metadata` via keyword arguments. Note that at
1057
+ # least one keyword argument is required. To specify no parameters, or to keep all
1058
+ # the default parameter values, pass an empty Hash as a request object (see above).
1059
+ #
1060
+ # @param parent [::String]
1061
+ # Required. The parent branch resource name, such as
1062
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
1063
+ # @param matcher [::Google::Cloud::DiscoveryEngine::V1beta::BatchGetDocumentsMetadataRequest::Matcher, ::Hash]
1064
+ # Required. Matcher for the
1065
+ # {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}s.
1066
+ #
1067
+ # @yield [response, operation] Access the result along with the RPC operation
1068
+ # @yieldparam response [::Google::Cloud::DiscoveryEngine::V1beta::BatchGetDocumentsMetadataResponse]
1069
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
1070
+ #
1071
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::BatchGetDocumentsMetadataResponse]
1072
+ #
1073
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
1074
+ #
1075
+ # @example Basic example
1076
+ # require "google/cloud/discovery_engine/v1beta"
1077
+ #
1078
+ # # Create a client object. The client can be reused for multiple calls.
1079
+ # client = Google::Cloud::DiscoveryEngine::V1beta::DocumentService::Client.new
1080
+ #
1081
+ # # Create a request. To set request fields, pass in keyword arguments.
1082
+ # request = Google::Cloud::DiscoveryEngine::V1beta::BatchGetDocumentsMetadataRequest.new
1083
+ #
1084
+ # # Call the batch_get_documents_metadata method.
1085
+ # result = client.batch_get_documents_metadata request
1086
+ #
1087
+ # # The returned object is of type Google::Cloud::DiscoveryEngine::V1beta::BatchGetDocumentsMetadataResponse.
1088
+ # p result
1089
+ #
1090
+ def batch_get_documents_metadata request, options = nil
1091
+ raise ::ArgumentError, "request must be provided" if request.nil?
1092
+
1093
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1beta::BatchGetDocumentsMetadataRequest
1094
+
1095
+ # Converts hash and nil to an options object
1096
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
1097
+
1098
+ # Customize the options with defaults
1099
+ metadata = @config.rpcs.batch_get_documents_metadata.metadata.to_h
1100
+
1101
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
1102
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1103
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
1104
+ gapic_version: ::Google::Cloud::DiscoveryEngine::V1beta::VERSION
1105
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
1106
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1107
+
1108
+ header_params = {}
1109
+ if request.parent
1110
+ header_params["parent"] = request.parent
1111
+ end
1112
+
1113
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1114
+ metadata[:"x-goog-request-params"] ||= request_params_header
1115
+
1116
+ options.apply_defaults timeout: @config.rpcs.batch_get_documents_metadata.timeout,
1117
+ metadata: metadata,
1118
+ retry_policy: @config.rpcs.batch_get_documents_metadata.retry_policy
1119
+
1120
+ options.apply_defaults timeout: @config.timeout,
1121
+ metadata: @config.metadata,
1122
+ retry_policy: @config.retry_policy
1123
+
1124
+ @document_service_stub.call_rpc :batch_get_documents_metadata, request, options: options do |response, operation|
1125
+ yield response, operation if block_given?
1126
+ return response
1127
+ end
1128
+ rescue ::GRPC::BadStatus => e
1129
+ raise ::Google::Cloud::Error.from_error(e)
1130
+ end
1131
+
1031
1132
  ##
1032
1133
  # Configuration class for the DocumentService API.
1033
1134
  #
@@ -1216,6 +1317,11 @@ module Google
1216
1317
  # @return [::Gapic::Config::Method]
1217
1318
  #
1218
1319
  attr_reader :purge_documents
1320
+ ##
1321
+ # RPC-specific configuration for `batch_get_documents_metadata`
1322
+ # @return [::Gapic::Config::Method]
1323
+ #
1324
+ attr_reader :batch_get_documents_metadata
1219
1325
 
1220
1326
  # @private
1221
1327
  def initialize parent_rpcs = nil
@@ -1233,6 +1339,8 @@ module Google
1233
1339
  @import_documents = ::Gapic::Config::Method.new import_documents_config
1234
1340
  purge_documents_config = parent_rpcs.purge_documents if parent_rpcs.respond_to? :purge_documents
1235
1341
  @purge_documents = ::Gapic::Config::Method.new purge_documents_config
1342
+ batch_get_documents_metadata_config = parent_rpcs.batch_get_documents_metadata if parent_rpcs.respond_to? :batch_get_documents_metadata
1343
+ @batch_get_documents_metadata = ::Gapic::Config::Method.new batch_get_documents_metadata_config
1236
1344
 
1237
1345
  yield self if block_given?
1238
1346
  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
  #
@@ -890,11 +890,18 @@ module Google
890
890
  # @param options [::Gapic::CallOptions, ::Hash]
891
891
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
892
892
  #
893
- # @overload purge_documents(parent: nil, filter: nil, force: nil)
893
+ # @overload purge_documents(gcs_source: nil, inline_source: nil, parent: nil, filter: nil, error_config: nil, force: nil)
894
894
  # Pass arguments to `purge_documents` via keyword arguments. Note that at
895
895
  # least one keyword argument is required. To specify no parameters, or to keep all
896
896
  # the default parameter values, pass an empty Hash as a request object (see above).
897
897
  #
898
+ # @param gcs_source [::Google::Cloud::DiscoveryEngine::V1beta::GcsSource, ::Hash]
899
+ # Cloud Storage location for the input content.
900
+ # Supported `data_schema`:
901
+ # * `document_id`: One valid
902
+ # {::Google::Cloud::DiscoveryEngine::V1beta::Document#id Document.id} per line.
903
+ # @param inline_source [::Google::Cloud::DiscoveryEngine::V1beta::PurgeDocumentsRequest::InlineSource, ::Hash]
904
+ # Inline source for the input content for purge.
898
905
  # @param parent [::String]
899
906
  # Required. The parent resource name, such as
900
907
  # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
@@ -902,6 +909,8 @@ module Google
902
909
  # Required. Filter matching documents to purge. Only currently supported
903
910
  # value is
904
911
  # `*` (all items).
912
+ # @param error_config [::Google::Cloud::DiscoveryEngine::V1beta::PurgeErrorConfig, ::Hash]
913
+ # The desired location of errors incurred during the purge.
905
914
  # @param force [::Boolean]
906
915
  # Actually performs the purge. If `force` is set to false, return the
907
916
  # expected purge count without deleting any documents.
@@ -972,6 +981,91 @@ module Google
972
981
  raise ::Google::Cloud::Error.from_error(e)
973
982
  end
974
983
 
984
+ ##
985
+ # Gets index freshness metadata for
986
+ # {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}s. Supported for
987
+ # website search only.
988
+ #
989
+ # @overload batch_get_documents_metadata(request, options = nil)
990
+ # Pass arguments to `batch_get_documents_metadata` via a request object, either of type
991
+ # {::Google::Cloud::DiscoveryEngine::V1beta::BatchGetDocumentsMetadataRequest} or an equivalent Hash.
992
+ #
993
+ # @param request [::Google::Cloud::DiscoveryEngine::V1beta::BatchGetDocumentsMetadataRequest, ::Hash]
994
+ # A request object representing the call parameters. Required. To specify no
995
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
996
+ # @param options [::Gapic::CallOptions, ::Hash]
997
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
998
+ #
999
+ # @overload batch_get_documents_metadata(parent: nil, matcher: nil)
1000
+ # Pass arguments to `batch_get_documents_metadata` via keyword arguments. Note that at
1001
+ # least one keyword argument is required. To specify no parameters, or to keep all
1002
+ # the default parameter values, pass an empty Hash as a request object (see above).
1003
+ #
1004
+ # @param parent [::String]
1005
+ # Required. The parent branch resource name, such as
1006
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
1007
+ # @param matcher [::Google::Cloud::DiscoveryEngine::V1beta::BatchGetDocumentsMetadataRequest::Matcher, ::Hash]
1008
+ # Required. Matcher for the
1009
+ # {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}s.
1010
+ # @yield [result, operation] Access the result along with the TransportOperation object
1011
+ # @yieldparam result [::Google::Cloud::DiscoveryEngine::V1beta::BatchGetDocumentsMetadataResponse]
1012
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
1013
+ #
1014
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::BatchGetDocumentsMetadataResponse]
1015
+ #
1016
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
1017
+ #
1018
+ # @example Basic example
1019
+ # require "google/cloud/discovery_engine/v1beta"
1020
+ #
1021
+ # # Create a client object. The client can be reused for multiple calls.
1022
+ # client = Google::Cloud::DiscoveryEngine::V1beta::DocumentService::Rest::Client.new
1023
+ #
1024
+ # # Create a request. To set request fields, pass in keyword arguments.
1025
+ # request = Google::Cloud::DiscoveryEngine::V1beta::BatchGetDocumentsMetadataRequest.new
1026
+ #
1027
+ # # Call the batch_get_documents_metadata method.
1028
+ # result = client.batch_get_documents_metadata request
1029
+ #
1030
+ # # The returned object is of type Google::Cloud::DiscoveryEngine::V1beta::BatchGetDocumentsMetadataResponse.
1031
+ # p result
1032
+ #
1033
+ def batch_get_documents_metadata request, options = nil
1034
+ raise ::ArgumentError, "request must be provided" if request.nil?
1035
+
1036
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1beta::BatchGetDocumentsMetadataRequest
1037
+
1038
+ # Converts hash and nil to an options object
1039
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
1040
+
1041
+ # Customize the options with defaults
1042
+ call_metadata = @config.rpcs.batch_get_documents_metadata.metadata.to_h
1043
+
1044
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
1045
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1046
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
1047
+ gapic_version: ::Google::Cloud::DiscoveryEngine::V1beta::VERSION,
1048
+ transports_version_send: [:rest]
1049
+
1050
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
1051
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1052
+
1053
+ options.apply_defaults timeout: @config.rpcs.batch_get_documents_metadata.timeout,
1054
+ metadata: call_metadata,
1055
+ retry_policy: @config.rpcs.batch_get_documents_metadata.retry_policy
1056
+
1057
+ options.apply_defaults timeout: @config.timeout,
1058
+ metadata: @config.metadata,
1059
+ retry_policy: @config.retry_policy
1060
+
1061
+ @document_service_stub.batch_get_documents_metadata request, options do |result, operation|
1062
+ yield result, operation if block_given?
1063
+ return result
1064
+ end
1065
+ rescue ::Gapic::Rest::Error => e
1066
+ raise ::Google::Cloud::Error.from_error(e)
1067
+ end
1068
+
975
1069
  ##
976
1070
  # Configuration class for the DocumentService REST API.
977
1071
  #
@@ -1140,6 +1234,11 @@ module Google
1140
1234
  # @return [::Gapic::Config::Method]
1141
1235
  #
1142
1236
  attr_reader :purge_documents
1237
+ ##
1238
+ # RPC-specific configuration for `batch_get_documents_metadata`
1239
+ # @return [::Gapic::Config::Method]
1240
+ #
1241
+ attr_reader :batch_get_documents_metadata
1143
1242
 
1144
1243
  # @private
1145
1244
  def initialize parent_rpcs = nil
@@ -1157,6 +1256,8 @@ module Google
1157
1256
  @import_documents = ::Gapic::Config::Method.new import_documents_config
1158
1257
  purge_documents_config = parent_rpcs.purge_documents if parent_rpcs.respond_to? :purge_documents
1159
1258
  @purge_documents = ::Gapic::Config::Method.new purge_documents_config
1259
+ batch_get_documents_metadata_config = parent_rpcs.batch_get_documents_metadata if parent_rpcs.respond_to? :batch_get_documents_metadata
1260
+ @batch_get_documents_metadata = ::Gapic::Config::Method.new batch_get_documents_metadata_config
1160
1261
 
1161
1262
  yield self if block_given?
1162
1263
  end