google-cloud-discovery_engine-v1beta 0.15.0 → 0.17.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (131) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +30 -20
  3. data/lib/google/cloud/discovery_engine/v1beta/completion_service/client.rb +186 -6
  4. data/lib/google/cloud/discovery_engine/v1beta/completion_service/operations.rb +12 -15
  5. data/lib/google/cloud/discovery_engine/v1beta/completion_service/paths.rb +62 -0
  6. data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/client.rb +179 -6
  7. data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/operations.rb +43 -38
  8. data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/service_stub.rb +131 -31
  9. data/lib/google/cloud/discovery_engine/v1beta/control_service/client.rb +35 -12
  10. data/lib/google/cloud/discovery_engine/v1beta/control_service/rest/client.rb +35 -12
  11. data/lib/google/cloud/discovery_engine/v1beta/control_service/rest/service_stub.rb +54 -32
  12. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/client.rb +48 -27
  13. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest/client.rb +48 -27
  14. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest/service_stub.rb +118 -80
  15. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/client.rb +31 -6
  16. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/operations.rb +12 -15
  17. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/rest/client.rb +31 -6
  18. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/rest/operations.rb +43 -38
  19. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/rest/service_stub.rb +54 -32
  20. data/lib/google/cloud/discovery_engine/v1beta/document_service/client.rb +31 -9
  21. data/lib/google/cloud/discovery_engine/v1beta/document_service/operations.rb +12 -15
  22. data/lib/google/cloud/discovery_engine/v1beta/document_service/paths.rb +25 -0
  23. data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/client.rb +31 -9
  24. data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/operations.rb +43 -38
  25. data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/service_stub.rb +78 -50
  26. data/lib/google/cloud/discovery_engine/v1beta/engine_service/client.rb +35 -12
  27. data/lib/google/cloud/discovery_engine/v1beta/engine_service/operations.rb +12 -15
  28. data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/client.rb +35 -12
  29. data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/operations.rb +43 -38
  30. data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/service_stub.rb +78 -50
  31. data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/client.rb +31 -5
  32. data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/operations.rb +12 -15
  33. data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/rest/client.rb +31 -5
  34. data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/rest/operations.rb +43 -38
  35. data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/rest/service_stub.rb +46 -26
  36. data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/client.rb +244 -6
  37. data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/paths.rb +85 -0
  38. data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/rest/client.rb +152 -6
  39. data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/rest/service_stub.rb +83 -7
  40. data/lib/google/cloud/discovery_engine/v1beta/project_service/client.rb +29 -2
  41. data/lib/google/cloud/discovery_engine/v1beta/project_service/operations.rb +12 -15
  42. data/lib/google/cloud/discovery_engine/v1beta/project_service/rest/client.rb +29 -2
  43. data/lib/google/cloud/discovery_engine/v1beta/project_service/rest/operations.rb +43 -38
  44. data/lib/google/cloud/discovery_engine/v1beta/project_service/rest/service_stub.rb +22 -8
  45. data/lib/google/cloud/discovery_engine/v1beta/rank_service/client.rb +29 -3
  46. data/lib/google/cloud/discovery_engine/v1beta/rank_service/rest/client.rb +29 -3
  47. data/lib/google/cloud/discovery_engine/v1beta/rank_service/rest/service_stub.rb +22 -8
  48. data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/client.rb +28 -2
  49. data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/rest/client.rb +28 -2
  50. data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/rest/service_stub.rb +22 -8
  51. data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/client.rb +30 -7
  52. data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/operations.rb +12 -15
  53. data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/rest/client.rb +30 -7
  54. data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/rest/operations.rb +43 -38
  55. data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/rest/service_stub.rb +62 -38
  56. data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service/client.rb +29 -6
  57. data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service/rest/client.rb +29 -6
  58. data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service/rest/service_stub.rb +54 -32
  59. data/lib/google/cloud/discovery_engine/v1beta/schema_service/client.rb +32 -6
  60. data/lib/google/cloud/discovery_engine/v1beta/schema_service/operations.rb +12 -15
  61. data/lib/google/cloud/discovery_engine/v1beta/schema_service/rest/client.rb +32 -6
  62. data/lib/google/cloud/discovery_engine/v1beta/schema_service/rest/operations.rb +43 -38
  63. data/lib/google/cloud/discovery_engine/v1beta/schema_service/rest/service_stub.rb +54 -32
  64. data/lib/google/cloud/discovery_engine/v1beta/search_service/client.rb +427 -3
  65. data/lib/google/cloud/discovery_engine/v1beta/search_service/rest/client.rb +417 -3
  66. data/lib/google/cloud/discovery_engine/v1beta/search_service/rest/service_stub.rb +99 -7
  67. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/client.rb +29 -3
  68. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/operations.rb +12 -15
  69. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/rest/client.rb +29 -3
  70. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/rest/operations.rb +43 -38
  71. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/rest/service_stub.rb +30 -14
  72. data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/client.rb +31 -6
  73. data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/rest/client.rb +31 -6
  74. data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/rest/service_stub.rb +38 -20
  75. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/client.rb +361 -14
  76. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/operations.rb +12 -15
  77. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/paths.rb +49 -0
  78. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/client.rb +340 -14
  79. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/operations.rb +43 -38
  80. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/service_stub.rb +308 -73
  81. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/client.rb +31 -6
  82. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/operations.rb +12 -15
  83. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/client.rb +31 -6
  84. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/operations.rb +43 -38
  85. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/service_stub.rb +46 -26
  86. data/lib/google/cloud/discovery_engine/v1beta/version.rb +1 -1
  87. data/lib/google/cloud/discoveryengine/v1beta/answer_pb.rb +1 -1
  88. data/lib/google/cloud/discoveryengine/v1beta/common_pb.rb +1 -1
  89. data/lib/google/cloud/discoveryengine/v1beta/completion_service_pb.rb +18 -1
  90. data/lib/google/cloud/discoveryengine/v1beta/completion_service_services_pb.rb +2 -0
  91. data/lib/google/cloud/discoveryengine/v1beta/control_pb.rb +1 -1
  92. data/lib/google/cloud/discoveryengine/v1beta/conversational_search_service_pb.rb +4 -1
  93. data/lib/google/cloud/discoveryengine/v1beta/custom_tuning_model_pb.rb +1 -1
  94. data/lib/google/cloud/discoveryengine/v1beta/data_store_pb.rb +7 -1
  95. data/lib/google/cloud/discoveryengine/v1beta/document_service_pb.rb +2 -1
  96. data/lib/google/cloud/discoveryengine/v1beta/engine_pb.rb +1 -1
  97. data/lib/google/cloud/discoveryengine/v1beta/grounded_generation_service_pb.rb +24 -1
  98. data/lib/google/cloud/discoveryengine/v1beta/grounded_generation_service_services_pb.rb +4 -0
  99. data/lib/google/cloud/discoveryengine/v1beta/grounding_pb.rb +2 -1
  100. data/lib/google/cloud/discoveryengine/v1beta/search_service_pb.rb +3 -1
  101. data/lib/google/cloud/discoveryengine/v1beta/search_service_services_pb.rb +14 -0
  102. data/lib/google/cloud/discoveryengine/v1beta/serving_config_pb.rb +2 -2
  103. data/lib/google/cloud/discoveryengine/v1beta/site_search_engine_pb.rb +2 -1
  104. data/lib/google/cloud/discoveryengine/v1beta/site_search_engine_service_pb.rb +10 -1
  105. data/lib/google/cloud/discoveryengine/v1beta/site_search_engine_service_services_pb.rb +7 -0
  106. data/lib/google/cloud/discoveryengine/v1beta/user_event_pb.rb +1 -1
  107. data/proto_docs/google/api/client.rb +39 -0
  108. data/proto_docs/google/cloud/discoveryengine/v1beta/answer.rb +20 -6
  109. data/proto_docs/google/cloud/discoveryengine/v1beta/completion_service.rb +268 -0
  110. data/proto_docs/google/cloud/discoveryengine/v1beta/control.rb +9 -0
  111. data/proto_docs/google/cloud/discoveryengine/v1beta/control_service.rb +6 -6
  112. data/proto_docs/google/cloud/discoveryengine/v1beta/conversational_search_service.rb +95 -15
  113. data/proto_docs/google/cloud/discoveryengine/v1beta/custom_tuning_model.rb +8 -3
  114. data/proto_docs/google/cloud/discoveryengine/v1beta/data_store.rb +131 -0
  115. data/proto_docs/google/cloud/discoveryengine/v1beta/document_processing_config.rb +7 -5
  116. data/proto_docs/google/cloud/discoveryengine/v1beta/document_service.rb +19 -0
  117. data/proto_docs/google/cloud/discoveryengine/v1beta/engine.rb +5 -1
  118. data/proto_docs/google/cloud/discoveryengine/v1beta/engine_service.rb +4 -4
  119. data/proto_docs/google/cloud/discoveryengine/v1beta/grounded_generation_service.rb +396 -1
  120. data/proto_docs/google/cloud/discoveryengine/v1beta/grounding.rb +10 -0
  121. data/proto_docs/google/cloud/discoveryengine/v1beta/project.rb +1 -1
  122. data/proto_docs/google/cloud/discoveryengine/v1beta/purge_config.rb +1 -1
  123. data/proto_docs/google/cloud/discoveryengine/v1beta/rank_service.rb +1 -1
  124. data/proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb +71 -0
  125. data/proto_docs/google/cloud/discoveryengine/v1beta/serving_config.rb +16 -0
  126. data/proto_docs/google/cloud/discoveryengine/v1beta/serving_config_service.rb +2 -2
  127. data/proto_docs/google/cloud/discoveryengine/v1beta/site_search_engine.rb +17 -0
  128. data/proto_docs/google/cloud/discoveryengine/v1beta/site_search_engine_service.rb +147 -1
  129. data/proto_docs/google/cloud/discoveryengine/v1beta/user_event.rb +9 -1
  130. data/proto_docs/google/longrunning/operations.rb +19 -14
  131. metadata +5 -5
