google-cloud-discovery_engine-v1beta 0.10.0 → 0.12.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (140) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/discovery_engine/v1beta/completion_service/client.rb +9 -3
  3. data/lib/google/cloud/discovery_engine/v1beta/completion_service/operations.rb +13 -5
  4. data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/client.rb +9 -3
  5. data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/operations.rb +21 -6
  6. data/lib/google/cloud/discovery_engine/v1beta/control_service/client.rb +875 -0
  7. data/lib/google/cloud/discovery_engine/v1beta/control_service/credentials.rb +47 -0
  8. data/lib/google/cloud/discovery_engine/v1beta/control_service/paths.rb +167 -0
  9. data/lib/google/cloud/discovery_engine/v1beta/control_service/rest/client.rb +814 -0
  10. data/lib/google/cloud/discovery_engine/v1beta/control_service/rest/service_stub.rb +440 -0
  11. data/lib/google/cloud/discovery_engine/v1beta/control_service/rest.rb +55 -0
  12. data/lib/google/cloud/discovery_engine/v1beta/control_service.rb +58 -0
  13. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/client.rb +764 -6
  14. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/paths.rb +199 -0
  15. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest/client.rb +715 -6
  16. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest/service_stub.rb +520 -0
  17. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/client.rb +15 -7
  18. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/operations.rb +13 -5
  19. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/rest/client.rb +15 -7
  20. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/rest/operations.rb +21 -6
  21. data/lib/google/cloud/discovery_engine/v1beta/document_service/client.rb +71 -37
  22. data/lib/google/cloud/discovery_engine/v1beta/document_service/operations.rb +13 -5
  23. data/lib/google/cloud/discovery_engine/v1beta/document_service/paths.rb +21 -0
  24. data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/client.rb +71 -37
  25. data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/operations.rb +21 -6
  26. data/lib/google/cloud/discovery_engine/v1beta/engine_service/client.rb +312 -5
  27. data/lib/google/cloud/discovery_engine/v1beta/engine_service/operations.rb +13 -5
  28. data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/client.rb +291 -5
  29. data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/operations.rb +21 -6
  30. data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/service_stub.rb +180 -0
  31. data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/client.rb +471 -0
  32. data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/credentials.rb +47 -0
  33. data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/paths.rb +52 -0
  34. data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/rest/client.rb +438 -0
  35. data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/rest/service_stub.rb +129 -0
  36. data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/rest.rb +52 -0
  37. data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service.rb +55 -0
  38. data/lib/google/cloud/discovery_engine/v1beta/project_service/client.rb +485 -0
  39. data/lib/google/cloud/discovery_engine/v1beta/project_service/credentials.rb +47 -0
  40. data/lib/google/cloud/discovery_engine/v1beta/project_service/operations.rb +809 -0
  41. data/lib/google/cloud/discovery_engine/v1beta/project_service/paths.rb +47 -0
  42. data/lib/google/cloud/discovery_engine/v1beta/project_service/rest/client.rb +452 -0
  43. data/lib/google/cloud/discovery_engine/v1beta/project_service/rest/operations.rb +1092 -0
  44. data/lib/google/cloud/discovery_engine/v1beta/project_service/rest/service_stub.rb +129 -0
  45. data/lib/google/cloud/discovery_engine/v1beta/project_service/rest.rb +54 -0
  46. data/lib/google/cloud/discovery_engine/v1beta/project_service.rb +57 -0
  47. data/lib/google/cloud/discovery_engine/v1beta/rank_service/client.rb +481 -0
  48. data/lib/google/cloud/discovery_engine/v1beta/rank_service/credentials.rb +47 -0
  49. data/lib/google/cloud/discovery_engine/v1beta/rank_service/paths.rb +52 -0
  50. data/lib/google/cloud/discovery_engine/v1beta/rank_service/rest/client.rb +448 -0
  51. data/lib/google/cloud/discovery_engine/v1beta/rank_service/rest/service_stub.rb +129 -0
  52. data/lib/google/cloud/discovery_engine/v1beta/rank_service/rest.rb +52 -0
  53. data/lib/google/cloud/discovery_engine/v1beta/rank_service.rb +55 -0
  54. data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/client.rb +24 -19
  55. data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/paths.rb +66 -0
  56. data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/rest/client.rb +24 -19
  57. data/lib/google/cloud/discovery_engine/v1beta/rest.rb +4 -0
  58. data/lib/google/cloud/discovery_engine/v1beta/schema_service/client.rb +18 -10
  59. data/lib/google/cloud/discovery_engine/v1beta/schema_service/operations.rb +13 -5
  60. data/lib/google/cloud/discovery_engine/v1beta/schema_service/rest/client.rb +18 -10
  61. data/lib/google/cloud/discovery_engine/v1beta/schema_service/rest/operations.rb +21 -6
  62. data/lib/google/cloud/discovery_engine/v1beta/search_service/client.rb +26 -14
  63. data/lib/google/cloud/discovery_engine/v1beta/search_service/rest/client.rb +26 -14
  64. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/client.rb +104 -2
  65. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/operations.rb +13 -5
  66. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/rest/client.rb +97 -2
  67. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/rest/operations.rb +21 -6
  68. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/rest/service_stub.rb +59 -0
  69. data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/client.rb +9 -3
  70. data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/rest/client.rb +9 -3
  71. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/client.rb +27 -12
  72. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/operations.rb +13 -5
  73. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/client.rb +27 -12
  74. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/operations.rb +21 -6
  75. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/client.rb +23 -6
  76. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/operations.rb +13 -5
  77. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/paths.rb +21 -0
  78. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/client.rb +23 -6
  79. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/operations.rb +21 -6
  80. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/service_stub.rb +8 -0
  81. data/lib/google/cloud/discovery_engine/v1beta/version.rb +1 -1
  82. data/lib/google/cloud/discovery_engine/v1beta.rb +4 -0
  83. data/lib/google/cloud/discoveryengine/v1beta/answer_pb.rb +69 -0
  84. data/lib/google/cloud/discoveryengine/v1beta/common_pb.rb +2 -1
  85. data/lib/google/cloud/discoveryengine/v1beta/control_pb.rb +55 -0
  86. data/lib/google/cloud/discoveryengine/v1beta/control_service_pb.rb +57 -0
  87. data/lib/google/cloud/discoveryengine/v1beta/control_service_services_pb.rb +69 -0
  88. data/lib/google/cloud/discoveryengine/v1beta/conversational_search_service_pb.rb +32 -1
  89. data/lib/google/cloud/discoveryengine/v1beta/conversational_search_service_services_pb.rb +25 -0
  90. data/lib/google/cloud/discoveryengine/v1beta/custom_tuning_model_pb.rb +48 -0
  91. data/lib/google/cloud/discoveryengine/v1beta/document_processing_config_pb.rb +1 -1
  92. data/lib/google/cloud/discoveryengine/v1beta/document_service_pb.rb +3 -1
  93. data/lib/google/cloud/discoveryengine/v1beta/document_service_services_pb.rb +1 -1
  94. data/lib/google/cloud/discoveryengine/v1beta/engine_pb.rb +1 -1
  95. data/lib/google/cloud/discoveryengine/v1beta/engine_service_pb.rb +6 -1
  96. data/lib/google/cloud/discoveryengine/v1beta/engine_service_services_pb.rb +12 -0
  97. data/lib/google/cloud/discoveryengine/v1beta/grounded_generation_service_pb.rb +52 -0
  98. data/lib/google/cloud/discoveryengine/v1beta/grounded_generation_service_services_pb.rb +45 -0
  99. data/lib/google/cloud/discoveryengine/v1beta/grounding_pb.rb +46 -0
  100. data/lib/google/cloud/discoveryengine/v1beta/import_config_pb.rb +13 -1
  101. data/lib/google/cloud/discoveryengine/v1beta/project_pb.rb +49 -0
  102. data/lib/google/cloud/discoveryengine/v1beta/project_service_pb.rb +50 -0
  103. data/lib/google/cloud/discoveryengine/v1beta/project_service_services_pb.rb +51 -0
  104. data/lib/google/cloud/discoveryengine/v1beta/rank_service_pb.rb +49 -0
  105. data/lib/google/cloud/discoveryengine/v1beta/rank_service_services_pb.rb +45 -0
  106. data/lib/google/cloud/discoveryengine/v1beta/search_service_pb.rb +7 -1
  107. data/lib/google/cloud/discoveryengine/v1beta/search_tuning_service_pb.rb +5 -1
  108. data/lib/google/cloud/discoveryengine/v1beta/search_tuning_service_services_pb.rb +2 -0
  109. data/lib/google/cloud/discoveryengine/v1beta/session_pb.rb +50 -0
  110. data/lib/google/cloud/discoveryengine/v1beta/site_search_engine_pb.rb +1 -1
  111. data/lib/google/cloud/discoveryengine/v1beta/user_event_pb.rb +1 -1
  112. data/lib/google/cloud/discoveryengine/v1beta/user_event_service_pb.rb +1 -1
  113. data/lib/google/cloud/discoveryengine/v1beta/user_event_service_services_pb.rb +1 -1
  114. data/proto_docs/google/cloud/discoveryengine/v1beta/answer.rb +362 -0
  115. data/proto_docs/google/cloud/discoveryengine/v1beta/common.rb +25 -1
  116. data/proto_docs/google/cloud/discoveryengine/v1beta/control.rb +209 -0
  117. data/proto_docs/google/cloud/discoveryengine/v1beta/control_service.rb +126 -0
  118. data/proto_docs/google/cloud/discoveryengine/v1beta/conversation.rb +2 -2
  119. data/proto_docs/google/cloud/discoveryengine/v1beta/conversational_search_service.rb +491 -0
  120. data/proto_docs/google/cloud/discoveryengine/v1beta/custom_tuning_model.rb +75 -0
  121. data/proto_docs/google/cloud/discoveryengine/v1beta/data_store_service.rb +2 -2
  122. data/proto_docs/google/cloud/discoveryengine/v1beta/document_processing_config.rb +4 -5
  123. data/proto_docs/google/cloud/discoveryengine/v1beta/document_service.rb +9 -6
  124. data/proto_docs/google/cloud/discoveryengine/v1beta/engine.rb +5 -5
  125. data/proto_docs/google/cloud/discoveryengine/v1beta/engine_service.rb +51 -0
  126. data/proto_docs/google/cloud/discoveryengine/v1beta/grounded_generation_service.rb +144 -0
  127. data/proto_docs/google/cloud/discoveryengine/v1beta/grounding.rb +79 -0
  128. data/proto_docs/google/cloud/discoveryengine/v1beta/import_config.rb +312 -26
  129. data/proto_docs/google/cloud/discoveryengine/v1beta/project.rb +106 -0
  130. data/proto_docs/google/cloud/discoveryengine/v1beta/project_service.rb +57 -0
  131. data/proto_docs/google/cloud/discoveryengine/v1beta/rank_service.rb +127 -0
  132. data/proto_docs/google/cloud/discoveryengine/v1beta/recommendation_service.rb +20 -19
  133. data/proto_docs/google/cloud/discoveryengine/v1beta/schema_service.rb +5 -5
  134. data/proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb +181 -43
  135. data/proto_docs/google/cloud/discoveryengine/v1beta/search_tuning_service.rb +47 -1
  136. data/proto_docs/google/cloud/discoveryengine/v1beta/session.rb +88 -0
  137. data/proto_docs/google/cloud/discoveryengine/v1beta/site_search_engine.rb +3 -0
  138. data/proto_docs/google/cloud/discoveryengine/v1beta/user_event.rb +25 -4
  139. data/proto_docs/google/cloud/discoveryengine/v1beta/user_event_service.rb +13 -1
  140. metadata +56 -2
