google-apis-discoveryengine_v1beta 0.89.0 → 0.91.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.
@@ -22,679 +22,6 @@ module Google
22
22
  module Apis
23
23
  module DiscoveryengineV1beta
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::DiscoveryengineV1beta::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::DiscoveryengineV1beta::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::DiscoveryengineV1beta::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::DiscoveryengineV1beta::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::DiscoveryengineV1beta::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::DiscoveryengineV1beta::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::DiscoveryengineV1beta::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::DiscoveryengineV1beta::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::DiscoveryengineV1beta::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::DiscoveryengineV1beta::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::DiscoveryengineV1beta::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::DiscoveryengineV1beta::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::DiscoveryengineV1beta::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::DiscoveryengineV1beta::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::DiscoveryengineV1beta::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::DiscoveryengineV1beta::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::DiscoveryengineV1beta::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::DiscoveryengineV1beta::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
-
698
25
  # `Distribution` contains summary statistics for a population of values. It
699
26
  # optionally contains a histogram representing the distribution of those values
700
27
  # across a set of buckets. The summary statistics are the count, mean, sum of
@@ -1676,6 +1003,18 @@ module Google
1676
1003
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1AssistantCustomerPolicy]
1677
1004
  attr_accessor :customer_policy
1678
1005
 
1006
+ # Optional. Description for additional information. Expected to be shown on the
1007
+ # configuration UI, not to the users of the assistant.
1008
+ # Corresponds to the JSON property `description`
1009
+ # @return [String]
1010
+ attr_accessor :description
1011
+
1012
+ # Required. The assistant display name. It must be a UTF-8 encoded string with a
1013
+ # length limit of 128 characters.
1014
+ # Corresponds to the JSON property `displayName`
1015
+ # @return [String]
1016
+ attr_accessor :display_name
1017
+
1679
1018
  # Optional. Note: not implemented yet. Use enabled_actions instead. The enabled
1680
1019
  # tools on this assistant. The keys are connector name, for example "projects/`
1681
1020
  # projectId`/locations/`locationId`/collections/`collectionId`/dataconnector The
@@ -1713,6 +1052,8 @@ module Google
1713
1052
  # Update properties of this object
1714
1053
  def update!(**args)
1715
1054
  @customer_policy = args[:customer_policy] if args.key?(:customer_policy)
1055
+ @description = args[:description] if args.key?(:description)
1056
+ @display_name = args[:display_name] if args.key?(:display_name)
1716
1057
  @enabled_tools = args[:enabled_tools] if args.key?(:enabled_tools)
1717
1058
  @generation_config = args[:generation_config] if args.key?(:generation_config)
1718
1059
  @name = args[:name] if args.key?(:name)
@@ -1823,6 +1164,11 @@ module Google
1823
1164
  class GoogleCloudDiscoveryengineV1AssistantGenerationConfig
1824
1165
  include Google::Apis::Core::Hashable
1825
1166
 
1167
+ # Optional. The list of models that are allowed to be used for assistant.
1168
+ # Corresponds to the JSON property `allowedModelIds`
1169
+ # @return [Array<String>]
1170
+ attr_accessor :allowed_model_ids
1171
+
1826
1172
  # The default language to use for the generation of the assistant response. Use
1827
1173
  # an ISO 639-1 language code such as `en`. If not specified, the language will
1828
1174
  # be automatically detected.
@@ -1830,6 +1176,11 @@ module Google
1830
1176
  # @return [String]
1831
1177
  attr_accessor :default_language
1832
1178
 
1179
+ # Optional. The default model to use for assistant.
1180
+ # Corresponds to the JSON property `defaultModelId`
1181
+ # @return [String]
1182
+ attr_accessor :default_model_id
1183
+
1833
1184
  # System instruction, also known as the prompt preamble for LLM calls.
1834
1185
  # Corresponds to the JSON property `systemInstruction`
1835
1186
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1AssistantGenerationConfigSystemInstruction]
@@ -1841,7 +1192,9 @@ module Google
1841
1192
 
1842
1193
  # Update properties of this object