@@ -111,6 +111,274 @@ module Google
111
111
  extend ::Google::Protobuf::MessageExts::ClassMethods
112
112
  end
113
113
  end
114
+
115
+ # Request message for
116
+ # {::Google::Cloud::DiscoveryEngine::V1beta::CompletionService::Client#advanced_complete_query CompletionService.AdvancedCompleteQuery}
117
+ # method.
118
+ # .
119
+ # @!attribute [rw] completion_config
120
+ # @return [::String]
121
+ # Required. The completion_config of the parent dataStore or engine resource
122
+ # name for which the completion is performed, such as
123
+ # `projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig`
124
+ # `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`.
125
+ # @!attribute [rw] query
126
+ # @return [::String]
127
+ # Required. The typeahead input used to fetch suggestions. Maximum length is
128
+ # 128 characters.
129
+ #
130
+ # The query can not be empty for most of the suggestion types. If it is
131
+ # empty, an `INVALID_ARGUMENT` error is returned. The exception is when the
132
+ # suggestion_types contains only the type `RECENT_SEARCH`, the query can
133
+ # be an empty string. The is called "zero prefix" feature, which returns
134
+ # user's recently searched queries given the empty query.
135
+ # @!attribute [rw] query_model
136
+ # @return [::String]
137
+ # Specifies the autocomplete data model. This overrides any model specified
138
+ # in the Configuration > Autocomplete section of the Cloud console. Currently
139
+ # supported values:
140
+ #
141
+ # * `document` - Using suggestions generated from user-imported documents.
142
+ # * `search-history` - Using suggestions generated from the past history of
143
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SearchService::Client#search SearchService.Search}
144
+ # API calls. Do not use it when there is no traffic for Search API.
145
+ # * `user-event` - Using suggestions generated from user-imported search
146
+ # events.
147
+ # * `document-completable` - Using suggestions taken directly from
148
+ # user-imported document fields marked as completable.
149
+ #
150
+ # Default values:
151
+ #
152
+ # * `document` is the default model for regular dataStores.
153
+ # * `search-history` is the default model for site search dataStores.
154
+ # @!attribute [rw] user_pseudo_id
155
+ # @return [::String]
156
+ # A unique identifier for tracking visitors. For example, this could be
157
+ # implemented with an HTTP cookie, which should be able to uniquely identify
158
+ # a visitor on a single device. This unique identifier should not change if
159
+ # the visitor logs in or out of the website.
160
+ #
161
+ # This field should NOT have a fixed value such as `unknown_visitor`.
162
+ #
163
+ # This should be the same identifier as
164
+ # {::Google::Cloud::DiscoveryEngine::V1beta::UserEvent#user_pseudo_id UserEvent.user_pseudo_id}
165
+ # and
166
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#user_pseudo_id SearchRequest.user_pseudo_id}.
167
+ #
168
+ # The field must be a UTF-8 encoded string with a length limit of 128
169
+ # @!attribute [rw] user_info
170
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::UserInfo]
171
+ # Optional. Information about the end user.
172
+ #
173
+ # This should be the same identifier information as
174
+ # {::Google::Cloud::DiscoveryEngine::V1beta::UserEvent#user_info UserEvent.user_info}
175
+ # and
176
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#user_info SearchRequest.user_info}.
177
+ # @!attribute [rw] include_tail_suggestions
178
+ # @return [::Boolean]
179
+ # Indicates if tail suggestions should be returned if there are no
180
+ # suggestions that match the full query. Even if set to true, if there are
181
+ # suggestions that match the full query, those are returned and no
182
+ # tail suggestions are returned.
183
+ # @!attribute [rw] boost_spec
184
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryRequest::BoostSpec]
185
+ # Optional. Specification to boost suggestions matching the condition.
186
+ # @!attribute [rw] suggestion_types
187
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryRequest::SuggestionType>]
188
+ # Optional. Suggestion types to return. If empty or unspecified, query
189
+ # suggestions are returned. Only one suggestion type is supported at the
190
+ # moment.
191
+ class AdvancedCompleteQueryRequest
192
+ include ::Google::Protobuf::MessageExts
193
+ extend ::Google::Protobuf::MessageExts::ClassMethods
194
+
195
+ # Specification to boost suggestions based on the condtion of the suggestion.
196
+ # @!attribute [rw] condition_boost_specs
197
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryRequest::BoostSpec::ConditionBoostSpec>]
198
+ # Condition boost specifications. If a suggestion matches multiple
199
+ # conditions in the specifictions, boost values from these specifications
200
+ # are all applied and combined in a non-linear way. Maximum number of
201
+ # specifications is 20.
202
+ #
203
+ # Note: Currently only support language condition boost.
204
+ class BoostSpec
205
+ include ::Google::Protobuf::MessageExts
206
+ extend ::Google::Protobuf::MessageExts::ClassMethods
207
+
208
+ # Boost applies to suggestions which match a condition.
209
+ # @!attribute [rw] condition
210
+ # @return [::String]
211
+ # An expression which specifies a boost condition. The syntax is the same
212
+ # as [filter expression
213
+ # syntax](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax).
214
+ # Currently, the only supported condition is a list of BCP-47 lang codes.
215
+ #
216
+ # Example:
217
+ #
218
+ # * To boost suggestions in languages `en` or `fr`:
219
+ # `(lang_code: ANY("en", "fr"))`
220
+ # @!attribute [rw] boost
221
+ # @return [::Float]
222
+ # Strength of the boost, which should be in [-1, 1].
223
+ # Negative boost means demotion. Default is 0.0.
224
+ #
225
+ # Setting to 1.0 gives the suggestions a big promotion. However, it does
226
+ # not necessarily mean that the top result will be a boosted suggestion.
227
+ #
228
+ # Setting to -1.0 gives the suggestions a big demotion. However, other
229
+ # suggestions that are relevant might still be shown.
230
+ #
231
+ # Setting to 0.0 means no boost applied. The boosting condition is
232
+ # ignored.
233
+ class ConditionBoostSpec
234
+ include ::Google::Protobuf::MessageExts
235
+ extend ::Google::Protobuf::MessageExts::ClassMethods
236
+ end
237
+ end
238
+
239
+ # Suggestion type to return.
240
+ module SuggestionType
241
+ # Default value.
242
+ SUGGESTION_TYPE_UNSPECIFIED = 0
243
+
244
+ # Returns query suggestions.
245
+ QUERY = 1
246
+
247
+ # Returns people suggestions.
248
+ PEOPLE = 2
249
+
250
+ # Returns content suggestions.
251
+ CONTENT = 3
252
+
253
+ # Returns recent search suggestions.
254
+ RECENT_SEARCH = 4
255
+
256
+ # Returns Google Workspace suggestions.
257
+ GOOGLE_WORKSPACE = 5
258
+ end
259
+ end
260
+
261
+ # Response message for
262
+ # {::Google::Cloud::DiscoveryEngine::V1beta::CompletionService::Client#advanced_complete_query CompletionService.AdvancedCompleteQuery}
263
+ # method.
264
+ # @!attribute [rw] query_suggestions
265
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryResponse::QuerySuggestion>]
266
+ # Results of the matched query suggestions. The result list is ordered and
267
+ # the first result is a top suggestion.
268
+ # @!attribute [rw] tail_match_triggered
269
+ # @return [::Boolean]
270
+ # True if the returned suggestions are all tail suggestions.
271
+ #
272
+ # For tail matching to be triggered, include_tail_suggestions in the request
273
+ # must be true and there must be no suggestions that match the full query.
274
+ # @!attribute [rw] people_suggestions
275
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryResponse::PersonSuggestion>]
276
+ # Results of the matched people suggestions. The result list is ordered and
277
+ # the first result is the top suggestion.
278
+ # @!attribute [rw] content_suggestions
279
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryResponse::ContentSuggestion>]
280
+ # Results of the matched content suggestions. The result list is ordered and
281
+ # the first result is the top suggestion.
282
+ # @!attribute [rw] recent_search_suggestions
283
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryResponse::RecentSearchSuggestion>]
284
+ # Results of the matched "recent search" suggestions. The result list is
285
+ # ordered and the first result is the top suggestion.
286
+ class AdvancedCompleteQueryResponse
287
+ include ::Google::Protobuf::MessageExts
288
+ extend ::Google::Protobuf::MessageExts::ClassMethods
289
+
290
+ # Suggestions as search queries.
291
+ # @!attribute [rw] suggestion
292
+ # @return [::String]
293
+ # The suggestion for the query.
294
+ # @!attribute [rw] completable_field_paths
295
+ # @return [::Array<::String>]
296
+ # The unique document field paths that serve as the source of this
297
+ # suggestion if it was generated from completable fields.
298
+ #
299
+ # This field is only populated for the document-completable model.
300
+ # @!attribute [rw] data_store
301
+ # @return [::Array<::String>]
302
+ # The name of the dataStore that this suggestion belongs to.
303
+ class QuerySuggestion
304
+ include ::Google::Protobuf::MessageExts
305
+ extend ::Google::Protobuf::MessageExts::ClassMethods
306
+ end
307
+
308
+ # Suggestions as people.
309
+ # @!attribute [rw] suggestion
310
+ # @return [::String]
311
+ # The suggestion for the query.
312
+ # @!attribute [rw] person_type
313
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryResponse::PersonSuggestion::PersonType]
314
+ # The type of the person.
315
+ # @!attribute [rw] document
316
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::Document]
317
+ # The document data snippet in the suggestion. Only a subset of fields is
318
+ # populated.
319
+ # @!attribute [rw] data_store
320
+ # @return [::String]
321
+ # The name of the dataStore that this suggestion belongs to.
322
+ class PersonSuggestion
323
+ include ::Google::Protobuf::MessageExts
324
+ extend ::Google::Protobuf::MessageExts::ClassMethods
325
+
326
+ # The type of the person based on the source.
327
+ module PersonType
328
+ # Default value.
329
+ PERSON_TYPE_UNSPECIFIED = 0
330
+
331
+ # The suggestion is from a GOOGLE_IDENTITY source.
332
+ CLOUD_IDENTITY = 1
333
+
334
+ # The suggestion is from a THIRD_PARTY_IDENTITY source.
335
+ THIRD_PARTY_IDENTITY = 2
336
+ end
337
+ end
338
+
339
+ # Suggestions as content.
340
+ # @!attribute [rw] suggestion
341
+ # @return [::String]
342
+ # The suggestion for the query.
343
+ # @!attribute [rw] content_type
344
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryResponse::ContentSuggestion::ContentType]
345
+ # The type of the content suggestion.
346
+ # @!attribute [rw] document
347
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::Document]
348
+ # The document data snippet in the suggestion. Only a subset of fields will
349
+ # be populated.
350
+ # @!attribute [rw] data_store
351
+ # @return [::String]
352
+ # The name of the dataStore that this suggestion belongs to.
353
+ class ContentSuggestion
354
+ include ::Google::Protobuf::MessageExts
355
+ extend ::Google::Protobuf::MessageExts::ClassMethods
356
+
357
+ # The type of the content returned for content suggestions.
358
+ module ContentType
359
+ # Default value.
360
+ CONTENT_TYPE_UNSPECIFIED = 0
361
+
362
+ # The suggestion is from a Google Workspace source.
363
+ GOOGLE_WORKSPACE = 1
364
+
365
+ # The suggestion is from a third party source.
366
+ THIRD_PARTY = 2
367
+ end
368
+ end
369
+
370
+ # Suggestions from recent search history.
371
+ # @!attribute [rw] suggestion
372
+ # @return [::String]
373
+ # The suggestion for the query.
374
+ # @!attribute [rw] recent_search_time
375
+ # @return [::Google::Protobuf::Timestamp]
376
+ # The time when this recent rearch happened.
377
+ class RecentSearchSuggestion
378
+ include ::Google::Protobuf::MessageExts
379
+ extend ::Google::Protobuf::MessageExts::ClassMethods
380
+ end
381
+ end
114
382
  end
