google-cloud-discovery_engine-v1beta 0.3.0 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/google/cloud/discovery_engine/v1beta/completion_service/client.rb +7 -3
- data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/client.rb +7 -3
- data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/client.rb +925 -0
- data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/credentials.rb +47 -0
- data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/paths.rb +176 -0
- data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest/client.rb +763 -0
- data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest/service_stub.rb +450 -0
- data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest.rb +52 -0
- data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service.rb +55 -0
- data/lib/google/cloud/discovery_engine/v1beta/document_service/client.rb +5 -4
- data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/client.rb +5 -4
- data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/operations.rb +42 -0
- data/lib/google/cloud/discovery_engine/v1beta/rest.rb +2 -1
- data/lib/google/cloud/discovery_engine/v1beta/schema_service/rest/operations.rb +42 -0
- data/lib/google/cloud/discovery_engine/v1beta/search_service/client.rb +14 -12
- data/lib/google/cloud/discovery_engine/v1beta/search_service/rest/client.rb +14 -12
- data/lib/google/cloud/discovery_engine/v1beta/user_event_service/client.rb +2 -2
- data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/client.rb +2 -2
- data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/operations.rb +42 -0
- data/lib/google/cloud/discovery_engine/v1beta/version.rb +1 -1
- data/lib/google/cloud/discovery_engine/v1beta.rb +2 -1
- data/lib/google/cloud/discoveryengine/v1beta/completion_service_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/conversation_pb.rb +53 -0
- data/lib/google/cloud/discoveryengine/v1beta/conversational_search_service_pb.rb +61 -0
- data/lib/google/cloud/discoveryengine/v1beta/conversational_search_service_services_pb.rb +67 -0
- data/lib/google/cloud/discoveryengine/v1beta/search_service_pb.rb +3 -1
- data/lib/google/cloud/discoveryengine/v1beta/user_event_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/user_event_service_services_pb.rb +1 -1
- data/proto_docs/google/cloud/discoveryengine/v1beta/common.rb +1 -2
- data/proto_docs/google/cloud/discoveryengine/v1beta/completion_service.rb +13 -2
- data/proto_docs/google/cloud/discoveryengine/v1beta/conversation.rb +134 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/conversational_search_service.rb +175 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/document.rb +2 -4
- data/proto_docs/google/cloud/discoveryengine/v1beta/document_service.rb +2 -1
- data/proto_docs/google/cloud/discoveryengine/v1beta/import_config.rb +17 -17
- data/proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb +161 -60
- data/proto_docs/google/cloud/discoveryengine/v1beta/user_event.rb +37 -29
- data/proto_docs/google/cloud/discoveryengine/v1beta/user_event_service.rb +1 -1
- data/proto_docs/google/protobuf/field_mask.rb +229 -0
- metadata +15 -2
@@ -40,11 +40,14 @@ module Google
|
|
40
40
|
# @!attribute [rw] query
|
41
41
|
# @return [::String]
|
42
42
|
# Raw search query.
|
43
|
+
# @!attribute [rw] image_query
|
44
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ImageQuery]
|
45
|
+
# Raw image query.
|
43
46
|
# @!attribute [rw] page_size
|
44
47
|
# @return [::Integer]
|
45
48
|
# Maximum number of {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}s
|
46
49
|
# to return. If unspecified, defaults to a reasonable value. The maximum
|
47
|
-
# allowed value is 100. Values above 100
|
50
|
+
# allowed value is 100. Values above 100 are coerced to 100.
|
48
51
|
#
|
49
52
|
# If this field is negative, an `INVALID_ARGUMENT` is returned.
|
50
53
|
# @!attribute [rw] page_token
|
@@ -76,17 +79,18 @@ module Google
|
|
76
79
|
# If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
77
80
|
# @!attribute [rw] order_by
|
78
81
|
# @return [::String]
|
79
|
-
# The order in which documents are returned.
|
82
|
+
# The order in which documents are returned. Documents can be ordered by
|
80
83
|
# a field in an {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}
|
81
|
-
# object. Leave it unset if ordered by relevance.
|
84
|
+
# object. Leave it unset if ordered by relevance. `order_by` expression is
|
82
85
|
# case-sensitive.
|
83
86
|
#
|
84
|
-
# If this field is unrecognizable, an
|
87
|
+
# If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
85
88
|
# @!attribute [rw] user_info
|
86
89
|
# @return [::Google::Cloud::DiscoveryEngine::V1beta::UserInfo]
|
87
90
|
# Information about the end user.
|
88
|
-
# Highly recommended for analytics.
|
89
|
-
#
|
91
|
+
# Highly recommended for analytics.
|
92
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::UserInfo#user_agent UserInfo.user_agent}
|
93
|
+
# is used to deduce `device_type` for analytics.
|
90
94
|
# @!attribute [rw] facet_specs
|
91
95
|
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec>]
|
92
96
|
# Facet specifications for faceted search. If empty, no facets are returned.
|
@@ -110,11 +114,11 @@ module Google
|
|
110
114
|
# @!attribute [rw] query_expansion_spec
|
111
115
|
# @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec]
|
112
116
|
# The query expansion specification that specifies the conditions under which
|
113
|
-
# query expansion
|
117
|
+
# query expansion occurs.
|
114
118
|
# @!attribute [rw] spell_correction_spec
|
115
119
|
# @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec]
|
116
120
|
# The spell correction specification that specifies the mode under
|
117
|
-
# which spell correction
|
121
|
+
# which spell correction takes effect.
|
118
122
|
# @!attribute [rw] user_pseudo_id
|
119
123
|
# @return [::String]
|
120
124
|
# A unique identifier for tracking visitors. For example, this could be
|
@@ -133,12 +137,11 @@ module Google
|
|
133
137
|
# characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
134
138
|
# @!attribute [rw] content_search_spec
|
135
139
|
# @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec]
|
136
|
-
#
|
137
|
-
# search.
|
140
|
+
# A specification for configuring the behavior of content search.
|
138
141
|
# @!attribute [rw] safe_search
|
139
142
|
# @return [::Boolean]
|
140
143
|
# Whether to turn on safe search. This is only supported for
|
141
|
-
#
|
144
|
+
# website search.
|
142
145
|
# @!attribute [rw] user_labels
|
143
146
|
# @return [::Google::Protobuf::Map{::String => ::String}]
|
144
147
|
# The user labels applied to a resource must meet the following requirements:
|
@@ -162,6 +165,16 @@ module Google
|
|
162
165
|
include ::Google::Protobuf::MessageExts
|
163
166
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
164
167
|
|
168
|
+
# Specifies the image query input.
|
169
|
+
# @!attribute [rw] image_bytes
|
170
|
+
# @return [::String]
|
171
|
+
# Base64 encoded image bytes. Supported image formats: JPEG, PNG, and
|
172
|
+
# BMP.
|
173
|
+
class ImageQuery
|
174
|
+
include ::Google::Protobuf::MessageExts
|
175
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
176
|
+
end
|
177
|
+
|
165
178
|
# A facet specification to perform faceted search.
|
166
179
|
# @!attribute [rw] facet_key
|
167
180
|
# @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey]
|
@@ -170,7 +183,7 @@ module Google
|
|
170
183
|
# @return [::Integer]
|
171
184
|
# Maximum of facet values that should be returned for this facet. If
|
172
185
|
# unspecified, defaults to 20. The maximum allowed value is 300. Values
|
173
|
-
# above 300
|
186
|
+
# above 300 are coerced to 300.
|
174
187
|
#
|
175
188
|
# If this field is negative, an `INVALID_ARGUMENT` is returned.
|
176
189
|
# @!attribute [rw] excluded_filter_keys
|
@@ -207,15 +220,15 @@ module Google
|
|
207
220
|
# @return [::Boolean]
|
208
221
|
# Enables dynamic position for this facet. If set to true, the position of
|
209
222
|
# this facet among all facets in the response is determined automatically.
|
210
|
-
#
|
211
|
-
#
|
212
|
-
# response
|
223
|
+
# If dynamic facets are enabled, it is ordered together.
|
224
|
+
# If set to false, the position of this facet in the
|
225
|
+
# response is the same as in the request, and it is ranked before
|
213
226
|
# the facets with dynamic position enable and all dynamic facets.
|
214
227
|
#
|
215
228
|
# For example, you may always want to have rating facet returned in
|
216
229
|
# the response, but it's not necessarily to always display the rating facet
|
217
230
|
# at the top. In that case, you can set enable_dynamic_position to true so
|
218
|
-
# that the position of rating facet in response
|
231
|
+
# that the position of rating facet in response is determined
|
219
232
|
# automatically.
|
220
233
|
#
|
221
234
|
# Another example, assuming you have the following facets in the request:
|
@@ -226,13 +239,13 @@ module Google
|
|
226
239
|
#
|
227
240
|
# * "brands", enable_dynamic_position = false
|
228
241
|
#
|
229
|
-
# And also you have a dynamic facets
|
230
|
-
#
|
242
|
+
# And also you have a dynamic facets enabled, which generates a facet
|
243
|
+
# `gender`. Then the final order of the facets in the response can be
|
231
244
|
# ("price", "brands", "rating", "gender") or ("price", "brands", "gender",
|
232
245
|
# "rating") depends on how API orders "gender" and "rating" facets.
|
233
|
-
# However, notice that "price" and "brands"
|
234
|
-
# ranked at
|
235
|
-
# false.
|
246
|
+
# However, notice that "price" and "brands" are always
|
247
|
+
# ranked at first and second position because their enable_dynamic_position
|
248
|
+
# is false.
|
236
249
|
class FacetSpec
|
237
250
|
include ::Google::Protobuf::MessageExts
|
238
251
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -245,7 +258,7 @@ module Google
|
|
245
258
|
# which the facet values are computed. Facet key is case-sensitive.
|
246
259
|
# @!attribute [rw] intervals
|
247
260
|
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Interval>]
|
248
|
-
# Set only if values should be
|
261
|
+
# Set only if values should be bucketed into intervals. Must be set
|
249
262
|
# for facets with numerical values. Must not be set for facet with text
|
250
263
|
# values. Maximum number of intervals is 30.
|
251
264
|
# @!attribute [rw] restricted_values
|
@@ -253,22 +266,22 @@ module Google
|
|
253
266
|
# Only get facet for the given restricted values. Only supported on
|
254
267
|
# textual fields. For example, suppose "category" has three values
|
255
268
|
# "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set
|
256
|
-
# "restricted_values" to "Action > 2022", the "category" facet
|
257
|
-
#
|
269
|
+
# "restricted_values" to "Action > 2022", the "category" facet only
|
270
|
+
# contains "Action > 2022". Only supported on textual fields. Maximum
|
258
271
|
# is 10.
|
259
272
|
# @!attribute [rw] prefixes
|
260
273
|
# @return [::Array<::String>]
|
261
274
|
# Only get facet values that start with the given string prefix. For
|
262
275
|
# example, suppose "category" has three values "Action > 2022",
|
263
276
|
# "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the
|
264
|
-
# "category" facet
|
277
|
+
# "category" facet only contains "Action > 2022" and "Action > 2021".
|
265
278
|
# Only supported on textual fields. Maximum is 10.
|
266
279
|
# @!attribute [rw] contains
|
267
280
|
# @return [::Array<::String>]
|
268
281
|
# Only get facet values that contains the given strings. For example,
|
269
282
|
# suppose "category" has three values "Action > 2022",
|
270
283
|
# "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the
|
271
|
-
# "category" facet
|
284
|
+
# "category" facet only contains "Action > 2022" and "Sci-Fi > 2022".
|
272
285
|
# Only supported on textual fields. Maximum is 10.
|
273
286
|
# @!attribute [rw] case_insensitive
|
274
287
|
# @return [::Boolean]
|
@@ -405,15 +418,14 @@ module Google
|
|
405
418
|
end
|
406
419
|
end
|
407
420
|
|
408
|
-
#
|
409
|
-
# search.
|
421
|
+
# A specification for configuring the behavior of content search.
|
410
422
|
# @!attribute [rw] snippet_spec
|
411
423
|
# @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SnippetSpec]
|
412
|
-
# If
|
413
|
-
# search
|
424
|
+
# If `snippetSpec` is not specified, snippets are not included in the
|
425
|
+
# search response.
|
414
426
|
# @!attribute [rw] summary_spec
|
415
427
|
# @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec]
|
416
|
-
# If
|
428
|
+
# If `summarySpec` is not specified, summaries are not included in the
|
417
429
|
# search response.
|
418
430
|
# @!attribute [rw] extractive_content_spec
|
419
431
|
# @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::ExtractiveContentSpec]
|
@@ -423,68 +435,123 @@ module Google
|
|
423
435
|
include ::Google::Protobuf::MessageExts
|
424
436
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
425
437
|
|
426
|
-
#
|
438
|
+
# A specification for configuring snippets in a search response.
|
427
439
|
# @!attribute [rw] max_snippet_count
|
428
440
|
# @return [::Integer]
|
429
|
-
#
|
430
|
-
#
|
431
|
-
#
|
432
|
-
# UI rendering.
|
433
|
-
#
|
434
|
-
# If the matching snippets is less than the max_snippet_count, return all
|
435
|
-
# of the snippets; otherwise, return the max_snippet_count.
|
436
|
-
#
|
437
|
-
# At most 5 snippets will be returned for each SearchResult.
|
441
|
+
# [DEPRECATED] This field is deprecated. To control snippet return, use
|
442
|
+
# `return_snippet` field. For backwards compatibility, we will return
|
443
|
+
# snippet if max_snippet_count > 0.
|
438
444
|
# @!attribute [rw] reference_only
|
439
445
|
# @return [::Boolean]
|
440
|
-
#
|
446
|
+
# [DEPRECATED] This field is deprecated and will have no affect on the
|
447
|
+
# snippet.
|
448
|
+
# @!attribute [rw] return_snippet
|
449
|
+
# @return [::Boolean]
|
450
|
+
# If `true`, then return snippet. If no snippet can be generated, we
|
451
|
+
# return "No snippet is available for this page." A `snippet_status` with
|
452
|
+
# `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.
|
441
453
|
class SnippetSpec
|
442
454
|
include ::Google::Protobuf::MessageExts
|
443
455
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
444
456
|
end
|
445
457
|
|
446
|
-
#
|
458
|
+
# A specification for configuring a summary returned in a search
|
459
|
+
# response.
|
447
460
|
# @!attribute [rw] summary_result_count
|
448
461
|
# @return [::Integer]
|
449
|
-
# The number of top results the summary
|
450
|
-
#
|
451
|
-
#
|
452
|
-
#
|
462
|
+
# The number of top results to generate the summary from. If the number
|
463
|
+
# of results returned is less than `summaryResultCount`, the summary is
|
464
|
+
# generated from all of the results.
|
465
|
+
#
|
466
|
+
# At most five results can be used to generate a summary.
|
467
|
+
# @!attribute [rw] include_citations
|
468
|
+
# @return [::Boolean]
|
469
|
+
# Specifies whether to include citations in the summary. The default
|
470
|
+
# value is `false`.
|
453
471
|
#
|
454
|
-
#
|
472
|
+
# When this field is set to `true`, summaries include in-line citation
|
473
|
+
# numbers.
|
474
|
+
#
|
475
|
+
# Example summary including citations:
|
476
|
+
#
|
477
|
+
# BigQuery is Google Cloud's fully managed and completely serverless
|
478
|
+
# enterprise data warehouse [1]. BigQuery supports all data types, works
|
479
|
+
# across clouds, and has built-in machine learning and business
|
480
|
+
# intelligence, all within a unified platform [2, 3].
|
481
|
+
#
|
482
|
+
# The citation numbers refer to the returned search results and are
|
483
|
+
# 1-indexed. For example, [1] means that the sentence is attributed to
|
484
|
+
# the first search result. [2, 3] means that the sentence is attributed
|
485
|
+
# to both the second and third search results.
|
486
|
+
# @!attribute [rw] ignore_adversarial_query
|
487
|
+
# @return [::Boolean]
|
488
|
+
# Specifies whether to filter out adversarial queries. The default value
|
489
|
+
# is `false`.
|
490
|
+
#
|
491
|
+
# Google employs search-query classification to detect adversarial
|
492
|
+
# queries. No summary is returned if the search query is classified as an
|
493
|
+
# adversarial query. For example, a user might ask a question regarding
|
494
|
+
# negative comments about the company or submit a query designed to
|
495
|
+
# generate unsafe, policy-violating output. If this field is set to
|
496
|
+
# `true`, we skip generating summaries for adversarial queries and return
|
497
|
+
# fallback messages instead.
|
498
|
+
# @!attribute [rw] ignore_non_summary_seeking_query
|
499
|
+
# @return [::Boolean]
|
500
|
+
# Specifies whether to filter out queries that are not summary-seeking.
|
501
|
+
# The default value is `false`.
|
502
|
+
#
|
503
|
+
# Google employs search-query classification to detect summary-seeking
|
504
|
+
# queries. No summary is returned if the search query is classified as a
|
505
|
+
# non-summary seeking query. For example, `why is the sky blue` and `Who
|
506
|
+
# is the best soccer player in the world?` are summary-seeking queries,
|
507
|
+
# but `SFO airport` and `world cup 2026` are not. They are most likely
|
508
|
+
# navigational queries. If this field is set to `true`, we skip
|
509
|
+
# generating summaries for non-summary seeking queries and return
|
510
|
+
# fallback messages instead.
|
455
511
|
class SummarySpec
|
456
512
|
include ::Google::Protobuf::MessageExts
|
457
513
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
458
514
|
end
|
459
515
|
|
460
|
-
#
|
516
|
+
# A specification for configuring the extractive content in a search
|
517
|
+
# response.
|
461
518
|
# @!attribute [rw] max_extractive_answer_count
|
462
519
|
# @return [::Integer]
|
463
|
-
# The
|
520
|
+
# The maximum number of extractive answers returned in each search
|
521
|
+
# result.
|
464
522
|
#
|
465
523
|
# An extractive answer is a verbatim answer extracted from the original
|
466
|
-
# document, which provides precise and contextually relevant answer to
|
524
|
+
# document, which provides a precise and contextually relevant answer to
|
467
525
|
# the search query.
|
468
526
|
#
|
469
527
|
# If the number of matching answers is less than the
|
470
|
-
#
|
471
|
-
# the
|
528
|
+
# `max_extractive_answer_count`, return all of the answers. Otherwise,
|
529
|
+
# return the `max_extractive_answer_count`.
|
472
530
|
#
|
473
|
-
# At most
|
531
|
+
# At most one answer is returned for each
|
532
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SearchResult SearchResult}.
|
474
533
|
# @!attribute [rw] max_extractive_segment_count
|
475
534
|
# @return [::Integer]
|
476
535
|
# The max number of extractive segments returned in each search result.
|
536
|
+
# Only applied if the
|
537
|
+
# [DataStore][google.cloud.discoveryengine.v1beta.DataStore] is set to
|
538
|
+
# [DataStore.ContentConfig.CONTENT_REQUIRED][google.cloud.discoveryengine.v1beta.DataStore.ContentConfig.CONTENT_REQUIRED]
|
539
|
+
# or
|
540
|
+
# [DataStore.solution_types][google.cloud.discoveryengine.v1beta.DataStore.solution_types]
|
541
|
+
# is
|
542
|
+
# [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_CHAT].
|
477
543
|
#
|
478
544
|
# An extractive segment is a text segment extracted from the original
|
479
|
-
# document
|
480
|
-
# verbose than an
|
545
|
+
# document that is relevant to the search query, and, in general, more
|
546
|
+
# verbose than an extractive answer. The segment could then be used as
|
481
547
|
# input for LLMs to generate summaries and answers.
|
482
548
|
#
|
483
|
-
# If the number of matching segments is less than
|
484
|
-
# max_extractive_segment_count
|
485
|
-
# return the max_extractive_segment_count
|
549
|
+
# If the number of matching segments is less than
|
550
|
+
# `max_extractive_segment_count`, return all of the segments. Otherwise,
|
551
|
+
# return the `max_extractive_segment_count`.
|
486
552
|
#
|
487
|
-
# Currently one segment
|
553
|
+
# Currently one segment is returned for each
|
554
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SearchResult SearchResult}.
|
488
555
|
class ExtractiveContentSpec
|
489
556
|
include ::Google::Protobuf::MessageExts
|
490
557
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -620,6 +687,9 @@ module Google
|
|
620
687
|
# @!attribute [rw] refinement_attributes
|
621
688
|
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::GuidedSearchResult::RefinementAttribute>]
|
622
689
|
# A list of ranked refinement attributes.
|
690
|
+
# @!attribute [rw] follow_up_questions
|
691
|
+
# @return [::Array<::String>]
|
692
|
+
# Suggested follow-up questions.
|
623
693
|
class GuidedSearchResult
|
624
694
|
include ::Google::Protobuf::MessageExts
|
625
695
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -641,9 +711,40 @@ module Google
|
|
641
711
|
# @!attribute [rw] summary_text
|
642
712
|
# @return [::String]
|
643
713
|
# The summary content.
|
714
|
+
# @!attribute [rw] summary_skipped_reasons
|
715
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SummarySkippedReason>]
|
716
|
+
# Additional summary-skipped reasons. This provides the reason for ignored
|
717
|
+
# cases. If nothing is skipped, this field is not set.
|
644
718
|
class Summary
|
645
719
|
include ::Google::Protobuf::MessageExts
|
646
720
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
721
|
+
|
722
|
+
# An Enum for summary-skipped reasons.
|
723
|
+
module SummarySkippedReason
|
724
|
+
# Default value. The summary skipped reason is not specified.
|
725
|
+
SUMMARY_SKIPPED_REASON_UNSPECIFIED = 0
|
726
|
+
|
727
|
+
# The adversarial query ignored case.
|
728
|
+
#
|
729
|
+
# Only populated when
|
730
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec#ignore_adversarial_query SummarySpec.ignore_adversarial_query}
|
731
|
+
# is set to `true`.
|
732
|
+
ADVERSARIAL_QUERY_IGNORED = 1
|
733
|
+
|
734
|
+
# The non-summary seeking query ignored case.
|
735
|
+
#
|
736
|
+
# Only populated when
|
737
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec#ignore_non_summary_seeking_query SummarySpec.ignore_non_summary_seeking_query}
|
738
|
+
# is set to `true`.
|
739
|
+
NON_SUMMARY_SEEKING_QUERY_IGNORED = 2
|
740
|
+
|
741
|
+
# The out-of-domain query ignored case.
|
742
|
+
#
|
743
|
+
# Google skips the summary if there are no high-relevance search results.
|
744
|
+
# For example, the data store contains facts about company A but the
|
745
|
+
# user query is asking questions about company B.
|
746
|
+
OUT_OF_DOMAIN_QUERY_IGNORED = 3
|
747
|
+
end
|
647
748
|
end
|
648
749
|
end
|
649
750
|
end
|
@@ -57,7 +57,7 @@ module Google
|
|
57
57
|
# quality.
|
58
58
|
#
|
59
59
|
# The field must be a UTF-8 encoded string with a length limit of 128
|
60
|
-
# characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
60
|
+
# characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
61
61
|
#
|
62
62
|
# The field should not contain PII or user-data. We recommend to use Google
|
63
63
|
# Analytics [Client
|
@@ -111,20 +111,20 @@ module Google
|
|
111
111
|
#
|
112
112
|
# The value must be one of:
|
113
113
|
#
|
114
|
-
# *
|
114
|
+
# * {::Google::Cloud::DiscoveryEngine::V1beta::RecommendResponse#attribution_token RecommendResponse.attribution_token} for events that are the result of
|
115
115
|
# {::Google::Cloud::DiscoveryEngine::V1beta::RecommendationService::Client#recommend RecommendationService.Recommend}.
|
116
116
|
# * {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse#attribution_token SearchResponse.attribution_token} for events that are the result of
|
117
117
|
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchService::Client#search SearchService.Search}.
|
118
|
-
# * [CompleteQueryResponse.attribution_token][] for events that are the
|
119
|
-
# result of
|
120
|
-
# {::Google::Cloud::DiscoveryEngine::V1beta::CompletionService::Client#complete_query CompletionService.CompleteQuery}.
|
121
118
|
#
|
122
119
|
# This token enables us to accurately attribute page view or conversion
|
123
120
|
# completion back to the event and the particular predict response containing
|
124
121
|
# this clicked/purchased product. If user clicks on product K in the
|
125
|
-
# recommendation results, pass
|
126
|
-
#
|
127
|
-
#
|
122
|
+
# recommendation results, pass
|
123
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::RecommendResponse#attribution_token RecommendResponse.attribution_token}
|
124
|
+
# as a URL parameter to product K's page. When recording events on product
|
125
|
+
# K's page, log the
|
126
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::RecommendResponse#attribution_token RecommendResponse.attribution_token}
|
127
|
+
# to this field.
|
128
128
|
# @!attribute [rw] filter
|
129
129
|
# @return [::String]
|
130
130
|
# The filter syntax consists of an expression language for constructing a
|
@@ -142,10 +142,11 @@ module Google
|
|
142
142
|
# to https://google.aip.dev/160#filtering.
|
143
143
|
#
|
144
144
|
# The value must be a UTF-8 encoded string with a length limit of 1,000
|
145
|
-
# characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
145
|
+
# characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
146
146
|
# @!attribute [rw] documents
|
147
147
|
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::DocumentInfo>]
|
148
|
-
# List of
|
148
|
+
# List of {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}s
|
149
|
+
# associated with this user event.
|
149
150
|
#
|
150
151
|
# This field is optional except for the following event types:
|
151
152
|
#
|
@@ -167,12 +168,14 @@ module Google
|
|
167
168
|
# Panel metadata associated with this user event.
|
168
169
|
# @!attribute [rw] search_info
|
169
170
|
# @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchInfo]
|
170
|
-
#
|
171
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchService::Client#search SearchService.Search}
|
172
|
+
# details related to the event.
|
171
173
|
#
|
172
174
|
# This field should be set for `search` event.
|
173
175
|
# @!attribute [rw] completion_info
|
174
176
|
# @return [::Google::Cloud::DiscoveryEngine::V1beta::CompletionInfo]
|
175
|
-
#
|
177
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::CompletionService::Client#complete_query CompletionService.CompleteQuery}
|
178
|
+
# details related to the event.
|
176
179
|
#
|
177
180
|
# This field should be set for `search` event when autocomplete function is
|
178
181
|
# enabled and the user clicks a suggestion for search.
|
@@ -212,7 +215,7 @@ module Google
|
|
212
215
|
# * For number attributes, at most 400 values are allowed.
|
213
216
|
#
|
214
217
|
# For product recommendations, an example of extra user information is
|
215
|
-
# `
|
218
|
+
# `traffic_channel`, which is how a user arrives at the site. Users can
|
216
219
|
# arrive
|
217
220
|
# at the site by coming to the site directly, coming through Google
|
218
221
|
# search, or in other ways.
|
@@ -240,7 +243,7 @@ module Google
|
|
240
243
|
#
|
241
244
|
# This should be kept the same for all user events triggered from the same
|
242
245
|
# pageview. For example, an item detail page view could trigger multiple
|
243
|
-
# events as the user is browsing the page. The `
|
246
|
+
# events as the user is browsing the page. The `pageview_id` property should
|
244
247
|
# be kept the same for all these events so that they can be grouped together
|
245
248
|
# properly.
|
246
249
|
#
|
@@ -256,10 +259,10 @@ module Google
|
|
256
259
|
#
|
257
260
|
# Category pages include special pages such as sales or promotions. For
|
258
261
|
# instance, a special sale page may have the category hierarchy:
|
259
|
-
# "pageCategory" : "Sales > 2017 Black Friday Deals"
|
262
|
+
# `"pageCategory" : "Sales > 2017 Black Friday Deals"`.
|
260
263
|
#
|
261
264
|
# Required for `view-category-page` events. Other event types should not set
|
262
|
-
# this field. Otherwise, an INVALID_ARGUMENT error is returned.
|
265
|
+
# this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
263
266
|
# @!attribute [rw] uri
|
264
267
|
# @return [::String]
|
265
268
|
# Complete URL (window.location.href) of the user's current page.
|
@@ -289,14 +292,14 @@ module Google
|
|
289
292
|
# for definition.
|
290
293
|
#
|
291
294
|
# The value must be a UTF-8 encoded string with a length limit of 5,000
|
292
|
-
# characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
295
|
+
# characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
293
296
|
#
|
294
297
|
# At least one of
|
295
298
|
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchInfo#search_query search_query}
|
296
299
|
# or
|
297
300
|
# {::Google::Cloud::DiscoveryEngine::V1beta::PageInfo#page_category PageInfo.page_category}
|
298
301
|
# is required for `search` events. Other event types should not set this
|
299
|
-
# field. Otherwise, an INVALID_ARGUMENT error is returned.
|
302
|
+
# field. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
300
303
|
# @!attribute [rw] order_by
|
301
304
|
# @return [::String]
|
302
305
|
# The order in which products are returned, if applicable.
|
@@ -306,10 +309,10 @@ module Google
|
|
306
309
|
# for definition and syntax.
|
307
310
|
#
|
308
311
|
# The value must be a UTF-8 encoded string with a length limit of 1,000
|
309
|
-
# characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
312
|
+
# characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
310
313
|
#
|
311
314
|
# This can only be set for `search` events. Other event types should not set
|
312
|
-
# this field. Otherwise, an INVALID_ARGUMENT error is returned.
|
315
|
+
# this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
313
316
|
# @!attribute [rw] offset
|
314
317
|
# @return [::Integer]
|
315
318
|
# An integer that specifies the current offset for pagination (the 0-indexed
|
@@ -319,10 +322,10 @@ module Google
|
|
319
322
|
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#offset SearchRequest.offset}
|
320
323
|
# for definition.
|
321
324
|
#
|
322
|
-
# If this field is negative, an INVALID_ARGUMENT is returned.
|
325
|
+
# If this field is negative, an `INVALID_ARGUMENT` is returned.
|
323
326
|
#
|
324
327
|
# This can only be set for `search` events. Other event types should not set
|
325
|
-
# this field. Otherwise, an INVALID_ARGUMENT error is returned.
|
328
|
+
# this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
326
329
|
class SearchInfo
|
327
330
|
include ::Google::Protobuf::MessageExts
|
328
331
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -332,10 +335,12 @@ module Google
|
|
332
335
|
# clicked completion info.
|
333
336
|
# @!attribute [rw] selected_suggestion
|
334
337
|
# @return [::String]
|
335
|
-
# End user selected
|
338
|
+
# End user selected
|
339
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::CompleteQueryResponse::QuerySuggestion#suggestion CompleteQueryResponse.QuerySuggestion.suggestion}.
|
336
340
|
# @!attribute [rw] selected_position
|
337
341
|
# @return [::Integer]
|
338
|
-
# End user selected
|
342
|
+
# End user selected
|
343
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::CompleteQueryResponse::QuerySuggestion#suggestion CompleteQueryResponse.QuerySuggestion.suggestion}
|
339
344
|
# position, starting from 0.
|
340
345
|
class CompletionInfo
|
341
346
|
include ::Google::Protobuf::MessageExts
|
@@ -398,10 +403,11 @@ module Google
|
|
398
403
|
# Detailed document information associated with a user event.
|
399
404
|
# @!attribute [rw] id
|
400
405
|
# @return [::String]
|
401
|
-
#
|
406
|
+
# The {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} resource ID.
|
402
407
|
# @!attribute [rw] name
|
403
408
|
# @return [::String]
|
404
|
-
#
|
409
|
+
# The {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} resource
|
410
|
+
# full name, of the form:
|
405
411
|
# `projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`
|
406
412
|
# @!attribute [rw] quantity
|
407
413
|
# @return [::Integer]
|
@@ -452,11 +458,13 @@ module Google
|
|
452
458
|
# @return [::Google::Protobuf::Duration]
|
453
459
|
# The media progress time in seconds, if applicable.
|
454
460
|
# For example, if the end user has finished 90 seconds of a playback video,
|
455
|
-
# then
|
456
|
-
#
|
461
|
+
# then
|
462
|
+
# {::Google::Protobuf::Duration#seconds MediaInfo.media_progress_duration.seconds}
|
463
|
+
# should be set to 90.
|
457
464
|
# @!attribute [rw] media_progress_percentage
|
458
465
|
# @return [::Float]
|
459
|
-
# Media progress should be computed using only the
|
466
|
+
# Media progress should be computed using only the
|
467
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::MediaInfo#media_progress_duration media_progress_duration}
|
460
468
|
# relative to the media total length.
|
461
469
|
#
|
462
470
|
# This value must be between `[0, 1.0]` inclusive.
|
@@ -47,7 +47,7 @@ module Google
|
|
47
47
|
# @return [::String]
|
48
48
|
# The URL including cgi-parameters but excluding the hash fragment with a
|
49
49
|
# length limit of 5,000 characters. This is often more useful than the
|
50
|
-
# referer URL, because many browsers only send the domain for
|
50
|
+
# referer URL, because many browsers only send the domain for third-party
|
51
51
|
# requests.
|
52
52
|
# @!attribute [rw] ets
|
53
53
|
# @return [::Integer]
|