1843
1194
  def update!(**args)
1195
+ @allowed_model_ids = args[:allowed_model_ids] if args.key?(:allowed_model_ids)
1844
1196
  @default_language = args[:default_language] if args.key?(:default_language)
1197
+ @default_model_id = args[:default_model_id] if args.key?(:default_model_id)
1845
1198
  @system_instruction = args[:system_instruction] if args.key?(:system_instruction)
1846
1199
  end
1847
1200
  end
@@ -4493,6 +3846,14 @@ module Google
4493
3846
  class GoogleCloudDiscoveryengineV1EngineSearchEngineConfig
4494
3847
  include Google::Apis::Core::Hashable
4495
3848
 
3849
+ # Optional. The required subscription tier of this engine. They cannot be
3850
+ # modified after engine creation. If the required subscription tier is search,
3851
+ # user with higher license tier like assist can still access the standalone app
3852
+ # associated with this engine.
3853
+ # Corresponds to the JSON property `requiredSubscriptionTier`
3854
+ # @return [String]
3855
+ attr_accessor :required_subscription_tier
3856
+
4496
3857
  # The add-on that this search engine enables.
4497
3858
  # Corresponds to the JSON property `searchAddOns`
4498
3859
  # @return [Array<String>]
@@ -4511,6 +3872,7 @@ module Google
4511
3872
 
4512
3873
  # Update properties of this object
4513
3874
  def update!(**args)
3875
+ @required_subscription_tier = args[:required_subscription_tier] if args.key?(:required_subscription_tier)
4514
3876
  @search_add_ons = args[:search_add_ons] if args.key?(:search_add_ons)
4515
3877
  @search_tier = args[:search_tier] if args.key?(:search_tier)
4516
3878
  end
@@ -11400,6 +10762,14 @@ module Google
11400
10762
  class GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig
11401
10763
  include Google::Apis::Core::Hashable
11402
10764
 
10765
+ # Optional. The required subscription tier of this engine. They cannot be
10766
+ # modified after engine creation. If the required subscription tier is search,
10767
+ # user with higher license tier like assist can still access the standalone app
10768
+ # associated with this engine.
10769
+ # Corresponds to the JSON property `requiredSubscriptionTier`
10770
+ # @return [String]
10771
+ attr_accessor :required_subscription_tier
10772
+
11403
10773
  # The add-on that this search engine enables.
11404
10774
  # Corresponds to the JSON property `searchAddOns`
11405
10775
  # @return [Array<String>]
@@ -11418,6 +10788,7 @@ module Google
11418
10788
 
11419
10789
  # Update properties of this object
11420
10790
  def update!(**args)
10791
+ @required_subscription_tier = args[:required_subscription_tier] if args.key?(:required_subscription_tier)
11421
10792
  @search_add_ons = args[:search_add_ons] if args.key?(:search_add_ons)
11422
10793
  @search_tier = args[:search_tier] if args.key?(:search_tier)
11423
10794
  end
@@ -13718,6 +13089,18 @@ module Google
13718
13089
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec]
13719
13090
  attr_accessor :content_search_spec
13720
13091
 
13092
+ # Optional. Crowding specifications for improving result diversity. If multiple
13093
+ # CrowdingSpecs are specified, crowding will be evaluated on each unique
13094
+ # combination of the `field` values, and max_count will be the maximum value of `
13095
+ # max_count` across all CrowdingSpecs. For example, if the first CrowdingSpec
13096
+ # has `field` = "color" and `max_count` = 3, and the second CrowdingSpec has `
13097
+ # field` = "size" and `max_count` = 2, then after 3 documents that share the
13098
+ # same color AND size have been returned, subsequent ones should be removed or
13099
+ # demoted.
13100
+ # Corresponds to the JSON property `crowdingSpecs`
13101
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec>]
13102
+ attr_accessor :crowding_specs
13103
+
13721
13104
  # Defines custom fine tuning spec.
13722
13105
  # Corresponds to the JSON property `customFineTuningSpec`