115
383
  end
116
384
  end
@@ -26,6 +26,9 @@ module Google
26
26
  # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Condition::QueryTerm>]
27
27
  # Search only
28
28
  # A list of terms to match the query on.
29
+ # Cannot be set when
30
+ # {::Google::Cloud::DiscoveryEngine::V1beta::Condition#query_regex Condition.query_regex}
31
+ # is set.
29
32
  #
30
33
  # Maximum of 10 query terms.
31
34
  # @!attribute [rw] active_time_range
@@ -33,6 +36,12 @@ module Google
33
36
  # Range of time(s) specifying when condition is active.
34
37
  #
35
38
  # Maximum of 10 time ranges.
39
+ # @!attribute [rw] query_regex
40
+ # @return [::String]
41
+ # Optional. Query regex to match the whole search query.
42
+ # Cannot be set when
43
+ # {::Google::Cloud::DiscoveryEngine::V1beta::Condition#query_terms Condition.query_terms}
44
+ # is set. This is currently supporting promotion use case.
36
45
  class Condition
37
46
  include ::Google::Protobuf::MessageExts
38
47
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -25,9 +25,9 @@ module Google
25
25
  # @!attribute [rw] parent
26
26
  # @return [::String]
27
27
  # Required. Full resource name of parent data store. Format:
28
- # `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`
28
+ # `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`
29
29
  # or
30
- # `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.
30
+ # `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
31
31
  # @!attribute [rw] control
32
32
  # @return [::Google::Cloud::DiscoveryEngine::V1beta::Control]
33
33
  # Required. The Control to create.
@@ -66,7 +66,7 @@ module Google
66
66
  # @!attribute [rw] name
67
67
  # @return [::String]
68
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}`
69
+ # `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
70
70
  class DeleteControlRequest
71
71
  include ::Google::Protobuf::MessageExts
72
72
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -76,7 +76,7 @@ module Google
76
76
  # @!attribute [rw] name
77
77
  # @return [::String]
78
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}`
79
+ # `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
80
80
  class GetControlRequest
81
81
  include ::Google::Protobuf::MessageExts
82
82
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -86,9 +86,9 @@ module Google
86
86
  # @!attribute [rw] parent
87
87
  # @return [::String]
88
88
  # Required. The data store resource name. Format:
89
- # `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`
89
+ # `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`
90
90
  # or
91
- # `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.
91
+ # `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
92
92
  # @!attribute [rw] page_size
93
93
  # @return [::Integer]
94
94
  # Optional. Maximum number of results to return. If unspecified, defaults
@@ -27,9 +27,9 @@ module Google
27
27
  # @!attribute [rw] name
