google-cloud-gemini_data_analytics-v1beta 0.9.1 → 0.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/lib/google/cloud/gemini_data_analytics/v1beta/data_agent_service/paths.rb +21 -0
- data/lib/google/cloud/gemini_data_analytics/v1beta/data_chat_service/client.rb +24 -7
- data/lib/google/cloud/gemini_data_analytics/v1beta/data_chat_service/paths.rb +21 -0
- data/lib/google/cloud/gemini_data_analytics/v1beta/data_chat_service/rest/client.rb +24 -7
- data/lib/google/cloud/gemini_data_analytics/v1beta/version.rb +1 -1
- data/lib/google/cloud/geminidataanalytics/v1beta/context_pb.rb +13 -1
- data/lib/google/cloud/geminidataanalytics/v1beta/conversation_pb.rb +1 -1
- data/lib/google/cloud/geminidataanalytics/v1beta/data_agent_pb.rb +1 -1
- data/lib/google/cloud/geminidataanalytics/v1beta/data_chat_service_pb.rb +4 -1
- data/lib/google/cloud/geminidataanalytics/v1beta/data_chat_service_services_pb.rb +1 -1
- data/lib/google/cloud/geminidataanalytics/v1beta/datasource_pb.rb +3 -1
- data/proto_docs/google/cloud/geminidataanalytics/v1beta/context.rb +202 -5
- data/proto_docs/google/cloud/geminidataanalytics/v1beta/conversation.rb +14 -2
- data/proto_docs/google/cloud/geminidataanalytics/v1beta/data_agent.rb +6 -0
- data/proto_docs/google/cloud/geminidataanalytics/v1beta/data_chat_service.rb +105 -21
- data/proto_docs/google/cloud/geminidataanalytics/v1beta/datasource.rb +101 -15
- metadata +7 -4
|
@@ -40,19 +40,24 @@ module Google
|
|
|
40
40
|
# @return [::Array<::Google::Cloud::GeminiDataAnalytics::V1beta::ExampleQuery>]
|
|
41
41
|
# Optional. A list of example queries, providing examples of relevant and
|
|
42
42
|
# commonly used SQL queries and their corresponding natural language queries
|
|
43
|
-
# optionally present. Currently only used for BigQuery data sources
|
|
43
|
+
# optionally present. Currently only used for BigQuery data sources and
|
|
44
|
+
# databases (alloydb, cloudsql, spanner) data sources.
|
|
44
45
|
# @!attribute [rw] looker_golden_queries
|
|
45
46
|
# @return [::Array<::Google::Cloud::GeminiDataAnalytics::V1beta::LookerGoldenQuery>]
|
|
46
47
|
# Optional. A list of golden queries, providing examples of relevant and
|
|
47
48
|
# commonly used Looker queries and their corresponding natural language
|
|
48
|
-
# queries optionally present.
|
|
49
|
+
# queries optionally present. Only supported for Looker data sources.
|
|
49
50
|
# @!attribute [rw] glossary_terms
|
|
50
51
|
# @return [::Array<::Google::Cloud::GeminiDataAnalytics::V1beta::GlossaryTerm>]
|
|
51
52
|
# Optional. Term definitions (currently, only user authored)
|
|
53
|
+
# Not supported for databases (alloydb, cloudsql, spanner) data sources.
|
|
52
54
|
# @!attribute [rw] schema_relationships
|
|
53
55
|
# @return [::Array<::Google::Cloud::GeminiDataAnalytics::V1beta::Context::SchemaRelationship>]
|
|
54
56
|
# Optional. Relationships between table schema, including referencing and
|
|
55
57
|
# referenced columns.
|
|
58
|
+
# @!attribute [rw] user_functions
|
|
59
|
+
# @return [::Google::Cloud::GeminiDataAnalytics::V1beta::UserFunctions]
|
|
60
|
+
# Optional. A collection of user functions to be included in context.
|
|
56
61
|
class Context
|
|
57
62
|
include ::Google::Protobuf::MessageExts
|
|
58
63
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -74,10 +79,10 @@ module Google
|
|
|
74
79
|
# index in the `left_schema_paths` list.
|
|
75
80
|
# @!attribute [rw] sources
|
|
76
81
|
# @return [::Array<::Google::Cloud::GeminiDataAnalytics::V1beta::Context::SchemaRelationship::Source>]
|
|
77
|
-
# Sources which generated the schema relation edge.
|
|
82
|
+
# Optional. Sources which generated the schema relation edge.
|
|
78
83
|
# @!attribute [rw] confidence_score
|
|
79
84
|
# @return [::Float]
|
|
80
|
-
# A confidence score for the suggested relationship.
|
|
85
|
+
# Optional. A confidence score for the suggested relationship.
|
|
81
86
|
# Manually added edges have the highest confidence score.
|
|
82
87
|
class SchemaRelationship
|
|
83
88
|
include ::Google::Protobuf::MessageExts
|
|
@@ -114,6 +119,43 @@ module Google
|
|
|
114
119
|
end
|
|
115
120
|
end
|
|
116
121
|
|
|
122
|
+
# A collection of user functions to be included in context.
|
|
123
|
+
# @!attribute [rw] bq_routines
|
|
124
|
+
# @return [::Array<::Google::Cloud::GeminiDataAnalytics::V1beta::BigQueryRoutine>]
|
|
125
|
+
# A list of BigQuery routines to include in the context.
|
|
126
|
+
class UserFunctions
|
|
127
|
+
include ::Google::Protobuf::MessageExts
|
|
128
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
129
|
+
end
|
|
130
|
+
|
|
131
|
+
# A reference to a BigQuery routine.
|
|
132
|
+
# @!attribute [rw] routine_reference
|
|
133
|
+
# @return [::Google::Cloud::GeminiDataAnalytics::V1beta::BigQueryRoutineReference]
|
|
134
|
+
# The reference to the BigQuery routine.
|
|
135
|
+
# @!attribute [rw] description
|
|
136
|
+
# @return [::String]
|
|
137
|
+
# User override or addition to description, to tell the agent when to use the
|
|
138
|
+
# UDF.
|
|
139
|
+
class BigQueryRoutine
|
|
140
|
+
include ::Google::Protobuf::MessageExts
|
|
141
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
142
|
+
end
|
|
143
|
+
|
|
144
|
+
# A reference to a BigQuery routine.
|
|
145
|
+
# @!attribute [rw] project_id
|
|
146
|
+
# @return [::String]
|
|
147
|
+
# The project ID of the routine.
|
|
148
|
+
# @!attribute [rw] dataset_id
|
|
149
|
+
# @return [::String]
|
|
150
|
+
# The dataset ID of the routine.
|
|
151
|
+
# @!attribute [rw] routine_id
|
|
152
|
+
# @return [::String]
|
|
153
|
+
# The routine ID of the routine.
|
|
154
|
+
class BigQueryRoutineReference
|
|
155
|
+
include ::Google::Protobuf::MessageExts
|
|
156
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
157
|
+
end
|
|
158
|
+
|
|
117
159
|
# Example of relevant and commonly used SQL query and its corresponding natural
|
|
118
160
|
# language queries optionally present. Currently only used for BigQuery data
|
|
119
161
|
# sources.
|
|
@@ -126,11 +168,66 @@ module Google
|
|
|
126
168
|
# @return [::String]
|
|
127
169
|
# Optional. A natural language question that a user might ask.
|
|
128
170
|
# For example: "How many orders were placed last month?"
|
|
171
|
+
# @!attribute [rw] parameters
|
|
172
|
+
# @return [::Array<::Google::Cloud::GeminiDataAnalytics::V1beta::QueryParameter>]
|
|
173
|
+
# Optional. The list of query parameters.
|
|
174
|
+
# Example: The parameterized SQL query
|
|
175
|
+
# "SELECT * FROM my_table WHERE id = @id" can be matched with any value of
|
|
176
|
+
# id.
|
|
129
177
|
class ExampleQuery
|
|
130
178
|
include ::Google::Protobuf::MessageExts
|
|
131
179
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
132
180
|
end
|
|
133
181
|
|
|
182
|
+
# A query parameter message represents a parameter that can be used to
|
|
183
|
+
# parameterize a SQL query.
|
|
184
|
+
# @!attribute [rw] name
|
|
185
|
+
# @return [::String]
|
|
186
|
+
# Required. The name of the parameter reference in the SQL query.
|
|
187
|
+
# @!attribute [rw] description
|
|
188
|
+
# @return [::String]
|
|
189
|
+
# Optional. The description of the parameter that can be used by LLM to
|
|
190
|
+
# extract the parameter value from the user question.
|
|
191
|
+
# @!attribute [rw] data_type
|
|
192
|
+
# @return [::String]
|
|
193
|
+
# Required. The data type of the parameter, e.g. "STRING", "INT64", "DATE",
|
|
194
|
+
# etc. For valid values, see the [BigQuery
|
|
195
|
+
# documentation](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types).
|
|
196
|
+
# This will be used to populate
|
|
197
|
+
# google.cloud.bigquery.v2.QueryParameterType.type.
|
|
198
|
+
class QueryParameter
|
|
199
|
+
include ::Google::Protobuf::MessageExts
|
|
200
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
201
|
+
end
|
|
202
|
+
|
|
203
|
+
# A matched query message represents the agent having matched one of the
|
|
204
|
+
# example queries supplied in context as being applicable to the current
|
|
205
|
+
# question. It will also contain additional info during the matching process.
|
|
206
|
+
# @!attribute [rw] example_query
|
|
207
|
+
# @return [::Google::Cloud::GeminiDataAnalytics::V1beta::ExampleQuery]
|
|
208
|
+
# The query that was matched based on an example query.
|
|
209
|
+
# @!attribute [rw] query_parameter_values
|
|
210
|
+
# @return [::Array<::Google::Cloud::GeminiDataAnalytics::V1beta::QueryParameterValues>]
|
|
211
|
+
# The extracted values for the query parameters.
|
|
212
|
+
class MatchedQuery
|
|
213
|
+
include ::Google::Protobuf::MessageExts
|
|
214
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
215
|
+
end
|
|
216
|
+
|
|
217
|
+
# A query parameter values message represents the values for the query
|
|
218
|
+
# parameters that were extracted from the user question by LLM, based on the
|
|
219
|
+
# example query.
|
|
220
|
+
# @!attribute [rw] name
|
|
221
|
+
# @return [::String]
|
|
222
|
+
# Required. The name of the parameter.
|
|
223
|
+
# @!attribute [rw] value
|
|
224
|
+
# @return [::String]
|
|
225
|
+
# Required. The value of the parameter.
|
|
226
|
+
class QueryParameterValues
|
|
227
|
+
include ::Google::Protobuf::MessageExts
|
|
228
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
229
|
+
end
|
|
230
|
+
|
|
134
231
|
# A golden query for Looker, including natural language questions and a
|
|
135
232
|
# corresponding Looker Query. Analogous to ExampleQuery.
|
|
136
233
|
# @!attribute [rw] natural_language_questions
|
|
@@ -166,6 +263,16 @@ module Google
|
|
|
166
263
|
# @!attribute [rw] limit
|
|
167
264
|
# @return [::String]
|
|
168
265
|
# Optional. Limit in the query.
|
|
266
|
+
# @!attribute [rw] query_id
|
|
267
|
+
# @return [::String]
|
|
268
|
+
# Optional. The primary identifier for the query resource in Looker, used for
|
|
269
|
+
# API operations. Maps to `id` (or `slug`) in the Looker API `Query`
|
|
270
|
+
# resource.
|
|
271
|
+
# @!attribute [rw] client_id
|
|
272
|
+
# @return [::String]
|
|
273
|
+
# Optional. The short alphanumeric identifier for the query, used for share
|
|
274
|
+
# links and Explore URLs (e.g., in the `qid` parameter). Maps to `client_id`
|
|
275
|
+
# in the Looker API `Query` resource.
|
|
169
276
|
class LookerQuery
|
|
170
277
|
include ::Google::Protobuf::MessageExts
|
|
171
278
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -176,7 +283,9 @@ module Google
|
|
|
176
283
|
# Required. The field to filter on.
|
|
177
284
|
# @!attribute [rw] value
|
|
178
285
|
# @return [::String]
|
|
179
|
-
#
|
|
286
|
+
# Optional. The value for the field to filter on.
|
|
287
|
+
# Optional so we can preserve the default value as an empty
|
|
288
|
+
# string, important to get a valid and working Looker Explore url.
|
|
180
289
|
class Filter
|
|
181
290
|
include ::Google::Protobuf::MessageExts
|
|
182
291
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -212,9 +321,23 @@ module Google
|
|
|
212
321
|
# @!attribute [rw] datasource
|
|
213
322
|
# @return [::Google::Cloud::GeminiDataAnalytics::V1beta::DatasourceOptions]
|
|
214
323
|
# Optional. Options for datasources.
|
|
324
|
+
# @!attribute [rw] model
|
|
325
|
+
# @return [::Google::Cloud::GeminiDataAnalytics::V1beta::ConversationOptions::Model]
|
|
326
|
+
# Optional. The model to use for the agent loop.
|
|
215
327
|
class ConversationOptions
|
|
216
328
|
include ::Google::Protobuf::MessageExts
|
|
217
329
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
330
|
+
|
|
331
|
+
# Allowed models for the agent/conversation.
|
|
332
|
+
module Model
|
|
333
|
+
# No model specified. The model may be set on the chat request, or the
|
|
334
|
+
# default model will be used.
|
|
335
|
+
MODEL_UNSPECIFIED = 0
|
|
336
|
+
|
|
337
|
+
# Use the most up-to-date non-preview model. This may constrain certain
|
|
338
|
+
# request level settings.
|
|
339
|
+
LATEST_GA_MODEL = 1
|
|
340
|
+
end
|
|
218
341
|
end
|
|
219
342
|
|
|
220
343
|
# Options for datasources configurations.
|
|
@@ -285,6 +408,80 @@ module Google
|
|
|
285
408
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
286
409
|
end
|
|
287
410
|
end
|
|
411
|
+
|
|
412
|
+
# Source attributions for content.
|
|
413
|
+
# @!attribute [r] sources
|
|
414
|
+
# @return [::Array<::Google::Cloud::GeminiDataAnalytics::V1beta::CitationSource>]
|
|
415
|
+
# Output only. List of the sources being cited.
|
|
416
|
+
# @!attribute [r] anchors
|
|
417
|
+
# @return [::Array<::Google::Cloud::GeminiDataAnalytics::V1beta::CitationAnchor>]
|
|
418
|
+
# Output only. List of the anchors of the citations.
|
|
419
|
+
class Citation
|
|
420
|
+
include ::Google::Protobuf::MessageExts
|
|
421
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
422
|
+
end
|
|
423
|
+
|
|
424
|
+
# The source of the citation.
|
|
425
|
+
# @!attribute [r] uri
|
|
426
|
+
# @return [::String]
|
|
427
|
+
# Output only. The uri used as the source, such as a web grounding URL.
|
|
428
|
+
#
|
|
429
|
+
# Note: The following fields are mutually exclusive: `uri`, `example_query`, `glossary_term`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
430
|
+
# @!attribute [r] example_query
|
|
431
|
+
# @return [::Google::Cloud::GeminiDataAnalytics::V1beta::ExampleQuery]
|
|
432
|
+
# Output only. The example query used as the source.
|
|
433
|
+
#
|
|
434
|
+
# Note: The following fields are mutually exclusive: `example_query`, `uri`, `glossary_term`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
435
|
+
# @!attribute [r] glossary_term
|
|
436
|
+
# @return [::Google::Cloud::GeminiDataAnalytics::V1beta::GlossaryTerm]
|
|
437
|
+
# Output only. The glossary term used as the source.
|
|
438
|
+
#
|
|
439
|
+
# Note: The following fields are mutually exclusive: `glossary_term`, `uri`, `example_query`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
440
|
+
# @!attribute [r] id
|
|
441
|
+
# @return [::String]
|
|
442
|
+
# Output only. Unique identifier of the source. This ID is service-generated
|
|
443
|
+
# and is unique within the scope of a single `Citation` message.
|
|
444
|
+
# @!attribute [r] title
|
|
445
|
+
# @return [::String]
|
|
446
|
+
# Output only. The title of the source.
|
|
447
|
+
class CitationSource
|
|
448
|
+
include ::Google::Protobuf::MessageExts
|
|
449
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
450
|
+
end
|
|
451
|
+
|
|
452
|
+
# The anchor of the citation.
|
|
453
|
+
# @!attribute [r] text_message_anchor
|
|
454
|
+
# @return [::Google::Cloud::GeminiDataAnalytics::V1beta::CitationAnchor::TextMessageCitationAnchor]
|
|
455
|
+
# Output only. Only set if the citation is for a TextMessage.
|
|
456
|
+
class CitationAnchor
|
|
457
|
+
include ::Google::Protobuf::MessageExts
|
|
458
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
459
|
+
|
|
460
|
+
# Citation anchor within a TextMessage.
|
|
461
|
+
# @!attribute [r] part_index
|
|
462
|
+
# @return [::Integer]
|
|
463
|
+
# Output only. The 0-based index of the part within the TextMessage.parts
|
|
464
|
+
# field.
|
|
465
|
+
# @!attribute [r] start_offset_bytes
|
|
466
|
+
# @return [::Integer]
|
|
467
|
+
# Output only. The offset, measured in UTF-8 bytes, within the part string
|
|
468
|
+
# where the citation begins (inclusive). Example: For the text "Hello,
|
|
469
|
+
# world" where "world" is cited, the start offset bytes (inclusive) is 7
|
|
470
|
+
# and the end offset bytes (exclusive) is 12.
|
|
471
|
+
# @!attribute [r] end_offset_bytes
|
|
472
|
+
# @return [::Integer]
|
|
473
|
+
# Output only. The offset, measured in UTF-8 bytes, within the part string
|
|
474
|
+
# where the citation ends (exclusive). Example: For the text "Hello, world"
|
|
475
|
+
# where "world" is cited, the start offset bytes (inclusive) is 7 and the
|
|
476
|
+
# end offset bytes (exclusive) is 12.
|
|
477
|
+
# @!attribute [r] source_ids
|
|
478
|
+
# @return [::Array<::String>]
|
|
479
|
+
# Output only. The ids of the sources that are cited.
|
|
480
|
+
class TextMessageCitationAnchor
|
|
481
|
+
include ::Google::Protobuf::MessageExts
|
|
482
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
483
|
+
end
|
|
484
|
+
end
|
|
288
485
|
end
|
|
289
486
|
end
|
|
290
487
|
end
|
|
@@ -53,6 +53,17 @@ module Google
|
|
|
53
53
|
# Optional. Open-ended and user-defined labels that can be set by the client
|
|
54
54
|
# to tag a conversation (e.g. to filter conversations for specific
|
|
55
55
|
# surfaces/products).
|
|
56
|
+
# @!attribute [rw] kms_key
|
|
57
|
+
# @return [::String]
|
|
58
|
+
# Optional. Customer managed encryption key (CMEK) to use for encrypting the
|
|
59
|
+
# Conversation resources. Encryption will happen at Titan layer, we will pass
|
|
60
|
+
# the KMS key to Titan.
|
|
61
|
+
#
|
|
62
|
+
# Format:
|
|
63
|
+
# projects/\\{project_id}/locations/\\{location}/keyRings/\\{key_ring_name}/cryptoKeys/\\{key_name}.
|
|
64
|
+
# @!attribute [rw] memory_paused
|
|
65
|
+
# @return [::Boolean]
|
|
66
|
+
# Optional. Whether memory is paused for this conversation.
|
|
56
67
|
class Conversation
|
|
57
68
|
include ::Google::Protobuf::MessageExts
|
|
58
69
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -111,8 +122,9 @@ module Google
|
|
|
111
122
|
# @!attribute [rw] page_size
|
|
112
123
|
# @return [::Integer]
|
|
113
124
|
# Optional. Requested page size. Server may return fewer items than
|
|
114
|
-
# requested. The max page size is 100
|
|
115
|
-
# to 100
|
|
125
|
+
# requested. The max page size is `100`. All larger page sizes will be
|
|
126
|
+
# coerced to `100`. If unspecified, server will pick `50` as an appropriate
|
|
127
|
+
# default.
|
|
116
128
|
# @!attribute [rw] page_token
|
|
117
129
|
# @return [::String]
|
|
118
130
|
# Optional. A token identifying a page of results the server should return.
|
|
@@ -71,6 +71,12 @@ module Google
|
|
|
71
71
|
# Output only. Timestamp in UTC of when this data agent is considered
|
|
72
72
|
# expired. This is *always* provided on output, regardless of what was sent
|
|
73
73
|
# on input.
|
|
74
|
+
# @!attribute [rw] kms_key
|
|
75
|
+
# @return [::String]
|
|
76
|
+
# Optional. Customer managed encryption key (CMEK) to use for encrypting the
|
|
77
|
+
# DataAgent resources. Cloud KMS CryptoKeys must reside in the same location
|
|
78
|
+
# as the DataAgent. The expected format is
|
|
79
|
+
# `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
|
|
74
80
|
class DataAgent
|
|
75
81
|
include ::Google::Protobuf::MessageExts
|
|
76
82
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -80,19 +80,20 @@ module Google
|
|
|
80
80
|
# used to enforce row-level security during SQL generation and query
|
|
81
81
|
# execution.
|
|
82
82
|
# @!attribute [rw] parameters
|
|
83
|
-
# @return [::Google::
|
|
83
|
+
# @return [::Array<::Google::Cloud::GeminiDataAnalytics::V1beta::ParameterizedSecureViewParameters::Parameter>]
|
|
84
84
|
# Optional. Named parameters for Parameterized Secure Views (PSV).
|
|
85
|
-
# The map keys are parameter names (e.g., `"user_id"`), and values are the
|
|
86
|
-
# corresponding parameter values (e.g., `"123"`).
|
|
87
85
|
class ParameterizedSecureViewParameters
|
|
88
86
|
include ::Google::Protobuf::MessageExts
|
|
89
87
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
90
88
|
|
|
89
|
+
# Represents a single parameter for Parameterized Secure Views.
|
|
91
90
|
# @!attribute [rw] key
|
|
92
91
|
# @return [::String]
|
|
92
|
+
# Required. The parameter key (e.g., `"user_id"`).
|
|
93
93
|
# @!attribute [rw] value
|
|
94
94
|
# @return [::String]
|
|
95
|
-
|
|
95
|
+
# Required. The parameter value (e.g., `"123"`).
|
|
96
|
+
class Parameter
|
|
96
97
|
include ::Google::Protobuf::MessageExts
|
|
97
98
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
98
99
|
end
|
|
@@ -197,8 +198,9 @@ module Google
|
|
|
197
198
|
# @!attribute [rw] page_size
|
|
198
199
|
# @return [::Integer]
|
|
199
200
|
# Optional. Requested page size. Server may return fewer items than
|
|
200
|
-
# requested. The max page size is 100
|
|
201
|
-
# to 100
|
|
201
|
+
# requested. The max page size is `100`. All larger page sizes will be
|
|
202
|
+
# coerced to `100`. If unspecified, server will pick `50` as an appropriate
|
|
203
|
+
# default.
|
|
202
204
|
# @!attribute [rw] page_token
|
|
203
205
|
# @return [::String]
|
|
204
206
|
# Optional. A token identifying a page of results the server should return.
|
|
@@ -267,10 +269,14 @@ module Google
|
|
|
267
269
|
# conversations and agents resources.
|
|
268
270
|
#
|
|
269
271
|
# Note: The following fields are mutually exclusive: `client_managed_resource_context`, `inline_context`, `conversation_reference`, `data_agent_context`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
272
|
+
# @!attribute [rw] looker_settings
|
|
273
|
+
# @return [::Google::Cloud::GeminiDataAnalytics::V1beta::LookerSettings]
|
|
274
|
+
# Optional. Looker specific settings.
|
|
270
275
|
# @!attribute [rw] project
|
|
271
276
|
# @deprecated This field is deprecated and may be removed in the next major version update.
|
|
272
277
|
# @return [::String]
|
|
273
|
-
# Optional.
|
|
278
|
+
# Optional. Deprecated: Use `parent` field instead.
|
|
279
|
+
# The Google Cloud project to be used for quota and billing.
|
|
274
280
|
# @!attribute [rw] parent
|
|
275
281
|
# @return [::String]
|
|
276
282
|
# Required. The parent value for chat request.
|
|
@@ -278,10 +284,24 @@ module Google
|
|
|
278
284
|
# @!attribute [rw] messages
|
|
279
285
|
# @return [::Array<::Google::Cloud::GeminiDataAnalytics::V1beta::Message>]
|
|
280
286
|
# Required. Content of current conversation.
|
|
287
|
+
# @!attribute [rw] credentials
|
|
288
|
+
# @return [::Google::Cloud::GeminiDataAnalytics::V1beta::Credentials]
|
|
289
|
+
# Optional. The credentials to use when calling the data source(s) specified
|
|
290
|
+
# in the context.
|
|
291
|
+
#
|
|
292
|
+
# This field can be used to provide credentials for various data sources.
|
|
293
|
+
# For example, when connecting to Looker, it currently supports both OAuth
|
|
294
|
+
# token and API key-based credentials, as described in
|
|
295
|
+
# [Authentication with an
|
|
296
|
+
# SDK](https://cloud.google.com/looker/docs/api-auth#authentication_with_an_sdk).
|
|
281
297
|
# @!attribute [rw] thinking_mode
|
|
282
298
|
# @return [::Google::Cloud::GeminiDataAnalytics::V1beta::ChatRequest::ThinkingMode]
|
|
283
299
|
# Optional. The thinking mode to use for the agent loop.
|
|
284
300
|
# Defaults to THINKING_MODE_UNSPECIFIED if not specified.
|
|
301
|
+
# @!attribute [rw] model
|
|
302
|
+
# @return [::Google::Cloud::GeminiDataAnalytics::V1beta::ChatRequest::Model]
|
|
303
|
+
# Optional. The model to use for the agent loop when processing the request.
|
|
304
|
+
# This setting only has an effect when context.options.model is not set.
|
|
285
305
|
class ChatRequest
|
|
286
306
|
include ::Google::Protobuf::MessageExts
|
|
287
307
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -297,6 +317,16 @@ module Google
|
|
|
297
317
|
# Thinking mode, solves complex problems.
|
|
298
318
|
THINKING = 2
|
|
299
319
|
end
|
|
320
|
+
|
|
321
|
+
# Model selection for the agent.
|
|
322
|
+
module Model
|
|
323
|
+
# No model specified. The default model will be used.
|
|
324
|
+
MODEL_UNSPECIFIED = 0
|
|
325
|
+
|
|
326
|
+
# Use the most up-to-date non-preview model. This may constrain certain
|
|
327
|
+
# request level settings.
|
|
328
|
+
LATEST_GA_MODEL = 1
|
|
329
|
+
end
|
|
300
330
|
end
|
|
301
331
|
|
|
302
332
|
# Context for the chat request using a data agent.
|
|
@@ -304,8 +334,10 @@ module Google
|
|
|
304
334
|
# @return [::String]
|
|
305
335
|
# Required. The name of the data agent resource.
|
|
306
336
|
# @!attribute [rw] credentials
|
|
337
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
|
307
338
|
# @return [::Google::Cloud::GeminiDataAnalytics::V1beta::Credentials]
|
|
308
|
-
# Optional.
|
|
339
|
+
# Optional. Deprecated: Use credentials in ChatRequest.
|
|
340
|
+
# The credentials to use when calling the Looker data source.
|
|
309
341
|
#
|
|
310
342
|
# Currently supports both OAuth token and API key-based credentials, as
|
|
311
343
|
# described in
|
|
@@ -392,6 +424,20 @@ module Google
|
|
|
392
424
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
393
425
|
end
|
|
394
426
|
|
|
427
|
+
# Message to hold Looker specific custom settings.
|
|
428
|
+
# @!attribute [rw] enable_dev_mode
|
|
429
|
+
# @return [::Boolean]
|
|
430
|
+
# Optional. Whether to operate in Looker's Development Mode.
|
|
431
|
+
# If true, the API session will be switched to the "dev" workspace,
|
|
432
|
+
# allowing interaction with LookML changes in the user's development branch.
|
|
433
|
+
# If false or unset, the session remains in the default state (Production
|
|
434
|
+
# Mode).
|
|
435
|
+
# See https://cloud.google.com/looker/docs/dev-mode-prod-mode.
|
|
436
|
+
class LookerSettings
|
|
437
|
+
include ::Google::Protobuf::MessageExts
|
|
438
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
439
|
+
end
|
|
440
|
+
|
|
395
441
|
# A message from the user that is interacting with the system.
|
|
396
442
|
# @!attribute [rw] text
|
|
397
443
|
# @return [::String]
|
|
@@ -402,7 +448,7 @@ module Google
|
|
|
402
448
|
end
|
|
403
449
|
|
|
404
450
|
# A message from the system in response to the user. This message can also be a
|
|
405
|
-
# message from the user as historical context for
|
|
451
|
+
# message from the user as historical context for multi-turn conversations with
|
|
406
452
|
# the system.
|
|
407
453
|
# @!attribute [rw] text
|
|
408
454
|
# @return [::Google::Cloud::GeminiDataAnalytics::V1beta::TextMessage]
|
|
@@ -440,8 +486,10 @@ module Google
|
|
|
440
486
|
#
|
|
441
487
|
# Note: The following fields are mutually exclusive: `example_queries`, `text`, `schema`, `data`, `analysis`, `chart`, `error`, `clarification`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
442
488
|
# @!attribute [rw] clarification
|
|
489
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
|
443
490
|
# @return [::Google::Cloud::GeminiDataAnalytics::V1beta::ClarificationMessage]
|
|
444
|
-
# Optional.
|
|
491
|
+
# Optional. Deprecated: Use TextMessage with TextType.FINAL_RESPONSE
|
|
492
|
+
# instead. A message containing clarification questions.
|
|
445
493
|
#
|
|
446
494
|
# Note: The following fields are mutually exclusive: `clarification`, `text`, `schema`, `data`, `analysis`, `chart`, `error`, `example_queries`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
447
495
|
# @!attribute [rw] group_id
|
|
@@ -449,6 +497,9 @@ module Google
|
|
|
449
497
|
# Identifies the group that the event belongs to. Similar events are deemed
|
|
450
498
|
# to be logically relevant to each other and should be shown together in
|
|
451
499
|
# the UI.
|
|
500
|
+
# @!attribute [r] citation
|
|
501
|
+
# @return [::Google::Cloud::GeminiDataAnalytics::V1beta::Citation]
|
|
502
|
+
# Output only. Citation information for the system message.
|
|
452
503
|
class SystemMessage
|
|
453
504
|
include ::Google::Protobuf::MessageExts
|
|
454
505
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -486,6 +537,10 @@ module Google
|
|
|
486
537
|
# (`FINAL_RESPONSE`). These messages provide insight into the agent's
|
|
487
538
|
# actions.
|
|
488
539
|
PROGRESS = 3
|
|
540
|
+
|
|
541
|
+
# The text is a list of follow-up questions suggested.
|
|
542
|
+
# Each item in parts is a follow-up question.
|
|
543
|
+
FOLLOWUP_QUESTIONS = 4
|
|
489
544
|
end
|
|
490
545
|
end
|
|
491
546
|
|
|
@@ -528,29 +583,34 @@ module Google
|
|
|
528
583
|
# @return [::Google::Cloud::GeminiDataAnalytics::V1beta::DataQuery]
|
|
529
584
|
# A data retrieval query.
|
|
530
585
|
#
|
|
531
|
-
# Note: The following fields are mutually exclusive: `query`, `generated_sql`, `result`, `generated_looker_query`, `big_query_job`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
586
|
+
# Note: The following fields are mutually exclusive: `query`, `generated_sql`, `result`, `generated_looker_query`, `big_query_job`, `matched_query`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
532
587
|
# @!attribute [rw] generated_sql
|
|
533
588
|
# @return [::String]
|
|
534
589
|
# SQL generated by the system to retrieve data.
|
|
535
590
|
#
|
|
536
|
-
# Note: The following fields are mutually exclusive: `generated_sql`, `query`, `result`, `generated_looker_query`, `big_query_job`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
591
|
+
# Note: The following fields are mutually exclusive: `generated_sql`, `query`, `result`, `generated_looker_query`, `big_query_job`, `matched_query`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
537
592
|
# @!attribute [rw] result
|
|
538
593
|
# @return [::Google::Cloud::GeminiDataAnalytics::V1beta::DataResult]
|
|
539
594
|
# Retrieved data.
|
|
540
595
|
#
|
|
541
|
-
# Note: The following fields are mutually exclusive: `result`, `query`, `generated_sql`, `generated_looker_query`, `big_query_job`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
596
|
+
# Note: The following fields are mutually exclusive: `result`, `query`, `generated_sql`, `generated_looker_query`, `big_query_job`, `matched_query`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
542
597
|
# @!attribute [rw] generated_looker_query
|
|
543
598
|
# @deprecated This field is deprecated and may be removed in the next major version update.
|
|
544
599
|
# @return [::Google::Cloud::GeminiDataAnalytics::V1beta::LookerQuery]
|
|
545
|
-
# Looker Query generated by the system to retrieve data.
|
|
546
600
|
# Deprecated: generated looker query is now under DataQuery.looker.
|
|
601
|
+
# Looker Query generated by the system to retrieve data.
|
|
547
602
|
#
|
|
548
|
-
# Note: The following fields are mutually exclusive: `generated_looker_query`, `query`, `generated_sql`, `result`, `big_query_job`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
603
|
+
# Note: The following fields are mutually exclusive: `generated_looker_query`, `query`, `generated_sql`, `result`, `big_query_job`, `matched_query`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
549
604
|
# @!attribute [rw] big_query_job
|
|
550
605
|
# @return [::Google::Cloud::GeminiDataAnalytics::V1beta::BigQueryJob]
|
|
551
606
|
# A BigQuery job executed by the system to retrieve data.
|
|
552
607
|
#
|
|
553
|
-
# Note: The following fields are mutually exclusive: `big_query_job`, `query`, `generated_sql`, `result`, `generated_looker_query`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
608
|
+
# Note: The following fields are mutually exclusive: `big_query_job`, `query`, `generated_sql`, `result`, `generated_looker_query`, `matched_query`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
609
|
+
# @!attribute [rw] matched_query
|
|
610
|
+
# @return [::Google::Cloud::GeminiDataAnalytics::V1beta::MatchedQuery]
|
|
611
|
+
# A pre-existing query that was matched to retrieve data.
|
|
612
|
+
#
|
|
613
|
+
# Note: The following fields are mutually exclusive: `matched_query`, `query`, `generated_sql`, `result`, `generated_looker_query`, `big_query_job`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
554
614
|
class DataMessage
|
|
555
615
|
include ::Google::Protobuf::MessageExts
|
|
556
616
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -794,45 +854,65 @@ module Google
|
|
|
794
854
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
795
855
|
end
|
|
796
856
|
|
|
857
|
+
# Deprecated: Use TextMessage with TextType.FINAL_RESPONSE instead.
|
|
797
858
|
# Represents a single question to the user to help clarify their query.
|
|
859
|
+
# @deprecated This message is deprecated and may be removed in the next major version update.
|
|
798
860
|
# @!attribute [rw] question
|
|
861
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
|
799
862
|
# @return [::String]
|
|
800
|
-
# Required. The
|
|
863
|
+
# Required. Deprecated: The parent message is deprecated.
|
|
864
|
+
# The natural language question to ask the user.
|
|
801
865
|
# @!attribute [rw] selection_mode
|
|
866
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
|
802
867
|
# @return [::Google::Cloud::GeminiDataAnalytics::V1beta::ClarificationQuestion::SelectionMode]
|
|
803
|
-
# Required. The
|
|
868
|
+
# Required. Deprecated: The parent message is deprecated.
|
|
869
|
+
# The selection mode for this question.
|
|
804
870
|
# @!attribute [rw] options
|
|
871
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
|
805
872
|
# @return [::Array<::String>]
|
|
806
|
-
# Required.
|
|
873
|
+
# Required. Deprecated: The parent message is deprecated.
|
|
874
|
+
# A list of distinct options for the user to choose from.
|
|
807
875
|
# The number of options is limited to a maximum of 5.
|
|
808
876
|
# @!attribute [rw] clarification_question_type
|
|
877
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
|
809
878
|
# @return [::Google::Cloud::GeminiDataAnalytics::V1beta::ClarificationQuestion::ClarificationQuestionType]
|
|
810
|
-
# Optional. The
|
|
879
|
+
# Optional. Deprecated: The parent message is deprecated.
|
|
880
|
+
# The type of clarification question.
|
|
811
881
|
class ClarificationQuestion
|
|
812
882
|
include ::Google::Protobuf::MessageExts
|
|
813
883
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
814
884
|
|
|
885
|
+
# Deprecated: The parent message is deprecated.
|
|
815
886
|
# The selection mode for the clarification question.
|
|
887
|
+
# @deprecated This enum is deprecated and may be removed in the next major version update.
|
|
816
888
|
module SelectionMode
|
|
889
|
+
# Deprecated: The parent message is deprecated.
|
|
817
890
|
# Unspecified selection mode.
|
|
818
891
|
SELECTION_MODE_UNSPECIFIED = 0
|
|
819
892
|
|
|
893
|
+
# Deprecated: The parent message is deprecated.
|
|
820
894
|
# The user can select only one option.
|
|
821
895
|
SINGLE_SELECT = 1
|
|
822
896
|
|
|
897
|
+
# Deprecated: The parent message is deprecated.
|
|
823
898
|
# The user can select multiple options.
|
|
824
899
|
MULTI_SELECT = 2
|
|
825
900
|
end
|
|
826
901
|
|
|
902
|
+
# Deprecated: The parent message is deprecated.
|
|
827
903
|
# The type of clarification question.
|
|
828
904
|
# This enum may be extended with new values in the future.
|
|
905
|
+
# @deprecated This enum is deprecated and may be removed in the next major version update.
|
|
829
906
|
module ClarificationQuestionType
|
|
907
|
+
# Deprecated: The parent message is deprecated.
|
|
830
908
|
# Unspecified clarification question type.
|
|
831
909
|
CLARIFICATION_QUESTION_TYPE_UNSPECIFIED = 0
|
|
832
910
|
|
|
911
|
+
# Deprecated: The parent message is deprecated.
|
|
833
912
|
# The clarification question is for filter values.
|
|
834
913
|
FILTER_VALUES = 1
|
|
835
914
|
|
|
915
|
+
# Deprecated: The parent message is deprecated.
|
|
836
916
|
# The clarification question is for data fields. This is a generic term
|
|
837
917
|
# encompassing SQL columns, Looker fields (dimensions/measures), or
|
|
838
918
|
# nested data structure properties.
|
|
@@ -840,11 +920,15 @@ module Google
|
|
|
840
920
|
end
|
|
841
921
|
end
|
|
842
922
|
|
|
923
|
+
# Deprecated: Use TextMessage with TextType.FINAL_RESPONSE instead.
|
|
843
924
|
# A message of questions to help clarify the user's query. This is returned
|
|
844
925
|
# when the system cannot confidently answer the user's question.
|
|
926
|
+
# @deprecated This message is deprecated and may be removed in the next major version update.
|
|
845
927
|
# @!attribute [rw] questions
|
|
928
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
|
846
929
|
# @return [::Array<::Google::Cloud::GeminiDataAnalytics::V1beta::ClarificationQuestion>]
|
|
847
|
-
# Required.
|
|
930
|
+
# Required. Deprecated: The parent message is deprecated.
|
|
931
|
+
# A batch of clarification questions to ask the user.
|
|
848
932
|
class ClarificationMessage
|
|
849
933
|
include ::Google::Protobuf::MessageExts
|
|
850
934
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|