13723
13106
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec]
@@ -13810,6 +13193,20 @@ module Google
13810
13193
  # @return [String]
13811
13194
  attr_accessor :order_by
13812
13195
 
13196
+ # Optional. The categories associated with a category page. Must be set for
13197
+ # category navigation queries to achieve good search quality. The format should
13198
+ # be the same as UserEvent.PageInfo.page_category. This field is the equivalent
13199
+ # of the query for browse (navigation) queries. It's used by the browse model
13200
+ # when the query is empty. If the field is empty, it will not be used by the
13201
+ # browse model. To represent full path of a category, use '>' character to
13202
+ # separate different hierarchies. If '>' is part of the category name, replace
13203
+ # it with other character(s). For example, `Graphics Cards > RTX>4090 > Founders
13204
+ # Edition` where "RTX > 4090" represents one level, can be rewritten as `
13205
+ # Graphics Cards > RTX_4090 > Founders Edition`
13206
+ # Corresponds to the JSON property `pageCategories`
13207
+ # @return [Array<String>]
13208
+ attr_accessor :page_categories
13209
+
13813
13210
  # Maximum number of Documents to return. The maximum allowed value depends on
13814
13211
  # the data type. Values above the maximum value are coerced to the maximum value.
13815
13212
  # * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with
@@ -14042,6 +13439,7 @@ module Google
14042
13439
  @branch = args[:branch] if args.key?(:branch)
14043
13440
  @canonical_filter = args[:canonical_filter] if args.key?(:canonical_filter)
14044
13441
  @content_search_spec = args[:content_search_spec] if args.key?(:content_search_spec)
13442
+ @crowding_specs = args[:crowding_specs] if args.key?(:crowding_specs)
14045
13443
  @custom_fine_tuning_spec = args[:custom_fine_tuning_spec] if args.key?(:custom_fine_tuning_spec)
14046
13444
  @data_store_specs = args[:data_store_specs] if args.key?(:data_store_specs)
14047
13445
  @display_spec = args[:display_spec] if args.key?(:display_spec)
@@ -14054,6 +13452,7 @@ module Google
14054
13452
  @offset = args[:offset] if args.key?(:offset)
14055
13453
  @one_box_page_size = args[:one_box_page_size] if args.key?(:one_box_page_size)
14056
13454
  @order_by = args[:order_by] if args.key?(:order_by)
13455
+ @page_categories = args[:page_categories] if args.key?(:page_categories)
14057
13456
  @page_size = args[:page_size] if args.key?(:page_size)
14058
13457
  @page_token = args[:page_token] if args.key?(:page_token)
14059
13458
  @params = args[:params] if args.key?(:params)
@@ -14594,6 +13993,45 @@ module Google
14594
13993
  end
14595
13994
  end
14596
13995
 
13996
+ # Specification for crowding. Crowding improves the diversity of search results
13997
+ # by limiting the number of results that share the same field value. For example,
13998
+ # crowding on the color field with a max_count of 3 and mode
13999
+ # DROP_CROWDED_RESULTS will return at most 3 results with the same color across
14000
+ # all pages.
14001
+ class GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec
14002
+ include Google::Apis::Core::Hashable
14003
+
14004
+ # The field to use for crowding. Documents can be crowded by a field in the
14005
+ # Document object. Crowding field is case sensitive.
14006
+ # Corresponds to the JSON property `field`
14007
+ # @return [String]
14008
+ attr_accessor :field
14009
+
14010
+ # The maximum number of documents to keep per value of the field. Once there are
14011
+ # at least max_count previous results which contain the same value for the given
14012
+ # field (according to the order specified in `order_by`), later results with the
14013
+ # same value are "crowded away". If not specified, the default value is 1.
14014
+ # Corresponds to the JSON property `maxCount`
14015
+ # @return [Fixnum]
14016
+ attr_accessor :max_count
14017
+
14018
+ # Mode to use for documents that are crowded away.
14019
+ # Corresponds to the JSON property `mode`
14020
+ # @return [String]
14021
+ attr_accessor :mode
14022
+
14023
+ def initialize(**args)
14024
+ update!(**args)
14025
+ end
14026
+
14027
+ # Update properties of this object
14028
+ def update!(**args)
14029
+ @field = args[:field] if args.key?(:field)
14030
+ @max_count = args[:max_count] if args.key?(:max_count)
14031
+ @mode = args[:mode] if args.key?(:mode)
14032
+ end
14033
+ end
14034
+
14597
14035
  # A struct to define data stores to filter on in a search call and