28
28
  # @return [::String]
29
29
  # Required. The resource name of the Conversation to get. Format:
30
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`.
30
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`.
31
31
  # Use
32
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-`
32
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-`
33
33
  # to activate auto session mode, which automatically creates a new
34
34
  # conversation inside a ConverseConversation session.
35
35
  # @!attribute [rw] query
@@ -38,7 +38,7 @@ module Google
38
38
  # @!attribute [rw] serving_config
39
39
  # @return [::String]
40
40
  # The resource name of the Serving Config to use. Format:
41
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`
41
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`
42
42
  # If this is not set, the default serving config will be used.
43
43
  # @!attribute [rw] conversation
44
44
  # @return [::Google::Cloud::DiscoveryEngine::V1beta::Conversation]
@@ -131,7 +131,7 @@ module Google
131
131
  # @!attribute [rw] parent
132
132
  # @return [::String]
133
133
  # Required. Full resource name of parent data store. Format:
134
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
134
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
135
135
  # @!attribute [rw] conversation
136
136
  # @return [::Google::Cloud::DiscoveryEngine::V1beta::Conversation]
137
137
  # Required. The conversation to create.
@@ -162,7 +162,7 @@ module Google
162
162
  # @!attribute [rw] name
163
163
  # @return [::String]
164
164
  # Required. The resource name of the Conversation to delete. Format:
165
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
165
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
166
166
  class DeleteConversationRequest
167
167
  include ::Google::Protobuf::MessageExts
168
168
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -172,7 +172,7 @@ module Google
172
172
  # @!attribute [rw] name
173
173
  # @return [::String]
174
174
  # Required. The resource name of the Conversation to get. Format:
175
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
175
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
176
176
  class GetConversationRequest
177
177
  include ::Google::Protobuf::MessageExts
178
178
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -182,7 +182,7 @@ module Google
182
182
  # @!attribute [rw] parent
183
183
  # @return [::String]
184
184
  # Required. The data store resource name. Format:
185
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
185
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
186
186
  # @!attribute [rw] page_size
187
187
  # @return [::Integer]
188
188
  # Maximum number of results to return. If unspecified, defaults
@@ -255,6 +255,9 @@ module Google
255
255
  # @!attribute [rw] related_questions_spec
256
256
  # @return [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::RelatedQuestionsSpec]
257
257
  # Related questions specification.
258
+ # @!attribute [rw] grounding_spec
259
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::GroundingSpec]
260
+ # Optional. Grounding specification.
258
261
  # @!attribute [rw] answer_generation_spec
259
262
  # @return [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::AnswerGenerationSpec]
260
263
  # Answer generation specification.
@@ -265,7 +268,11 @@ module Google
265
268
  # @return [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::QueryUnderstandingSpec]
266
269
  # Query understanding specification.
267
270
  # @!attribute [rw] asynchronous_mode
271
+ # @deprecated This field is deprecated and may be removed in the next major version update.
268
272
  # @return [::Boolean]
273
+ # Deprecated: This field is deprecated. Streaming Answer API will be
274
+ # supported.
275
+ #
269
276
  # Asynchronous mode control.
270
277
  #
271
278
  # If enabled, the response will be returned with answer/session resource
@@ -328,6 +335,35 @@ module Google
328
335
  extend ::Google::Protobuf::MessageExts::ClassMethods
329
336
  end
330
337
 
