google-cloud-discovery_engine-v1beta 0.15.0 → 0.17.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (131) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +30 -20
  3. data/lib/google/cloud/discovery_engine/v1beta/completion_service/client.rb +186 -6
  4. data/lib/google/cloud/discovery_engine/v1beta/completion_service/operations.rb +12 -15
  5. data/lib/google/cloud/discovery_engine/v1beta/completion_service/paths.rb +62 -0
  6. data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/client.rb +179 -6
  7. data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/operations.rb +43 -38
  8. data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/service_stub.rb +131 -31
  9. data/lib/google/cloud/discovery_engine/v1beta/control_service/client.rb +35 -12
  10. data/lib/google/cloud/discovery_engine/v1beta/control_service/rest/client.rb +35 -12
  11. data/lib/google/cloud/discovery_engine/v1beta/control_service/rest/service_stub.rb +54 -32
  12. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/client.rb +48 -27
  13. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest/client.rb +48 -27
  14. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest/service_stub.rb +118 -80
  15. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/client.rb +31 -6
  16. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/operations.rb +12 -15
  17. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/rest/client.rb +31 -6
  18. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/rest/operations.rb +43 -38
  19. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/rest/service_stub.rb +54 -32
  20. data/lib/google/cloud/discovery_engine/v1beta/document_service/client.rb +31 -9
  21. data/lib/google/cloud/discovery_engine/v1beta/document_service/operations.rb +12 -15
  22. data/lib/google/cloud/discovery_engine/v1beta/document_service/paths.rb +25 -0
  23. data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/client.rb +31 -9
  24. data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/operations.rb +43 -38
  25. data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/service_stub.rb +78 -50
  26. data/lib/google/cloud/discovery_engine/v1beta/engine_service/client.rb +35 -12
  27. data/lib/google/cloud/discovery_engine/v1beta/engine_service/operations.rb +12 -15
  28. data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/client.rb +35 -12
  29. data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/operations.rb +43 -38
  30. data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/service_stub.rb +78 -50
  31. data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/client.rb +31 -5
  32. data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/operations.rb +12 -15
  33. data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/rest/client.rb +31 -5
  34. data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/rest/operations.rb +43 -38
  35. data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/rest/service_stub.rb +46 -26
  36. data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/client.rb +244 -6
  37. data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/paths.rb +85 -0
  38. data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/rest/client.rb +152 -6
  39. data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/rest/service_stub.rb +83 -7
  40. data/lib/google/cloud/discovery_engine/v1beta/project_service/client.rb +29 -2
  41. data/lib/google/cloud/discovery_engine/v1beta/project_service/operations.rb +12 -15
  42. data/lib/google/cloud/discovery_engine/v1beta/project_service/rest/client.rb +29 -2
  43. data/lib/google/cloud/discovery_engine/v1beta/project_service/rest/operations.rb +43 -38
  44. data/lib/google/cloud/discovery_engine/v1beta/project_service/rest/service_stub.rb +22 -8
  45. data/lib/google/cloud/discovery_engine/v1beta/rank_service/client.rb +29 -3
  46. data/lib/google/cloud/discovery_engine/v1beta/rank_service/rest/client.rb +29 -3
  47. data/lib/google/cloud/discovery_engine/v1beta/rank_service/rest/service_stub.rb +22 -8
  48. data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/client.rb +28 -2
  49. data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/rest/client.rb +28 -2
  50. data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/rest/service_stub.rb +22 -8
  51. data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/client.rb +30 -7
  52. data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/operations.rb +12 -15
  53. data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/rest/client.rb +30 -7
  54. data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/rest/operations.rb +43 -38
  55. data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/rest/service_stub.rb +62 -38
  56. data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service/client.rb +29 -6
  57. data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service/rest/client.rb +29 -6
  58. data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service/rest/service_stub.rb +54 -32
  59. data/lib/google/cloud/discovery_engine/v1beta/schema_service/client.rb +32 -6
  60. data/lib/google/cloud/discovery_engine/v1beta/schema_service/operations.rb +12 -15
  61. data/lib/google/cloud/discovery_engine/v1beta/schema_service/rest/client.rb +32 -6
  62. data/lib/google/cloud/discovery_engine/v1beta/schema_service/rest/operations.rb +43 -38
  63. data/lib/google/cloud/discovery_engine/v1beta/schema_service/rest/service_stub.rb +54 -32
  64. data/lib/google/cloud/discovery_engine/v1beta/search_service/client.rb +427 -3
  65. data/lib/google/cloud/discovery_engine/v1beta/search_service/rest/client.rb +417 -3
  66. data/lib/google/cloud/discovery_engine/v1beta/search_service/rest/service_stub.rb +99 -7
  67. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/client.rb +29 -3
  68. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/operations.rb +12 -15
  69. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/rest/client.rb +29 -3
  70. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/rest/operations.rb +43 -38
  71. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/rest/service_stub.rb +30 -14
  72. data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/client.rb +31 -6
  73. data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/rest/client.rb +31 -6
  74. data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/rest/service_stub.rb +38 -20
  75. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/client.rb +361 -14
  76. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/operations.rb +12 -15
  77. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/paths.rb +49 -0
  78. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/client.rb +340 -14
  79. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/operations.rb +43 -38
  80. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/service_stub.rb +308 -73
  81. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/client.rb +31 -6
  82. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/operations.rb +12 -15
  83. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/client.rb +31 -6
  84. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/operations.rb +43 -38
  85. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/service_stub.rb +46 -26
  86. data/lib/google/cloud/discovery_engine/v1beta/version.rb +1 -1
  87. data/lib/google/cloud/discoveryengine/v1beta/answer_pb.rb +1 -1
  88. data/lib/google/cloud/discoveryengine/v1beta/common_pb.rb +1 -1
  89. data/lib/google/cloud/discoveryengine/v1beta/completion_service_pb.rb +18 -1
  90. data/lib/google/cloud/discoveryengine/v1beta/completion_service_services_pb.rb +2 -0
  91. data/lib/google/cloud/discoveryengine/v1beta/control_pb.rb +1 -1
  92. data/lib/google/cloud/discoveryengine/v1beta/conversational_search_service_pb.rb +4 -1
  93. data/lib/google/cloud/discoveryengine/v1beta/custom_tuning_model_pb.rb +1 -1
  94. data/lib/google/cloud/discoveryengine/v1beta/data_store_pb.rb +7 -1
  95. data/lib/google/cloud/discoveryengine/v1beta/document_service_pb.rb +2 -1
  96. data/lib/google/cloud/discoveryengine/v1beta/engine_pb.rb +1 -1
  97. data/lib/google/cloud/discoveryengine/v1beta/grounded_generation_service_pb.rb +24 -1
  98. data/lib/google/cloud/discoveryengine/v1beta/grounded_generation_service_services_pb.rb +4 -0
  99. data/lib/google/cloud/discoveryengine/v1beta/grounding_pb.rb +2 -1
  100. data/lib/google/cloud/discoveryengine/v1beta/search_service_pb.rb +3 -1
  101. data/lib/google/cloud/discoveryengine/v1beta/search_service_services_pb.rb +14 -0
  102. data/lib/google/cloud/discoveryengine/v1beta/serving_config_pb.rb +2 -2
  103. data/lib/google/cloud/discoveryengine/v1beta/site_search_engine_pb.rb +2 -1
  104. data/lib/google/cloud/discoveryengine/v1beta/site_search_engine_service_pb.rb +10 -1
  105. data/lib/google/cloud/discoveryengine/v1beta/site_search_engine_service_services_pb.rb +7 -0
  106. data/lib/google/cloud/discoveryengine/v1beta/user_event_pb.rb +1 -1
  107. data/proto_docs/google/api/client.rb +39 -0
  108. data/proto_docs/google/cloud/discoveryengine/v1beta/answer.rb +20 -6
  109. data/proto_docs/google/cloud/discoveryengine/v1beta/completion_service.rb +268 -0
  110. data/proto_docs/google/cloud/discoveryengine/v1beta/control.rb +9 -0
  111. data/proto_docs/google/cloud/discoveryengine/v1beta/control_service.rb +6 -6
  112. data/proto_docs/google/cloud/discoveryengine/v1beta/conversational_search_service.rb +95 -15
  113. data/proto_docs/google/cloud/discoveryengine/v1beta/custom_tuning_model.rb +8 -3
  114. data/proto_docs/google/cloud/discoveryengine/v1beta/data_store.rb +131 -0
  115. data/proto_docs/google/cloud/discoveryengine/v1beta/document_processing_config.rb +7 -5
  116. data/proto_docs/google/cloud/discoveryengine/v1beta/document_service.rb +19 -0
  117. data/proto_docs/google/cloud/discoveryengine/v1beta/engine.rb +5 -1
  118. data/proto_docs/google/cloud/discoveryengine/v1beta/engine_service.rb +4 -4
  119. data/proto_docs/google/cloud/discoveryengine/v1beta/grounded_generation_service.rb +396 -1
  120. data/proto_docs/google/cloud/discoveryengine/v1beta/grounding.rb +10 -0
  121. data/proto_docs/google/cloud/discoveryengine/v1beta/project.rb +1 -1
  122. data/proto_docs/google/cloud/discoveryengine/v1beta/purge_config.rb +1 -1
  123. data/proto_docs/google/cloud/discoveryengine/v1beta/rank_service.rb +1 -1
  124. data/proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb +71 -0
  125. data/proto_docs/google/cloud/discoveryengine/v1beta/serving_config.rb +16 -0
  126. data/proto_docs/google/cloud/discoveryengine/v1beta/serving_config_service.rb +2 -2
  127. data/proto_docs/google/cloud/discoveryengine/v1beta/site_search_engine.rb +17 -0
  128. data/proto_docs/google/cloud/discoveryengine/v1beta/site_search_engine_service.rb +147 -1
  129. data/proto_docs/google/cloud/discoveryengine/v1beta/user_event.rb +9 -1
  130. data/proto_docs/google/longrunning/operations.rb +19 -14
  131. metadata +5 -5