14598
14036
  # configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error
14599
14037
  # is returned.
@@ -18468,6 +17906,18 @@ module Google
18468
17906
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAssistantCustomerPolicy]
18469
17907
  attr_accessor :customer_policy
18470
17908
 
17909
+ # Optional. Description for additional information. Expected to be shown on the
17910
+ # configuration UI, not to the users of the assistant.
17911
+ # Corresponds to the JSON property `description`
17912
+ # @return [String]
17913
+ attr_accessor :description
17914
+
17915
+ # Required. The assistant display name. It must be a UTF-8 encoded string with a
17916
+ # length limit of 128 characters.
17917
+ # Corresponds to the JSON property `displayName`
17918
+ # @return [String]
17919
+ attr_accessor :display_name
17920
+
18471
17921
  # Optional. Note: not implemented yet. Use enabled_actions instead. The enabled
18472
17922
  # tools on this assistant. The keys are connector name, for example "projects/`
18473
17923
  # projectId`/locations/`locationId`/collections/`collectionId`/dataconnector The
@@ -18505,6 +17955,8 @@ module Google
18505
17955
  # Update properties of this object
18506
17956
  def update!(**args)
18507
17957
  @customer_policy = args[:customer_policy] if args.key?(:customer_policy)
17958
+ @description = args[:description] if args.key?(:description)
17959
+ @display_name = args[:display_name] if args.key?(:display_name)
18508
17960
  @enabled_tools = args[:enabled_tools] if args.key?(:enabled_tools)
18509
17961
  @generation_config = args[:generation_config] if args.key?(:generation_config)
18510
17962
  @name = args[:name] if args.key?(:name)
@@ -18767,6 +18219,11 @@ module Google
18767
18219
  class GoogleCloudDiscoveryengineV1betaAssistantGenerationConfig
18768
18220
  include Google::Apis::Core::Hashable
18769
18221
 
18222
+ # Optional. The list of models that are allowed to be used for assistant.
18223
+ # Corresponds to the JSON property `allowedModelIds`
18224
+ # @return [Array<String>]
18225
+ attr_accessor :allowed_model_ids
18226
+
18770
18227
  # The default language to use for the generation of the assistant response. Use
18771
18228
  # an ISO 639-1 language code such as `en`. If not specified, the language will
18772
18229
  # be automatically detected.
@@ -18774,6 +18231,11 @@ module Google
18774
18231
  # @return [String]
18775
18232
  attr_accessor :default_language
18776
18233
 
18234
+ # Optional. The default model to use for assistant.
18235
+ # Corresponds to the JSON property `defaultModelId`
18236
+ # @return [String]
18237
+ attr_accessor :default_model_id
18238
+
18777
18239
  # System instruction, also known as the prompt preamble for LLM calls.
18778
18240
  # Corresponds to the JSON property `systemInstruction`
18779
18241
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAssistantGenerationConfigSystemInstruction]
@@ -18785,7 +18247,9 @@ module Google
18785
18247
 
18786
18248
  # Update properties of this object
18787
18249
  def update!(**args)
18250
+ @allowed_model_ids = args[:allowed_model_ids] if args.key?(:allowed_model_ids)
18788
18251
  @default_language = args[:default_language] if args.key?(:default_language)
18252
+ @default_model_id = args[:default_model_id] if args.key?(:default_model_id)
18789
18253
  @system_instruction = args[:system_instruction] if args.key?(:system_instruction)
18790
18254
  end
18791
18255
  end
@@ -22841,6 +22305,14 @@ module Google
22841
22305
  class GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig
22842
22306
  include Google::Apis::Core::Hashable
22843
22307
 
22308
+ # Optional. The required subscription tier of this engine. They cannot be
22309
+ # modified after engine creation. If the required subscription tier is search,
22310
+ # user with higher license tier like assist can still access the standalone app
22311
+ # associated with this engine.
22312
+ # Corresponds to the JSON property `requiredSubscriptionTier`
22313
+ # @return [String]
22314
+ attr_accessor :required_subscription_tier
22315
+
22844
22316
  # The add-on that this search engine enables.
22845
22317
  # Corresponds to the JSON property `searchAddOns`
22846
22318
  # @return [Array<String>]
@@ -22859,6 +22331,7 @@ module Google
22859
22331
 
22860
22332
  # Update properties of this object
22861
22333
  def update!(**args)
22334
+ @required_subscription_tier = args[:required_subscription_tier] if args.key?(:required_subscription_tier)
22862
22335
  @search_add_ons = args[:search_add_ons] if args.key?(:search_add_ons)
22863
22336
  @search_tier = args[:search_tier] if args.key?(:search_tier)
22864
22337
  end
@@ -23310,6 +22783,11 @@ module Google
23310
22783
  # @return [String]
23311
22784
  attr_accessor :external_identity
23312
22785
 
22786
+ # Optional. The name of the external identity.
22787
+ # Corresponds to the JSON property `externalIdentityName`
22788
+ # @return [String]
22789
+ attr_accessor :external_identity_name
22790
+
23313
22791
  # Group identifier. For Google Workspace user account, group_id should be the
23314
22792
  # google workspace group email. For non-google identity provider, group_id is
23315
22793
  # the mapped group identifier configured during the workforcepool config.
@@ -23331,6 +22809,7 @@ module Google
23331
22809
  # Update properties of this object
23332
22810
  def update!(**args)
23333
22811
  @external_identity = args[:external_identity] if args.key?(:external_identity)
22812
+ @external_identity_name = args[:external_identity_name] if args.key?(:external_identity_name)
23334
22813
  @group_id = args[:group_id] if args.key?(:group_id)
23335
22814
  @user_id = args[:user_id] if args.key?(:user_id)
23336
22815
  end
@@ -24436,6 +23915,32 @@ module Google
24436
23915
  end
24437
23916
  end
24438
23917
 
23918
+ # Response message for the AssistantService.ListAssistants method.
23919
+ class GoogleCloudDiscoveryengineV1betaListAssistantsResponse
23920
+ include Google::Apis::Core::Hashable
23921
+
23922
+ # All the customer's Assistants.
23923
+ # Corresponds to the JSON property `assistants`
23924
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAssistant>]
23925
+ attr_accessor :assistants
23926
+
23927
+ # A token that can be sent as ListAssistantsRequest.page_token to retrieve the
23928
+ # next page. If this field is omitted, there are no subsequent pages.
23929
+ # Corresponds to the JSON property `nextPageToken`
23930
+ # @return [String]
23931
+ attr_accessor :next_page_token
23932
+
23933
+ def initialize(**args)
23934
+ update!(**args)
23935
+ end
23936
+
23937
+ # Update properties of this object
23938
+ def update!(**args)
23939
+ @assistants = args[:assistants] if args.key?(:assistants)
23940
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
23941
+ end
23942
+ end
23943
+
24439
23944
  # Response message for CmekConfigService.ListCmekConfigs method.
24440
23945
  class GoogleCloudDiscoveryengineV1betaListCmekConfigsResponse
24441
23946
  include Google::Apis::Core::Hashable
@@ -26893,6 +26398,18 @@ module Google
26893
26398
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec]
26894
26399
  attr_accessor :content_search_spec
26895
26400
 