@@ -0,0 +1,126 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2024 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module DiscoveryEngine
23
+ module V1beta
24
+ # Request for CreateControl method.
25
+ # @!attribute [rw] parent
26
+ # @return [::String]
27
+ # Required. Full resource name of parent data store. Format:
28
+ # `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`
29
+ # or
30
+ # `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.
31
+ # @!attribute [rw] control
32
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::Control]
33
+ # Required. The Control to create.
34
+ # @!attribute [rw] control_id
35
+ # @return [::String]
36
+ # Required. The ID to use for the Control, which will become the final
37
+ # component of the Control's resource name.
38
+ #
39
+ # This value must be within 1-63 characters.
40
+ # Valid characters are /[a-z][0-9]-_/.
41
+ class CreateControlRequest
42
+ include ::Google::Protobuf::MessageExts
43
+ extend ::Google::Protobuf::MessageExts::ClassMethods
44
+ end
45
+
46
+ # Request for UpdateControl method.
47
+ # @!attribute [rw] control
48
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::Control]
49
+ # Required. The Control to update.
50
+ # @!attribute [rw] update_mask
51
+ # @return [::Google::Protobuf::FieldMask]
52
+ # Optional. Indicates which fields in the provided
53
+ # {::Google::Cloud::DiscoveryEngine::V1beta::Control Control} to update. The
54
+ # following are NOT supported:
55
+ #
56
+ # * {::Google::Cloud::DiscoveryEngine::V1beta::Control#name Control.name}
57
+ # * {::Google::Cloud::DiscoveryEngine::V1beta::Control#solution_type Control.solution_type}
58
+ #
59
+ # If not set or empty, all supported fields are updated.
60
+ class UpdateControlRequest
61
+ include ::Google::Protobuf::MessageExts
62
+ extend ::Google::Protobuf::MessageExts::ClassMethods
63
+ end
64
+
65
+ # Request for DeleteControl method.
66
+ # @!attribute [rw] name
67
+ # @return [::String]
68
+ # Required. The resource name of the Control to delete. Format:
69
+ # `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
70
+ class DeleteControlRequest
71
+ include ::Google::Protobuf::MessageExts
72
+ extend ::Google::Protobuf::MessageExts::ClassMethods
73
+ end
74
+
75
+ # Request for GetControl method.
76
+ # @!attribute [rw] name
77
+ # @return [::String]
78
+ # Required. The resource name of the Control to get. Format:
79
+ # `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
80
+ class GetControlRequest
81
+ include ::Google::Protobuf::MessageExts
82
+ extend ::Google::Protobuf::MessageExts::ClassMethods
83
+ end
84
+
85
+ # Request for ListControls method.
86
+ # @!attribute [rw] parent
87
+ # @return [::String]
88
+ # Required. The data store resource name. Format:
89
+ # `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`
90
+ # or
91
+ # `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.
92
+ # @!attribute [rw] page_size
93
+ # @return [::Integer]
94
+ # Optional. Maximum number of results to return. If unspecified, defaults
95
+ # to 50. Max allowed value is 1000.
96
+ # @!attribute [rw] page_token
97
+ # @return [::String]
98
+ # Optional. A page token, received from a previous `ListControls` call.
99
+ # Provide this to retrieve the subsequent page.
100
+ # @!attribute [rw] filter
101
+ # @return [::String]
102
+ # Optional. A filter to apply on the list results. Supported features:
103
+ #
104
+ # * List all the products under the parent branch if
105
+ # {::Google::Cloud::DiscoveryEngine::V1beta::ListControlsRequest#filter filter} is
106
+ # unset. Currently this field is unsupported.
107
+ class ListControlsRequest
108
+ include ::Google::Protobuf::MessageExts
109
+ extend ::Google::Protobuf::MessageExts::ClassMethods
110
+ end
111
+
112
+ # Response for ListControls method.
113
+ # @!attribute [rw] controls
114
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Control>]
115
+ # All the Controls for a given data store.
116
+ # @!attribute [rw] next_page_token
117
+ # @return [::String]
118
+ # Pagination token, if not returned indicates the last page.
119
+ class ListControlsResponse
120
+ include ::Google::Protobuf::MessageExts
121
+ extend ::Google::Protobuf::MessageExts::ClassMethods
122
+ end
123
+ end
124
+ end
125
+ end
126
+ end
@@ -25,9 +25,9 @@ module Google
25
25
  # @!attribute [rw] name
