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
@@ -50,7 +50,7 @@ module Google
|
|
50
50
|
# characters.
|
51
51
|
#
|
52
52
|
# Format:
|
53
|
-
# `projects/{
|
53
|
+
# `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
|
54
54
|
# engine should be 1-63 characters, and valid characters are
|
55
55
|
# /[a-z0-9][a-z0-9-_]*/. Otherwise, an INVALID_ARGUMENT error is returned.
|
56
56
|
# @!attribute [rw] display_name
|
@@ -98,6 +98,10 @@ module Google
|
|
98
98
|
# @!attribute [rw] common_config
|
99
99
|
# @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::CommonConfig]
|
100
100
|
# Common config spec that specifies the metadata of the engine.
|
101
|
+
# @!attribute [rw] disable_analytics
|
102
|
+
# @return [::Boolean]
|
103
|
+
# Optional. Whether to disable analytics for searches performed on this
|
104
|
+
# engine.
|
101
105
|
class Engine
|
102
106
|
include ::Google::Protobuf::MessageExts
|
103
107
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -179,7 +179,7 @@ module Google
|
|
179
179
|
# @return [::String]
|
180
180
|
# Required. The name of the engine to pause.
|
181
181
|
# Format:
|
182
|
-
# `projects/{
|
182
|
+
# `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`
|
183
183
|
class PauseEngineRequest
|
184
184
|
include ::Google::Protobuf::MessageExts
|
185
185
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -190,7 +190,7 @@ module Google
|
|
190
190
|
# @return [::String]
|
191
191
|
# Required. The name of the engine to resume.
|
192
192
|
# Format:
|
193
|
-
# `projects/{
|
193
|
+
# `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`
|
194
194
|
class ResumeEngineRequest
|
195
195
|
include ::Google::Protobuf::MessageExts
|
196
196
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -202,7 +202,7 @@ module Google
|
|
202
202
|
# @return [::String]
|
203
203
|
# Required. The resource name of the engine to tune.
|
204
204
|
# Format:
|
205
|
-
# `projects/{
|
205
|
+
# `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`
|
206
206
|
class TuneEngineRequest
|
207
207
|
include ::Google::Protobuf::MessageExts
|
208
208
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -213,7 +213,7 @@ module Google
|
|
213
213
|
# @return [::String]
|
214
214
|
# Required. The resource name of the engine that this tune applies to.
|
215
215
|
# Format:
|
216
|
-
# `projects/{
|
216
|
+
# `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`
|
217
217
|
class TuneEngineMetadata
|
218
218
|
include ::Google::Protobuf::MessageExts
|
219
219
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -21,6 +21,388 @@ module Google
|
|
21
21
|
module Cloud
|
22
22
|
module DiscoveryEngine
|
23
23
|
module V1beta
|
24
|
+
# Base structured datatype containing multi-part content of a message.
|
25
|
+
# @!attribute [rw] role
|
26
|
+
# @return [::String]
|
27
|
+
# Producer of the content. Must be either `user` or `model`.
|
28
|
+
#
|
29
|
+
# Intended to be used for multi-turn conversations. Otherwise, it can be left
|
30
|
+
# unset.
|
31
|
+
# @!attribute [rw] parts
|
32
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::GroundedGenerationContent::Part>]
|
33
|
+
# Ordered `Parts` that constitute a single message.
|
34
|
+
class GroundedGenerationContent
|
35
|
+
include ::Google::Protobuf::MessageExts
|
36
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
37
|
+
|
38
|
+
# Single part of content.
|
39
|
+
# @!attribute [rw] text
|
40
|
+
# @return [::String]
|
41
|
+
# Inline text.
|
42
|
+
class Part
|
43
|
+
include ::Google::Protobuf::MessageExts
|
44
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
45
|
+
end
|
46
|
+
end
|
47
|
+
|
48
|
+
# Top-level message sent by the client for the `GenerateGroundedContent`
|
49
|
+
# method.
|
50
|
+
# @!attribute [rw] location
|
51
|
+
# @return [::String]
|
52
|
+
# Required. Location resource.
|
53
|
+
#
|
54
|
+
# Format: `projects/{project}/locations/{location}`.
|
55
|
+
# @!attribute [rw] system_instruction
|
56
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::GroundedGenerationContent]
|
57
|
+
# Content of the system instruction for the current API.
|
58
|
+
#
|
59
|
+
# These instructions will take priority over any other prompt instructions
|
60
|
+
# if the selected model is supporting them.
|
61
|
+
# @!attribute [rw] contents
|
62
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::GroundedGenerationContent>]
|
63
|
+
# Content of the current conversation with the model.
|
64
|
+
#
|
65
|
+
# For single-turn queries, this is a single instance. For multi-turn queries,
|
66
|
+
# this is a repeated field that contains conversation history + latest
|
67
|
+
# request.
|
68
|
+
# @!attribute [rw] generation_spec
|
69
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::GenerateGroundedContentRequest::GenerationSpec]
|
70
|
+
# Content generation specification.
|
71
|
+
# @!attribute [rw] grounding_spec
|
72
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::GenerateGroundedContentRequest::GroundingSpec]
|
73
|
+
# Grounding specification.
|
74
|
+
# @!attribute [rw] user_labels
|
75
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
76
|
+
# The user labels applied to a resource must meet the following requirements:
|
77
|
+
#
|
78
|
+
# * Each resource can have multiple labels, up to a maximum of 64.
|
79
|
+
# * Each label must be a key-value pair.
|
80
|
+
# * Keys have a minimum length of 1 character and a maximum length of 63
|
81
|
+
# characters and cannot be empty. Values can be empty and have a maximum
|
82
|
+
# length of 63 characters.
|
83
|
+
# * Keys and values can contain only lowercase letters, numeric characters,
|
84
|
+
# underscores, and dashes. All characters must use UTF-8 encoding, and
|
85
|
+
# international characters are allowed.
|
86
|
+
# * The key portion of a label must be unique. However, you can use the same
|
87
|
+
# key with multiple resources.
|
88
|
+
# * Keys must start with a lowercase letter or international character.
|
89
|
+
#
|
90
|
+
# See [Google Cloud
|
91
|
+
# Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
|
92
|
+
# for more details.
|
93
|
+
class GenerateGroundedContentRequest
|
94
|
+
include ::Google::Protobuf::MessageExts
|
95
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
96
|
+
|
97
|
+
# Content generation specification.
|
98
|
+
# @!attribute [rw] model_id
|
99
|
+
# @return [::String]
|
100
|
+
# Specifies which Vertex model id to use for generation.
|
101
|
+
# @!attribute [rw] language_code
|
102
|
+
# @return [::String]
|
103
|
+
# Language code for content. Use language tags defined by
|
104
|
+
# [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
|
105
|
+
# @!attribute [rw] temperature
|
106
|
+
# @return [::Float]
|
107
|
+
# If specified, custom value for the temperature will be used.
|
108
|
+
# @!attribute [rw] top_p
|
109
|
+
# @return [::Float]
|
110
|
+
# If specified, custom value for nucleus sampling will be used.
|
111
|
+
# @!attribute [rw] top_k
|
112
|
+
# @return [::Integer]
|
113
|
+
# If specified, custom value for top-k sampling will be used.
|
114
|
+
# @!attribute [rw] frequency_penalty
|
115
|
+
# @return [::Float]
|
116
|
+
# If specified, custom value for frequency penalty will be used.
|
117
|
+
# @!attribute [rw] presence_penalty
|
118
|
+
# @return [::Float]
|
119
|
+
# If specified, custom value for presence penalty will be used.
|
120
|
+
# @!attribute [rw] max_output_tokens
|
121
|
+
# @return [::Integer]
|
122
|
+
# If specified, custom value for max output tokens will be used.
|
123
|
+
class GenerationSpec
|
124
|
+
include ::Google::Protobuf::MessageExts
|
125
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
126
|
+
end
|
127
|
+
|
128
|
+
# Describes the options to customize dynamic retrieval.
|
129
|
+
# @!attribute [rw] predictor
|
130
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::GenerateGroundedContentRequest::DynamicRetrievalConfiguration::DynamicRetrievalPredictor]
|
131
|
+
# Specification for the predictor for dynamic retrieval.
|
132
|
+
class DynamicRetrievalConfiguration
|
133
|
+
include ::Google::Protobuf::MessageExts
|
134
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
135
|
+
|
136
|
+
# Describes the predictor settings for dynamic retrieval.
|
137
|
+
# @!attribute [rw] version
|
138
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::GenerateGroundedContentRequest::DynamicRetrievalConfiguration::DynamicRetrievalPredictor::Version]
|
139
|
+
# The version of the predictor to be used in dynamic retrieval.
|
140
|
+
# @!attribute [rw] threshold
|
141
|
+
# @return [::Float]
|
142
|
+
# The value of the threshold. If the predictor will predict a
|
143
|
+
# value smaller than this, it would suppress grounding in the source.
|
144
|
+
class DynamicRetrievalPredictor
|
145
|
+
include ::Google::Protobuf::MessageExts
|
146
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
147
|
+
|
148
|
+
# The version of the predictor to be used in dynamic retrieval.
|
149
|
+
module Version
|
150
|
+
# Automatically choose the best version of the retrieval predictor.
|
151
|
+
VERSION_UNSPECIFIED = 0
|
152
|
+
|
153
|
+
# The V1 model which is evaluating each source independently.
|
154
|
+
V1_INDEPENDENT = 1
|
155
|
+
end
|
156
|
+
end
|
157
|
+
end
|
158
|
+
|
159
|
+
# Grounding source.
|
160
|
+
# @!attribute [rw] inline_source
|
161
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::GenerateGroundedContentRequest::GroundingSource::InlineSource]
|
162
|
+
# If set, grounding is performed with inline content.
|
163
|
+
# @!attribute [rw] search_source
|
164
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::GenerateGroundedContentRequest::GroundingSource::SearchSource]
|
165
|
+
# If set, grounding is performed with Vertex AI Search.
|
166
|
+
# @!attribute [rw] google_search_source
|
167
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::GenerateGroundedContentRequest::GroundingSource::GoogleSearchSource]
|
168
|
+
# If set, grounding is performed with Google Search.
|
169
|
+
class GroundingSource
|
170
|
+
include ::Google::Protobuf::MessageExts
|
171
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
172
|
+
|
173
|
+
# Message to be used for grounding based on inline content.
|
174
|
+
# @!attribute [rw] grounding_facts
|
175
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::GroundingFact>]
|
176
|
+
# List of facts to be used for grounding.
|
177
|
+
# @!attribute [rw] attributes
|
178
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
179
|
+
# Attributes associated with the content.
|
180
|
+
#
|
181
|
+
# Common attributes include `source` (indicating where the content was
|
182
|
+
# sourced from) and `author` (indicating the author of the content).
|
183
|
+
class InlineSource
|
184
|
+
include ::Google::Protobuf::MessageExts
|
185
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
186
|
+
|
187
|
+
# @!attribute [rw] key
|
188
|
+
# @return [::String]
|
189
|
+
# @!attribute [rw] value
|
190
|
+
# @return [::String]
|
191
|
+
class AttributesEntry
|
192
|
+
include ::Google::Protobuf::MessageExts
|
193
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
194
|
+
end
|
195
|
+
end
|
196
|
+
|
197
|
+
# Message to be used for grounding with Vertex AI Search.
|
198
|
+
# @!attribute [rw] serving_config
|
199
|
+
# @return [::String]
|
200
|
+
# The resource name of the Engine to use.
|
201
|
+
#
|
202
|
+
# Format:
|
203
|
+
# `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`
|
204
|
+
# @!attribute [rw] max_result_count
|
205
|
+
# @return [::Integer]
|
206
|
+
# Number of search results to return.
|
207
|
+
#
|
208
|
+
# The default value is 10. The maximumm allowed value is 10.
|
209
|
+
# @!attribute [rw] filter
|
210
|
+
# @return [::String]
|
211
|
+
# Filter expression to be applied to the search.
|
212
|
+
#
|
213
|
+
# The syntax is the same as
|
214
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#filter SearchRequest.filter}.
|
215
|
+
# @!attribute [rw] safe_search
|
216
|
+
# @return [::Boolean]
|
217
|
+
# If set, safe search is enabled in Vertex AI Search requests.
|
218
|
+
class SearchSource
|
219
|
+
include ::Google::Protobuf::MessageExts
|
220
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
221
|
+
end
|
222
|
+
|
223
|
+
# Google Search config parameters.
|
224
|
+
# @!attribute [rw] dynamic_retrieval_config
|
225
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::GenerateGroundedContentRequest::DynamicRetrievalConfiguration]
|
226
|
+
# Optional. Specifies the dynamic retrieval configuration for the given
|
227
|
+
# source.
|
228
|
+
class GoogleSearchSource
|
229
|
+
include ::Google::Protobuf::MessageExts
|
230
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
231
|
+
end
|
232
|
+
end
|
233
|
+
|
234
|
+
# Grounding specification.
|
235
|
+
# @!attribute [rw] grounding_sources
|
236
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::GenerateGroundedContentRequest::GroundingSource>]
|
237
|
+
# Grounding sources.
|
238
|
+
class GroundingSpec
|
239
|
+
include ::Google::Protobuf::MessageExts
|
240
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
241
|
+
end
|
242
|
+
|
243
|
+
# @!attribute [rw] key
|
244
|
+
# @return [::String]
|
245
|
+
# @!attribute [rw] value
|
246
|
+
# @return [::String]
|
247
|
+
class UserLabelsEntry
|
248
|
+
include ::Google::Protobuf::MessageExts
|
249
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
250
|
+
end
|
251
|
+
end
|
252
|
+
|
253
|
+
# Response for the `GenerateGroundedContent` method.
|
254
|
+
# @!attribute [rw] candidates
|
255
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::GenerateGroundedContentResponse::Candidate>]
|
256
|
+
# Generated candidates.
|
257
|
+
class GenerateGroundedContentResponse
|
258
|
+
include ::Google::Protobuf::MessageExts
|
259
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
260
|
+
|
261
|
+
# A response candidate generated from the model.
|
262
|
+
# @!attribute [rw] index
|
263
|
+
# @return [::Integer]
|
264
|
+
# Index of the candidate.
|
265
|
+
# @!attribute [rw] content
|
266
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::GroundedGenerationContent]
|
267
|
+
# Content of the candidate.
|
268
|
+
# @!attribute [rw] grounding_score
|
269
|
+
# @return [::Float]
|
270
|
+
# The overall grounding score for the candidate, in the range of [0, 1].
|
271
|
+
# @!attribute [rw] grounding_metadata
|
272
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::GenerateGroundedContentResponse::Candidate::GroundingMetadata]
|
273
|
+
# Grounding metadata for the generated content.
|
274
|
+
class Candidate
|
275
|
+
include ::Google::Protobuf::MessageExts
|
276
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
277
|
+
|
278
|
+
# Citation for the generated content.
|
279
|
+
# @!attribute [rw] retrieval_metadata
|
280
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::GenerateGroundedContentResponse::Candidate::GroundingMetadata::RetrievalMetadata>]
|
281
|
+
# Retrieval metadata to provide an understanding in the
|
282
|
+
# retrieval steps performed by the model. There can be multiple such
|
283
|
+
# messages which can correspond to different parts of the retrieval. This
|
284
|
+
# is a mechanism used to ensure transparency to our users.
|
285
|
+
# @!attribute [rw] support_chunks
|
286
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::FactChunk>]
|
287
|
+
# List of chunks to be attributed across all claims in the candidate.
|
288
|
+
# These are derived from the grounding sources supplied in the request.
|
289
|
+
# @!attribute [rw] web_search_queries
|
290
|
+
# @return [::Array<::String>]
|
291
|
+
# Web search queries for the following-up web search.
|
292
|
+
# @!attribute [rw] search_entry_point
|
293
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::GenerateGroundedContentResponse::Candidate::GroundingMetadata::SearchEntryPoint]
|
294
|
+
# Google search entry for the following-up web searches.
|
295
|
+
# @!attribute [rw] grounding_support
|
296
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::GenerateGroundedContentResponse::Candidate::GroundingMetadata::GroundingSupport>]
|
297
|
+
# GroundingSupport across all claims in the answer candidate.
|
298
|
+
# An support to a fact indicates that the claim is supported by
|
299
|
+
# the fact.
|
300
|
+
class GroundingMetadata
|
301
|
+
include ::Google::Protobuf::MessageExts
|
302
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
303
|
+
|
304
|
+
# Describes the metadata associated with a retrieval step.
|
305
|
+
# @!attribute [rw] source
|
306
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::GenerateGroundedContentResponse::Candidate::GroundingMetadata::RetrievalMetadata::Source]
|
307
|
+
# Describes the source to which the metadata is referring to.
|
308
|
+
# @!attribute [rw] dynamic_retrieval_metadata
|
309
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::GenerateGroundedContentResponse::Candidate::GroundingMetadata::DynamicRetrievalMetadata]
|
310
|
+
# Metadata for dynamic retrieval.
|
311
|
+
class RetrievalMetadata
|
312
|
+
include ::Google::Protobuf::MessageExts
|
313
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
314
|
+
|
315
|
+
# Describes the source to which the metadata is associated to.
|
316
|
+
module Source
|
317
|
+
# Unspecified source.
|
318
|
+
SOURCE_UNSPECIFIED = 0
|
319
|
+
|
320
|
+
# Vertex AI search.
|
321
|
+
VERTEX_AI_SEARCH = 1
|
322
|
+
|
323
|
+
# Google Search.
|
324
|
+
GOOGLE_SEARCH = 3
|
325
|
+
|
326
|
+
# User inline provided content.
|
327
|
+
INLINE_CONTENT = 2
|
328
|
+
|
329
|
+
# Google Maps.
|
330
|
+
GOOGLE_MAPS = 4
|
331
|
+
end
|
332
|
+
end
|
333
|
+
|
334
|
+
# Describes the metadata about dynamic retrieval.
|
335
|
+
# @!attribute [rw] predictor_metadata
|
336
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::GenerateGroundedContentResponse::Candidate::GroundingMetadata::DynamicRetrievalPredictorMetadata]
|
337
|
+
# Metadata for the dynamic retrieval predictor.
|
338
|
+
class DynamicRetrievalMetadata
|
339
|
+
include ::Google::Protobuf::MessageExts
|
340
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
341
|
+
end
|
342
|
+
|
343
|
+
# Describes the metadata about the dynamic retrieval predictor.
|
344
|
+
# @!attribute [rw] version
|
345
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::GenerateGroundedContentResponse::Candidate::GroundingMetadata::DynamicRetrievalPredictorMetadata::Version]
|
346
|
+
# The version of the predictor which was used in dynamic retrieval.
|
347
|
+
# @!attribute [rw] prediction
|
348
|
+
# @return [::Float]
|
349
|
+
# The value of the predictor. This should be between [0, 1] where
|
350
|
+
# a value of 0 means that the query would not benefit from grounding,
|
351
|
+
# while a value of 1.0 means that the query would benefit the most.
|
352
|
+
# In between values allow to differentiate between different usefulness
|
353
|
+
# scores for grounding.
|
354
|
+
class DynamicRetrievalPredictorMetadata
|
355
|
+
include ::Google::Protobuf::MessageExts
|
356
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
357
|
+
|
358
|
+
# The version of the predictor which was used in dynamic retrieval.
|
359
|
+
module Version
|
360
|
+
# Unspecified version, should never be used.
|
361
|
+
VERSION_UNSPECIFIED = 0
|
362
|
+
|
363
|
+
# The V1 model which is evaluating each source independently.
|
364
|
+
V1_INDEPENDENT = 1
|
365
|
+
end
|
366
|
+
end
|
367
|
+
|
368
|
+
# Google search entry point.
|
369
|
+
# @!attribute [rw] rendered_content
|
370
|
+
# @return [::String]
|
371
|
+
# Web content snippet that can be embedded in a web page or an app
|
372
|
+
# webview.
|
373
|
+
# @!attribute [rw] sdk_blob
|
374
|
+
# @return [::String]
|
375
|
+
# Base64 encoded JSON representing array of <search term, search url>
|
376
|
+
# tuple.
|
377
|
+
class SearchEntryPoint
|
378
|
+
include ::Google::Protobuf::MessageExts
|
379
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
380
|
+
end
|
381
|
+
|
382
|
+
# Grounding info for a claim in the candidate and its support.
|
383
|
+
# @!attribute [rw] claim_text
|
384
|
+
# @return [::String]
|
385
|
+
# Text for the claim in the candidate. Always provided when a
|
386
|
+
# support is found.
|
387
|
+
# @!attribute [rw] support_chunk_indices
|
388
|
+
# @return [::Array<::Integer>]
|
389
|
+
# A list of indices (into 'support_chunks') specifying the
|
390
|
+
# citations associated with the claim. For instance [1,3,4] means
|
391
|
+
# that support_chunks[1], support_chunks[3],
|
392
|
+
# support_chunks[4] are the chunks attributed to the claim.
|
393
|
+
# @!attribute [rw] support_score
|
394
|
+
# @return [::Float]
|
395
|
+
# A score in the range of [0, 1] describing how grounded is a specific
|
396
|
+
# claim in the support chunks indicated.
|
397
|
+
# Higher value means that the claim is better supported by the chunks.
|
398
|
+
class GroundingSupport
|
399
|
+
include ::Google::Protobuf::MessageExts
|
400
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
401
|
+
end
|
402
|
+
end
|
403
|
+
end
|
404
|
+
end
|
405
|
+
|
24
406
|
# Specification for the grounding check.
|
25
407
|
# @!attribute [rw] citation_threshold
|
26
408
|
# @return [::Float]
|
@@ -43,7 +425,7 @@ module Google
|
|
43
425
|
# `projects/*/locations/global/groundingConfigs/default_grounding_config`.
|
44
426
|
# @!attribute [rw] answer_candidate
|
45
427
|
# @return [::String]
|
46
|
-
# Answer candidate to check.
|
428
|
+
# Answer candidate to check. It can have a maximum length of 4096 tokens.
|
47
429
|
# @!attribute [rw] facts
|
48
430
|
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::GroundingFact>]
|
49
431
|
# List of facts for the grounding check.
|
@@ -96,6 +478,10 @@ module Google
|
|
96
478
|
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::FactChunk>]
|
97
479
|
# List of facts cited across all claims in the answer candidate.
|
98
480
|
# These are derived from the facts supplied in the request.
|
481
|
+
# @!attribute [rw] cited_facts
|
482
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::CheckGroundingResponse::CheckGroundingFactChunk>]
|
483
|
+
# List of facts cited across all claims in the answer candidate.
|
484
|
+
# These are derived from the facts supplied in the request.
|
99
485
|
# @!attribute [rw] claims
|
100
486
|
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::CheckGroundingResponse::Claim>]
|
101
487
|
# Claim texts and citation info across all claims in the answer candidate.
|
@@ -103,6 +489,15 @@ module Google
|
|
103
489
|
include ::Google::Protobuf::MessageExts
|
104
490
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
105
491
|
|
492
|
+
# Fact chunk for grounding check.
|
493
|
+
# @!attribute [rw] chunk_text
|
494
|
+
# @return [::String]
|
495
|
+
# Text content of the fact chunk. Can be at most 10K characters long.
|
496
|
+
class CheckGroundingFactChunk
|
497
|
+
include ::Google::Protobuf::MessageExts
|
498
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
499
|
+
end
|
500
|
+
|
106
501
|
# Text and citation info for a claim in the answer candidate.
|
107
502
|
# @!attribute [rw] start_pos
|
108
503
|
# @return [::Integer]
|
@@ -130,8 +525,9 @@ module Google
|
|
130
525
|
# field will be set to false. In that case, no grounding check was done for
|
131
526
|
# the claim and therefore
|
132
527
|
# {::Google::Cloud::DiscoveryEngine::V1beta::CheckGroundingResponse::Claim#citation_indices citation_indices},
|
528
|
+
# [anti_citation_indices][google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim.anti_citation_indices],
|
133
529
|
# and
|
134
|
-
# [
|
530
|
+
# [score][google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim.score]
|
135
531
|
# should not be returned.
|
136
532
|
class Claim
|
137
533
|
include ::Google::Protobuf::MessageExts
|
@@ -21,6 +21,16 @@ module Google
|
|
21
21
|
module Cloud
|
22
22
|
module DiscoveryEngine
|
23
23
|
module V1beta
|
24
|
+
# Grounding configuration.
|
25
|
+
# @!attribute [rw] name
|
26
|
+
# @return [::String]
|
27
|
+
# Required. Name of the GroundingConfig, of the form
|
28
|
+
# `projects/{project}/locations/{location}/groundingConfigs/{grounding_config}`.
|
29
|
+
class GroundingConfig
|
30
|
+
include ::Google::Protobuf::MessageExts
|
31
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
32
|
+
end
|
33
|
+
|
24
34
|
# Grounding Fact.
|
25
35
|
# @!attribute [rw] fact_text
|
26
36
|
# @return [::String]
|
@@ -69,7 +69,7 @@ module Google
|
|
69
69
|
# BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format.
|
70
70
|
# @!attribute [rw] project_id
|
71
71
|
# @return [::String]
|
72
|
-
# The project ID
|
72
|
+
# The project ID or the project number that contains the BigQuery source. Has
|
73
73
|
# a length limit of 128 characters. If not specified, inherits the project
|
74
74
|
# ID from the parent request.
|
75
75
|
# @!attribute [rw] dataset_id
|
@@ -114,7 +114,7 @@ module Google
|
|
114
114
|
# The Spanner source for importing data
|
115
115
|
# @!attribute [rw] project_id
|
116
116
|
# @return [::String]
|
117
|
-
# The project ID that the Spanner source
|
117
|
+
# The project ID that contains the Spanner source. Has a length limit of 128
|
118
118
|
# characters. If not specified, inherits the project ID from the parent
|
119
119
|
# request.
|
120
120
|
# @!attribute [rw] instance_id
|
@@ -269,7 +269,7 @@ module Google
|
|
269
269
|
# The Cloud Bigtable source for importing data.
|
270
270
|
# @!attribute [rw] project_id
|
271
271
|
# @return [::String]
|
272
|
-
# The project ID that the Bigtable source
|
272
|
+
# The project ID that contains the Bigtable source. Has a length limit of 128
|
273
273
|
# characters. If not specified, inherits the project ID from the parent
|
274
274
|
# request.
|
275
275
|
# @!attribute [rw] instance_id
|
@@ -298,6 +298,12 @@ module Google
|
|
298
298
|
# Intermediate Cloud Storage directory used for the import with a length
|
299
299
|
# limit of 2,000 characters. Can be specified if one wants to have the
|
300
300
|
# FhirStore export to a specific Cloud Storage directory.
|
301
|
+
# @!attribute [rw] resource_types
|
302
|
+
# @return [::Array<::String>]
|
303
|
+
# The FHIR resource types to import. The resource types should be a subset of
|
304
|
+
# all [supported FHIR resource
|
305
|
+
# types](https://cloud.google.com/generative-ai-app-builder/docs/fhir-schema-reference#resource-level-specification).
|
306
|
+
# Default to all supported FHIR resource types if empty.
|
301
307
|
class FhirStoreSource
|
302
308
|
include ::Google::Protobuf::MessageExts
|
303
309
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -306,8 +312,8 @@ module Google
|
|
306
312
|
# Cloud SQL source import data from.
|
307
313
|
# @!attribute [rw] project_id
|
308
314
|
# @return [::String]
|
309
|
-
# The project ID that the Cloud SQL source
|
310
|
-
# characters. If not specified, inherits the project ID from the parent
|
315
|
+
# The project ID that contains the Cloud SQL source. Has a length limit of
|
316
|
+
# 128 characters. If not specified, inherits the project ID from the parent
|
311
317
|
# request.
|
312
318
|
# @!attribute [rw] instance_id
|
313
319
|
# @return [::String]
|
@@ -342,8 +348,8 @@ module Google
|
|
342
348
|
# AlloyDB source import data from.
|
343
349
|
# @!attribute [rw] project_id
|
344
350
|
# @return [::String]
|
345
|
-
# The project ID that the AlloyDB source
|
346
|
-
#
|
351
|
+
# The project ID that contains the AlloyDB source.
|
352
|
+
# Has a length limit of 128 characters. If not specified, inherits the
|
347
353
|
# project ID from the parent request.
|
348
354
|
# @!attribute [rw] location_id
|
349
355
|
# @return [::String]
|
@@ -25,7 +25,7 @@ module Google
|
|
25
25
|
# @!attribute [r] name
|
26
26
|
# @return [::String]
|
27
27
|
# Output only. Full resource name of the project, for example
|
28
|
-
# `projects/{
|
28
|
+
# `projects/{project}`.
|
29
29
|
# Note that when making requests, project number and project id are both
|
30
30
|
# acceptable, but the server will always respond in project number.
|
31
31
|
# @!attribute [r] create_time
|
@@ -26,7 +26,7 @@ module Google
|
|
26
26
|
# @return [::String]
|
27
27
|
# Required. The resource name of the catalog under which the events are
|
28
28
|
# created. The format is
|
29
|
-
# `projects
|
29
|
+
# `projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}`.
|
30
30
|
# @!attribute [rw] filter
|
31
31
|
# @return [::String]
|
32
32
|
# Required. The filter string to specify the events to be deleted with a
|
@@ -98,9 +98,30 @@ module Google
|
|
98
98
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
99
99
|
end
|
100
100
|
|
101
|
+
# Configuration of destination for Purge related errors.
|
102
|
+
# @!attribute [rw] gcs_prefix
|
103
|
+
# @return [::String]
|
104
|
+
# Cloud Storage prefix for purge errors. This must be an empty,
|
105
|
+
# existing Cloud Storage directory. Purge errors are written to
|
106
|
+
# sharded files in this directory, one per line, as a JSON-encoded
|
107
|
+
# `google.rpc.Status` message.
|
108
|
+
class PurgeErrorConfig
|
109
|
+
include ::Google::Protobuf::MessageExts
|
110
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
111
|
+
end
|
112
|
+
|
101
113
|
# Request message for
|
102
114
|
# {::Google::Cloud::DiscoveryEngine::V1beta::DocumentService::Client#purge_documents DocumentService.PurgeDocuments}
|
103
115
|
# method.
|
116
|
+
# @!attribute [rw] gcs_source
|
117
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::GcsSource]
|
118
|
+
# Cloud Storage location for the input content.
|
119
|
+
# Supported `data_schema`:
|
120
|
+
# * `document_id`: One valid
|
121
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::Document#id Document.id} per line.
|
122
|
+
# @!attribute [rw] inline_source
|
123
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::PurgeDocumentsRequest::InlineSource]
|
124
|
+
# Inline source for the input content for purge.
|
104
125
|
# @!attribute [rw] parent
|
105
126
|
# @return [::String]
|
106
127
|
# Required. The parent resource name, such as
|
@@ -110,6 +131,9 @@ module Google
|
|
110
131
|
# Required. Filter matching documents to purge. Only currently supported
|
111
132
|
# value is
|
112
133
|
# `*` (all items).
|
134
|
+
# @!attribute [rw] error_config
|
135
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::PurgeErrorConfig]
|
136
|
+
# The desired location of errors incurred during the purge.
|
113
137
|
# @!attribute [rw] force
|
114
138
|
# @return [::Boolean]
|
115
139
|
# Actually performs the purge. If `force` is set to false, return the
|
@@ -117,6 +141,20 @@ module Google
|
|
117
141
|
class PurgeDocumentsRequest
|
118
142
|
include ::Google::Protobuf::MessageExts
|
119
143
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
144
|
+
|
145
|
+
# The inline source for the input config for
|
146
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::DocumentService::Client#purge_documents DocumentService.PurgeDocuments}
|
147
|
+
# method.
|
148
|
+
# @!attribute [rw] documents
|
149
|
+
# @return [::Array<::String>]
|
150
|
+
# Required. A list of full resource name of documents to purge. In the
|
151
|
+
# format
|
152
|
+
# `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
|
153
|
+
# Recommended max of 100 items.
|
154
|
+
class InlineSource
|
155
|
+
include ::Google::Protobuf::MessageExts
|
156
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
157
|
+
end
|
120
158
|
end
|
121
159
|
|
122
160
|
# Response message for
|
@@ -55,7 +55,7 @@ module Google
|
|
55
55
|
# @!attribute [rw] ranking_config
|
56
56
|
# @return [::String]
|
57
57
|
# Required. The resource name of the rank service config, such as
|
58
|
-
# `projects/{project_num}/locations/{
|
58
|
+
# `projects/{project_num}/locations/{location}/rankingConfigs/default_ranking_config`.
|
59
59
|
# @!attribute [rw] model
|
60
60
|
# @return [::String]
|
61
61
|
# The identifier of the model to use. It is one of:
|