26401
+ # Optional. Crowding specifications for improving result diversity. If multiple
26402
+ # CrowdingSpecs are specified, crowding will be evaluated on each unique
26403
+ # combination of the `field` values, and max_count will be the maximum value of `
26404
+ # max_count` across all CrowdingSpecs. For example, if the first CrowdingSpec
26405
+ # has `field` = "color" and `max_count` = 3, and the second CrowdingSpec has `
26406
+ # field` = "size" and `max_count` = 2, then after 3 documents that share the
26407
+ # same color AND size have been returned, subsequent ones should be removed or
26408
+ # demoted.
26409
+ # Corresponds to the JSON property `crowdingSpecs`
26410
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec>]
26411
+ attr_accessor :crowding_specs
26412
+
26896
26413
  # Specifications that define the specific DataStores to be searched, along with
26897
26414
  # configurations for those data stores. This is only considered for Engines with
26898
26415
  # multiple data stores. For engines with a single data store, the specs directly
@@ -26980,6 +26497,20 @@ module Google
26980
26497
  # @return [String]
26981
26498
  attr_accessor :order_by
26982
26499
 
26500
+ # Optional. The categories associated with a category page. Must be set for
26501
+ # category navigation queries to achieve good search quality. The format should
26502
+ # be the same as UserEvent.PageInfo.page_category. This field is the equivalent
26503
+ # of the query for browse (navigation) queries. It's used by the browse model
26504
+ # when the query is empty. If the field is empty, it will not be used by the
26505
+ # browse model. To represent full path of a category, use '>' character to
26506
+ # separate different hierarchies. If '>' is part of the category name, replace
26507
+ # it with other character(s). For example, `Graphics Cards > RTX>4090 > Founders
26508
+ # Edition` where "RTX > 4090" represents one level, can be rewritten as `
26509
+ # Graphics Cards > RTX_4090 > Founders Edition`
26510
+ # Corresponds to the JSON property `pageCategories`
26511
+ # @return [Array<String>]
26512
+ attr_accessor :page_categories
26513
+
26983
26514
  # Maximum number of Documents to return. The maximum allowed value depends on
26984
26515
  # the data type. Values above the maximum value are coerced to the maximum value.
26985
26516
  # * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with
@@ -27203,6 +26734,7 @@ module Google
27203
26734
  @branch = args[:branch] if args.key?(:branch)
27204
26735
  @canonical_filter = args[:canonical_filter] if args.key?(:canonical_filter)
27205
26736
  @content_search_spec = args[:content_search_spec] if args.key?(:content_search_spec)
26737
+ @crowding_specs = args[:crowding_specs] if args.key?(:crowding_specs)
27206
26738
  @data_store_specs = args[:data_store_specs] if args.key?(:data_store_specs)
27207
26739
  @display_spec = args[:display_spec] if args.key?(:display_spec)
27208
26740
  @embedding_spec = args[:embedding_spec] if args.key?(:embedding_spec)
@@ -27214,6 +26746,7 @@ module Google
27214
26746
  @offset = args[:offset] if args.key?(:offset)
27215
26747
  @one_box_page_size = args[:one_box_page_size] if args.key?(:one_box_page_size)
27216
26748
  @order_by = args[:order_by] if args.key?(:order_by)
26749
+ @page_categories = args[:page_categories] if args.key?(:page_categories)
27217
26750
  @page_size = args[:page_size] if args.key?(:page_size)
27218
26751
  @page_token = args[:page_token] if args.key?(:page_token)
27219
26752
  @params = args[:params] if args.key?(:params)
@@ -27753,6 +27286,45 @@ module Google
27753
27286
  end
27754
27287
  end
27755
27288
 