@@ -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. Can have a maximum length of 1024 characters.
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]
@@ -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]
@@ -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/{project_number}`.
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/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}`
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
@@ -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/{location_id}/rankingConfigs/default_ranking_config`.
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:
@@ -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
@@ -313,6 +318,18 @@ module Google
313
318
  # Default to Google defined threshold, leveraging a balance of
314
319
  # precision and recall to deliver both highly accurate results and
315
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}.
316
333
  class SearchRequest
317
334
  include ::Google::Protobuf::MessageExts
318
335
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -335,6 +352,11 @@ module Google
335
352
  # Required. Full resource name of
336
353
  # {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore}, such as
337
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)
338
360
  class DataStoreSpec
339
361
  include ::Google::Protobuf::MessageExts
340
362
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -791,6 +813,19 @@ module Google
791
813
  # If this field is set to `false`, all search results are used regardless
792
814
  # of relevance to generate answers. If set to `true`, only queries with
793
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.
794
829
  # @!attribute [rw] model_prompt_spec
795
830
  # @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec::ModelPromptSpec]
796
831
  # If specified, the spec will be used to modify the prompt provided to
@@ -1062,6 +1097,30 @@ module Google
1062
1097
  extend ::Google::Protobuf::MessageExts::ClassMethods
1063
1098
  end
1064
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
+
1065
1124
  # @!attribute [rw] key
1066
1125
  # @return [::String]
1067
1126
  # @!attribute [rw] value
@@ -1401,6 +1460,7 @@ module Google
1401
1460
 
1402
1461
  # The non-summary seeking query ignored case.
1403
1462
  #
1463
+ # Google skips the summary if the query is chit chat.
1404
1464
  # Only used when
1405
1465
  # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec#ignore_non_summary_seeking_query SummarySpec.ignore_non_summary_seeking_query}
1406
1466
  # is set to `true`.
@@ -1443,6 +1503,14 @@ module Google
1443
1503
  # Google skips the summary if there is a customer policy violation
1444
1504
  # detected. The policy is defined by the customer.
1445
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
1446
1514
  end
1447
1515
  end
1448
1516
 
@@ -1672,6 +1740,9 @@ module Google
1672
1740
 
1673
1741
  # One Box result contains slack results.
1674
1742
  SLACK = 3
1743
+
1744
+ # One Box result contains Knowledge Graph search responses.
1745
+ KNOWLEDGE_GRAPH = 4
1675
1746
  end
1676
1747
  end
1677
1748
  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/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`
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/{project_number}/locations/{location}/collections/{collection}/engines/{engine}`
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