google-apis-discoveryengine_v1 0.45.0 → 0.47.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/CHANGELOG.md +8 -0
- data/lib/google/apis/discoveryengine_v1/classes.rb +1001 -40
- data/lib/google/apis/discoveryengine_v1/gem_version.rb +2 -2
- data/lib/google/apis/discoveryengine_v1/representations.rb +369 -3
- data/lib/google/apis/discoveryengine_v1/service.rb +133 -9
- metadata +2 -2
@@ -22,6 +22,679 @@ module Google
|
|
22
22
|
module Apis
|
23
23
|
module DiscoveryengineV1
|
24
24
|
|
25
|
+
# Information to read/write to blobstore2.
|
26
|
+
class GdataBlobstore2Info
|
27
|
+
include Google::Apis::Core::Hashable
|
28
|
+
|
29
|
+
# The blob generation id.
|
30
|
+
# Corresponds to the JSON property `blobGeneration`
|
31
|
+
# @return [Fixnum]
|
32
|
+
attr_accessor :blob_generation
|
33
|
+
|
34
|
+
# The blob id, e.g., /blobstore/prod/playground/scotty
|
35
|
+
# Corresponds to the JSON property `blobId`
|
36
|
+
# @return [String]
|
37
|
+
attr_accessor :blob_id
|
38
|
+
|
39
|
+
# Read handle passed from Bigstore -> Scotty for a GCS download. This is a
|
40
|
+
# signed, serialized blobstore2.ReadHandle proto which must never be set outside
|
41
|
+
# of Bigstore, and is not applicable to non-GCS media downloads.
|
42
|
+
# Corresponds to the JSON property `downloadReadHandle`
|
43
|
+
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
44
|
+
# @return [String]
|
45
|
+
attr_accessor :download_read_handle
|
46
|
+
|
47
|
+
# The blob read token. Needed to read blobs that have not been replicated. Might
|
48
|
+
# not be available until the final call.
|
49
|
+
# Corresponds to the JSON property `readToken`
|
50
|
+
# @return [String]
|
51
|
+
attr_accessor :read_token
|
52
|
+
|
53
|
+
# Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a
|
54
|
+
# signed, serialized blobstore2.BlobMetadataContainer proto which must never be
|
55
|
+
# consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
|
56
|
+
# Corresponds to the JSON property `uploadMetadataContainer`
|
57
|
+
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
58
|
+
# @return [String]
|
59
|
+
attr_accessor :upload_metadata_container
|
60
|
+
|
61
|
+
def initialize(**args)
|
62
|
+
update!(**args)
|
63
|
+
end
|
64
|
+
|
65
|
+
# Update properties of this object
|
66
|
+
def update!(**args)
|
67
|
+
@blob_generation = args[:blob_generation] if args.key?(:blob_generation)
|
68
|
+
@blob_id = args[:blob_id] if args.key?(:blob_id)
|
69
|
+
@download_read_handle = args[:download_read_handle] if args.key?(:download_read_handle)
|
70
|
+
@read_token = args[:read_token] if args.key?(:read_token)
|
71
|
+
@upload_metadata_container = args[:upload_metadata_container] if args.key?(:upload_metadata_container)
|
72
|
+
end
|
73
|
+
end
|
74
|
+
|
75
|
+
# A sequence of media data references representing composite data. Introduced to
|
76
|
+
# support Bigstore composite objects. For details, visit http://go/bigstore-
|
77
|
+
# composites.
|
78
|
+
class GdataCompositeMedia
|
79
|
+
include Google::Apis::Core::Hashable
|
80
|
+
|
81
|
+
# Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be
|
82
|
+
# the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating
|
83
|
+
# v1, use blobstore2_info instead. For now, any v2 blob will also be represented
|
84
|
+
# in this field as v1 BlobRef.
|
85
|
+
# Corresponds to the JSON property `blobRef`
|
86
|
+
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
87
|
+
# @return [String]
|
88
|
+
attr_accessor :blob_ref
|
89
|
+
|
90
|
+
# Information to read/write to blobstore2.
|
91
|
+
# Corresponds to the JSON property `blobstore2Info`
|
92
|
+
# @return [Google::Apis::DiscoveryengineV1::GdataBlobstore2Info]
|
93
|
+
attr_accessor :blobstore2_info
|
94
|
+
|
95
|
+
# A binary data reference for a media download. Serves as a technology-agnostic
|
96
|
+
# binary reference in some Google infrastructure. This value is a serialized
|
97
|
+
# storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get
|
98
|
+
# around the fact that the cosmo proto (as well as others it includes) doesn't
|
99
|
+
# support JavaScript. This prevents us from including the actual type of this
|
100
|
+
# field.
|
101
|
+
# Corresponds to the JSON property `cosmoBinaryReference`
|
102
|
+
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
103
|
+
# @return [String]
|
104
|
+
attr_accessor :cosmo_binary_reference
|
105
|
+
|
106
|
+
# crc32.c hash for the payload.
|
107
|
+
# Corresponds to the JSON property `crc32cHash`
|
108
|
+
# @return [Fixnum]
|
109
|
+
attr_accessor :crc32c_hash
|
110
|
+
|
111
|
+
# Media data, set if reference_type is INLINE
|
112
|
+
# Corresponds to the JSON property `inline`
|
113
|
+
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
114
|
+
# @return [String]
|
115
|
+
attr_accessor :inline
|
116
|
+
|
117
|
+
# Size of the data, in bytes
|
118
|
+
# Corresponds to the JSON property `length`
|
119
|
+
# @return [Fixnum]
|
120
|
+
attr_accessor :length
|
121
|
+
|
122
|
+
# MD5 hash for the payload.
|
123
|
+
# Corresponds to the JSON property `md5Hash`
|
124
|
+
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
125
|
+
# @return [String]
|
126
|
+
attr_accessor :md5_hash
|
127
|
+
|
128
|
+
# This is a copy of the tech.blob.ObjectId proto, which could not be used
|
129
|
+
# directly here due to transitive closure issues with JavaScript support; see
|
130
|
+
# http://b/8801763.
|
131
|
+
# Corresponds to the JSON property `objectId`
|
132
|
+
# @return [Google::Apis::DiscoveryengineV1::GdataObjectId]
|
133
|
+
attr_accessor :object_id_prop
|
134
|
+
|
135
|
+
# Path to the data, set if reference_type is PATH
|
136
|
+
# Corresponds to the JSON property `path`
|
137
|
+
# @return [String]
|
138
|
+
attr_accessor :path
|
139
|
+
|
140
|
+
# Describes what the field reference contains.
|
141
|
+
# Corresponds to the JSON property `referenceType`
|
142
|
+
# @return [String]
|
143
|
+
attr_accessor :reference_type
|
144
|
+
|
145
|
+
# SHA-1 hash for the payload.
|
146
|
+
# Corresponds to the JSON property `sha1Hash`
|
147
|
+
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
148
|
+
# @return [String]
|
149
|
+
attr_accessor :sha1_hash
|
150
|
+
|
151
|
+
def initialize(**args)
|
152
|
+
update!(**args)
|
153
|
+
end
|
154
|
+
|
155
|
+
# Update properties of this object
|
156
|
+
def update!(**args)
|
157
|
+
@blob_ref = args[:blob_ref] if args.key?(:blob_ref)
|
158
|
+
@blobstore2_info = args[:blobstore2_info] if args.key?(:blobstore2_info)
|
159
|
+
@cosmo_binary_reference = args[:cosmo_binary_reference] if args.key?(:cosmo_binary_reference)
|
160
|
+
@crc32c_hash = args[:crc32c_hash] if args.key?(:crc32c_hash)
|
161
|
+
@inline = args[:inline] if args.key?(:inline)
|
162
|
+
@length = args[:length] if args.key?(:length)
|
163
|
+
@md5_hash = args[:md5_hash] if args.key?(:md5_hash)
|
164
|
+
@object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop)
|
165
|
+
@path = args[:path] if args.key?(:path)
|
166
|
+
@reference_type = args[:reference_type] if args.key?(:reference_type)
|
167
|
+
@sha1_hash = args[:sha1_hash] if args.key?(:sha1_hash)
|
168
|
+
end
|
169
|
+
end
|
170
|
+
|
171
|
+
# Detailed Content-Type information from Scotty. The Content-Type of the media
|
172
|
+
# will typically be filled in by the header or Scotty's best_guess, but this
|
173
|
+
# extended information provides the backend with more information so that it can
|
174
|
+
# make a better decision if needed. This is only used on media upload requests
|
175
|
+
# from Scotty.
|
176
|
+
class GdataContentTypeInfo
|
177
|
+
include Google::Apis::Core::Hashable
|
178
|
+
|
179
|
+
# Scotty's best guess of what the content type of the file is.
|
180
|
+
# Corresponds to the JSON property `bestGuess`
|
181
|
+
# @return [String]
|
182
|
+
attr_accessor :best_guess
|
183
|
+
|
184
|
+
# The content type of the file derived by looking at specific bytes (i.e. "magic
|
185
|
+
# bytes") of the actual file.
|
186
|
+
# Corresponds to the JSON property `fromBytes`
|
187
|
+
# @return [String]
|
188
|
+
attr_accessor :from_bytes
|
189
|
+
|
190
|
+
# The content type of the file derived from the file extension of the original
|
191
|
+
# file name used by the client.
|
192
|
+
# Corresponds to the JSON property `fromFileName`
|
193
|
+
# @return [String]
|
194
|
+
attr_accessor :from_file_name
|
195
|
+
|
196
|
+
# The content type of the file as specified in the request headers, multipart
|
197
|
+
# headers, or RUPIO start request.
|
198
|
+
# Corresponds to the JSON property `fromHeader`
|
199
|
+
# @return [String]
|
200
|
+
attr_accessor :from_header
|
201
|
+
|
202
|
+
# The content type of the file derived from the file extension of the URL path.
|
203
|
+
# The URL path is assumed to represent a file name (which is typically only true
|
204
|
+
# for agents that are providing a REST API).
|
205
|
+
# Corresponds to the JSON property `fromUrlPath`
|
206
|
+
# @return [String]
|
207
|
+
attr_accessor :from_url_path
|
208
|
+
|
209
|
+
def initialize(**args)
|
210
|
+
update!(**args)
|
211
|
+
end
|
212
|
+
|
213
|
+
# Update properties of this object
|
214
|
+
def update!(**args)
|
215
|
+
@best_guess = args[:best_guess] if args.key?(:best_guess)
|
216
|
+
@from_bytes = args[:from_bytes] if args.key?(:from_bytes)
|
217
|
+
@from_file_name = args[:from_file_name] if args.key?(:from_file_name)
|
218
|
+
@from_header = args[:from_header] if args.key?(:from_header)
|
219
|
+
@from_url_path = args[:from_url_path] if args.key?(:from_url_path)
|
220
|
+
end
|
221
|
+
end
|
222
|
+
|
223
|
+
# Backend response for a Diff get checksums response. For details on the Scotty
|
224
|
+
# Diff protocol, visit http://go/scotty-diff-protocol.
|
225
|
+
class GdataDiffChecksumsResponse
|
226
|
+
include Google::Apis::Core::Hashable
|
227
|
+
|
228
|
+
# A sequence of media data references representing composite data. Introduced to
|
229
|
+
# support Bigstore composite objects. For details, visit http://go/bigstore-
|
230
|
+
# composites.
|
231
|
+
# Corresponds to the JSON property `checksumsLocation`
|
232
|
+
# @return [Google::Apis::DiscoveryengineV1::GdataCompositeMedia]
|
233
|
+
attr_accessor :checksums_location
|
234
|
+
|
235
|
+
# The chunk size of checksums. Must be a multiple of 256KB.
|
236
|
+
# Corresponds to the JSON property `chunkSizeBytes`
|
237
|
+
# @return [Fixnum]
|
238
|
+
attr_accessor :chunk_size_bytes
|
239
|
+
|
240
|
+
# A sequence of media data references representing composite data. Introduced to
|
241
|
+
# support Bigstore composite objects. For details, visit http://go/bigstore-
|
242
|
+
# composites.
|
243
|
+
# Corresponds to the JSON property `objectLocation`
|
244
|
+
# @return [Google::Apis::DiscoveryengineV1::GdataCompositeMedia]
|
245
|
+
attr_accessor :object_location
|
246
|
+
|
247
|
+
# The total size of the server object.
|
248
|
+
# Corresponds to the JSON property `objectSizeBytes`
|
249
|
+
# @return [Fixnum]
|
250
|
+
attr_accessor :object_size_bytes
|
251
|
+
|
252
|
+
# The object version of the object the checksums are being returned for.
|
253
|
+
# Corresponds to the JSON property `objectVersion`
|
254
|
+
# @return [String]
|
255
|
+
attr_accessor :object_version
|
256
|
+
|
257
|
+
def initialize(**args)
|
258
|
+
update!(**args)
|
259
|
+
end
|
260
|
+
|
261
|
+
# Update properties of this object
|
262
|
+
def update!(**args)
|
263
|
+
@checksums_location = args[:checksums_location] if args.key?(:checksums_location)
|
264
|
+
@chunk_size_bytes = args[:chunk_size_bytes] if args.key?(:chunk_size_bytes)
|
265
|
+
@object_location = args[:object_location] if args.key?(:object_location)
|
266
|
+
@object_size_bytes = args[:object_size_bytes] if args.key?(:object_size_bytes)
|
267
|
+
@object_version = args[:object_version] if args.key?(:object_version)
|
268
|
+
end
|
269
|
+
end
|
270
|
+
|
271
|
+
# Backend response for a Diff download response. For details on the Scotty Diff
|
272
|
+
# protocol, visit http://go/scotty-diff-protocol.
|
273
|
+
class GdataDiffDownloadResponse
|
274
|
+
include Google::Apis::Core::Hashable
|
275
|
+
|
276
|
+
# A sequence of media data references representing composite data. Introduced to
|
277
|
+
# support Bigstore composite objects. For details, visit http://go/bigstore-
|
278
|
+
# composites.
|
279
|
+
# Corresponds to the JSON property `objectLocation`
|
280
|
+
# @return [Google::Apis::DiscoveryengineV1::GdataCompositeMedia]
|
281
|
+
attr_accessor :object_location
|
282
|
+
|
283
|
+
def initialize(**args)
|
284
|
+
update!(**args)
|
285
|
+
end
|
286
|
+
|
287
|
+
# Update properties of this object
|
288
|
+
def update!(**args)
|
289
|
+
@object_location = args[:object_location] if args.key?(:object_location)
|
290
|
+
end
|
291
|
+
end
|
292
|
+
|
293
|
+
# A Diff upload request. For details on the Scotty Diff protocol, visit http://
|
294
|
+
# go/scotty-diff-protocol.
|
295
|
+
class GdataDiffUploadRequest
|
296
|
+
include Google::Apis::Core::Hashable
|
297
|
+
|
298
|
+
# A sequence of media data references representing composite data. Introduced to
|
299
|
+
# support Bigstore composite objects. For details, visit http://go/bigstore-
|
300
|
+
# composites.
|
301
|
+
# Corresponds to the JSON property `checksumsInfo`
|
302
|
+
# @return [Google::Apis::DiscoveryengineV1::GdataCompositeMedia]
|
303
|
+
attr_accessor :checksums_info
|
304
|
+
|
305
|
+
# A sequence of media data references representing composite data. Introduced to
|
306
|
+
# support Bigstore composite objects. For details, visit http://go/bigstore-
|
307
|
+
# composites.
|
308
|
+
# Corresponds to the JSON property `objectInfo`
|
309
|
+
# @return [Google::Apis::DiscoveryengineV1::GdataCompositeMedia]
|
310
|
+
attr_accessor :object_info
|
311
|
+
|
312
|
+
# The object version of the object that is the base version the incoming diff
|
313
|
+
# script will be applied to. This field will always be filled in.
|
314
|
+
# Corresponds to the JSON property `objectVersion`
|
315
|
+
# @return [String]
|
316
|
+
attr_accessor :object_version
|
317
|
+
|
318
|
+
def initialize(**args)
|
319
|
+
update!(**args)
|
320
|
+
end
|
321
|
+
|
322
|
+
# Update properties of this object
|
323
|
+
def update!(**args)
|
324
|
+
@checksums_info = args[:checksums_info] if args.key?(:checksums_info)
|
325
|
+
@object_info = args[:object_info] if args.key?(:object_info)
|
326
|
+
@object_version = args[:object_version] if args.key?(:object_version)
|
327
|
+
end
|
328
|
+
end
|
329
|
+
|
330
|
+
# Backend response for a Diff upload request. For details on the Scotty Diff
|
331
|
+
# protocol, visit http://go/scotty-diff-protocol.
|
332
|
+
class GdataDiffUploadResponse
|
333
|
+
include Google::Apis::Core::Hashable
|
334
|
+
|
335
|
+
# The object version of the object at the server. Must be included in the end
|
336
|
+
# notification response. The version in the end notification response must
|
337
|
+
# correspond to the new version of the object that is now stored at the server,
|
338
|
+
# after the upload.
|
339
|
+
# Corresponds to the JSON property `objectVersion`
|
340
|
+
# @return [String]
|
341
|
+
attr_accessor :object_version
|
342
|
+
|
343
|
+
# A sequence of media data references representing composite data. Introduced to
|
344
|
+
# support Bigstore composite objects. For details, visit http://go/bigstore-
|
345
|
+
# composites.
|
346
|
+
# Corresponds to the JSON property `originalObject`
|
347
|
+
# @return [Google::Apis::DiscoveryengineV1::GdataCompositeMedia]
|
348
|
+
attr_accessor :original_object
|
349
|
+
|
350
|
+
def initialize(**args)
|
351
|
+
update!(**args)
|
352
|
+
end
|
353
|
+
|
354
|
+
# Update properties of this object
|
355
|
+
def update!(**args)
|
356
|
+
@object_version = args[:object_version] if args.key?(:object_version)
|
357
|
+
@original_object = args[:original_object] if args.key?(:original_object)
|
358
|
+
end
|
359
|
+
end
|
360
|
+
|
361
|
+
# Backend response for a Diff get version response. For details on the Scotty
|
362
|
+
# Diff protocol, visit http://go/scotty-diff-protocol.
|
363
|
+
class GdataDiffVersionResponse
|
364
|
+
include Google::Apis::Core::Hashable
|
365
|
+
|
366
|
+
# The total size of the server object.
|
367
|
+
# Corresponds to the JSON property `objectSizeBytes`
|
368
|
+
# @return [Fixnum]
|
369
|
+
attr_accessor :object_size_bytes
|
370
|
+
|
371
|
+
# The version of the object stored at the server.
|
372
|
+
# Corresponds to the JSON property `objectVersion`
|
373
|
+
# @return [String]
|
374
|
+
attr_accessor :object_version
|
375
|
+
|
376
|
+
def initialize(**args)
|
377
|
+
update!(**args)
|
378
|
+
end
|
379
|
+
|
380
|
+
# Update properties of this object
|
381
|
+
def update!(**args)
|
382
|
+
@object_size_bytes = args[:object_size_bytes] if args.key?(:object_size_bytes)
|
383
|
+
@object_version = args[:object_version] if args.key?(:object_version)
|
384
|
+
end
|
385
|
+
end
|
386
|
+
|
387
|
+
# Parameters specific to media downloads.
|
388
|
+
class GdataDownloadParameters
|
389
|
+
include Google::Apis::Core::Hashable
|
390
|
+
|
391
|
+
# A boolean to be returned in the response to Scotty. Allows/disallows gzip
|
392
|
+
# encoding of the payload content when the server thinks it's advantageous (
|
393
|
+
# hence, does not guarantee compression) which allows Scotty to GZip the
|
394
|
+
# response to the client.
|
395
|
+
# Corresponds to the JSON property `allowGzipCompression`
|
396
|
+
# @return [Boolean]
|
397
|
+
attr_accessor :allow_gzip_compression
|
398
|
+
alias_method :allow_gzip_compression?, :allow_gzip_compression
|
399
|
+
|
400
|
+
# Determining whether or not Apiary should skip the inclusion of any Content-
|
401
|
+
# Range header on its response to Scotty.
|
402
|
+
# Corresponds to the JSON property `ignoreRange`
|
403
|
+
# @return [Boolean]
|
404
|
+
attr_accessor :ignore_range
|
405
|
+
alias_method :ignore_range?, :ignore_range
|
406
|
+
|
407
|
+
def initialize(**args)
|
408
|
+
update!(**args)
|
409
|
+
end
|
410
|
+
|
411
|
+
# Update properties of this object
|
412
|
+
def update!(**args)
|
413
|
+
@allow_gzip_compression = args[:allow_gzip_compression] if args.key?(:allow_gzip_compression)
|
414
|
+
@ignore_range = args[:ignore_range] if args.key?(:ignore_range)
|
415
|
+
end
|
416
|
+
end
|
417
|
+
|
418
|
+
# A reference to data stored on the filesystem, on GFS or in blobstore.
|
419
|
+
class GdataMedia
|
420
|
+
include Google::Apis::Core::Hashable
|
421
|
+
|
422
|
+
# Deprecated, use one of explicit hash type fields instead. Algorithm used for
|
423
|
+
# calculating the hash. As of 2011/01/21, "MD5" is the only possible value for
|
424
|
+
# this field. New values may be added at any time.
|
425
|
+
# Corresponds to the JSON property `algorithm`
|
426
|
+
# @return [String]
|
427
|
+
attr_accessor :algorithm
|
428
|
+
|
429
|
+
# Use object_id instead.
|
430
|
+
# Corresponds to the JSON property `bigstoreObjectRef`
|
431
|
+
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
432
|
+
# @return [String]
|
433
|
+
attr_accessor :bigstore_object_ref
|
434
|
+
|
435
|
+
# Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be
|
436
|
+
# the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating
|
437
|
+
# v1, use blobstore2_info instead. For now, any v2 blob will also be represented
|
438
|
+
# in this field as v1 BlobRef.
|
439
|
+
# Corresponds to the JSON property `blobRef`
|
440
|
+
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
441
|
+
# @return [String]
|
442
|
+
attr_accessor :blob_ref
|
443
|
+
|
444
|
+
# Information to read/write to blobstore2.
|
445
|
+
# Corresponds to the JSON property `blobstore2Info`
|
446
|
+
# @return [Google::Apis::DiscoveryengineV1::GdataBlobstore2Info]
|
447
|
+
attr_accessor :blobstore2_info
|
448
|
+
|
449
|
+
# A composite media composed of one or more media objects, set if reference_type
|
450
|
+
# is COMPOSITE_MEDIA. The media length field must be set to the sum of the
|
451
|
+
# lengths of all composite media objects. Note: All composite media must have
|
452
|
+
# length specified.
|
453
|
+
# Corresponds to the JSON property `compositeMedia`
|
454
|
+
# @return [Array<Google::Apis::DiscoveryengineV1::GdataCompositeMedia>]
|
455
|
+
attr_accessor :composite_media
|
456
|
+
|
457
|
+
# MIME type of the data
|
458
|
+
# Corresponds to the JSON property `contentType`
|
459
|
+
# @return [String]
|
460
|
+
attr_accessor :content_type
|
461
|
+
|
462
|
+
# Detailed Content-Type information from Scotty. The Content-Type of the media
|
463
|
+
# will typically be filled in by the header or Scotty's best_guess, but this
|
464
|
+
# extended information provides the backend with more information so that it can
|
465
|
+
# make a better decision if needed. This is only used on media upload requests
|
466
|
+
# from Scotty.
|
467
|
+
# Corresponds to the JSON property `contentTypeInfo`
|
468
|
+
# @return [Google::Apis::DiscoveryengineV1::GdataContentTypeInfo]
|
469
|
+
attr_accessor :content_type_info
|
470
|
+
|
471
|
+
# A binary data reference for a media download. Serves as a technology-agnostic
|
472
|
+
# binary reference in some Google infrastructure. This value is a serialized
|
473
|
+
# storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get
|
474
|
+
# around the fact that the cosmo proto (as well as others it includes) doesn't
|
475
|
+
# support JavaScript. This prevents us from including the actual type of this
|
476
|
+
# field.
|
477
|
+
# Corresponds to the JSON property `cosmoBinaryReference`
|
478
|
+
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
479
|
+
# @return [String]
|
480
|
+
attr_accessor :cosmo_binary_reference
|
481
|
+
|
482
|
+
# For Scotty Uploads: Scotty-provided hashes for uploads For Scotty Downloads: (
|
483
|
+
# WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.) A Hash provided
|
484
|
+
# by the agent to be used to verify the data being downloaded. Currently only
|
485
|
+
# supported for inline payloads. Further, only crc32c_hash is currently
|
486
|
+
# supported.
|
487
|
+
# Corresponds to the JSON property `crc32cHash`
|
488
|
+
# @return [Fixnum]
|
489
|
+
attr_accessor :crc32c_hash
|
490
|
+
|
491
|
+
# Backend response for a Diff get checksums response. For details on the Scotty
|
492
|
+
# Diff protocol, visit http://go/scotty-diff-protocol.
|
493
|
+
# Corresponds to the JSON property `diffChecksumsResponse`
|
494
|
+
# @return [Google::Apis::DiscoveryengineV1::GdataDiffChecksumsResponse]
|
495
|
+
attr_accessor :diff_checksums_response
|
496
|
+
|
497
|
+
# Backend response for a Diff download response. For details on the Scotty Diff
|
498
|
+
# protocol, visit http://go/scotty-diff-protocol.
|
499
|
+
# Corresponds to the JSON property `diffDownloadResponse`
|
500
|
+
# @return [Google::Apis::DiscoveryengineV1::GdataDiffDownloadResponse]
|
501
|
+
attr_accessor :diff_download_response
|
502
|
+
|
503
|
+
# A Diff upload request. For details on the Scotty Diff protocol, visit http://
|
504
|
+
# go/scotty-diff-protocol.
|
505
|
+
# Corresponds to the JSON property `diffUploadRequest`
|
506
|
+
# @return [Google::Apis::DiscoveryengineV1::GdataDiffUploadRequest]
|
507
|
+
attr_accessor :diff_upload_request
|
508
|
+
|
509
|
+
# Backend response for a Diff upload request. For details on the Scotty Diff
|
510
|
+
# protocol, visit http://go/scotty-diff-protocol.
|
511
|
+
# Corresponds to the JSON property `diffUploadResponse`
|
512
|
+
# @return [Google::Apis::DiscoveryengineV1::GdataDiffUploadResponse]
|
513
|
+
attr_accessor :diff_upload_response
|
514
|
+
|
515
|
+
# Backend response for a Diff get version response. For details on the Scotty
|
516
|
+
# Diff protocol, visit http://go/scotty-diff-protocol.
|
517
|
+
# Corresponds to the JSON property `diffVersionResponse`
|
518
|
+
# @return [Google::Apis::DiscoveryengineV1::GdataDiffVersionResponse]
|
519
|
+
attr_accessor :diff_version_response
|
520
|
+
|
521
|
+
# Parameters specific to media downloads.
|
522
|
+
# Corresponds to the JSON property `downloadParameters`
|
523
|
+
# @return [Google::Apis::DiscoveryengineV1::GdataDownloadParameters]
|
524
|
+
attr_accessor :download_parameters
|
525
|
+
|
526
|
+
# Original file name
|
527
|
+
# Corresponds to the JSON property `filename`
|
528
|
+
# @return [String]
|
529
|
+
attr_accessor :filename
|
530
|
+
|
531
|
+
# Deprecated, use one of explicit hash type fields instead. These two hash
|
532
|
+
# related fields will only be populated on Scotty based media uploads and will
|
533
|
+
# contain the content of the hash group in the NotificationRequest: http://cs/#
|
534
|
+
# google3/blobstore2/api/scotty/service/proto/upload_listener.proto&q=class:Hash
|
535
|
+
# Hex encoded hash value of the uploaded media.
|
536
|
+
# Corresponds to the JSON property `hash`
|
537
|
+
# @return [String]
|
538
|
+
attr_accessor :hash_prop
|
539
|
+
|
540
|
+
# For Scotty uploads only. If a user sends a hash code and the backend has
|
541
|
+
# requested that Scotty verify the upload against the client hash, Scotty will
|
542
|
+
# perform the check on behalf of the backend and will reject it if the hashes
|
543
|
+
# don't match. This is set to true if Scotty performed this verification.
|
544
|
+
# Corresponds to the JSON property `hashVerified`
|
545
|
+
# @return [Boolean]
|
546
|
+
attr_accessor :hash_verified
|
547
|
+
alias_method :hash_verified?, :hash_verified
|
548
|
+
|
549
|
+
# Media data, set if reference_type is INLINE
|
550
|
+
# Corresponds to the JSON property `inline`
|
551
|
+
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
552
|
+
# @return [String]
|
553
|
+
attr_accessor :inline
|
554
|
+
|
555
|
+
# |is_potential_retry| is set false only when Scotty is certain that it has not
|
556
|
+
# sent the request before. When a client resumes an upload, this field must be
|
557
|
+
# set true in agent calls, because Scotty cannot be certain that it has never
|
558
|
+
# sent the request before due to potential failure in the session state
|
559
|
+
# persistence.
|
560
|
+
# Corresponds to the JSON property `isPotentialRetry`
|
561
|
+
# @return [Boolean]
|
562
|
+
attr_accessor :is_potential_retry
|
563
|
+
alias_method :is_potential_retry?, :is_potential_retry
|
564
|
+
|
565
|
+
# Size of the data, in bytes
|
566
|
+
# Corresponds to the JSON property `length`
|
567
|
+
# @return [Fixnum]
|
568
|
+
attr_accessor :length
|
569
|
+
|
570
|
+
# Scotty-provided MD5 hash for an upload.
|
571
|
+
# Corresponds to the JSON property `md5Hash`
|
572
|
+
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
573
|
+
# @return [String]
|
574
|
+
attr_accessor :md5_hash
|
575
|
+
|
576
|
+
# Media id to forward to the operation GetMedia. Can be set if reference_type is
|
577
|
+
# GET_MEDIA.
|
578
|
+
# Corresponds to the JSON property `mediaId`
|
579
|
+
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
580
|
+
# @return [String]
|
581
|
+
attr_accessor :media_id
|
582
|
+
|
583
|
+
# This is a copy of the tech.blob.ObjectId proto, which could not be used
|
584
|
+
# directly here due to transitive closure issues with JavaScript support; see
|
585
|
+
# http://b/8801763.
|
586
|
+
# Corresponds to the JSON property `objectId`
|
587
|
+
# @return [Google::Apis::DiscoveryengineV1::GdataObjectId]
|
588
|
+
attr_accessor :object_id_prop
|
589
|
+
|
590
|
+
# Path to the data, set if reference_type is PATH
|
591
|
+
# Corresponds to the JSON property `path`
|
592
|
+
# @return [String]
|
593
|
+
attr_accessor :path
|
594
|
+
|
595
|
+
# Describes what the field reference contains.
|
596
|
+
# Corresponds to the JSON property `referenceType`
|
597
|
+
# @return [String]
|
598
|
+
attr_accessor :reference_type
|
599
|
+
|
600
|
+
# Scotty-provided SHA1 hash for an upload.
|
601
|
+
# Corresponds to the JSON property `sha1Hash`
|
602
|
+
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
603
|
+
# @return [String]
|
604
|
+
attr_accessor :sha1_hash
|
605
|
+
|
606
|
+
# Scotty-provided SHA256 hash for an upload.
|
607
|
+
# Corresponds to the JSON property `sha256Hash`
|
608
|
+
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
609
|
+
# @return [String]
|
610
|
+
attr_accessor :sha256_hash
|
611
|
+
|
612
|
+
# Time at which the media data was last updated, in milliseconds since UNIX
|
613
|
+
# epoch
|
614
|
+
# Corresponds to the JSON property `timestamp`
|
615
|
+
# @return [Fixnum]
|
616
|
+
attr_accessor :timestamp
|
617
|
+
|
618
|
+
# A unique fingerprint/version id for the media data
|
619
|
+
# Corresponds to the JSON property `token`
|
620
|
+
# @return [String]
|
621
|
+
attr_accessor :token
|
622
|
+
|
623
|
+
def initialize(**args)
|
624
|
+
update!(**args)
|
625
|
+
end
|
626
|
+
|
627
|
+
# Update properties of this object
|
628
|
+
def update!(**args)
|
629
|
+
@algorithm = args[:algorithm] if args.key?(:algorithm)
|
630
|
+
@bigstore_object_ref = args[:bigstore_object_ref] if args.key?(:bigstore_object_ref)
|
631
|
+
@blob_ref = args[:blob_ref] if args.key?(:blob_ref)
|
632
|
+
@blobstore2_info = args[:blobstore2_info] if args.key?(:blobstore2_info)
|
633
|
+
@composite_media = args[:composite_media] if args.key?(:composite_media)
|
634
|
+
@content_type = args[:content_type] if args.key?(:content_type)
|
635
|
+
@content_type_info = args[:content_type_info] if args.key?(:content_type_info)
|
636
|
+
@cosmo_binary_reference = args[:cosmo_binary_reference] if args.key?(:cosmo_binary_reference)
|
637
|
+
@crc32c_hash = args[:crc32c_hash] if args.key?(:crc32c_hash)
|
638
|
+
@diff_checksums_response = args[:diff_checksums_response] if args.key?(:diff_checksums_response)
|
639
|
+
@diff_download_response = args[:diff_download_response] if args.key?(:diff_download_response)
|
640
|
+
@diff_upload_request = args[:diff_upload_request] if args.key?(:diff_upload_request)
|
641
|
+
@diff_upload_response = args[:diff_upload_response] if args.key?(:diff_upload_response)
|
642
|
+
@diff_version_response = args[:diff_version_response] if args.key?(:diff_version_response)
|
643
|
+
@download_parameters = args[:download_parameters] if args.key?(:download_parameters)
|
644
|
+
@filename = args[:filename] if args.key?(:filename)
|
645
|
+
@hash_prop = args[:hash_prop] if args.key?(:hash_prop)
|
646
|
+
@hash_verified = args[:hash_verified] if args.key?(:hash_verified)
|
647
|
+
@inline = args[:inline] if args.key?(:inline)
|
648
|
+
@is_potential_retry = args[:is_potential_retry] if args.key?(:is_potential_retry)
|
649
|
+
@length = args[:length] if args.key?(:length)
|
650
|
+
@md5_hash = args[:md5_hash] if args.key?(:md5_hash)
|
651
|
+
@media_id = args[:media_id] if args.key?(:media_id)
|
652
|
+
@object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop)
|
653
|
+
@path = args[:path] if args.key?(:path)
|
654
|
+
@reference_type = args[:reference_type] if args.key?(:reference_type)
|
655
|
+
@sha1_hash = args[:sha1_hash] if args.key?(:sha1_hash)
|
656
|
+
@sha256_hash = args[:sha256_hash] if args.key?(:sha256_hash)
|
657
|
+
@timestamp = args[:timestamp] if args.key?(:timestamp)
|
658
|
+
@token = args[:token] if args.key?(:token)
|
659
|
+
end
|
660
|
+
end
|
661
|
+
|
662
|
+
# This is a copy of the tech.blob.ObjectId proto, which could not be used
|
663
|
+
# directly here due to transitive closure issues with JavaScript support; see
|
664
|
+
# http://b/8801763.
|
665
|
+
class GdataObjectId
|
666
|
+
include Google::Apis::Core::Hashable
|
667
|
+
|
668
|
+
# The name of the bucket to which this object belongs.
|
669
|
+
# Corresponds to the JSON property `bucketName`
|
670
|
+
# @return [String]
|
671
|
+
attr_accessor :bucket_name
|
672
|
+
|
673
|
+
# Generation of the object. Generations are monotonically increasing across
|
674
|
+
# writes, allowing them to be be compared to determine which generation is newer.
|
675
|
+
# If this is omitted in a request, then you are requesting the live object. See
|
676
|
+
# http://go/bigstore-versions
|
677
|
+
# Corresponds to the JSON property `generation`
|
678
|
+
# @return [Fixnum]
|
679
|
+
attr_accessor :generation
|
680
|
+
|
681
|
+
# The name of the object.
|
682
|
+
# Corresponds to the JSON property `objectName`
|
683
|
+
# @return [String]
|
684
|
+
attr_accessor :object_name
|
685
|
+
|
686
|
+
def initialize(**args)
|
687
|
+
update!(**args)
|
688
|
+
end
|
689
|
+
|
690
|
+
# Update properties of this object
|
691
|
+
def update!(**args)
|
692
|
+
@bucket_name = args[:bucket_name] if args.key?(:bucket_name)
|
693
|
+
@generation = args[:generation] if args.key?(:generation)
|
694
|
+
@object_name = args[:object_name] if args.key?(:object_name)
|
695
|
+
end
|
696
|
+
end
|
697
|
+
|
25
698
|
# `Distribution` contains summary statistics for a population of values. It
|
26
699
|
# optionally contains a histogram representing the distribution of those values
|
27
700
|
# across a set of buckets. The summary statistics are the count, mean, sum of
|
@@ -2920,6 +3593,14 @@ module Google
|
|
2920
3593
|
# @return [Array<String>]
|
2921
3594
|
attr_accessor :assist_skipped_reasons
|
2922
3595
|
|
3596
|
+
# Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/`
|
3597
|
+
# project`/locations/`location`/collections/`collection`/engines/`engine`/
|
3598
|
+
# sessions/`session`/assistAnswers/`assist_answer`` This field must be a UTF-8
|
3599
|
+
# encoded string with a length limit of 1024 characters.
|
3600
|
+
# Corresponds to the JSON property `name`
|
3601
|
+
# @return [String]
|
3602
|
+
attr_accessor :name
|
3603
|
+
|
2923
3604
|
# Replies of the assistant.
|
2924
3605
|
# Corresponds to the JSON property `replies`
|
2925
3606
|
# @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AssistAnswerReply>]
|
@@ -2937,6 +3618,7 @@ module Google
|
|
2937
3618
|
# Update properties of this object
|
2938
3619
|
def update!(**args)
|
2939
3620
|
@assist_skipped_reasons = args[:assist_skipped_reasons] if args.key?(:assist_skipped_reasons)
|
3621
|
+
@name = args[:name] if args.key?(:name)
|
2940
3622
|
@replies = args[:replies] if args.key?(:replies)
|
2941
3623
|
@state = args[:state] if args.key?(:state)
|
2942
3624
|
end
|
@@ -2990,6 +3672,59 @@ module Google
|
|
2990
3672
|
end
|
2991
3673
|
end
|
2992
3674
|
|
3675
|
+
# Discovery Engine Assistant resource.
|
3676
|
+
class GoogleCloudDiscoveryengineV1Assistant
|
3677
|
+
include Google::Apis::Core::Hashable
|
3678
|
+
|
3679
|
+
# Customer-defined policy for the assistant.
|
3680
|
+
# Corresponds to the JSON property `customerPolicy`
|
3681
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AssistantCustomerPolicy]
|
3682
|
+
attr_accessor :customer_policy
|
3683
|
+
|
3684
|
+
# Optional. Note: not implemented yet. Use enabled_actions instead. The enabled
|
3685
|
+
# tools on this assistant. The keys are connector name, for example "projects/`
|
3686
|
+
# projectId`/locations/`locationId`/collections/`collectionId`/dataconnector The
|
3687
|
+
# values consist of admin enabled tools towards the connector instance. Admin
|
3688
|
+
# can selectively enable multiple tools on any of the connector instances that
|
3689
|
+
# they created in the project. For example `"jira1ConnectorName": [(toolId1, "
|
3690
|
+
# createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3,
|
3691
|
+
# "sendEmail"),..] `
|
3692
|
+
# Corresponds to the JSON property `enabledTools`
|
3693
|
+
# @return [Hash<String,Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AssistantToolList>]
|
3694
|
+
attr_accessor :enabled_tools
|
3695
|
+
|
3696
|
+
# Configuration for the generation of the assistant response.
|
3697
|
+
# Corresponds to the JSON property `generationConfig`
|
3698
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AssistantGenerationConfig]
|
3699
|
+
attr_accessor :generation_config
|
3700
|
+
|
3701
|
+
# Immutable. Resource name of the assistant. Format: `projects/`project`/
|
3702
|
+
# locations/`location`/collections/`collection`/engines/`engine`/assistants/`
|
3703
|
+
# assistant`` It must be a UTF-8 encoded string with a length limit of 1024
|
3704
|
+
# characters.
|
3705
|
+
# Corresponds to the JSON property `name`
|
3706
|
+
# @return [String]
|
3707
|
+
attr_accessor :name
|
3708
|
+
|
3709
|
+
# Optional. The type of web grounding to use.
|
3710
|
+
# Corresponds to the JSON property `webGroundingType`
|
3711
|
+
# @return [String]
|
3712
|
+
attr_accessor :web_grounding_type
|
3713
|
+
|
3714
|
+
def initialize(**args)
|
3715
|
+
update!(**args)
|
3716
|
+
end
|
3717
|
+
|
3718
|
+
# Update properties of this object
|
3719
|
+
def update!(**args)
|
3720
|
+
@customer_policy = args[:customer_policy] if args.key?(:customer_policy)
|
3721
|
+
@enabled_tools = args[:enabled_tools] if args.key?(:enabled_tools)
|
3722
|
+
@generation_config = args[:generation_config] if args.key?(:generation_config)
|
3723
|
+
@name = args[:name] if args.key?(:name)
|
3724
|
+
@web_grounding_type = args[:web_grounding_type] if args.key?(:web_grounding_type)
|
3725
|
+
end
|
3726
|
+
end
|
3727
|
+
|
2993
3728
|
# Multi-modal content.
|
2994
3729
|
class GoogleCloudDiscoveryengineV1AssistantContent
|
2995
3730
|
include Google::Apis::Core::Hashable
|
@@ -3142,6 +3877,107 @@ module Google
|
|
3142
3877
|
end
|
3143
3878
|
end
|
3144
3879
|
|
3880
|
+
# Customer-defined policy for the assistant.
|
3881
|
+
class GoogleCloudDiscoveryengineV1AssistantCustomerPolicy
|
3882
|
+
include Google::Apis::Core::Hashable
|
3883
|
+
|
3884
|
+
# Optional. List of banned phrases.
|
3885
|
+
# Corresponds to the JSON property `bannedPhrases`
|
3886
|
+
# @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AssistantCustomerPolicyBannedPhrase>]
|
3887
|
+
attr_accessor :banned_phrases
|
3888
|
+
|
3889
|
+
def initialize(**args)
|
3890
|
+
update!(**args)
|
3891
|
+
end
|
3892
|
+
|
3893
|
+
# Update properties of this object
|
3894
|
+
def update!(**args)
|
3895
|
+
@banned_phrases = args[:banned_phrases] if args.key?(:banned_phrases)
|
3896
|
+
end
|
3897
|
+
end
|
3898
|
+
|
3899
|
+
# Definition of a customer-defined banned phrase. A banned phrase is not allowed
|
3900
|
+
# to appear in the user query or the LLM response, or else the answer will be
|
3901
|
+
# refused.
|
3902
|
+
class GoogleCloudDiscoveryengineV1AssistantCustomerPolicyBannedPhrase
|
3903
|
+
include Google::Apis::Core::Hashable
|
3904
|
+
|
3905
|
+
# Optional. If true, diacritical marks (e.g., accents, umlauts) are ignored when
|
3906
|
+
# matching banned phrases. For example, "cafe" would match "café".
|
3907
|
+
# Corresponds to the JSON property `ignoreDiacritics`
|
3908
|
+
# @return [Boolean]
|
3909
|
+
attr_accessor :ignore_diacritics
|
3910
|
+
alias_method :ignore_diacritics?, :ignore_diacritics
|
3911
|
+
|
3912
|
+
# Optional. Match type for the banned phrase.
|
3913
|
+
# Corresponds to the JSON property `matchType`
|
3914
|
+
# @return [String]
|
3915
|
+
attr_accessor :match_type
|
3916
|
+
|
3917
|
+
# Required. The raw string content to be banned.
|
3918
|
+
# Corresponds to the JSON property `phrase`
|
3919
|
+
# @return [String]
|
3920
|
+
attr_accessor :phrase
|
3921
|
+
|
3922
|
+
def initialize(**args)
|
3923
|
+
update!(**args)
|
3924
|
+
end
|
3925
|
+
|
3926
|
+
# Update properties of this object
|
3927
|
+
def update!(**args)
|
3928
|
+
@ignore_diacritics = args[:ignore_diacritics] if args.key?(:ignore_diacritics)
|
3929
|
+
@match_type = args[:match_type] if args.key?(:match_type)
|
3930
|
+
@phrase = args[:phrase] if args.key?(:phrase)
|
3931
|
+
end
|
3932
|
+
end
|
3933
|
+
|
3934
|
+
# Configuration for the generation of the assistant response.
|
3935
|
+
class GoogleCloudDiscoveryengineV1AssistantGenerationConfig
|
3936
|
+
include Google::Apis::Core::Hashable
|
3937
|
+
|
3938
|
+
# The default language to use for the generation of the assistant response. Use
|
3939
|
+
# an ISO 639-1 language code such as `en`. If not specified, the language will
|
3940
|
+
# be automatically detected.
|
3941
|
+
# Corresponds to the JSON property `defaultLanguage`
|
3942
|
+
# @return [String]
|
3943
|
+
attr_accessor :default_language
|
3944
|
+
|
3945
|
+
# System instruction, also known as the prompt preamble for LLM calls.
|
3946
|
+
# Corresponds to the JSON property `systemInstruction`
|
3947
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AssistantGenerationConfigSystemInstruction]
|
3948
|
+
attr_accessor :system_instruction
|
3949
|
+
|
3950
|
+
def initialize(**args)
|
3951
|
+
update!(**args)
|
3952
|
+
end
|
3953
|
+
|
3954
|
+
# Update properties of this object
|
3955
|
+
def update!(**args)
|
3956
|
+
@default_language = args[:default_language] if args.key?(:default_language)
|
3957
|
+
@system_instruction = args[:system_instruction] if args.key?(:system_instruction)
|
3958
|
+
end
|
3959
|
+
end
|
3960
|
+
|
3961
|
+
# System instruction, also known as the prompt preamble for LLM calls.
|
3962
|
+
class GoogleCloudDiscoveryengineV1AssistantGenerationConfigSystemInstruction
|
3963
|
+
include Google::Apis::Core::Hashable
|
3964
|
+
|
3965
|
+
# Optional. Additional system instruction that will be added to the default
|
3966
|
+
# system instruction.
|
3967
|
+
# Corresponds to the JSON property `additionalSystemInstruction`
|
3968
|
+
# @return [String]
|
3969
|
+
attr_accessor :additional_system_instruction
|
3970
|
+
|
3971
|
+
def initialize(**args)
|
3972
|
+
update!(**args)
|
3973
|
+
end
|
3974
|
+
|
3975
|
+
# Update properties of this object
|
3976
|
+
def update!(**args)
|
3977
|
+
@additional_system_instruction = args[:additional_system_instruction] if args.key?(:additional_system_instruction)
|
3978
|
+
end
|
3979
|
+
end
|
3980
|
+
|
3145
3981
|
# A piece of content and possibly its grounding information. Not all content
|
3146
3982
|
# needs grounding. Phrases like "Of course, I will gladly search it for you." do
|
3147
3983
|
# not need grounding.
|
@@ -3310,6 +4146,52 @@ module Google
|
|
3310
4146
|
end
|
3311
4147
|
end
|
3312
4148
|
|
4149
|
+
# Information to identify a tool.
|
4150
|
+
class GoogleCloudDiscoveryengineV1AssistantToolInfo
|
4151
|
+
include Google::Apis::Core::Hashable
|
4152
|
+
|
4153
|
+
# The display name of the tool.
|
4154
|
+
# Corresponds to the JSON property `toolDisplayName`
|
4155
|
+
# @return [String]
|
4156
|
+
attr_accessor :tool_display_name
|
4157
|
+
|
4158
|
+
# The name of the tool as defined by DataConnectorService.QueryAvailableActions.
|
4159
|
+
# Note: it's using `action` in the DataConnectorService apis, but they are the
|
4160
|
+
# same as the `tool` here.
|
4161
|
+
# Corresponds to the JSON property `toolName`
|
4162
|
+
# @return [String]
|
4163
|
+
attr_accessor :tool_name
|
4164
|
+
|
4165
|
+
def initialize(**args)
|
4166
|
+
update!(**args)
|
4167
|
+
end
|
4168
|
+
|
4169
|
+
# Update properties of this object
|
4170
|
+
def update!(**args)
|
4171
|
+
@tool_display_name = args[:tool_display_name] if args.key?(:tool_display_name)
|
4172
|
+
@tool_name = args[:tool_name] if args.key?(:tool_name)
|
4173
|
+
end
|
4174
|
+
end
|
4175
|
+
|
4176
|
+
# The enabled tools on a connector
|
4177
|
+
class GoogleCloudDiscoveryengineV1AssistantToolList
|
4178
|
+
include Google::Apis::Core::Hashable
|
4179
|
+
|
4180
|
+
# The list of tools with corresponding tool information.
|
4181
|
+
# Corresponds to the JSON property `toolInfo`
|
4182
|
+
# @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AssistantToolInfo>]
|
4183
|
+
attr_accessor :tool_info
|
4184
|
+
|
4185
|
+
def initialize(**args)
|
4186
|
+
update!(**args)
|
4187
|
+
end
|
4188
|
+
|
4189
|
+
# Update properties of this object
|
4190
|
+
def update!(**args)
|
4191
|
+
@tool_info = args[:tool_info] if args.key?(:tool_info)
|
4192
|
+
end
|
4193
|
+
end
|
4194
|
+
|
3313
4195
|
# Metadata related to the progress of the SiteSearchEngineService.
|
3314
4196
|
# BatchCreateTargetSites operation. This will be returned by the google.
|
3315
4197
|
# longrunning.Operation.metadata field.
|
@@ -4181,6 +5063,12 @@ module Google
|
|
4181
5063
|
class GoogleCloudDiscoveryengineV1ChunkDocumentMetadata
|
4182
5064
|
include Google::Apis::Core::Hashable
|
4183
5065
|
|
5066
|
+
# The mime type of the document. https://www.iana.org/assignments/media-types/
|
5067
|
+
# media-types.xhtml.
|
5068
|
+
# Corresponds to the JSON property `mimeType`
|
5069
|
+
# @return [String]
|
5070
|
+
attr_accessor :mime_type
|
5071
|
+
|
4184
5072
|
# Data representation. The structured JSON data for the document. It should
|
4185
5073
|
# conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.
|
4186
5074
|
# Corresponds to the JSON property `structData`
|
@@ -4203,6 +5091,7 @@ module Google
|
|
4203
5091
|
|
4204
5092
|
# Update properties of this object
|
4205
5093
|
def update!(**args)
|
5094
|
+
@mime_type = args[:mime_type] if args.key?(:mime_type)
|
4206
5095
|
@struct_data = args[:struct_data] if args.key?(:struct_data)
|
4207
5096
|
@title = args[:title] if args.key?(:title)
|
4208
5097
|
@uri = args[:uri] if args.key?(:uri)
|
@@ -4328,14 +5217,14 @@ module Google
|
|
4328
5217
|
attr_accessor :is_default
|
4329
5218
|
alias_method :is_default?, :is_default
|
4330
5219
|
|
4331
|
-
# KMS key resource name which will be used to encrypt resources `
|
4332
|
-
# project`/locations/`location`/keyRings/`keyRing`/cryptoKeys/`keyId``.
|
5220
|
+
# Required. KMS key resource name which will be used to encrypt resources `
|
5221
|
+
# projects/`project`/locations/`location`/keyRings/`keyRing`/cryptoKeys/`keyId``.
|
4333
5222
|
# Corresponds to the JSON property `kmsKey`
|
4334
5223
|
# @return [String]
|
4335
5224
|
attr_accessor :kms_key
|
4336
5225
|
|
4337
|
-
# KMS key version resource name which will be used to encrypt
|
4338
|
-
# cryptoKeyVersions/`keyVersion``.
|
5226
|
+
# Output only. KMS key version resource name which will be used to encrypt
|
5227
|
+
# resources `/cryptoKeyVersions/`keyVersion``.
|
4339
5228
|
# Corresponds to the JSON property `kmsKeyVersion`
|
4340
5229
|
# @return [String]
|
4341
5230
|
attr_accessor :kms_key_version
|
@@ -8661,6 +9550,11 @@ module Google
|
|
8661
9550
|
# @return [String]
|
8662
9551
|
attr_accessor :data_use_terms_version
|
8663
9552
|
|
9553
|
+
# Parameters for Agentspace.
|
9554
|
+
# Corresponds to the JSON property `saasParams`
|
9555
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ProvisionProjectRequestSaasParams]
|
9556
|
+
attr_accessor :saas_params
|
9557
|
+
|
8664
9558
|
def initialize(**args)
|
8665
9559
|
update!(**args)
|
8666
9560
|
end
|
@@ -8669,6 +9563,28 @@ module Google
|
|
8669
9563
|
def update!(**args)
|
8670
9564
|
@accept_data_use_terms = args[:accept_data_use_terms] if args.key?(:accept_data_use_terms)
|
8671
9565
|
@data_use_terms_version = args[:data_use_terms_version] if args.key?(:data_use_terms_version)
|
9566
|
+
@saas_params = args[:saas_params] if args.key?(:saas_params)
|
9567
|
+
end
|
9568
|
+
end
|
9569
|
+
|
9570
|
+
# Parameters for Agentspace.
|
9571
|
+
class GoogleCloudDiscoveryengineV1ProvisionProjectRequestSaasParams
|
9572
|
+
include Google::Apis::Core::Hashable
|
9573
|
+
|
9574
|
+
# Optional. Set to `true` to specify that caller has read and would like to give
|
9575
|
+
# consent to the [Terms for Agent Space quality of service].
|
9576
|
+
# Corresponds to the JSON property `acceptBizQos`
|
9577
|
+
# @return [Boolean]
|
9578
|
+
attr_accessor :accept_biz_qos
|
9579
|
+
alias_method :accept_biz_qos?, :accept_biz_qos
|
9580
|
+
|
9581
|
+
def initialize(**args)
|
9582
|
+
update!(**args)
|
9583
|
+
end
|
9584
|
+
|
9585
|
+
# Update properties of this object
|
9586
|
+
def update!(**args)
|
9587
|
+
@accept_biz_qos = args[:accept_biz_qos] if args.key?(:accept_biz_qos)
|
8672
9588
|
end
|
8673
9589
|
end
|
8674
9590
|
|
@@ -9119,7 +10035,7 @@ module Google
|
|
9119
10035
|
# @return [String]
|
9120
10036
|
attr_accessor :query
|
9121
10037
|
|
9122
|
-
# Required. A list of records to rank.
|
10038
|
+
# Required. A list of records to rank.
|
9123
10039
|
# Corresponds to the JSON property `records`
|
9124
10040
|
# @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1RankingRecord>]
|
9125
10041
|
attr_accessor :records
|
@@ -11822,12 +12738,6 @@ module Google
|
|
11822
12738
|
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecImageGenerationSpec]
|
11823
12739
|
attr_accessor :image_generation_spec
|
11824
12740
|
|
11825
|
-
# Optional. The name of the tool registry to use. Format: `projects/`project`/
|
11826
|
-
# locations/`location`/toolRegistries/`tool_registry``
|
11827
|
-
# Corresponds to the JSON property `toolRegistry`
|
11828
|
-
# @return [String]
|
11829
|
-
attr_accessor :tool_registry
|
11830
|
-
|
11831
12741
|
# Specification of the Vertex AI Search tool.
|
11832
12742
|
# Corresponds to the JSON property `vertexAiSearchSpec`
|
11833
12743
|
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecVertexAiSearchSpec]
|
@@ -11850,7 +12760,6 @@ module Google
|
|
11850
12760
|
# Update properties of this object
|
11851
12761
|
def update!(**args)
|
11852
12762
|
@image_generation_spec = args[:image_generation_spec] if args.key?(:image_generation_spec)
|
11853
|
-
@tool_registry = args[:tool_registry] if args.key?(:tool_registry)
|
11854
12763
|
@vertex_ai_search_spec = args[:vertex_ai_search_spec] if args.key?(:vertex_ai_search_spec)
|
11855
12764
|
@video_generation_spec = args[:video_generation_spec] if args.key?(:video_generation_spec)
|
11856
12765
|
@web_grounding_spec = args[:web_grounding_spec] if args.key?(:web_grounding_spec)
|
@@ -11881,14 +12790,6 @@ module Google
|
|
11881
12790
|
# @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec>]
|
11882
12791
|
attr_accessor :data_store_specs
|
11883
12792
|
|
11884
|
-
# Optional. Deprecated. Please refrain from using this field. Whether the Vertex
|
11885
|
-
# AI Search tool is disabled. Default value is false, the tool is enabled by
|
11886
|
-
# default.
|
11887
|
-
# Corresponds to the JSON property `disabled`
|
11888
|
-
# @return [Boolean]
|
11889
|
-
attr_accessor :disabled
|
11890
|
-
alias_method :disabled?, :disabled
|
11891
|
-
|
11892
12793
|
# Optional. The filter syntax consists of an expression language for
|
11893
12794
|
# constructing a predicate from one or more fields of the documents being
|
11894
12795
|
# filtered. Filter expression is case-sensitive. If this field is unrecognizable,
|
@@ -11911,7 +12812,6 @@ module Google
|
|
11911
12812
|
# Update properties of this object
|
11912
12813
|
def update!(**args)
|
11913
12814
|
@data_store_specs = args[:data_store_specs] if args.key?(:data_store_specs)
|
11914
|
-
@disabled = args[:disabled] if args.key?(:disabled)
|
11915
12815
|
@filter = args[:filter] if args.key?(:filter)
|
11916
12816
|
end
|
11917
12817
|
end
|
@@ -11933,20 +12833,12 @@ module Google
|
|
11933
12833
|
class GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecWebGroundingSpec
|
11934
12834
|
include Google::Apis::Core::Hashable
|
11935
12835
|
|
11936
|
-
# Optional. Deprecated. Please refrain from using this field. Whether the web
|
11937
|
-
# grounding tool is enabled.
|
11938
|
-
# Corresponds to the JSON property `enabled`
|
11939
|
-
# @return [Boolean]
|
11940
|
-
attr_accessor :enabled
|
11941
|
-
alias_method :enabled?, :enabled
|
11942
|
-
|
11943
12836
|
def initialize(**args)
|
11944
12837
|
update!(**args)
|
11945
12838
|
end
|
11946
12839
|
|
11947
12840
|
# Update properties of this object
|
11948
12841
|
def update!(**args)
|
11949
|
-
@enabled = args[:enabled] if args.key?(:enabled)
|
11950
12842
|
end
|
11951
12843
|
end
|
11952
12844
|
|
@@ -13906,14 +14798,14 @@ module Google
|
|
13906
14798
|
attr_accessor :is_default
|
13907
14799
|
alias_method :is_default?, :is_default
|
13908
14800
|
|
13909
|
-
# KMS key resource name which will be used to encrypt resources `
|
13910
|
-
# project`/locations/`location`/keyRings/`keyRing`/cryptoKeys/`keyId``.
|
14801
|
+
# Required. KMS key resource name which will be used to encrypt resources `
|
14802
|
+
# projects/`project`/locations/`location`/keyRings/`keyRing`/cryptoKeys/`keyId``.
|
13911
14803
|
# Corresponds to the JSON property `kmsKey`
|
13912
14804
|
# @return [String]
|
13913
14805
|
attr_accessor :kms_key
|
13914
14806
|
|
13915
|
-
# KMS key version resource name which will be used to encrypt
|
13916
|
-
# cryptoKeyVersions/`keyVersion``.
|
14807
|
+
# Output only. KMS key version resource name which will be used to encrypt
|
14808
|
+
# resources `/cryptoKeyVersions/`keyVersion``.
|
13917
14809
|
# Corresponds to the JSON property `kmsKeyVersion`
|
13918
14810
|
# @return [String]
|
13919
14811
|
attr_accessor :kms_key_version
|
@@ -16832,6 +17724,48 @@ module Google
|
|
16832
17724
|
end
|
16833
17725
|
end
|
16834
17726
|
|
17727
|
+
# Metadata related to the progress of the Export operation. This is returned by
|
17728
|
+
# the google.longrunning.Operation.metadata field.
|
17729
|
+
class GoogleCloudDiscoveryengineV1alphaExportMetricsMetadata
|
17730
|
+
include Google::Apis::Core::Hashable
|
17731
|
+
|
17732
|
+
# Operation create time.
|
17733
|
+
# Corresponds to the JSON property `createTime`
|
17734
|
+
# @return [String]
|
17735
|
+
attr_accessor :create_time
|
17736
|
+
|
17737
|
+
# Operation last update time. If the operation is done, this is also the finish
|
17738
|
+
# time.
|
17739
|
+
# Corresponds to the JSON property `updateTime`
|
17740
|
+
# @return [String]
|
17741
|
+
attr_accessor :update_time
|
17742
|
+
|
17743
|
+
def initialize(**args)
|
17744
|
+
update!(**args)
|
17745
|
+
end
|
17746
|
+
|
17747
|
+
# Update properties of this object
|
17748
|
+
def update!(**args)
|
17749
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
17750
|
+
@update_time = args[:update_time] if args.key?(:update_time)
|
17751
|
+
end
|
17752
|
+
end
|
17753
|
+
|
17754
|
+
# Response of the ExportMetricsRequest. If the long running operation was
|
17755
|
+
# successful, then this message is returned by the google.longrunning.Operations.
|
17756
|
+
# response field.
|
17757
|
+
class GoogleCloudDiscoveryengineV1alphaExportMetricsResponse
|
17758
|
+
include Google::Apis::Core::Hashable
|
17759
|
+
|
17760
|
+
def initialize(**args)
|
17761
|
+
update!(**args)
|
17762
|
+
end
|
17763
|
+
|
17764
|
+
# Update properties of this object
|
17765
|
+
def update!(**args)
|
17766
|
+
end
|
17767
|
+
end
|
17768
|
+
|
16835
17769
|
# Configurations for fields of a schema. For example, configuring a field is
|
16836
17770
|
# indexable, or searchable.
|
16837
17771
|
class GoogleCloudDiscoveryengineV1alphaFieldConfig
|
@@ -17648,9 +18582,12 @@ module Google
|
|
17648
18582
|
class GoogleCloudDiscoveryengineV1alphaListSessionsRequest
|
17649
18583
|
include Google::Apis::Core::Hashable
|
17650
18584
|
|
17651
|
-
# A
|
17652
|
-
# user_pseudo_id
|
17653
|
-
#
|
18585
|
+
# A comma-separated list of fields to filter by, in EBNF grammar. The supported
|
18586
|
+
# fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `
|
18587
|
+
# is_pinned` * `labels` * `create_time` * `update_time` Examples: * `
|
18588
|
+
# user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `
|
18589
|
+
# is_pinned=true AND (NOT labels:hidden)` * `create_time > "1970-01-01T12:00:00Z"
|
18590
|
+
# `
|
17654
18591
|
# Corresponds to the JSON property `filter`
|
17655
18592
|
# @return [String]
|
17656
18593
|
attr_accessor :filter
|
@@ -19821,6 +20758,17 @@ module Google
|
|
19821
20758
|
class GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec
|
19822
20759
|
include Google::Apis::Core::Hashable
|
19823
20760
|
|
20761
|
+
# Optional. Controls behavior of how extracted filters are applied to the search.
|
20762
|
+
# The default behavior depends on the request. For single datastore structured
|
20763
|
+
# search, the default is `HARD_FILTER`. For multi-datastore search, the default
|
20764
|
+
# behavior is `SOFT_BOOST`. Location-based filters are always applied as hard
|
20765
|
+
# filters, and the `SOFT_BOOST` setting will not affect them. This field is only
|
20766
|
+
# used if SearchRequest.natural_language_query_understanding_spec.
|
20767
|
+
# filter_extraction_condition is set to FilterExtractionCondition.ENABLED.
|
20768
|
+
# Corresponds to the JSON property `extractedFilterBehavior`
|
20769
|
+
# @return [String]
|
20770
|
+
attr_accessor :extracted_filter_behavior
|
20771
|
+
|
19824
20772
|
# The condition under which filter extraction should occur. Server behavior
|
19825
20773
|
# defaults to `DISABLED`.
|
19826
20774
|
# Corresponds to the JSON property `filterExtractionCondition`
|
@@ -19842,6 +20790,7 @@ module Google
|
|
19842
20790
|
|
19843
20791
|
# Update properties of this object
|
19844
20792
|
def update!(**args)
|
20793
|
+
@extracted_filter_behavior = args[:extracted_filter_behavior] if args.key?(:extracted_filter_behavior)
|
19845
20794
|
@filter_extraction_condition = args[:filter_extraction_condition] if args.key?(:filter_extraction_condition)
|
19846
20795
|
@geo_search_query_detection_field_names = args[:geo_search_query_detection_field_names] if args.key?(:geo_search_query_detection_field_names)
|
19847
20796
|
end
|
@@ -20994,14 +21943,14 @@ module Google
|
|
20994
21943
|
attr_accessor :is_default
|
20995
21944
|
alias_method :is_default?, :is_default
|
20996
21945
|
|
20997
|
-
# KMS key resource name which will be used to encrypt resources `
|
20998
|
-
# project`/locations/`location`/keyRings/`keyRing`/cryptoKeys/`keyId``.
|
21946
|
+
# Required. KMS key resource name which will be used to encrypt resources `
|
21947
|
+
# projects/`project`/locations/`location`/keyRings/`keyRing`/cryptoKeys/`keyId``.
|
20999
21948
|
# Corresponds to the JSON property `kmsKey`
|
21000
21949
|
# @return [String]
|
21001
21950
|
attr_accessor :kms_key
|
21002
21951
|
|
21003
|
-
# KMS key version resource name which will be used to encrypt
|
21004
|
-
# cryptoKeyVersions/`keyVersion``.
|
21952
|
+
# Output only. KMS key version resource name which will be used to encrypt
|
21953
|
+
# resources `/cryptoKeyVersions/`keyVersion``.
|
21005
21954
|
# Corresponds to the JSON property `kmsKeyVersion`
|
21006
21955
|
# @return [String]
|
21007
21956
|
attr_accessor :kms_key_version
|
@@ -25178,6 +26127,17 @@ module Google
|
|
25178
26127
|
class GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec
|
25179
26128
|
include Google::Apis::Core::Hashable
|
25180
26129
|
|
26130
|
+
# Optional. Controls behavior of how extracted filters are applied to the search.
|
26131
|
+
# The default behavior depends on the request. For single datastore structured
|
26132
|
+
# search, the default is `HARD_FILTER`. For multi-datastore search, the default
|
26133
|
+
# behavior is `SOFT_BOOST`. Location-based filters are always applied as hard
|
26134
|
+
# filters, and the `SOFT_BOOST` setting will not affect them. This field is only
|
26135
|
+
# used if SearchRequest.natural_language_query_understanding_spec.
|
26136
|
+
# filter_extraction_condition is set to FilterExtractionCondition.ENABLED.
|
26137
|
+
# Corresponds to the JSON property `extractedFilterBehavior`
|
26138
|
+
# @return [String]
|
26139
|
+
attr_accessor :extracted_filter_behavior
|
26140
|
+
|
25181
26141
|
# The condition under which filter extraction should occur. Server behavior
|
25182
26142
|
# defaults to `DISABLED`.
|
25183
26143
|
# Corresponds to the JSON property `filterExtractionCondition`
|
@@ -25199,6 +26159,7 @@ module Google
|
|
25199
26159
|
|
25200
26160
|
# Update properties of this object
|
25201
26161
|
def update!(**args)
|
26162
|
+
@extracted_filter_behavior = args[:extracted_filter_behavior] if args.key?(:extracted_filter_behavior)
|
25202
26163
|
@filter_extraction_condition = args[:filter_extraction_condition] if args.key?(:filter_extraction_condition)
|
25203
26164
|
@geo_search_query_detection_field_names = args[:geo_search_query_detection_field_names] if args.key?(:geo_search_query_detection_field_names)
|
25204
26165
|
end
|