google-cloud-discovery_engine-v1beta 0.14.2 → 0.16.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/google/cloud/discovery_engine/v1beta/completion_service/client.rb +155 -0
- data/lib/google/cloud/discovery_engine/v1beta/completion_service/paths.rb +62 -0
- data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/client.rb +148 -0
- data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/service_stub.rb +76 -0
- data/lib/google/cloud/discovery_engine/v1beta/control_service/client.rb +6 -6
- data/lib/google/cloud/discovery_engine/v1beta/control_service/rest/client.rb +6 -6
- data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/client.rb +18 -13
- data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest/client.rb +18 -13
- data/lib/google/cloud/discovery_engine/v1beta/document_service/client.rb +109 -1
- data/lib/google/cloud/discovery_engine/v1beta/document_service/paths.rb +25 -0
- data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/client.rb +102 -1
- data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/service_stub.rb +66 -0
- data/lib/google/cloud/discovery_engine/v1beta/engine_service/client.rb +3 -3
- data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/client.rb +3 -3
- data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/client.rb +218 -4
- data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/paths.rb +85 -0
- data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/rest/client.rb +125 -4
- data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/rest/service_stub.rb +60 -0
- data/lib/google/cloud/discovery_engine/v1beta/rank_service/client.rb +1 -1
- data/lib/google/cloud/discovery_engine/v1beta/rank_service/rest/client.rb +1 -1
- data/lib/google/cloud/discovery_engine/v1beta/search_service/client.rb +410 -4
- data/lib/google/cloud/discovery_engine/v1beta/search_service/rest/client.rb +402 -4
- data/lib/google/cloud/discovery_engine/v1beta/search_service/rest/service_stub.rb +76 -0
- data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/client.rb +2 -2
- data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/rest/client.rb +2 -2
- data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/client.rb +324 -1
- data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/paths.rb +49 -0
- data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/client.rb +303 -1
- data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/service_stub.rb +193 -0
- data/lib/google/cloud/discovery_engine/v1beta/user_event_service/client.rb +1 -1
- data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/client.rb +1 -1
- data/lib/google/cloud/discovery_engine/v1beta/version.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/answer_pb.rb +2 -1
- data/lib/google/cloud/discoveryengine/v1beta/common_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/completion_service_pb.rb +18 -1
- data/lib/google/cloud/discoveryengine/v1beta/completion_service_services_pb.rb +2 -0
- data/lib/google/cloud/discoveryengine/v1beta/control_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/conversational_search_service_pb.rb +4 -1
- data/lib/google/cloud/discoveryengine/v1beta/custom_tuning_model_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/data_store_pb.rb +7 -1
- data/lib/google/cloud/discoveryengine/v1beta/document_pb.rb +4 -1
- data/lib/google/cloud/discoveryengine/v1beta/document_service_pb.rb +11 -1
- data/lib/google/cloud/discoveryengine/v1beta/document_service_services_pb.rb +4 -0
- data/lib/google/cloud/discoveryengine/v1beta/engine_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/grounded_generation_service_pb.rb +24 -1
- data/lib/google/cloud/discoveryengine/v1beta/grounded_generation_service_services_pb.rb +4 -0
- data/lib/google/cloud/discoveryengine/v1beta/grounding_pb.rb +2 -1
- data/lib/google/cloud/discoveryengine/v1beta/import_config_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/purge_config_pb.rb +5 -1
- data/lib/google/cloud/discoveryengine/v1beta/search_service_pb.rb +6 -1
- data/lib/google/cloud/discoveryengine/v1beta/search_service_services_pb.rb +14 -0
- data/lib/google/cloud/discoveryengine/v1beta/serving_config_pb.rb +2 -2
- data/lib/google/cloud/discoveryengine/v1beta/site_search_engine_pb.rb +2 -1
- data/lib/google/cloud/discoveryengine/v1beta/site_search_engine_service_pb.rb +10 -1
- data/lib/google/cloud/discoveryengine/v1beta/site_search_engine_service_services_pb.rb +7 -0
- data/lib/google/cloud/discoveryengine/v1beta/user_event_pb.rb +1 -1
- data/proto_docs/google/api/client.rb +20 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/answer.rb +68 -8
- data/proto_docs/google/cloud/discoveryengine/v1beta/completion_service.rb +268 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/control.rb +10 -1
- data/proto_docs/google/cloud/discoveryengine/v1beta/control_service.rb +6 -6
- data/proto_docs/google/cloud/discoveryengine/v1beta/conversational_search_service.rb +98 -15
- data/proto_docs/google/cloud/discoveryengine/v1beta/custom_tuning_model.rb +11 -3
- data/proto_docs/google/cloud/discoveryengine/v1beta/data_store.rb +131 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/document.rb +22 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/document_processing_config.rb +9 -5
- data/proto_docs/google/cloud/discoveryengine/v1beta/document_service.rb +123 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/engine.rb +5 -1
- data/proto_docs/google/cloud/discoveryengine/v1beta/engine_service.rb +4 -4
- data/proto_docs/google/cloud/discoveryengine/v1beta/grounded_generation_service.rb +398 -2
- data/proto_docs/google/cloud/discoveryengine/v1beta/grounding.rb +10 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/import_config.rb +13 -7
- data/proto_docs/google/cloud/discoveryengine/v1beta/project.rb +1 -1
- data/proto_docs/google/cloud/discoveryengine/v1beta/purge_config.rb +39 -1
- data/proto_docs/google/cloud/discoveryengine/v1beta/rank_service.rb +1 -1
- data/proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb +175 -6
- data/proto_docs/google/cloud/discoveryengine/v1beta/serving_config.rb +16 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/serving_config_service.rb +2 -2
- data/proto_docs/google/cloud/discoveryengine/v1beta/site_search_engine.rb +17 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/site_search_engine_service.rb +147 -1
- data/proto_docs/google/cloud/discoveryengine/v1beta/user_event.rb +13 -1
- metadata +3 -3
@@ -76,6 +76,11 @@ module Google
|
|
76
76
|
# is unset.
|
77
77
|
#
|
78
78
|
# If this field is negative, an `INVALID_ARGUMENT` is returned.
|
79
|
+
# @!attribute [rw] one_box_page_size
|
80
|
+
# @return [::Integer]
|
81
|
+
# The maximum number of results to return for OneBox.
|
82
|
+
# This applies to each OneBox type individually.
|
83
|
+
# Default number is 10.
|
79
84
|
# @!attribute [rw] data_store_specs
|
80
85
|
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::DataStoreSpec>]
|
81
86
|
# Specs defining dataStores to filter on in a search call and configurations
|
@@ -120,9 +125,12 @@ module Google
|
|
120
125
|
# object. Leave it unset if ordered by relevance. `order_by` expression is
|
121
126
|
# case-sensitive.
|
122
127
|
#
|
123
|
-
# For more information on ordering
|
124
|
-
# [
|
125
|
-
#
|
128
|
+
# For more information on ordering the website search results, see
|
129
|
+
# [Order web search
|
130
|
+
# results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results).
|
131
|
+
# For more information on ordering the healthcare search results, see
|
132
|
+
# [Order healthcare search
|
133
|
+
# results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results).
|
126
134
|
# If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
127
135
|
# @!attribute [rw] user_info
|
128
136
|
# @return [::Google::Cloud::DiscoveryEngine::V1beta::UserInfo]
|
@@ -303,6 +311,25 @@ module Google
|
|
303
311
|
# Session specification.
|
304
312
|
#
|
305
313
|
# Can be used only when `session` is set.
|
314
|
+
# @!attribute [rw] relevance_threshold
|
315
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::RelevanceThreshold]
|
316
|
+
# The relevance threshold of the search results.
|
317
|
+
#
|
318
|
+
# Default to Google defined threshold, leveraging a balance of
|
319
|
+
# precision and recall to deliver both highly accurate results and
|
320
|
+
# comprehensive coverage of relevant information.
|
321
|
+
# @!attribute [rw] personalization_spec
|
322
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::PersonalizationSpec]
|
323
|
+
# The specification for personalization.
|
324
|
+
#
|
325
|
+
# Notice that if both
|
326
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig#personalization_spec ServingConfig.personalization_spec}
|
327
|
+
# and
|
328
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#personalization_spec SearchRequest.personalization_spec}
|
329
|
+
# are set,
|
330
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#personalization_spec SearchRequest.personalization_spec}
|
331
|
+
# overrides
|
332
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig#personalization_spec ServingConfig.personalization_spec}.
|
306
333
|
class SearchRequest
|
307
334
|
include ::Google::Protobuf::MessageExts
|
308
335
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -325,6 +352,11 @@ module Google
|
|
325
352
|
# Required. Full resource name of
|
326
353
|
# {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore}, such as
|
327
354
|
# `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
|
355
|
+
# @!attribute [rw] filter
|
356
|
+
# @return [::String]
|
357
|
+
# Optional. Filter specification to filter documents in the data store
|
358
|
+
# specified by data_store field. For more information on filtering, see
|
359
|
+
# [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
|
328
360
|
class DataStoreSpec
|
329
361
|
include ::Google::Protobuf::MessageExts
|
330
362
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -773,6 +805,27 @@ module Google
|
|
773
805
|
# navigational queries. If this field is set to `true`, we skip
|
774
806
|
# generating summaries for non-summary seeking queries and return
|
775
807
|
# fallback messages instead.
|
808
|
+
# @!attribute [rw] ignore_low_relevant_content
|
809
|
+
# @return [::Boolean]
|
810
|
+
# Specifies whether to filter out queries that have low relevance. The
|
811
|
+
# default value is `false`.
|
812
|
+
#
|
813
|
+
# If this field is set to `false`, all search results are used regardless
|
814
|
+
# of relevance to generate answers. If set to `true`, only queries with
|
815
|
+
# high relevance search results will generate answers.
|
816
|
+
# @!attribute [rw] ignore_jail_breaking_query
|
817
|
+
# @return [::Boolean]
|
818
|
+
# Optional. Specifies whether to filter out jail-breaking queries. The
|
819
|
+
# default value is `false`.
|
820
|
+
#
|
821
|
+
# Google employs search-query classification to detect jail-breaking
|
822
|
+
# queries. No summary is returned if the search query is classified as a
|
823
|
+
# jail-breaking query. A user might add instructions to the query to
|
824
|
+
# change the tone, style, language, content of the answer, or ask the
|
825
|
+
# model to act as a different entity, e.g. "Reply in the tone of a
|
826
|
+
# competing company's CEO". If this field is set to `true`, we skip
|
827
|
+
# generating summaries for jail-breaking queries and return fallback
|
828
|
+
# messages instead.
|
776
829
|
# @!attribute [rw] model_prompt_spec
|
777
830
|
# @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec::ModelPromptSpec]
|
778
831
|
# If specified, the spec will be used to modify the prompt provided to
|
@@ -1044,6 +1097,30 @@ module Google
|
|
1044
1097
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1045
1098
|
end
|
1046
1099
|
|
1100
|
+
# The specification for personalization.
|
1101
|
+
# @!attribute [rw] mode
|
1102
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::PersonalizationSpec::Mode]
|
1103
|
+
# The personalization mode of the search request.
|
1104
|
+
# Defaults to
|
1105
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::PersonalizationSpec::Mode::AUTO Mode.AUTO}.
|
1106
|
+
class PersonalizationSpec
|
1107
|
+
include ::Google::Protobuf::MessageExts
|
1108
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1109
|
+
|
1110
|
+
# The personalization mode of each search request.
|
1111
|
+
module Mode
|
1112
|
+
# Default value. In this case, server behavior defaults to
|
1113
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::PersonalizationSpec::Mode::AUTO Mode.AUTO}.
|
1114
|
+
MODE_UNSPECIFIED = 0
|
1115
|
+
|
1116
|
+
# Personalization is enabled if data quality requirements are met.
|
1117
|
+
AUTO = 1
|
1118
|
+
|
1119
|
+
# Disable personalization.
|
1120
|
+
DISABLED = 2
|
1121
|
+
end
|
1122
|
+
end
|
1123
|
+
|
1047
1124
|
# @!attribute [rw] key
|
1048
1125
|
# @return [::String]
|
1049
1126
|
# @!attribute [rw] value
|
@@ -1061,6 +1138,27 @@ module Google
|
|
1061
1138
|
include ::Google::Protobuf::MessageExts
|
1062
1139
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1063
1140
|
end
|
1141
|
+
|
1142
|
+
# The relevance threshold of the search results. The higher relevance
|
1143
|
+
# threshold is, the higher relevant results are shown and the less number of
|
1144
|
+
# results are returned.
|
1145
|
+
module RelevanceThreshold
|
1146
|
+
# Default value. In this case, server behavior defaults to Google defined
|
1147
|
+
# threshold.
|
1148
|
+
RELEVANCE_THRESHOLD_UNSPECIFIED = 0
|
1149
|
+
|
1150
|
+
# Lowest relevance threshold.
|
1151
|
+
LOWEST = 1
|
1152
|
+
|
1153
|
+
# Low relevance threshold.
|
1154
|
+
LOW = 2
|
1155
|
+
|
1156
|
+
# Medium relevance threshold.
|
1157
|
+
MEDIUM = 3
|
1158
|
+
|
1159
|
+
# High relevance threshold.
|
1160
|
+
HIGH = 4
|
1161
|
+
end
|
1064
1162
|
end
|
1065
1163
|
|
1066
1164
|
# Response message for
|
@@ -1088,7 +1186,8 @@ module Google
|
|
1088
1186
|
# A unique search token. This should be included in the
|
1089
1187
|
# {::Google::Cloud::DiscoveryEngine::V1beta::UserEvent UserEvent} logs resulting
|
1090
1188
|
# from this search, which enables accurate attribution of search model
|
1091
|
-
# performance.
|
1189
|
+
# performance. This also helps to identify a request during the customer
|
1190
|
+
# support scenarios.
|
1092
1191
|
# @!attribute [rw] redirect_uri
|
1093
1192
|
# @return [::String]
|
1094
1193
|
# The URI of a customer-defined redirect page. If redirect action is
|
@@ -1132,6 +1231,10 @@ module Google
|
|
1132
1231
|
# Only set if
|
1133
1232
|
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#session SearchRequest.session}
|
1134
1233
|
# is provided. See its description for more details.
|
1234
|
+
# @!attribute [rw] one_box_results
|
1235
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::OneBoxResult>]
|
1236
|
+
# A list of One Box results. There can be multiple One Box results of
|
1237
|
+
# different types.
|
1135
1238
|
class SearchResponse
|
1136
1239
|
include ::Google::Protobuf::MessageExts
|
1137
1240
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -1350,14 +1453,15 @@ module Google
|
|
1350
1453
|
|
1351
1454
|
# The adversarial query ignored case.
|
1352
1455
|
#
|
1353
|
-
# Only
|
1456
|
+
# Only used when
|
1354
1457
|
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec#ignore_adversarial_query SummarySpec.ignore_adversarial_query}
|
1355
1458
|
# is set to `true`.
|
1356
1459
|
ADVERSARIAL_QUERY_IGNORED = 1
|
1357
1460
|
|
1358
1461
|
# The non-summary seeking query ignored case.
|
1359
1462
|
#
|
1360
|
-
#
|
1463
|
+
# Google skips the summary if the query is chit chat.
|
1464
|
+
# Only used when
|
1361
1465
|
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec#ignore_non_summary_seeking_query SummarySpec.ignore_non_summary_seeking_query}
|
1362
1466
|
# is set to `true`.
|
1363
1467
|
NON_SUMMARY_SEEKING_QUERY_IGNORED = 2
|
@@ -1385,6 +1489,28 @@ module Google
|
|
1385
1489
|
# Google skips the summary if there is no relevant content in the
|
1386
1490
|
# retrieved search results.
|
1387
1491
|
NO_RELEVANT_CONTENT = 6
|
1492
|
+
|
1493
|
+
# The jail-breaking query ignored case.
|
1494
|
+
#
|
1495
|
+
# For example, "Reply in the tone of a competing company's CEO".
|
1496
|
+
# Only used when
|
1497
|
+
# [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query]
|
1498
|
+
# is set to `true`.
|
1499
|
+
JAIL_BREAKING_QUERY_IGNORED = 7
|
1500
|
+
|
1501
|
+
# The customer policy violation case.
|
1502
|
+
#
|
1503
|
+
# Google skips the summary if there is a customer policy violation
|
1504
|
+
# detected. The policy is defined by the customer.
|
1505
|
+
CUSTOMER_POLICY_VIOLATION = 8
|
1506
|
+
|
1507
|
+
# The non-answer seeking query ignored case.
|
1508
|
+
#
|
1509
|
+
# Google skips the summary if the query doesn't have clear intent.
|
1510
|
+
# Only used when
|
1511
|
+
# [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query]
|
1512
|
+
# is set to `true`.
|
1513
|
+
NON_SUMMARY_SEEKING_QUERY_IGNORED_V2 = 9
|
1388
1514
|
end
|
1389
1515
|
end
|
1390
1516
|
|
@@ -1454,6 +1580,9 @@ module Google
|
|
1454
1580
|
# @return [::Array<::String>]
|
1455
1581
|
# Values of the string field. The record will only be returned if the
|
1456
1582
|
# field value matches one of the values specified here.
|
1583
|
+
# @!attribute [rw] query_segment
|
1584
|
+
# @return [::String]
|
1585
|
+
# Identifies the keywords within the search query that match a filter.
|
1457
1586
|
class StringConstraint
|
1458
1587
|
include ::Google::Protobuf::MessageExts
|
1459
1588
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -1470,6 +1599,9 @@ module Google
|
|
1470
1599
|
# @!attribute [rw] value
|
1471
1600
|
# @return [::Float]
|
1472
1601
|
# The value specified in the numerical constraint.
|
1602
|
+
# @!attribute [rw] query_segment
|
1603
|
+
# @return [::String]
|
1604
|
+
# Identifies the keywords within the search query that match a filter.
|
1473
1605
|
class NumberConstraint
|
1474
1606
|
include ::Google::Protobuf::MessageExts
|
1475
1607
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -1506,6 +1638,12 @@ module Google
|
|
1506
1638
|
# The reference address that was inferred from the input query. The
|
1507
1639
|
# proximity of the reference address to the geolocation field will be
|
1508
1640
|
# used to filter the results.
|
1641
|
+
# @!attribute [rw] latitude
|
1642
|
+
# @return [::Float]
|
1643
|
+
# The latitude of the geolocation inferred from the input query.
|
1644
|
+
# @!attribute [rw] longitude
|
1645
|
+
# @return [::Float]
|
1646
|
+
# The longitude of the geolocation inferred from the input query.
|
1509
1647
|
# @!attribute [rw] radius_in_meters
|
1510
1648
|
# @return [::Float]
|
1511
1649
|
# The radius in meters around the address. The record is returned if
|
@@ -1576,6 +1714,37 @@ module Google
|
|
1576
1714
|
include ::Google::Protobuf::MessageExts
|
1577
1715
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1578
1716
|
end
|
1717
|
+
|
1718
|
+
# OneBoxResult is a holder for all results of specific type that we want
|
1719
|
+
# to display in UI differently.
|
1720
|
+
# @!attribute [rw] one_box_type
|
1721
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::OneBoxResult::OneBoxType]
|
1722
|
+
# The type of One Box result.
|
1723
|
+
# @!attribute [rw] search_results
|
1724
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SearchResult>]
|
1725
|
+
# The search results for this One Box.
|
1726
|
+
class OneBoxResult
|
1727
|
+
include ::Google::Protobuf::MessageExts
|
1728
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1729
|
+
|
1730
|
+
# The type of One Box result.
|
1731
|
+
module OneBoxType
|
1732
|
+
# Default value. Should not be used.
|
1733
|
+
ONE_BOX_TYPE_UNSPECIFIED = 0
|
1734
|
+
|
1735
|
+
# One Box result contains people results.
|
1736
|
+
PEOPLE = 1
|
1737
|
+
|
1738
|
+
# One Box result contains organization results.
|
1739
|
+
ORGANIZATION = 2
|
1740
|
+
|
1741
|
+
# One Box result contains slack results.
|
1742
|
+
SLACK = 3
|
1743
|
+
|
1744
|
+
# One Box result contains Knowledge Graph search responses.
|
1745
|
+
KNOWLEDGE_GRAPH = 4
|
1746
|
+
end
|
1747
|
+
end
|
1579
1748
|
end
|
1580
1749
|
end
|
1581
1750
|
end
|
@@ -187,6 +187,18 @@ module Google
|
|
187
187
|
# execute.
|
188
188
|
# Order does not matter.
|
189
189
|
# Maximum number of specifications is 100.
|
190
|
+
# @!attribute [rw] personalization_spec
|
191
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::PersonalizationSpec]
|
192
|
+
# The specification for personalization spec.
|
193
|
+
#
|
194
|
+
# Notice that if both
|
195
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig#personalization_spec ServingConfig.personalization_spec}
|
196
|
+
# and
|
197
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#personalization_spec SearchRequest.personalization_spec}
|
198
|
+
# are set,
|
199
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#personalization_spec SearchRequest.personalization_spec}
|
200
|
+
# overrides
|
201
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig#personalization_spec ServingConfig.personalization_spec}.
|
190
202
|
class ServingConfig
|
191
203
|
include ::Google::Protobuf::MessageExts
|
192
204
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -225,6 +237,10 @@ module Google
|
|
225
237
|
#
|
226
238
|
# If unset, watch history demotion will not be applied. Content freshness
|
227
239
|
# demotion will still be applied.
|
240
|
+
# @!attribute [rw] demote_content_watched_past_days
|
241
|
+
# @return [::Integer]
|
242
|
+
# Optional. Specifies the number of days to look back for demoting watched
|
243
|
+
# content. If set to zero or unset, defaults to the maximum of 365 days.
|
228
244
|
# @!attribute [rw] content_freshness_cutoff_days
|
229
245
|
# @return [::Integer]
|
230
246
|
# Specifies the content freshness used for recommendation result.
|
@@ -43,7 +43,7 @@ module Google
|
|
43
43
|
# @!attribute [rw] name
|
44
44
|
# @return [::String]
|
45
45
|
# Required. The resource name of the ServingConfig to get. Format:
|
46
|
-
# `projects/{
|
46
|
+
# `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`
|
47
47
|
class GetServingConfigRequest
|
48
48
|
include ::Google::Protobuf::MessageExts
|
49
49
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -53,7 +53,7 @@ module Google
|
|
53
53
|
# @!attribute [rw] parent
|
54
54
|
# @return [::String]
|
55
55
|
# Required. Full resource name of the parent resource. Format:
|
56
|
-
# `projects/{
|
56
|
+
# `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
|
57
57
|
# @!attribute [rw] page_size
|
58
58
|
# @return [::Integer]
|
59
59
|
# Optional. Maximum number of results to return. If unspecified, defaults
|
@@ -157,6 +157,23 @@ module Google
|
|
157
157
|
EXEMPTED = 3
|
158
158
|
end
|
159
159
|
end
|
160
|
+
|
161
|
+
# A sitemap for the SiteSearchEngine.
|
162
|
+
# @!attribute [rw] uri
|
163
|
+
# @return [::String]
|
164
|
+
# Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`.
|
165
|
+
# @!attribute [r] name
|
166
|
+
# @return [::String]
|
167
|
+
# Output only. The fully qualified resource name of the sitemap.
|
168
|
+
# `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/*`
|
169
|
+
# The `sitemap_id` suffix is system-generated.
|
170
|
+
# @!attribute [r] create_time
|
171
|
+
# @return [::Google::Protobuf::Timestamp]
|
172
|
+
# Output only. The sitemap's creation time.
|
173
|
+
class Sitemap
|
174
|
+
include ::Google::Protobuf::MessageExts
|
175
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
176
|
+
end
|
160
177
|
end
|
161
178
|
end
|
162
179
|
end
|
@@ -258,6 +258,137 @@ module Google
|
|
258
258
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
259
259
|
end
|
260
260
|
|
261
|
+
# Request message for
|
262
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SiteSearchEngineService::Client#create_sitemap SiteSearchEngineService.CreateSitemap}
|
263
|
+
# method.
|
264
|
+
# @!attribute [rw] parent
|
265
|
+
# @return [::String]
|
266
|
+
# Required. Parent resource name of the
|
267
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SiteSearchEngine SiteSearchEngine},
|
268
|
+
# such as
|
269
|
+
# `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.
|
270
|
+
# @!attribute [rw] sitemap
|
271
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::Sitemap]
|
272
|
+
# Required. The {::Google::Cloud::DiscoveryEngine::V1beta::Sitemap Sitemap} to
|
273
|
+
# create.
|
274
|
+
class CreateSitemapRequest
|
275
|
+
include ::Google::Protobuf::MessageExts
|
276
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
277
|
+
end
|
278
|
+
|
279
|
+
# Request message for
|
280
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SiteSearchEngineService::Client#delete_sitemap SiteSearchEngineService.DeleteSitemap}
|
281
|
+
# method.
|
282
|
+
# @!attribute [rw] name
|
283
|
+
# @return [::String]
|
284
|
+
# Required. Full resource name of
|
285
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::Sitemap Sitemap}, such as
|
286
|
+
# `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}`.
|
287
|
+
#
|
288
|
+
# If the caller does not have permission to access the
|
289
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::Sitemap Sitemap}, regardless of
|
290
|
+
# whether or not it exists, a PERMISSION_DENIED error is returned.
|
291
|
+
#
|
292
|
+
# If the requested {::Google::Cloud::DiscoveryEngine::V1beta::Sitemap Sitemap}
|
293
|
+
# does not exist, a NOT_FOUND error is returned.
|
294
|
+
class DeleteSitemapRequest
|
295
|
+
include ::Google::Protobuf::MessageExts
|
296
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
297
|
+
end
|
298
|
+
|
299
|
+
# Request message for
|
300
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SiteSearchEngineService::Client#fetch_sitemaps SiteSearchEngineService.FetchSitemaps}
|
301
|
+
# method.
|
302
|
+
# @!attribute [rw] parent
|
303
|
+
# @return [::String]
|
304
|
+
# Required. Parent resource name of the
|
305
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SiteSearchEngine SiteSearchEngine},
|
306
|
+
# such as
|
307
|
+
# `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.
|
308
|
+
# @!attribute [rw] matcher
|
309
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::FetchSitemapsRequest::Matcher]
|
310
|
+
# Optional. If specified, fetches the matching
|
311
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::Sitemap Sitemap}s. If not specified,
|
312
|
+
# fetches all {::Google::Cloud::DiscoveryEngine::V1beta::Sitemap Sitemap}s in the
|
313
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore}.
|
314
|
+
class FetchSitemapsRequest
|
315
|
+
include ::Google::Protobuf::MessageExts
|
316
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
317
|
+
|
318
|
+
# Matcher for the {::Google::Cloud::DiscoveryEngine::V1beta::Sitemap Sitemap}s by
|
319
|
+
# their uris.
|
320
|
+
# @!attribute [rw] uris
|
321
|
+
# @return [::Array<::String>]
|
322
|
+
# The {::Google::Cloud::DiscoveryEngine::V1beta::Sitemap Sitemap} uris.
|
323
|
+
class UrisMatcher
|
324
|
+
include ::Google::Protobuf::MessageExts
|
325
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
326
|
+
end
|
327
|
+
|
328
|
+
# Matcher for the {::Google::Cloud::DiscoveryEngine::V1beta::Sitemap Sitemap}s.
|
329
|
+
# Currently only supports uris matcher.
|
330
|
+
# @!attribute [rw] uris_matcher
|
331
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::FetchSitemapsRequest::UrisMatcher]
|
332
|
+
# Matcher by sitemap URIs.
|
333
|
+
class Matcher
|
334
|
+
include ::Google::Protobuf::MessageExts
|
335
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
336
|
+
end
|
337
|
+
end
|
338
|
+
|
339
|
+
# Metadata related to the progress of the
|
340
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SiteSearchEngineService::Client#create_sitemap SiteSearchEngineService.CreateSitemap}
|
341
|
+
# operation. This will be returned by the google.longrunning.Operation.metadata
|
342
|
+
# field.
|
343
|
+
# @!attribute [rw] create_time
|
344
|
+
# @return [::Google::Protobuf::Timestamp]
|
345
|
+
# Operation create time.
|
346
|
+
# @!attribute [rw] update_time
|
347
|
+
# @return [::Google::Protobuf::Timestamp]
|
348
|
+
# Operation last update time. If the operation is done, this is also the
|
349
|
+
# finish time.
|
350
|
+
class CreateSitemapMetadata
|
351
|
+
include ::Google::Protobuf::MessageExts
|
352
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
353
|
+
end
|
354
|
+
|
355
|
+
# Metadata related to the progress of the
|
356
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SiteSearchEngineService::Client#delete_sitemap SiteSearchEngineService.DeleteSitemap}
|
357
|
+
# operation. This will be returned by the google.longrunning.Operation.metadata
|
358
|
+
# field.
|
359
|
+
# @!attribute [rw] create_time
|
360
|
+
# @return [::Google::Protobuf::Timestamp]
|
361
|
+
# Operation create time.
|
362
|
+
# @!attribute [rw] update_time
|
363
|
+
# @return [::Google::Protobuf::Timestamp]
|
364
|
+
# Operation last update time. If the operation is done, this is also the
|
365
|
+
# finish time.
|
366
|
+
class DeleteSitemapMetadata
|
367
|
+
include ::Google::Protobuf::MessageExts
|
368
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
369
|
+
end
|
370
|
+
|
371
|
+
# Response message for
|
372
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SiteSearchEngineService::Client#fetch_sitemaps SiteSearchEngineService.FetchSitemaps}
|
373
|
+
# method.
|
374
|
+
# @!attribute [rw] sitemaps_metadata
|
375
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::FetchSitemapsResponse::SitemapMetadata>]
|
376
|
+
# List of {::Google::Cloud::DiscoveryEngine::V1beta::Sitemap Sitemap}s fetched.
|
377
|
+
class FetchSitemapsResponse
|
378
|
+
include ::Google::Protobuf::MessageExts
|
379
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
380
|
+
|
381
|
+
# Contains a {::Google::Cloud::DiscoveryEngine::V1beta::Sitemap Sitemap} and its
|
382
|
+
# metadata.
|
383
|
+
# @!attribute [rw] sitemap
|
384
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::Sitemap]
|
385
|
+
# The {::Google::Cloud::DiscoveryEngine::V1beta::Sitemap Sitemap}.
|
386
|
+
class SitemapMetadata
|
387
|
+
include ::Google::Protobuf::MessageExts
|
388
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
389
|
+
end
|
390
|
+
end
|
391
|
+
|
261
392
|
# Request message for
|
262
393
|
# {::Google::Cloud::DiscoveryEngine::V1beta::SiteSearchEngineService::Client#enable_advanced_site_search SiteSearchEngineService.EnableAdvancedSiteSearch}
|
263
394
|
# method.
|
@@ -349,6 +480,11 @@ module Google
|
|
349
480
|
# an INVALID_ARGUMENT error is thrown. Each URI should match at least one
|
350
481
|
# {::Google::Cloud::DiscoveryEngine::V1beta::TargetSite TargetSite} in
|
351
482
|
# `site_search_engine`.
|
483
|
+
# @!attribute [rw] site_credential
|
484
|
+
# @return [::String]
|
485
|
+
# Optional. Full resource name of the [SiteCredential][], such as
|
486
|
+
# `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/siteCredentials/*`.
|
487
|
+
# Only set to crawl private URIs.
|
352
488
|
class RecrawlUrisRequest
|
353
489
|
include ::Google::Protobuf::MessageExts
|
354
490
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -419,9 +555,19 @@ module Google
|
|
419
555
|
# finish time.
|
420
556
|
# @!attribute [rw] invalid_uris
|
421
557
|
# @return [::Array<::String>]
|
558
|
+
# Unique URIs in the request that have invalid format. Sample limited to
|
559
|
+
# 1000.
|
560
|
+
# @!attribute [rw] invalid_uris_count
|
561
|
+
# @return [::Integer]
|
562
|
+
# Total number of unique URIs in the request that have invalid format.
|
563
|
+
# @!attribute [rw] uris_not_matching_target_sites
|
564
|
+
# @return [::Array<::String>]
|
422
565
|
# Unique URIs in the request that don't match any TargetSite in the
|
423
566
|
# DataStore, only match TargetSites that haven't been fully indexed, or match
|
424
|
-
# a TargetSite with type EXCLUDE.
|
567
|
+
# a TargetSite with type EXCLUDE. Sample limited to 1000.
|
568
|
+
# @!attribute [rw] uris_not_matching_target_sites_count
|
569
|
+
# @return [::Integer]
|
570
|
+
# Total number of URIs that don't match any TargetSites.
|
425
571
|
# @!attribute [rw] valid_uris_count
|
426
572
|
# @return [::Integer]
|
427
573
|
# Total number of unique URIs in the request that are not in invalid_uris.
|
@@ -34,6 +34,7 @@ module Google
|
|
34
34
|
# * `view-item-list`: View of a panel or ordered list of Documents.
|
35
35
|
# * `view-home-page`: View of the home page.
|
36
36
|
# * `view-category-page`: View of a category page, e.g. Home > Men > Jeans
|
37
|
+
# * `add-feedback`: Add a user feedback.
|
37
38
|
#
|
38
39
|
# Retail-related values:
|
39
40
|
#
|
@@ -244,6 +245,10 @@ module Google
|
|
244
245
|
# @!attribute [rw] media_info
|
245
246
|
# @return [::Google::Cloud::DiscoveryEngine::V1beta::MediaInfo]
|
246
247
|
# Media-specific info.
|
248
|
+
# @!attribute [rw] panels
|
249
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::PanelInfo>]
|
250
|
+
# Optional. List of panels associated with this event.
|
251
|
+
# Used for page-level impression data.
|
247
252
|
class UserEvent
|
248
253
|
include ::Google::Protobuf::MessageExts
|
249
254
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -430,7 +435,7 @@ module Google
|
|
430
435
|
# @return [::String]
|
431
436
|
# The {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} resource
|
432
437
|
# full name, of the form:
|
433
|
-
# `projects/{
|
438
|
+
# `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`
|
434
439
|
# @!attribute [rw] uri
|
435
440
|
# @return [::String]
|
436
441
|
# The {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} URI - only
|
@@ -450,6 +455,10 @@ module Google
|
|
450
455
|
# @return [::Array<::String>]
|
451
456
|
# The promotion IDs associated with this Document.
|
452
457
|
# Currently, this field is restricted to at most one ID.
|
458
|
+
# @!attribute [r] joined
|
459
|
+
# @return [::Boolean]
|
460
|
+
# Output only. Whether the referenced Document can be found in the data
|
461
|
+
# store.
|
453
462
|
class DocumentInfo
|
454
463
|
include ::Google::Protobuf::MessageExts
|
455
464
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -474,6 +483,9 @@ module Google
|
|
474
483
|
# Must be set if
|
475
484
|
# {::Google::Cloud::DiscoveryEngine::V1beta::PanelInfo#panel_position panel_position}
|
476
485
|
# is set.
|
486
|
+
# @!attribute [rw] documents
|
487
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::DocumentInfo>]
|
488
|
+
# Optional. The document IDs associated with this panel.
|
477
489
|
class PanelInfo
|
478
490
|
include ::Google::Protobuf::MessageExts
|
479
491
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-cloud-discovery_engine-v1beta
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.16.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2024-
|
11
|
+
date: 2024-11-13 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: gapic-common
|
@@ -373,7 +373,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
373
373
|
- !ruby/object:Gem::Version
|
374
374
|
version: '0'
|
375
375
|
requirements: []
|
376
|
-
rubygems_version: 3.5.
|
376
|
+
rubygems_version: 3.5.22
|
377
377
|
signing_key:
|
378
378
|
specification_version: 4
|
379
379
|
summary: Discovery Engine API.
|