27289
+ # Specification for crowding. Crowding improves the diversity of search results
27290
+ # by limiting the number of results that share the same field value. For example,
27291
+ # crowding on the color field with a max_count of 3 and mode
27292
+ # DROP_CROWDED_RESULTS will return at most 3 results with the same color across
27293
+ # all pages.
27294
+ class GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec
27295
+ include Google::Apis::Core::Hashable
27296
+
27297
+ # The field to use for crowding. Documents can be crowded by a field in the
27298
+ # Document object. Crowding field is case sensitive.
27299
+ # Corresponds to the JSON property `field`
27300
+ # @return [String]
27301
+ attr_accessor :field
27302
+
27303
+ # The maximum number of documents to keep per value of the field. Once there are
27304
+ # at least max_count previous results which contain the same value for the given
27305
+ # field (according to the order specified in `order_by`), later results with the
27306
+ # same value are "crowded away". If not specified, the default value is 1.
27307
+ # Corresponds to the JSON property `maxCount`
27308
+ # @return [Fixnum]
27309
+ attr_accessor :max_count
27310
+
27311
+ # Mode to use for documents that are crowded away.
27312
+ # Corresponds to the JSON property `mode`
27313
+ # @return [String]
27314
+ attr_accessor :mode
27315
+
27316
+ def initialize(**args)
27317
+ update!(**args)
27318
+ end
27319
+
27320
+ # Update properties of this object
27321
+ def update!(**args)
27322
+ @field = args[:field] if args.key?(:field)
27323
+ @max_count = args[:max_count] if args.key?(:max_count)
27324
+ @mode = args[:mode] if args.key?(:mode)
27325
+ end
27326
+ end
27327
+
27756
27328
  # A struct to define data stores to filter on in a search call and
27757
27329
  # configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error
27758
27330
  # is returned.
@@ -28357,6 +27929,11 @@ module Google
28357
27929
  # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchLinkPromotion>]
28358
27930
  attr_accessor :search_link_promotions
28359
27931
 
27932
+ # Output only. Indicates the semantic state of the search response.
27933
+ # Corresponds to the JSON property `semanticState`
27934
+ # @return [String]
27935
+ attr_accessor :semantic_state
27936
+
28360
27937
  # Information about the session.
28361
27938
  # Corresponds to the JSON property `sessionInfo`
28362
27939
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseSessionInfo]
@@ -28402,6 +27979,7 @@ module Google
28402
27979
  @redirect_uri = args[:redirect_uri] if args.key?(:redirect_uri)
28403
27980
  @results = args[:results] if args.key?(:results)
28404
27981
  @search_link_promotions = args[:search_link_promotions] if args.key?(:search_link_promotions)
27982
+ @semantic_state = args[:semantic_state] if args.key?(:semantic_state)
28405
27983
  @session_info = args[:session_info] if args.key?(:session_info)
28406
27984
  @suggested_query = args[:suggested_query] if args.key?(:suggested_query)
28407
27985
  @summary = args[:summary] if args.key?(:summary)
@@ -30174,6 +29752,11 @@ module Google
30174
29752
  # @return [String]
30175
29753
  attr_accessor :assist_token
30176
29754
 
29755
+ # The tool names of the tools that were invoked.
29756
+ # Corresponds to the JSON property `invocationTools`
29757
+ # @return [Array<String>]
29758
+ attr_accessor :invocation_tools
29759
+
30177
29760
  # Information about the session.
30178
29761
  # Corresponds to the JSON property `sessionInfo`
30179
29762
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaStreamAssistResponseSessionInfo]
@@ -30187,6 +29770,7 @@ module Google
30187
29770
  def update!(**args)
30188
29771
  @answer = args[:answer] if args.key?(:answer)
30189
29772
  @assist_token = args[:assist_token] if args.key?(:assist_token)
29773
+ @invocation_tools = args[:invocation_tools] if args.key?(:invocation_tools)
30190
29774
  @session_info = args[:session_info] if args.key?(:session_info)
30191
29775
  end
30192
29776
  end
@@ -31173,8 +30757,9 @@ module Google
31173
30757
  attr_accessor :operations
31174
30758
 
31175
30759
  # Unordered list. Unreachable resources. Populated when the request sets `
31176
- # ListOperationsRequest.return_partial_success` and reads across collections e.g.
31177
- # when attempting to list all resources across all supported locations.
30760
+ # ListOperationsRequest.return_partial_success` and reads across collections.
30761
+ # For example, when attempting to list all resources across all supported
30762
+ # locations.
31178
30763
  # Corresponds to the JSON property `unreachable`
31179
30764
  # @return [Array<String>]
31180
30765
  attr_accessor :unreachable