338
+ # Grounding specification.
339
+ # @!attribute [rw] include_grounding_supports
340
+ # @return [::Boolean]
341
+ # Optional. Specifies whether to include grounding_supports in the answer.
342
+ # The default value is `false`.
343
+ #
344
+ # When this field is set to `true`, returned answer will have
345
+ # `grounding_score` and will contain GroundingSupports for each claim.
346
+ # @!attribute [rw] filtering_level
347
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::GroundingSpec::FilteringLevel]
348
+ # Optional. Specifies whether to enable the filtering based on grounding
349
+ # score and at what level.
350
+ class GroundingSpec
351
+ include ::Google::Protobuf::MessageExts
352
+ extend ::Google::Protobuf::MessageExts::ClassMethods
353
+
354
+ # Level to filter based on answer grounding.
355
+ module FilteringLevel
356
+ # Default is no filter
357
+ FILTERING_LEVEL_UNSPECIFIED = 0
358
+
359
+ # Filter answers based on a low threshold.
360
+ FILTERING_LEVEL_LOW = 1
361
+
362
+ # Filter answers based on a high threshold.
363
+ FILTERING_LEVEL_HIGH = 2
364
+ end
365
+ end
366
+
331
367
  # Answer generation specification.
332
368
  # @!attribute [rw] model_spec
333
369
  # @return [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::AnswerGenerationSpec::ModelSpec]
@@ -373,6 +409,19 @@ module Google
373
409
  # If this field is set to `false`, all search results are used regardless
374
410
  # of relevance to generate answers. If set to `true` or unset, the behavior
375
411
  # will be determined automatically by the service.
412
+ # @!attribute [rw] ignore_jail_breaking_query
413
+ # @return [::Boolean]
414
+ # Optional. Specifies whether to filter out jail-breaking queries. The
415
+ # default value is `false`.
416
+ #
417
+ # Google employs search-query classification to detect jail-breaking
418
+ # queries. No summary is returned if the search query is classified as a
419
+ # jail-breaking query. A user might add instructions to the query to
420
+ # change the tone, style, language, content of the answer, or ask the
421
+ # model to act as a different entity, e.g. "Reply in the tone of a
422
+ # competing company's CEO". If this field is set to `true`, we skip
423
+ # generating summaries for jail-breaking queries and return fallback
424
+ # messages instead.
376
425
  class AnswerGenerationSpec
377
426
  include ::Google::Protobuf::MessageExts
378
427
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -459,6 +508,10 @@ module Google
459
508
  # configurations for those dataStores. This is only considered for
460
509
  # engines with multiple dataStores use case. For single dataStore within
461
510
  # an engine, they should use the specs at the top level.
511
+ # @!attribute [rw] natural_language_query_understanding_spec
512
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::NaturalLanguageQueryUnderstandingSpec]
513
+ # Optional. Specification to enable natural language understanding
514
+ # capabilities for search requests.
462
515
  class SearchParams
463
516
  include ::Google::Protobuf::MessageExts
464
517
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -495,12 +548,18 @@ module Google
495
548
  # Title.
496
549
  # @!attribute [rw] document_contexts
497
550
  # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::SearchSpec::SearchResultList::SearchResult::UnstructuredDocumentInfo::DocumentContext>]
498
- # List of document contexts.
551
+ # List of document contexts. The content will be used for Answer
552
+ # Generation. This is supposed to be the main content of the document
553
+ # that can be long and comprehensive.
499
554
  # @!attribute [rw] extractive_segments
500
555
  # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::SearchSpec::SearchResultList::SearchResult::UnstructuredDocumentInfo::ExtractiveSegment>]
501
556
  # List of extractive segments.
502
557
  # @!attribute [rw] extractive_answers
558
+ # @deprecated This field is deprecated and may be removed in the next major version update.
503
559
  # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::SearchSpec::SearchResultList::SearchResult::UnstructuredDocumentInfo::ExtractiveAnswer>]
560
+ # Deprecated: This field is deprecated and will have no effect on
561
+ # the Answer generation.
562
+ # Please use document_contexts and extractive_segments fields.
504
563
  # List of extractive answers.
505
564
  class UnstructuredDocumentInfo
506
565
  include ::Google::Protobuf::MessageExts
@@ -512,7 +571,7 @@ module Google
512
571
  # Page identifier.
513
572
  # @!attribute [rw] content
514
573
  # @return [::String]
515
- # Document content.
574
+ # Document content to be used for answer generation.
516
575
  class DocumentContext
517
576
  include ::Google::Protobuf::MessageExts
518
577
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -520,6 +579,8 @@ module Google
520
579
 
521
580
  # Extractive segment.
522
581
  # [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments)
582
+ # Answer generation will only use it if document_contexts is empty.
583
+ # This is supposed to be shorter snippets.
523
584
  # @!attribute [rw] page_identifier
524
585
  # @return [::String]
525
586
  # Page identifier.
@@ -552,9 +613,25 @@ module Google
552
613
  # @!attribute [rw] content
553
614
  # @return [::String]
554
615
  # Chunk textual content.
