google-cloud-discovery_engine-v1beta 0.10.0 → 0.12.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/google/cloud/discovery_engine/v1beta/completion_service/client.rb +9 -3
- data/lib/google/cloud/discovery_engine/v1beta/completion_service/operations.rb +13 -5
- data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/client.rb +9 -3
- data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/operations.rb +21 -6
- data/lib/google/cloud/discovery_engine/v1beta/control_service/client.rb +875 -0
- data/lib/google/cloud/discovery_engine/v1beta/control_service/credentials.rb +47 -0
- data/lib/google/cloud/discovery_engine/v1beta/control_service/paths.rb +167 -0
- data/lib/google/cloud/discovery_engine/v1beta/control_service/rest/client.rb +814 -0
- data/lib/google/cloud/discovery_engine/v1beta/control_service/rest/service_stub.rb +440 -0
- data/lib/google/cloud/discovery_engine/v1beta/control_service/rest.rb +55 -0
- data/lib/google/cloud/discovery_engine/v1beta/control_service.rb +58 -0
- data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/client.rb +764 -6
- data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/paths.rb +199 -0
- data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest/client.rb +715 -6
- data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest/service_stub.rb +520 -0
- data/lib/google/cloud/discovery_engine/v1beta/data_store_service/client.rb +15 -7
- data/lib/google/cloud/discovery_engine/v1beta/data_store_service/operations.rb +13 -5
- data/lib/google/cloud/discovery_engine/v1beta/data_store_service/rest/client.rb +15 -7
- data/lib/google/cloud/discovery_engine/v1beta/data_store_service/rest/operations.rb +21 -6
- data/lib/google/cloud/discovery_engine/v1beta/document_service/client.rb +71 -37
- data/lib/google/cloud/discovery_engine/v1beta/document_service/operations.rb +13 -5
- data/lib/google/cloud/discovery_engine/v1beta/document_service/paths.rb +21 -0
- data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/client.rb +71 -37
- data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/operations.rb +21 -6
- data/lib/google/cloud/discovery_engine/v1beta/engine_service/client.rb +312 -5
- data/lib/google/cloud/discovery_engine/v1beta/engine_service/operations.rb +13 -5
- data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/client.rb +291 -5
- data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/operations.rb +21 -6
- data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/service_stub.rb +180 -0
- data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/client.rb +471 -0
- data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/credentials.rb +47 -0
- data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/paths.rb +52 -0
- data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/rest/client.rb +438 -0
- data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/rest/service_stub.rb +129 -0
- data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/rest.rb +52 -0
- data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service.rb +55 -0
- data/lib/google/cloud/discovery_engine/v1beta/project_service/client.rb +485 -0
- data/lib/google/cloud/discovery_engine/v1beta/project_service/credentials.rb +47 -0
- data/lib/google/cloud/discovery_engine/v1beta/project_service/operations.rb +809 -0
- data/lib/google/cloud/discovery_engine/v1beta/project_service/paths.rb +47 -0
- data/lib/google/cloud/discovery_engine/v1beta/project_service/rest/client.rb +452 -0
- data/lib/google/cloud/discovery_engine/v1beta/project_service/rest/operations.rb +1092 -0
- data/lib/google/cloud/discovery_engine/v1beta/project_service/rest/service_stub.rb +129 -0
- data/lib/google/cloud/discovery_engine/v1beta/project_service/rest.rb +54 -0
- data/lib/google/cloud/discovery_engine/v1beta/project_service.rb +57 -0
- data/lib/google/cloud/discovery_engine/v1beta/rank_service/client.rb +481 -0
- data/lib/google/cloud/discovery_engine/v1beta/rank_service/credentials.rb +47 -0
- data/lib/google/cloud/discovery_engine/v1beta/rank_service/paths.rb +52 -0
- data/lib/google/cloud/discovery_engine/v1beta/rank_service/rest/client.rb +448 -0
- data/lib/google/cloud/discovery_engine/v1beta/rank_service/rest/service_stub.rb +129 -0
- data/lib/google/cloud/discovery_engine/v1beta/rank_service/rest.rb +52 -0
- data/lib/google/cloud/discovery_engine/v1beta/rank_service.rb +55 -0
- data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/client.rb +24 -19
- data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/paths.rb +66 -0
- data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/rest/client.rb +24 -19
- data/lib/google/cloud/discovery_engine/v1beta/rest.rb +4 -0
- data/lib/google/cloud/discovery_engine/v1beta/schema_service/client.rb +18 -10
- data/lib/google/cloud/discovery_engine/v1beta/schema_service/operations.rb +13 -5
- data/lib/google/cloud/discovery_engine/v1beta/schema_service/rest/client.rb +18 -10
- data/lib/google/cloud/discovery_engine/v1beta/schema_service/rest/operations.rb +21 -6
- data/lib/google/cloud/discovery_engine/v1beta/search_service/client.rb +26 -14
- data/lib/google/cloud/discovery_engine/v1beta/search_service/rest/client.rb +26 -14
- data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/client.rb +104 -2
- data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/operations.rb +13 -5
- data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/rest/client.rb +97 -2
- data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/rest/operations.rb +21 -6
- data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/rest/service_stub.rb +59 -0
- data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/client.rb +9 -3
- data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/rest/client.rb +9 -3
- data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/client.rb +27 -12
- data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/operations.rb +13 -5
- data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/client.rb +27 -12
- data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/operations.rb +21 -6
- data/lib/google/cloud/discovery_engine/v1beta/user_event_service/client.rb +23 -6
- data/lib/google/cloud/discovery_engine/v1beta/user_event_service/operations.rb +13 -5
- data/lib/google/cloud/discovery_engine/v1beta/user_event_service/paths.rb +21 -0
- data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/client.rb +23 -6
- data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/operations.rb +21 -6
- data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/service_stub.rb +8 -0
- data/lib/google/cloud/discovery_engine/v1beta/version.rb +1 -1
- data/lib/google/cloud/discovery_engine/v1beta.rb +4 -0
- data/lib/google/cloud/discoveryengine/v1beta/answer_pb.rb +69 -0
- data/lib/google/cloud/discoveryengine/v1beta/common_pb.rb +2 -1
- data/lib/google/cloud/discoveryengine/v1beta/control_pb.rb +55 -0
- data/lib/google/cloud/discoveryengine/v1beta/control_service_pb.rb +57 -0
- data/lib/google/cloud/discoveryengine/v1beta/control_service_services_pb.rb +69 -0
- data/lib/google/cloud/discoveryengine/v1beta/conversational_search_service_pb.rb +32 -1
- data/lib/google/cloud/discoveryengine/v1beta/conversational_search_service_services_pb.rb +25 -0
- data/lib/google/cloud/discoveryengine/v1beta/custom_tuning_model_pb.rb +48 -0
- data/lib/google/cloud/discoveryengine/v1beta/document_processing_config_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/document_service_pb.rb +3 -1
- data/lib/google/cloud/discoveryengine/v1beta/document_service_services_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/engine_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/engine_service_pb.rb +6 -1
- data/lib/google/cloud/discoveryengine/v1beta/engine_service_services_pb.rb +12 -0
- data/lib/google/cloud/discoveryengine/v1beta/grounded_generation_service_pb.rb +52 -0
- data/lib/google/cloud/discoveryengine/v1beta/grounded_generation_service_services_pb.rb +45 -0
- data/lib/google/cloud/discoveryengine/v1beta/grounding_pb.rb +46 -0
- data/lib/google/cloud/discoveryengine/v1beta/import_config_pb.rb +13 -1
- data/lib/google/cloud/discoveryengine/v1beta/project_pb.rb +49 -0
- data/lib/google/cloud/discoveryengine/v1beta/project_service_pb.rb +50 -0
- data/lib/google/cloud/discoveryengine/v1beta/project_service_services_pb.rb +51 -0
- data/lib/google/cloud/discoveryengine/v1beta/rank_service_pb.rb +49 -0
- data/lib/google/cloud/discoveryengine/v1beta/rank_service_services_pb.rb +45 -0
- data/lib/google/cloud/discoveryengine/v1beta/search_service_pb.rb +7 -1
- data/lib/google/cloud/discoveryengine/v1beta/search_tuning_service_pb.rb +5 -1
- data/lib/google/cloud/discoveryengine/v1beta/search_tuning_service_services_pb.rb +2 -0
- data/lib/google/cloud/discoveryengine/v1beta/session_pb.rb +50 -0
- data/lib/google/cloud/discoveryengine/v1beta/site_search_engine_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/user_event_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/user_event_service_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/answer.rb +362 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/common.rb +25 -1
- data/proto_docs/google/cloud/discoveryengine/v1beta/control.rb +209 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/control_service.rb +126 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/conversation.rb +2 -2
- data/proto_docs/google/cloud/discoveryengine/v1beta/conversational_search_service.rb +491 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/custom_tuning_model.rb +75 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/data_store_service.rb +2 -2
- data/proto_docs/google/cloud/discoveryengine/v1beta/document_processing_config.rb +4 -5
- data/proto_docs/google/cloud/discoveryengine/v1beta/document_service.rb +9 -6
- data/proto_docs/google/cloud/discoveryengine/v1beta/engine.rb +5 -5
- data/proto_docs/google/cloud/discoveryengine/v1beta/engine_service.rb +51 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/grounded_generation_service.rb +144 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/grounding.rb +79 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/import_config.rb +312 -26
- data/proto_docs/google/cloud/discoveryengine/v1beta/project.rb +106 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/project_service.rb +57 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/rank_service.rb +127 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/recommendation_service.rb +20 -19
- data/proto_docs/google/cloud/discoveryengine/v1beta/schema_service.rb +5 -5
- data/proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb +181 -43
- data/proto_docs/google/cloud/discoveryengine/v1beta/search_tuning_service.rb +47 -1
- data/proto_docs/google/cloud/discoveryengine/v1beta/session.rb +88 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/site_search_engine.rb +3 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/user_event.rb +25 -4
- data/proto_docs/google/cloud/discoveryengine/v1beta/user_event_service.rb +13 -1
- metadata +56 -2
@@ -0,0 +1,127 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2024 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Cloud
|
22
|
+
module DiscoveryEngine
|
23
|
+
module V1beta
|
24
|
+
# Record message for
|
25
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::RankService::Client#rank RankService.Rank}
|
26
|
+
# method.
|
27
|
+
# @!attribute [rw] id
|
28
|
+
# @return [::String]
|
29
|
+
# The unique ID to represent the record.
|
30
|
+
# @!attribute [rw] title
|
31
|
+
# @return [::String]
|
32
|
+
# The title of the record. Empty by default.
|
33
|
+
# At least one of
|
34
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::RankingRecord#title title} or
|
35
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::RankingRecord#content content} should
|
36
|
+
# be set otherwise an INVALID_ARGUMENT error is thrown.
|
37
|
+
# @!attribute [rw] content
|
38
|
+
# @return [::String]
|
39
|
+
# The content of the record. Empty by default.
|
40
|
+
# At least one of
|
41
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::RankingRecord#title title} or
|
42
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::RankingRecord#content content} should
|
43
|
+
# be set otherwise an INVALID_ARGUMENT error is thrown.
|
44
|
+
# @!attribute [rw] score
|
45
|
+
# @return [::Float]
|
46
|
+
# The score of this record based on the given query and selected model.
|
47
|
+
class RankingRecord
|
48
|
+
include ::Google::Protobuf::MessageExts
|
49
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
50
|
+
end
|
51
|
+
|
52
|
+
# Request message for
|
53
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::RankService::Client#rank RankService.Rank}
|
54
|
+
# method.
|
55
|
+
# @!attribute [rw] ranking_config
|
56
|
+
# @return [::String]
|
57
|
+
# Required. The resource name of the rank service config, such as
|
58
|
+
# `projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config`.
|
59
|
+
# @!attribute [rw] model
|
60
|
+
# @return [::String]
|
61
|
+
# The identifier of the model to use. It is one of:
|
62
|
+
#
|
63
|
+
# * `semantic-ranker-512@latest`: Semantic ranking model with maxiumn input
|
64
|
+
# token size 512.
|
65
|
+
#
|
66
|
+
# It is set to `semantic-ranker-512@latest` by default if unspecified.
|
67
|
+
# @!attribute [rw] top_n
|
68
|
+
# @return [::Integer]
|
69
|
+
# The number of results to return. If this is unset or no bigger than zero,
|
70
|
+
# returns all results.
|
71
|
+
# @!attribute [rw] query
|
72
|
+
# @return [::String]
|
73
|
+
# The query to use.
|
74
|
+
# @!attribute [rw] records
|
75
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::RankingRecord>]
|
76
|
+
# Required. A list of records to rank. At most 200 records to rank.
|
77
|
+
# @!attribute [rw] ignore_record_details_in_response
|
78
|
+
# @return [::Boolean]
|
79
|
+
# If true, the response will contain only record ID and score. By default, it
|
80
|
+
# is false, the response will contain record details.
|
81
|
+
# @!attribute [rw] user_labels
|
82
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
83
|
+
# The user labels applied to a resource must meet the following requirements:
|
84
|
+
#
|
85
|
+
# * Each resource can have multiple labels, up to a maximum of 64.
|
86
|
+
# * Each label must be a key-value pair.
|
87
|
+
# * Keys have a minimum length of 1 character and a maximum length of 63
|
88
|
+
# characters and cannot be empty. Values can be empty and have a maximum
|
89
|
+
# length of 63 characters.
|
90
|
+
# * Keys and values can contain only lowercase letters, numeric characters,
|
91
|
+
# underscores, and dashes. All characters must use UTF-8 encoding, and
|
92
|
+
# international characters are allowed.
|
93
|
+
# * The key portion of a label must be unique. However, you can use the same
|
94
|
+
# key with multiple resources.
|
95
|
+
# * Keys must start with a lowercase letter or international character.
|
96
|
+
#
|
97
|
+
# See [Google Cloud
|
98
|
+
# Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
|
99
|
+
# for more details.
|
100
|
+
class RankRequest
|
101
|
+
include ::Google::Protobuf::MessageExts
|
102
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
103
|
+
|
104
|
+
# @!attribute [rw] key
|
105
|
+
# @return [::String]
|
106
|
+
# @!attribute [rw] value
|
107
|
+
# @return [::String]
|
108
|
+
class UserLabelsEntry
|
109
|
+
include ::Google::Protobuf::MessageExts
|
110
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
111
|
+
end
|
112
|
+
end
|
113
|
+
|
114
|
+
# Response message for
|
115
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::RankService::Client#rank RankService.Rank}
|
116
|
+
# method.
|
117
|
+
# @!attribute [rw] records
|
118
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::RankingRecord>]
|
119
|
+
# A list of records sorted by descending score.
|
120
|
+
class RankResponse
|
121
|
+
include ::Google::Protobuf::MessageExts
|
122
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
123
|
+
end
|
124
|
+
end
|
125
|
+
end
|
126
|
+
end
|
127
|
+
end
|
@@ -30,7 +30,7 @@ module Google
|
|
30
30
|
# `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*`
|
31
31
|
#
|
32
32
|
# One default serving config is created along with your recommendation engine
|
33
|
-
# creation. The engine ID
|
33
|
+
# creation. The engine ID is used as the ID of the default serving
|
34
34
|
# config. For example, for Engine
|
35
35
|
# `projects/*/locations/global/collections/*/engines/my-engine`, you can use
|
36
36
|
# `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine`
|
@@ -58,9 +58,9 @@ module Google
|
|
58
58
|
# @!attribute [rw] page_size
|
59
59
|
# @return [::Integer]
|
60
60
|
# Maximum number of results to return. Set this property
|
61
|
-
# to the number of recommendation results needed. If zero, the service
|
62
|
-
#
|
63
|
-
# above 100
|
61
|
+
# to the number of recommendation results needed. If zero, the service
|
62
|
+
# chooses a reasonable default. The maximum allowed value is 100. Values
|
63
|
+
# above 100 are set to 100.
|
64
64
|
# @!attribute [rw] filter
|
65
65
|
# @return [::String]
|
66
66
|
# Filter for restricting recommendation results with a length limit of 5,000
|
@@ -81,19 +81,19 @@ module Google
|
|
81
81
|
# * (available: true) AND
|
82
82
|
# (launguage: ANY("en", "es")) OR (categories: ANY("Movie"))
|
83
83
|
#
|
84
|
-
# If your filter blocks all results, the API
|
84
|
+
# If your filter blocks all results, the API returns generic
|
85
85
|
# (unfiltered) popular Documents. If you only want results strictly matching
|
86
|
-
# the filters, set `strictFiltering` to
|
86
|
+
# the filters, set `strictFiltering` to `true` in
|
87
87
|
# {::Google::Cloud::DiscoveryEngine::V1beta::RecommendRequest#params RecommendRequest.params}
|
88
88
|
# to receive empty results instead.
|
89
89
|
#
|
90
|
-
# Note that the API
|
90
|
+
# Note that the API never returns
|
91
91
|
# {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}s with
|
92
|
-
# `storageStatus`
|
92
|
+
# `storageStatus` as `EXPIRED` or `DELETED` regardless of filter choices.
|
93
93
|
# @!attribute [rw] validate_only
|
94
94
|
# @return [::Boolean]
|
95
|
-
# Use validate only mode for this recommendation query. If set to true
|
96
|
-
# fake model
|
95
|
+
# Use validate only mode for this recommendation query. If set to `true`, a
|
96
|
+
# fake model is used that returns arbitrary Document IDs.
|
97
97
|
# Note that the validate only mode should only be used for testing the API,
|
98
98
|
# or if the model is not ready.
|
99
99
|
# @!attribute [rw] params
|
@@ -102,16 +102,17 @@ module Google
|
|
102
102
|
#
|
103
103
|
# Allowed values:
|
104
104
|
#
|
105
|
-
# * `returnDocument`: Boolean. If set to true
|
106
|
-
# object
|
105
|
+
# * `returnDocument`: Boolean. If set to `true`, the associated Document
|
106
|
+
# object is returned in
|
107
107
|
# {::Google::Cloud::DiscoveryEngine::V1beta::RecommendResponse::RecommendationResult#document RecommendResponse.RecommendationResult.document}.
|
108
|
-
# * `returnScore`: Boolean. If set to true, the recommendation
|
109
|
-
# corresponding to each returned Document
|
108
|
+
# * `returnScore`: Boolean. If set to true, the recommendation score
|
109
|
+
# corresponding to each returned Document is set in
|
110
110
|
# {::Google::Cloud::DiscoveryEngine::V1beta::RecommendResponse::RecommendationResult#metadata RecommendResponse.RecommendationResult.metadata}.
|
111
|
-
# The given
|
112
|
-
#
|
113
|
-
# * `strictFiltering`: Boolean. True by default. If set to false
|
114
|
-
#
|
111
|
+
# The given score indicates the probability of a Document conversion given
|
112
|
+
# the user's context and history.
|
113
|
+
# * `strictFiltering`: Boolean. True by default. If set to `false`, the
|
114
|
+
# service
|
115
|
+
# returns generic (unfiltered) popular Documents instead of empty if
|
115
116
|
# your filter blocks all recommendation results.
|
116
117
|
# * `diversityLevel`: String. Default empty. If set to be non-empty, then
|
117
118
|
# it needs to be one of:
|
@@ -202,7 +203,7 @@ module Google
|
|
202
203
|
# {::Google::Cloud::DiscoveryEngine::V1beta::RecommendRequest#params RecommendRequest.params}.
|
203
204
|
# @!attribute [rw] metadata
|
204
205
|
# @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
|
205
|
-
# Additional Document metadata
|
206
|
+
# Additional Document metadata or annotations.
|
206
207
|
#
|
207
208
|
# Possible values:
|
208
209
|
#
|
@@ -46,9 +46,9 @@ module Google
|
|
46
46
|
# to return. The service may return fewer than this value.
|
47
47
|
#
|
48
48
|
# If unspecified, at most 100
|
49
|
-
# {::Google::Cloud::DiscoveryEngine::V1beta::Schema Schema}s
|
49
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::Schema Schema}s are returned.
|
50
50
|
#
|
51
|
-
# The maximum value is 1000; values above 1000
|
51
|
+
# The maximum value is 1000; values above 1000 are set to 1000.
|
52
52
|
# @!attribute [rw] page_token
|
53
53
|
# @return [::String]
|
54
54
|
# A page token, received from a previous
|
@@ -94,7 +94,7 @@ module Google
|
|
94
94
|
# @!attribute [rw] schema_id
|
95
95
|
# @return [::String]
|
96
96
|
# Required. The ID to use for the
|
97
|
-
# {::Google::Cloud::DiscoveryEngine::V1beta::Schema Schema}, which
|
97
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::Schema Schema}, which becomes the
|
98
98
|
# final component of the
|
99
99
|
# {::Google::Cloud::DiscoveryEngine::V1beta::Schema#name Schema.name}.
|
100
100
|
#
|
@@ -117,8 +117,8 @@ module Google
|
|
117
117
|
# @return [::Boolean]
|
118
118
|
# If set to true, and the
|
119
119
|
# {::Google::Cloud::DiscoveryEngine::V1beta::Schema Schema} is not found, a new
|
120
|
-
# {::Google::Cloud::DiscoveryEngine::V1beta::Schema Schema}
|
121
|
-
#
|
120
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::Schema Schema} is created. In this
|
121
|
+
# situation, `update_mask` is ignored.
|
122
122
|
class UpdateSchemaRequest
|
123
123
|
include ::Google::Protobuf::MessageExts
|
124
124
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -48,10 +48,14 @@ module Google
|
|
48
48
|
# @!attribute [rw] page_size
|
49
49
|
# @return [::Integer]
|
50
50
|
# Maximum number of {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}s
|
51
|
-
# to return.
|
52
|
-
#
|
51
|
+
# to return. The maximum allowed value depends on the data type. Values above
|
52
|
+
# the maximum value are coerced to the maximum value.
|
53
53
|
#
|
54
|
-
#
|
54
|
+
# * Websites with basic indexing: Default `10`, Maximum `25`.
|
55
|
+
# * Websites with advanced indexing: Default `25`, Maximum `50`.
|
56
|
+
# * Other: Default `50`, Maximum `100`.
|
57
|
+
#
|
58
|
+
# If this field is negative, an `INVALID_ARGUMENT` is returned.
|
55
59
|
# @!attribute [rw] page_token
|
56
60
|
# @return [::String]
|
57
61
|
# A page token received from a previous
|
@@ -74,7 +78,10 @@ module Google
|
|
74
78
|
# If this field is negative, an `INVALID_ARGUMENT` is returned.
|
75
79
|
# @!attribute [rw] data_store_specs
|
76
80
|
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::DataStoreSpec>]
|
77
|
-
#
|
81
|
+
# Specs defining dataStores to filter on in a search call and configurations
|
82
|
+
# for those dataStores. This is only considered for engines with multiple
|
83
|
+
# dataStores use case. For single dataStore within an engine, they should
|
84
|
+
# use the specs at the top level.
|
78
85
|
# @!attribute [rw] filter
|
79
86
|
# @return [::String]
|
80
87
|
# The filter syntax consists of an expression language for constructing a
|
@@ -111,7 +118,9 @@ module Google
|
|
111
118
|
# The order in which documents are returned. Documents can be ordered by
|
112
119
|
# a field in an {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}
|
113
120
|
# object. Leave it unset if ordered by relevance. `order_by` expression is
|
114
|
-
# case-sensitive.
|
121
|
+
# case-sensitive.
|
122
|
+
#
|
123
|
+
# For more information on ordering for retail search, see
|
115
124
|
# [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order)
|
116
125
|
#
|
117
126
|
# If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
@@ -131,7 +140,7 @@ module Google
|
|
131
140
|
# @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec]
|
132
141
|
# Boost specification to boost certain documents.
|
133
142
|
# For more information on boosting, see
|
134
|
-
# [Boosting](https://cloud.google.com/
|
143
|
+
# [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
|
135
144
|
# @!attribute [rw] params
|
136
145
|
# @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
|
137
146
|
# Additional search parameters.
|
@@ -140,8 +149,7 @@ module Google
|
|
140
149
|
#
|
141
150
|
# * `user_country_code`: string. Default empty. If set to non-empty, results
|
142
151
|
# are restricted or boosted based on the location provided.
|
143
|
-
#
|
144
|
-
# user_country_code: "au"
|
152
|
+
# For example, `user_country_code: "au"`
|
145
153
|
#
|
146
154
|
# For available codes see [Country
|
147
155
|
# Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes)
|
@@ -149,8 +157,7 @@ module Google
|
|
149
157
|
# * `search_type`: double. Default empty. Enables non-webpage searching
|
150
158
|
# depending on the value. The only valid non-default value is 1,
|
151
159
|
# which enables image searching.
|
152
|
-
#
|
153
|
-
# search_type: 1
|
160
|
+
# For example, `search_type: 1`
|
154
161
|
# @!attribute [rw] query_expansion_spec
|
155
162
|
# @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec]
|
156
163
|
# The query expansion specification that specifies the conditions under which
|
@@ -188,7 +195,8 @@ module Google
|
|
188
195
|
#
|
189
196
|
# If
|
190
197
|
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::EmbeddingSpec::EmbeddingVector#field_path SearchRequest.EmbeddingSpec.EmbeddingVector.field_path}
|
191
|
-
# is not provided, it will use
|
198
|
+
# is not provided, it will use
|
199
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig#embedding_config ServingConfig.EmbeddingConfig.field_path}.
|
192
200
|
# @!attribute [rw] ranking_expression
|
193
201
|
# @return [::String]
|
194
202
|
# The ranking expression controls the customized ranking on retrieval
|
@@ -248,7 +256,9 @@ module Google
|
|
248
256
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
249
257
|
end
|
250
258
|
|
251
|
-
# A struct to define data stores to filter on in a search call
|
259
|
+
# A struct to define data stores to filter on in a search call and
|
260
|
+
# configurations for those data stores. A maximum of 1 DataStoreSpec per
|
261
|
+
# data_store is allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
252
262
|
# @!attribute [rw] data_store
|
253
263
|
# @return [::String]
|
254
264
|
# Required. Full resource name of
|
@@ -265,7 +275,7 @@ module Google
|
|
265
275
|
# Required. The facet key specification.
|
266
276
|
# @!attribute [rw] limit
|
267
277
|
# @return [::Integer]
|
268
|
-
# Maximum
|
278
|
+
# Maximum facet values that are returned for this facet. If
|
269
279
|
# unspecified, defaults to 20. The maximum allowed value is 300. Values
|
270
280
|
# above 300 are coerced to 300.
|
271
281
|
#
|
@@ -362,7 +372,7 @@ module Google
|
|
362
372
|
# Only supported on textual fields. Maximum is 10.
|
363
373
|
# @!attribute [rw] contains
|
364
374
|
# @return [::Array<::String>]
|
365
|
-
# Only get facet values that
|
375
|
+
# Only get facet values that contain the given strings. For example,
|
366
376
|
# suppose "category" has three values "Action > 2022",
|
367
377
|
# "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the
|
368
378
|
# "category" facet only contains "Action > 2022" and "Sci-Fi > 2022".
|
@@ -425,23 +435,109 @@ module Google
|
|
425
435
|
# Strength of the condition boost, which should be in [-1, 1]. Negative
|
426
436
|
# boost means demotion. Default is 0.0.
|
427
437
|
#
|
428
|
-
# Setting to 1.0 gives the document a big promotion. However, it does
|
429
|
-
# necessarily mean that the boosted document will be the top result
|
430
|
-
# all times, nor that other documents will be excluded. Results
|
431
|
-
# still be shown even when none of them matches the condition.
|
432
|
-
# results that are significantly more relevant to the search query
|
433
|
-
# still trump your heavily favored but irrelevant documents.
|
438
|
+
# Setting to 1.0 gives the document a big promotion. However, it does
|
439
|
+
# not necessarily mean that the boosted document will be the top result
|
440
|
+
# at all times, nor that other documents will be excluded. Results
|
441
|
+
# could still be shown even when none of them matches the condition.
|
442
|
+
# And results that are significantly more relevant to the search query
|
443
|
+
# can still trump your heavily favored but irrelevant documents.
|
434
444
|
#
|
435
445
|
# Setting to -1.0 gives the document a big demotion. However, results
|
436
446
|
# that are deeply relevant might still be shown. The document will have
|
437
|
-
# an upstream battle to get a fairly high ranking, but it is not
|
438
|
-
# out completely.
|
447
|
+
# an upstream battle to get a fairly high ranking, but it is not
|
448
|
+
# blocked out completely.
|
439
449
|
#
|
440
450
|
# Setting to 0.0 means no boost applied. The boosting condition is
|
441
|
-
# ignored.
|
451
|
+
# ignored. Only one of the (condition, boost) combination or the
|
452
|
+
# boost_control_spec below are set. If both are set then the global boost
|
453
|
+
# is ignored and the more fine-grained boost_control_spec is applied.
|
454
|
+
# @!attribute [rw] boost_control_spec
|
455
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec::ConditionBoostSpec::BoostControlSpec]
|
456
|
+
# Complex specification for custom ranking based on customer defined
|
457
|
+
# attribute value.
|
442
458
|
class ConditionBoostSpec
|
443
459
|
include ::Google::Protobuf::MessageExts
|
444
460
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
461
|
+
|
462
|
+
# Specification for custom ranking based on customer specified attribute
|
463
|
+
# value. It provides more controls for customized ranking than the simple
|
464
|
+
# (condition, boost) combination above.
|
465
|
+
# @!attribute [rw] field_name
|
466
|
+
# @return [::String]
|
467
|
+
# The name of the field whose value will be used to determine the
|
468
|
+
# boost amount.
|
469
|
+
# @!attribute [rw] attribute_type
|
470
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec::ConditionBoostSpec::BoostControlSpec::AttributeType]
|
471
|
+
# The attribute type to be used to determine the boost amount. The
|
472
|
+
# attribute value can be derived from the field value of the specified
|
473
|
+
# field_name. In the case of numerical it is straightforward i.e.
|
474
|
+
# attribute_value = numerical_field_value. In the case of freshness
|
475
|
+
# however, attribute_value = (time.now() - datetime_field_value).
|
476
|
+
# @!attribute [rw] interpolation_type
|
477
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec::ConditionBoostSpec::BoostControlSpec::InterpolationType]
|
478
|
+
# The interpolation type to be applied to connect the control points
|
479
|
+
# listed below.
|
480
|
+
# @!attribute [rw] control_points
|
481
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec::ConditionBoostSpec::BoostControlSpec::ControlPoint>]
|
482
|
+
# The control points used to define the curve. The monotonic function
|
483
|
+
# (defined through the interpolation_type above) passes through the
|
484
|
+
# control points listed here.
|
485
|
+
class BoostControlSpec
|
486
|
+
include ::Google::Protobuf::MessageExts
|
487
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
488
|
+
|
489
|
+
# The control points used to define the curve. The curve defined
|
490
|
+
# through these control points can only be monotonically increasing
|
491
|
+
# or decreasing(constant values are acceptable).
|
492
|
+
# @!attribute [rw] attribute_value
|
493
|
+
# @return [::String]
|
494
|
+
# Can be one of:
|
495
|
+
# 1. The numerical field value.
|
496
|
+
# 2. The duration spec for freshness:
|
497
|
+
# The value must be formatted as an XSD `dayTimeDuration` value (a
|
498
|
+
# restricted subset of an ISO 8601 duration value). The pattern for
|
499
|
+
# this is: `[nD][T[nH][nM][nS]]`.
|
500
|
+
# @!attribute [rw] boost_amount
|
501
|
+
# @return [::Float]
|
502
|
+
# The value between -1 to 1 by which to boost the score if the
|
503
|
+
# attribute_value evaluates to the value specified above.
|
504
|
+
class ControlPoint
|
505
|
+
include ::Google::Protobuf::MessageExts
|
506
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
507
|
+
end
|
508
|
+
|
509
|
+
# The attribute(or function) for which the custom ranking is to be
|
510
|
+
# applied.
|
511
|
+
module AttributeType
|
512
|
+
# Unspecified AttributeType.
|
513
|
+
ATTRIBUTE_TYPE_UNSPECIFIED = 0
|
514
|
+
|
515
|
+
# The value of the numerical field will be used to dynamically update
|
516
|
+
# the boost amount. In this case, the attribute_value (the x value)
|
517
|
+
# of the control point will be the actual value of the numerical
|
518
|
+
# field for which the boost_amount is specified.
|
519
|
+
NUMERICAL = 1
|
520
|
+
|
521
|
+
# For the freshness use case the attribute value will be the duration
|
522
|
+
# between the current time and the date in the datetime field
|
523
|
+
# specified. The value must be formatted as an XSD `dayTimeDuration`
|
524
|
+
# value (a restricted subset of an ISO 8601 duration value). The
|
525
|
+
# pattern for this is: `[nD][T[nH][nM][nS]]`.
|
526
|
+
# For example, `5D`, `3DT12H30M`, `T24H`.
|
527
|
+
FRESHNESS = 2
|
528
|
+
end
|
529
|
+
|
530
|
+
# The interpolation type to be applied. Default will be linear
|
531
|
+
# (Piecewise Linear).
|
532
|
+
module InterpolationType
|
533
|
+
# Interpolation type is unspecified. In this case, it defaults to
|
534
|
+
# Linear.
|
535
|
+
INTERPOLATION_TYPE_UNSPECIFIED = 0
|
536
|
+
|
537
|
+
# Piecewise linear interpolation will be applied.
|
538
|
+
LINEAR = 1
|
539
|
+
end
|
540
|
+
end
|
445
541
|
end
|
446
542
|
end
|
447
543
|
|
@@ -480,8 +576,8 @@ module Google
|
|
480
576
|
# The specification for query spell correction.
|
481
577
|
# @!attribute [rw] mode
|
482
578
|
# @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode]
|
483
|
-
# The mode under which spell correction
|
484
|
-
#
|
579
|
+
# The mode under which spell correction
|
580
|
+
# replaces the original search query. Defaults to
|
485
581
|
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode::AUTO Mode.AUTO}.
|
486
582
|
class SpellCorrectionSpec
|
487
583
|
include ::Google::Protobuf::MessageExts
|
@@ -494,10 +590,10 @@ module Google
|
|
494
590
|
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode::AUTO Mode.AUTO}.
|
495
591
|
MODE_UNSPECIFIED = 0
|
496
592
|
|
497
|
-
# Search API
|
498
|
-
#
|
593
|
+
# Search API tries to find a spelling suggestion. If a suggestion is
|
594
|
+
# found, it is put in the
|
499
595
|
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse#corrected_query SearchResponse.corrected_query}.
|
500
|
-
# The
|
596
|
+
# The spelling suggestion won't be used as the search query.
|
501
597
|
SUGGESTION_ONLY = 1
|
502
598
|
|
503
599
|
# Automatic spell correction built by the Search API. Search will
|
@@ -553,7 +649,10 @@ module Google
|
|
553
649
|
# of results returned is less than `summaryResultCount`, the summary is
|
554
650
|
# generated from all of the results.
|
555
651
|
#
|
556
|
-
# At most 10 results
|
652
|
+
# At most 10 results for documents mode, or 50 for chunks mode, can be
|
653
|
+
# used to generate a summary. The chunks mode is used when
|
654
|
+
# [SearchRequest.ContentSearchSpec.search_result_mode][] is set to
|
655
|
+
# [CHUNKS][SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS].
|
557
656
|
# @!attribute [rw] include_citations
|
558
657
|
# @return [::Boolean]
|
559
658
|
# Specifies whether to include citations in the summary. The default
|
@@ -611,6 +710,14 @@ module Google
|
|
611
710
|
# @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec::ModelSpec]
|
612
711
|
# If specified, the spec will be used to modify the model specification
|
613
712
|
# provided to the LLM.
|
713
|
+
# @!attribute [rw] use_semantic_chunks
|
714
|
+
# @return [::Boolean]
|
715
|
+
# If true, answer will be generated from most relevant chunks from top
|
716
|
+
# search results. This feature will improve summary quality.
|
717
|
+
# Note that with this feature enabled, not all top search results
|
718
|
+
# will be referenced and included in the reference list, so the citation
|
719
|
+
# source index only points to the search results listed in the reference
|
720
|
+
# list.
|
614
721
|
class SummarySpec
|
615
722
|
include ::Google::Protobuf::MessageExts
|
616
723
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -633,11 +740,13 @@ module Google
|
|
633
740
|
# Supported values are:
|
634
741
|
#
|
635
742
|
# * `stable`: string. Default value when no value is specified. Uses a
|
636
|
-
#
|
637
|
-
#
|
638
|
-
#
|
639
|
-
#
|
640
|
-
#
|
743
|
+
# generally available, fine-tuned model. For more information, see
|
744
|
+
# [Answer generation model versions and
|
745
|
+
# lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
|
746
|
+
# * `preview`: string. (Public preview) Uses a preview model. For more
|
747
|
+
# information, see
|
748
|
+
# [Answer generation model versions and
|
749
|
+
# lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
|
641
750
|
class ModelSpec
|
642
751
|
include ::Google::Protobuf::MessageExts
|
643
752
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -683,10 +792,9 @@ module Google
|
|
683
792
|
# @!attribute [rw] return_extractive_segment_score
|
684
793
|
# @return [::Boolean]
|
685
794
|
# Specifies whether to return the confidence score from the extractive
|
686
|
-
# segments in each search result.
|
687
|
-
#
|
688
|
-
#
|
689
|
-
# users, please reach out to Cloud Support team if you want to use it.
|
795
|
+
# segments in each search result. This feature is available only for new
|
796
|
+
# or allowlisted data stores. To allowlist your data store,
|
797
|
+
# contact your Customer Engineer. The default value is `false`.
|
690
798
|
# @!attribute [rw] num_previous_segments
|
691
799
|
# @return [::Integer]
|
692
800
|
# Specifies whether to also include the adjacent from each selected
|
@@ -798,6 +906,8 @@ module Google
|
|
798
906
|
# @!attribute [rw] applied_controls
|
799
907
|
# @return [::Array<::String>]
|
800
908
|
# Controls applied as part of the Control service.
|
909
|
+
# @!attribute [rw] geo_search_debug_info
|
910
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::GeoSearchDebugInfo>]
|
801
911
|
# @!attribute [rw] query_expansion_info
|
802
912
|
# @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::QueryExpansionInfo]
|
803
913
|
# Query expansion information for the returned results.
|
@@ -813,7 +923,7 @@ module Google
|
|
813
923
|
# @!attribute [rw] document
|
814
924
|
# @return [::Google::Cloud::DiscoveryEngine::V1beta::Document]
|
815
925
|
# The document data snippet in the search response. Only fields that are
|
816
|
-
# marked as retrievable are populated.
|
926
|
+
# marked as `retrievable` are populated.
|
817
927
|
# @!attribute [rw] model_scores
|
818
928
|
# @return [::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1beta::DoubleList}]
|
819
929
|
# Google provided available scores.
|
@@ -834,7 +944,7 @@ module Google
|
|
834
944
|
# A facet result.
|
835
945
|
# @!attribute [rw] key
|
836
946
|
# @return [::String]
|
837
|
-
# The key for this facet.
|
947
|
+
# The key for this facet. For example, `"colors"` or `"price"`. It matches
|
838
948
|
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key SearchRequest.FacetSpec.FacetKey.key}.
|
839
949
|
# @!attribute [rw] values
|
840
950
|
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue>]
|
@@ -879,17 +989,17 @@ module Google
|
|
879
989
|
# Useful attribute for search result refinements.
|
880
990
|
# @!attribute [rw] attribute_key
|
881
991
|
# @return [::String]
|
882
|
-
# Attribute key used to refine the results
|
992
|
+
# Attribute key used to refine the results. For example, `"movie_type"`.
|
883
993
|
# @!attribute [rw] attribute_value
|
884
994
|
# @return [::String]
|
885
|
-
# Attribute value used to refine the results
|
995
|
+
# Attribute value used to refine the results. For example, `"drama"`.
|
886
996
|
class RefinementAttribute
|
887
997
|
include ::Google::Protobuf::MessageExts
|
888
998
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
889
999
|
end
|
890
1000
|
end
|
891
1001
|
|
892
|
-
# Summary of the top N search
|
1002
|
+
# Summary of the top N search results specified by the summary spec.
|
893
1003
|
# @!attribute [rw] summary_text
|
894
1004
|
# @return [::String]
|
895
1005
|
# The summary content.
|
@@ -971,9 +1081,24 @@ module Google
|
|
971
1081
|
# @!attribute [rw] uri
|
972
1082
|
# @return [::String]
|
973
1083
|
# Cloud Storage or HTTP uri for the document.
|
1084
|
+
# @!attribute [rw] chunk_contents
|
1085
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::Reference::ChunkContent>]
|
1086
|
+
# List of cited chunk contents derived from document content.
|
974
1087
|
class Reference
|
975
1088
|
include ::Google::Protobuf::MessageExts
|
976
1089
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1090
|
+
|
1091
|
+
# Chunk content.
|
1092
|
+
# @!attribute [rw] content
|
1093
|
+
# @return [::String]
|
1094
|
+
# Chunk textual content.
|
1095
|
+
# @!attribute [rw] page_identifier
|
1096
|
+
# @return [::String]
|
1097
|
+
# Page identifier.
|
1098
|
+
class ChunkContent
|
1099
|
+
include ::Google::Protobuf::MessageExts
|
1100
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1101
|
+
end
|
977
1102
|
end
|
978
1103
|
|
979
1104
|
# Summary with metadata information.
|
@@ -1030,6 +1155,19 @@ module Google
|
|
1030
1155
|
end
|
1031
1156
|
end
|
1032
1157
|
|
1158
|
+
# Debug information specifically related to forward geocoding issues arising
|
1159
|
+
# from Geolocation Search.
|
1160
|
+
# @!attribute [rw] original_address_query
|
1161
|
+
# @return [::String]
|
1162
|
+
# The address from which forward geocoding ingestion produced issues.
|
1163
|
+
# @!attribute [rw] error_message
|
1164
|
+
# @return [::String]
|
1165
|
+
# The error produced.
|
1166
|
+
class GeoSearchDebugInfo
|
1167
|
+
include ::Google::Protobuf::MessageExts
|
1168
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1169
|
+
end
|
1170
|
+
|
1033
1171
|
# Information describing query expansion including whether expansion has
|
1034
1172
|
# occurred.
|
1035
1173
|
# @!attribute [rw] expanded_query
|