26
26
  # @return [::String]
27
27
  # Immutable. Fully qualified name
28
- # `project/*/locations/global/collections/{collection}/dataStore/*/conversations/*`
28
+ # `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*`
29
29
  # or
30
- # `project/*/locations/global/collections/{collection}/engines/*/conversations/*`.
30
+ # `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`.
31
31
  # @!attribute [rw] state
32
32
  # @return [::Google::Cloud::DiscoveryEngine::V1beta::Conversation::State]
33
33
  # The state of the Conversation.
@@ -226,6 +226,497 @@ module Google
226
226
  include ::Google::Protobuf::MessageExts
227
227
  extend ::Google::Protobuf::MessageExts::ClassMethods
228
228
  end
229
+
230
+ # Request message for
231
+ # {::Google::Cloud::DiscoveryEngine::V1beta::ConversationalSearchService::Client#answer_query ConversationalSearchService.AnswerQuery}
232
+ # method.
233
+ # @!attribute [rw] serving_config
234
+ # @return [::String]
235
+ # Required. The resource name of the Search serving config, such as
236
+ # `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`,
237
+ # or
238
+ # `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`.
239
+ # This field is used to identify the serving configuration name, set
240
+ # of models used to make the search.
241
+ # @!attribute [rw] query
242
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::Query]
243
+ # Required. Current user query.
244
+ # @!attribute [rw] session
245
+ # @return [::String]
246
+ # The session resource name. Not required.
247
+ #
248
+ # When session field is not set, the API is in sessionless mode.
249
+ #
250
+ # We support auto session mode: users can use the wildcard symbol `-` as
251
+ # session ID. A new ID will be automatically generated and assigned.
252
+ # @!attribute [rw] safety_spec
253
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::SafetySpec]
254
+ # Model specification.
255
+ # @!attribute [rw] related_questions_spec
256
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::RelatedQuestionsSpec]
257
+ # Related questions specification.
258
+ # @!attribute [rw] answer_generation_spec
259
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::AnswerGenerationSpec]
260
+ # Answer generation specification.
261
+ # @!attribute [rw] search_spec
262
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::SearchSpec]
263
+ # Search specification.
264
+ # @!attribute [rw] query_understanding_spec
265
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::QueryUnderstandingSpec]
266
+ # Query understanding specification.
267
+ # @!attribute [rw] asynchronous_mode
268
+ # @return [::Boolean]
269
+ # Asynchronous mode control.
270
+ #
271
+ # If enabled, the response will be returned with answer/session resource
272
+ # name without final answer. The API users need to do the polling to get
273
+ # the latest status of answer/session by calling
274
+ # {::Google::Cloud::DiscoveryEngine::V1beta::ConversationalSearchService::Client#get_answer ConversationalSearchService.GetAnswer}
275
+ # or
276
+ # {::Google::Cloud::DiscoveryEngine::V1beta::ConversationalSearchService::Client#get_session ConversationalSearchService.GetSession}
277
+ # method.
278
+ # @!attribute [rw] user_pseudo_id
279
+ # @return [::String]
280
+ # A unique identifier for tracking visitors. For example, this could be
281
+ # implemented with an HTTP cookie, which should be able to uniquely identify
282
+ # a visitor on a single device. This unique identifier should not change if
283
+ # the visitor logs in or out of the website.
284
+ #
285
+ # This field should NOT have a fixed value such as `unknown_visitor`.
286
+ #
287
+ # The field must be a UTF-8 encoded string with a length limit of 128
288
+ # characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
289
+ class AnswerQueryRequest
290
+ include ::Google::Protobuf::MessageExts
291
+ extend ::Google::Protobuf::MessageExts::ClassMethods
292
+
293
+ # Safety specification.
294
+ # @!attribute [rw] enable
295
+ # @return [::Boolean]
296
+ # Enable the safety filtering on the answer response. It is false by
297
+ # default.
298
+ class SafetySpec
299
+ include ::Google::Protobuf::MessageExts
300
+ extend ::Google::Protobuf::MessageExts::ClassMethods
301
+ end
302
+
303
+ # Related questions specification.
304
+ # @!attribute [rw] enable
305
+ # @return [::Boolean]
306
+ # Enable related questions feature if true.
307
+ class RelatedQuestionsSpec
308
+ include ::Google::Protobuf::MessageExts
309
+ extend ::Google::Protobuf::MessageExts::ClassMethods
310
+ end
311
+
312
+ # Answer generation specification.
313
+ # @!attribute [rw] model_spec
314
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::AnswerGenerationSpec::ModelSpec]
315
+ # Answer generation model specification.
316
+ # @!attribute [rw] prompt_spec
317
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::AnswerGenerationSpec::PromptSpec]
318
+ # Answer generation prompt specification.
319
+ # @!attribute [rw] include_citations
320
+ # @return [::Boolean]
321
+ # Specifies whether to include citation metadata in the answer. The default
322
+ # value is `false`.
323
+ # @!attribute [rw] answer_language_code
324
+ # @return [::String]
325
+ # Language code for Answer. Use language tags defined by
326
+ # [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
327
+ # Note: This is an experimental feature.
328
+ # @!attribute [rw] ignore_adversarial_query
329
+ # @return [::Boolean]
330
+ # Specifies whether to filter out adversarial queries. The default value
331
+ # is `false`.
332
+ #
333
+ # Google employs search-query classification to detect adversarial
334
+ # queries. No answer is returned if the search query is classified as an
335
+ # adversarial query. For example, a user might ask a question regarding
336
+ # negative comments about the company or submit a query designed to
337
+ # generate unsafe, policy-violating output. If this field is set to
338
+ # `true`, we skip generating answers for adversarial queries and return
339
+ # fallback messages instead.
340
+ # @!attribute [rw] ignore_non_answer_seeking_query
341
+ # @return [::Boolean]
342
+ # Specifies whether to filter out queries that are not answer-seeking.
343
+ # The default value is `false`.
344
+ #
345
+ # Google employs search-query classification to detect answer-seeking
346
+ # queries. No answer is returned if the search query is classified as a
347
+ # non-answer seeking query. If this field is set to `true`, we skip
348
+ # generating answers for non-answer seeking queries and return
349
+ # fallback messages instead.
350
+ # @!attribute [rw] ignore_low_relevant_content
351
+ # @return [::Boolean]
352
+ # Specifies whether to filter out queries that have low relevance.
353
+ #
354
+ # If this field is set to `false`, all search results are used regardless
355
+ # of relevance to generate answers. If set to `true` or unset, the behavior
356
+ # will be determined automatically by the service.
357
+ class AnswerGenerationSpec
358
+ include ::Google::Protobuf::MessageExts
359
+ extend ::Google::Protobuf::MessageExts::ClassMethods
360
+
361
+ # Answer Generation Model specification.
362
+ # @!attribute [rw] model_version
363
+ # @return [::String]
364
+ # Model version. If not set, it will use the default stable model.
365
+ # Allowed values are: stable, preview.
366
+ class ModelSpec
367
+ include ::Google::Protobuf::MessageExts
368
+ extend ::Google::Protobuf::MessageExts::ClassMethods
369
+ end
370
+
371
+ # Answer generation prompt specification.
372
+ # @!attribute [rw] preamble
373
+ # @return [::String]
374
+ # Customized preamble.
375
+ class PromptSpec
376
+ include ::Google::Protobuf::MessageExts
377
+ extend ::Google::Protobuf::MessageExts::ClassMethods
378
+ end
379
+ end
380
+
381
+ # Search specification.
382
+ # @!attribute [rw] search_params
383
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::SearchSpec::SearchParams]
384
+ # Search parameters.
385
+ # @!attribute [rw] search_result_list
386
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::SearchSpec::SearchResultList]
387
+ # Search result list.
388
+ class SearchSpec
389
+ include ::Google::Protobuf::MessageExts
390
+ extend ::Google::Protobuf::MessageExts::ClassMethods
391
+
392
+ # Search parameters.
393
+ # @!attribute [rw] max_return_results
394
+ # @return [::Integer]
395
+ # Number of search results to return.
396
+ # The default value is 10.
397
+ # @!attribute [rw] filter
398
+ # @return [::String]
399
+ # The filter syntax consists of an expression language for constructing
400
+ # a predicate from one or more fields of the documents being filtered.
401
+ # Filter expression is case-sensitive. This will be used to filter
402
+ # search results which may affect the Answer response.
403
+ #
404
+ # If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
405
+ #
406
+ # Filtering in Vertex AI Search is done by mapping the LHS filter key
407
+ # to a key property defined in the Vertex AI Search backend -- this
408
+ # mapping is defined by the customer in their schema. For example a
409
+ # media customers might have a field 'name' in their schema. In this
410
+ # case the filter would look like this: filter --> name:'ANY("king
411
+ # kong")'
412
+ #
413
+ # For more information about filtering including syntax and filter
414
+ # operators, see
415
+ # [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
416
+ # @!attribute [rw] boost_spec
417
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec]
418
+ # Boost specification to boost certain documents in search results which
419
+ # may affect the answer query response. For more information on boosting,
420
+ # see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
421
+ # @!attribute [rw] order_by
422
+ # @return [::String]
423
+ # The order in which documents are returned. Documents can be ordered
424
+ # by a field in an
425
+ # {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} object. Leave
426
+ # it unset if ordered by relevance. `order_by` expression is
427
+ # case-sensitive. For more information on ordering, see
428
+ # [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order)
429
+ #
430
+ # If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
431
+ # @!attribute [rw] data_store_specs
432
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::DataStoreSpec>]
433
+ # Specs defining dataStores to filter on in a search call and
434
+ # configurations for those dataStores. This is only considered for
435
+ # engines with multiple dataStores use case. For single dataStore within
436
+ # an engine, they should use the specs at the top level.
437
+ class SearchParams
438
+ include ::Google::Protobuf::MessageExts
439
+ extend ::Google::Protobuf::MessageExts::ClassMethods
440
+ end
441
+
442
+ # Search result list.
443
+ # @!attribute [rw] search_results
444
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::SearchSpec::SearchResultList::SearchResult>]
445
+ # Search results.
446
+ class SearchResultList
447
+ include ::Google::Protobuf::MessageExts
448
+ extend ::Google::Protobuf::MessageExts::ClassMethods
449
+
450
+ # Search result.
451
+ # @!attribute [rw] unstructured_document_info
452
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::SearchSpec::SearchResultList::SearchResult::UnstructuredDocumentInfo]
453
+ # Unstructured document information.
454
+ # @!attribute [rw] chunk_info
455
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::SearchSpec::SearchResultList::SearchResult::ChunkInfo]
456
+ # Chunk information.
457
+ class SearchResult
458
+ include ::Google::Protobuf::MessageExts
459
+ extend ::Google::Protobuf::MessageExts::ClassMethods
460
+
461
+ # Unstructured document information.
462
+ # @!attribute [rw] document
463
+ # @return [::String]
464
+ # Document resource name.
465
+ # @!attribute [rw] uri
466
+ # @return [::String]
467
+ # URI for the document.
468
+ # @!attribute [rw] title
469
+ # @return [::String]
470
+ # Title.
471
+ # @!attribute [rw] document_contexts
472
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::SearchSpec::SearchResultList::SearchResult::UnstructuredDocumentInfo::DocumentContext>]
473
+ # List of document contexts.
474
+ # @!attribute [rw] extractive_segments
475
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::SearchSpec::SearchResultList::SearchResult::UnstructuredDocumentInfo::ExtractiveSegment>]
476
+ # List of extractive segments.
477
+ # @!attribute [rw] extractive_answers
478
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::SearchSpec::SearchResultList::SearchResult::UnstructuredDocumentInfo::ExtractiveAnswer>]
479
+ # List of extractive answers.
480
+ class UnstructuredDocumentInfo
481
+ include ::Google::Protobuf::MessageExts
482
+ extend ::Google::Protobuf::MessageExts::ClassMethods
483
+
484
+ # Document context.
485
+ # @!attribute [rw] page_identifier
486
+ # @return [::String]
487
+ # Page identifier.
488
+ # @!attribute [rw] content
489
+ # @return [::String]
490
+ # Document content.
491
+ class DocumentContext
492
+ include ::Google::Protobuf::MessageExts
493
+ extend ::Google::Protobuf::MessageExts::ClassMethods
494
+ end
495
+
496
+ # Extractive segment.
497
+ # [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments)
498
+ # @!attribute [rw] page_identifier
499
+ # @return [::String]
500
+ # Page identifier.
501
+ # @!attribute [rw] content
502
+ # @return [::String]
503
+ # Extractive segment content.
504
+ class ExtractiveSegment
505
+ include ::Google::Protobuf::MessageExts
506
+ extend ::Google::Protobuf::MessageExts::ClassMethods
507
+ end
508
+
509
+ # Extractive answer.
510
+ # [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#get-answers)
511
+ # @!attribute [rw] page_identifier
512
+ # @return [::String]
513
+ # Page identifier.
514
+ # @!attribute [rw] content
515
+ # @return [::String]
516
+ # Extractive answer content.
517
+ class ExtractiveAnswer
518
+ include ::Google::Protobuf::MessageExts
519
+ extend ::Google::Protobuf::MessageExts::ClassMethods
520
+ end
521
+ end
522
+
523
+ # Chunk information.
524
+ # @!attribute [rw] chunk
525
+ # @return [::String]
526
+ # Chunk resource name.
527
+ # @!attribute [rw] content
528
+ # @return [::String]
529
+ # Chunk textual content.
530
+ class ChunkInfo
531
+ include ::Google::Protobuf::MessageExts
532
+ extend ::Google::Protobuf::MessageExts::ClassMethods
533
+ end
534
+ end
535
+ end
536
+ end
537
+
538
+ # Query understanding specification.
539
+ # @!attribute [rw] query_classification_spec
540
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::QueryUnderstandingSpec::QueryClassificationSpec]
541
+ # Query classification specification.
542
+ # @!attribute [rw] query_rephraser_spec
543
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::QueryUnderstandingSpec::QueryRephraserSpec]
544
+ # Query rephraser specification.
545
+ class QueryUnderstandingSpec
546
+ include ::Google::Protobuf::MessageExts
547
+ extend ::Google::Protobuf::MessageExts::ClassMethods
548
+
549
+ # Query classification specification.
550
+ # @!attribute [rw] types
551
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::QueryUnderstandingSpec::QueryClassificationSpec::Type>]
552
+ # Enabled query classification types.
553
+ class QueryClassificationSpec
554
+ include ::Google::Protobuf::MessageExts
555
+ extend ::Google::Protobuf::MessageExts::ClassMethods
556
+
557
+ # Query classification types.
558
+ module Type
559
+ # Unspecified query classification type.
560
+ TYPE_UNSPECIFIED = 0
561
+
562
+ # Adversarial query classification type.
563
+ ADVERSARIAL_QUERY = 1
564
+
565
+ # Non-answer-seeking query classification type.
566
+ NON_ANSWER_SEEKING_QUERY = 2
567
+ end
568
+ end
569
+
570
+ # Query rephraser specification.
571
+ # @!attribute [rw] disable
572
+ # @return [::Boolean]
573
+ # Disable query rephraser.
574
+ # @!attribute [rw] max_rephrase_steps
575
+ # @return [::Integer]
576
+ # Max rephrase steps.
577
+ # The max number is 5 steps.
578
+ # If not set or set to < 1, it will be set to 1 by default.
579
+ class QueryRephraserSpec
580
+ include ::Google::Protobuf::MessageExts
581
+ extend ::Google::Protobuf::MessageExts::ClassMethods
582
+ end
583
+ end
584
+ end
585
+
586
+ # Response message for
587
+ # {::Google::Cloud::DiscoveryEngine::V1beta::ConversationalSearchService::Client#answer_query ConversationalSearchService.AnswerQuery}
588
+ # method.
589
+ # @!attribute [rw] answer
590
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::Answer]
591
+ # Answer resource object.
592
+ # If [AnswerQueryRequest.StepSpec.max_step_count][] is greater than 1,
593
+ # use {::Google::Cloud::DiscoveryEngine::V1beta::Answer#name Answer.name} to fetch
594
+ # answer information using
595
+ # {::Google::Cloud::DiscoveryEngine::V1beta::ConversationalSearchService::Client#get_answer ConversationalSearchService.GetAnswer}
596
+ # API.
597
+ # @!attribute [rw] session
598
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::Session]
599
+ # Session resource object.
600
+ # It will be only available when session field is set and valid in the
601
+ # {::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest AnswerQueryRequest}
602
+ # request.
603
+ # @!attribute [rw] answer_query_token
604
+ # @return [::String]
605
+ # A global unique ID used for logging.
606
+ class AnswerQueryResponse
607
+ include ::Google::Protobuf::MessageExts
608
+ extend ::Google::Protobuf::MessageExts::ClassMethods
609
+ end
610
+
611
+ # Request for GetAnswer method.
612
+ # @!attribute [rw] name
613
+ # @return [::String]
614
+ # Required. The resource name of the Answer to get. Format:
615
+ # `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`
616
+ class GetAnswerRequest
617
+ include ::Google::Protobuf::MessageExts
618
+ extend ::Google::Protobuf::MessageExts::ClassMethods
619
+ end
620
+
621
+ # Request for CreateSession method.
622
+ # @!attribute [rw] parent
623
+ # @return [::String]
624
+ # Required. Full resource name of parent data store. Format:
625
+ # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
626
+ # @!attribute [rw] session
627
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::Session]
628
+ # Required. The session to create.
629
+ class CreateSessionRequest
630
+ include ::Google::Protobuf::MessageExts
631
+ extend ::Google::Protobuf::MessageExts::ClassMethods
632
+ end
633
+
634
+ # Request for UpdateSession method.
635
+ # @!attribute [rw] session
636
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::Session]
637
+ # Required. The Session to update.
638
+ # @!attribute [rw] update_mask
639
+ # @return [::Google::Protobuf::FieldMask]
640
+ # Indicates which fields in the provided
641
+ # {::Google::Cloud::DiscoveryEngine::V1beta::Session Session} to update. The
642
+ # following are NOT supported:
643
+ #
644
+ # * {::Google::Cloud::DiscoveryEngine::V1beta::Session#name Session.name}
645
+ #
646
+ # If not set or empty, all supported fields are updated.
647
+ class UpdateSessionRequest
648
+ include ::Google::Protobuf::MessageExts
649
+ extend ::Google::Protobuf::MessageExts::ClassMethods
650
+ end
651
+
652
+ # Request for DeleteSession method.
653
+ # @!attribute [rw] name
654
+ # @return [::String]
655
+ # Required. The resource name of the Session to delete. Format:
656
+ # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
657
+ class DeleteSessionRequest
658
+ include ::Google::Protobuf::MessageExts
659
+ extend ::Google::Protobuf::MessageExts::ClassMethods
660
+ end
661
+
662
+ # Request for GetSession method.
663
+ # @!attribute [rw] name
664
+ # @return [::String]
665
+ # Required. The resource name of the Session to get. Format:
666
+ # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
667
+ class GetSessionRequest
668
+ include ::Google::Protobuf::MessageExts
669
+ extend ::Google::Protobuf::MessageExts::ClassMethods
670
+ end
671
+
672
+ # Request for ListSessions method.
673
+ # @!attribute [rw] parent
674
+ # @return [::String]
675
+ # Required. The data store resource name. Format:
676
+ # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
677
+ # @!attribute [rw] page_size
678
+ # @return [::Integer]
679
+ # Maximum number of results to return. If unspecified, defaults
680
+ # to 50. Max allowed value is 1000.
681
+ # @!attribute [rw] page_token
682
+ # @return [::String]
683
+ # A page token, received from a previous `ListSessions` call.
684
+ # Provide this to retrieve the subsequent page.
685
+ # @!attribute [rw] filter
686
+ # @return [::String]
687
+ # A filter to apply on the list results. The supported features are:
688
+ # user_pseudo_id, state.
689
+ #
690
+ # Example:
691
+ # "user_pseudo_id = some_id"
692
+ # @!attribute [rw] order_by
693
+ # @return [::String]
694
+ # A comma-separated list of fields to order by, sorted in ascending order.
695
+ # Use "desc" after a field name for descending.
696
+ # Supported fields:
697
+ # * `update_time`
698
+ # * `create_time`
699
+ # * `session_name`
700
+ #
701
+ # Example:
702
+ # "update_time desc"
703
+ # "create_time"
704
+ class ListSessionsRequest
705
+ include ::Google::Protobuf::MessageExts
706
+ extend ::Google::Protobuf::MessageExts::ClassMethods
707
+ end
708
+
709
+ # Response for ListSessions method.
710
+ # @!attribute [rw] sessions
711
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Session>]
712
+ # All the Sessions for a given data store.
713
+ # @!attribute [rw] next_page_token
714
+ # @return [::String]
715
+ # Pagination token, if not returned indicates the last page.
716
+ class ListSessionsResponse
717
+ include ::Google::Protobuf::MessageExts
718
+ extend ::Google::Protobuf::MessageExts::ClassMethods
719
+ end
229
720
  end
230
721
  end
231
722
  end