616
+ # @!attribute [rw] document_metadata
617
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::SearchSpec::SearchResultList::SearchResult::ChunkInfo::DocumentMetadata]
618
+ # Metadata of the document from the current chunk.
555
619
  class ChunkInfo
556
620
  include ::Google::Protobuf::MessageExts
557
621
  extend ::Google::Protobuf::MessageExts::ClassMethods
622
+
623
+ # Document metadata contains the information of the document of the
624
+ # current chunk.
625
+ # @!attribute [rw] uri
626
+ # @return [::String]
627
+ # Uri of the document.
628
+ # @!attribute [rw] title
629
+ # @return [::String]
630
+ # Title of the document.
631
+ class DocumentMetadata
632
+ include ::Google::Protobuf::MessageExts
633
+ extend ::Google::Protobuf::MessageExts::ClassMethods
634
+ end
558
635
  end
559
636
  end
560
637
  end
@@ -587,11 +664,14 @@ module Google
587
664
  # Adversarial query classification type.
588
665
  ADVERSARIAL_QUERY = 1
589
666
 
590
- # Non-answer-seeking query classification type.
667
+ # Non-answer-seeking query classification type, for chit chat.
591
668
  NON_ANSWER_SEEKING_QUERY = 2
592
669
 
593
670
  # Jail-breaking query classification type.
594
671
  JAIL_BREAKING_QUERY = 3
672
+
673
+ # Non-answer-seeking query classification type, for no clear intent.
674
+ NON_ANSWER_SEEKING_QUERY_V2 = 4
595
675
  end
596
676
  end
597
677
 
@@ -651,7 +731,7 @@ module Google
651
731
  # @!attribute [rw] name
652
732
  # @return [::String]
653
733
  # Required. The resource name of the Answer to get. Format:
654
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`
734
+ # `projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`
655
735
  class GetAnswerRequest
656
736
  include ::Google::Protobuf::MessageExts
657
737
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -661,7 +741,7 @@ module Google
661
741
  # @!attribute [rw] parent
662
742
  # @return [::String]
663
743
  # Required. Full resource name of parent data store. Format:
664
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
744
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
665
745
  # @!attribute [rw] session
666
746
  # @return [::Google::Cloud::DiscoveryEngine::V1beta::Session]
667
747
  # Required. The session to create.
@@ -692,7 +772,7 @@ module Google
692
772
  # @!attribute [rw] name
693
773
  # @return [::String]
694
774
  # Required. The resource name of the Session to delete. Format:
695
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
775
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
696
776
  class DeleteSessionRequest
697
777
  include ::Google::Protobuf::MessageExts
698
778
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -702,7 +782,7 @@ module Google
702
782
  # @!attribute [rw] name
703
783
  # @return [::String]
704
784
  # Required. The resource name of the Session to get. Format:
705
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
785
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
706
786
  class GetSessionRequest
707
787
  include ::Google::Protobuf::MessageExts
708
788
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -712,7 +792,7 @@ module Google
712
792
  # @!attribute [rw] parent
713
793
  # @return [::String]
714
794
  # Required. The data store resource name. Format:
715
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
795
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
716
796
  # @!attribute [rw] page_size
717
797
  # @return [::Integer]
718
798
  # Maximum number of results to return. If unspecified, defaults
@@ -27,8 +27,9 @@ module Google
27
27
  # Required. The fully qualified resource name of the model.
28
28
  #
29
29
  # Format:
30
- # `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`
31
- # model must be an alpha-numerical string with limit of 40 characters.
30
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`.
31
+ #
32
+ # Model must be an alpha-numerical string with limit of 40 characters.
32
33
  # @!attribute [rw] display_name
33
34
  # @return [::String]
34
35
  # The display name of the model.
@@ -41,13 +42,17 @@ module Google
41
42
  # @!attribute [rw] create_time
42
43
  # @deprecated This field is deprecated and may be removed in the next major version update.
43
44
  # @return [::Google::Protobuf::Timestamp]
44
- # Timestamp the Model was created at.
45
+ # Deprecated: Timestamp the Model was created at.
45
46
  # @!attribute [rw] training_start_time
46
47
  # @return [::Google::Protobuf::Timestamp]
47
48
  # Timestamp the model training was initiated.
48
49
  # @!attribute [rw] metrics
49
50
  # @return [::Google::Protobuf::Map{::String => ::Float}]
50
51
  # The metrics of the trained model.
52
+ # @!attribute [rw] error_message
53
+ # @return [::String]
54
+ # Currently this is only populated if the model state is
55
+ # `INPUT_VALIDATION_FAILED`.
51
56
  class CustomTuningModel
52
57
  include ::Google::Protobuf::MessageExts
53
58
  extend ::Google::Protobuf::MessageExts::ClassMethods