google-apis-discoveryengine_v1alpha 0.83.0 → 0.85.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,893 +22,6 @@ module Google
22
22
  module Apis
23
23
  module DiscoveryengineV1alpha
24
24
 
25
- # Extra information added to operations that support Scotty media requests.
26
- class ApiservingMediaRequestInfo
27
- include Google::Apis::Core::Hashable
28
-
29
- # The number of current bytes uploaded or downloaded.
30
- # Corresponds to the JSON property `currentBytes`
31
- # @return [Fixnum]
32
- attr_accessor :current_bytes
33
-
34
- # Data to be copied to backend requests. Custom data is returned to Scotty in
35
- # the agent_state field, which Scotty will then provide in subsequent upload
36
- # notifications.
37
- # Corresponds to the JSON property `customData`
38
- # @return [String]
39
- attr_accessor :custom_data
40
-
41
- # Set if the http request info is diff encoded. The value of this field is the
42
- # version number of the base revision. This is corresponding to Apiary's
43
- # mediaDiffObjectVersion (//depot/google3/java/com/google/api/server/media/
44
- # variable/DiffObjectVersionVariable.java). See go/esf-scotty-diff-upload for
45
- # more information.
46
- # Corresponds to the JSON property `diffObjectVersion`
47
- # @return [String]
48
- attr_accessor :diff_object_version
49
-
50
- # The existence of the final_status field indicates that this is the last call
51
- # to the agent for this request_id. http://google3/uploader/agent/scotty_agent.
52
- # proto?l=737&rcl=347601929
53
- # Corresponds to the JSON property `finalStatus`
54
- # @return [Fixnum]
55
- attr_accessor :final_status
56
-
57
- # The type of notification received from Scotty.
58
- # Corresponds to the JSON property `notificationType`
59
- # @return [String]
60
- attr_accessor :notification_type
61
-
62
- # The physical headers provided by RequestReceivedParameters in Scotty request.
63
- # type is uploader_service.KeyValuePairs.
64
- # Corresponds to the JSON property `physicalHeaders`
65
- # NOTE: Values are automatically base64 encoded/decoded in the client library.
66
- # @return [String]
67
- attr_accessor :physical_headers
68
-
69
- # The Scotty request ID.
70
- # Corresponds to the JSON property `requestId`
71
- # @return [String]
72
- attr_accessor :request_id
73
-
74
- # The partition of the Scotty server handling this request. type is
75
- # uploader_service.RequestReceivedParamsServingInfo LINT.IfChange(
76
- # request_received_params_serving_info_annotations) LINT.ThenChange()
77
- # Corresponds to the JSON property `requestReceivedParamsServingInfo`
78
- # NOTE: Values are automatically base64 encoded/decoded in the client library.
79
- # @return [String]
80
- attr_accessor :request_received_params_serving_info
81
-
82
- # The total size of the file.
83
- # Corresponds to the JSON property `totalBytes`
84
- # @return [Fixnum]
85
- attr_accessor :total_bytes
86
-
87
- # Whether the total bytes field contains an estimated data.
88
- # Corresponds to the JSON property `totalBytesIsEstimated`
89
- # @return [Boolean]
90
- attr_accessor :total_bytes_is_estimated
91
- alias_method :total_bytes_is_estimated?, :total_bytes_is_estimated
92
-
93
- def initialize(**args)
94
- update!(**args)
95
- end
96
-
97
- # Update properties of this object
98
- def update!(**args)
99
- @current_bytes = args[:current_bytes] if args.key?(:current_bytes)
100
- @custom_data = args[:custom_data] if args.key?(:custom_data)
101
- @diff_object_version = args[:diff_object_version] if args.key?(:diff_object_version)
102
- @final_status = args[:final_status] if args.key?(:final_status)
103
- @notification_type = args[:notification_type] if args.key?(:notification_type)
104
- @physical_headers = args[:physical_headers] if args.key?(:physical_headers)
105
- @request_id = args[:request_id] if args.key?(:request_id)
106
- @request_received_params_serving_info = args[:request_received_params_serving_info] if args.key?(:request_received_params_serving_info)
107
- @total_bytes = args[:total_bytes] if args.key?(:total_bytes)
108
- @total_bytes_is_estimated = args[:total_bytes_is_estimated] if args.key?(:total_bytes_is_estimated)
109
- end
110
- end
111
-
112
- # This message is for backends to pass their scotty media specific fields to ESF.
113
- # Backend will include this in their response message to ESF. Example:
114
- # ExportFile is an rpc defined for upload using scotty from ESF. rpc ExportFile(
115
- # ExportFileRequest) returns (ExportFileResponse) Message ExportFileResponse
116
- # will include apiserving.MediaResponseInfo to tell ESF about data like
117
- # dynamic_dropzone it needs to pass to Scotty. message ExportFileResponse `
118
- # optional gdata.Media blob = 1; optional apiserving.MediaResponseInfo
119
- # media_response_info = 2 `
120
- class ApiservingMediaResponseInfo
121
- include Google::Apis::Core::Hashable
122
-
123
- # Data to copy from backend response to the next backend requests. Custom data
124
- # is returned to Scotty in the agent_state field, which Scotty will then provide
125
- # in subsequent upload notifications.
126
- # Corresponds to the JSON property `customData`
127
- # @return [String]
128
- attr_accessor :custom_data
129
-
130
- # Specifies any transformation to be applied to data before persisting it or
131
- # retrieving from storage. E.g., encryption options for blobstore2. This should
132
- # be of the form uploader_service.DataStorageTransform.
133
- # Corresponds to the JSON property `dataStorageTransform`
134
- # NOTE: Values are automatically base64 encoded/decoded in the client library.
135
- # @return [String]
136
- attr_accessor :data_storage_transform
137
-
138
- # For the first notification of a |diff_encoded| HttpRequestInfo, this is the
139
- # index of the blob mint that Scotty should use when writing the resulting blob.
140
- # This field is optional. It's not required ever, even if `
141
- # original_object_blob_mint_index` is set. In situations like that, we will use
142
- # the destination blob's mint for the destination blob and regular blob ACL
143
- # checks for the original object. Note: This field is only for use by Drive API
144
- # for diff uploads.
145
- # Corresponds to the JSON property `destinationBlobMintIndex`
146
- # @return [Fixnum]
147
- attr_accessor :destination_blob_mint_index
148
-
149
- # Specifies the Scotty Drop Target to use for uploads. If present in a media
150
- # response, Scotty does not upload to a standard drop zone. Instead, Scotty
151
- # saves the upload directly to the location specified in this drop target.
152
- # Unlike drop zones, the drop target is the final storage location for an upload.
153
- # So, the agent does not need to clone the blob at the end of the upload. The
154
- # agent is responsible for garbage collecting any orphaned blobs that may occur
155
- # due to aborted uploads. For more information, see the drop target design doc
156
- # here: http://goto/ScottyDropTarget This field will be preferred to
157
- # dynamicDropzone. If provided, the identified field in the response must be of
158
- # the type uploader.agent.DropTarget.
159
- # Corresponds to the JSON property `dynamicDropTarget`
160
- # NOTE: Values are automatically base64 encoded/decoded in the client library.
161
- # @return [String]
162
- attr_accessor :dynamic_drop_target
163
-
164
- # Specifies the Scotty dropzone to use for uploads.
165
- # Corresponds to the JSON property `dynamicDropzone`
166
- # @return [String]
167
- attr_accessor :dynamic_dropzone
168
-
169
- # A reference to data stored on the filesystem, on GFS or in blobstore.
170
- # Corresponds to the JSON property `mediaForDiff`
171
- # @return [Google::Apis::DiscoveryengineV1alpha::GdataMedia]
172
- attr_accessor :media_for_diff
173
-
174
- # For the first notification of a |diff_encoded| HttpRequestInfo, this is the
175
- # index of the blob mint that Scotty should use when reading the original blob.
176
- # This field is optional. It's not required ever, even if `
177
- # destination_blob_mint_index` is set. In situations like that, we will use the
178
- # destination blob's mint for the destination blob and regular blob ACL checks
179
- # for the original object. Note: This field is only for use by Drive API for
180
- # diff uploads.
181
- # Corresponds to the JSON property `originalObjectBlobMintIndex`
182
- # @return [Fixnum]
183
- attr_accessor :original_object_blob_mint_index
184
-
185
- # Request class to use for all Blobstore operations for this request.
186
- # Corresponds to the JSON property `requestClass`
187
- # @return [String]
188
- attr_accessor :request_class
189
-
190
- # Requester ID passed along to be recorded in the Scotty logs
191
- # Corresponds to the JSON property `scottyAgentUserId`
192
- # @return [Fixnum]
193
- attr_accessor :scotty_agent_user_id
194
-
195
- # Customer-specific data to be recorded in the Scotty logs type is
196
- # logs_proto_scotty.CustomerLog
197
- # Corresponds to the JSON property `scottyCustomerLog`
198
- # NOTE: Values are automatically base64 encoded/decoded in the client library.
199
- # @return [String]
200
- attr_accessor :scotty_customer_log
201
-
202
- # Specifies the TrafficClass that Scotty should use for any RPCs to fetch the
203
- # response bytes. Will override the traffic class GTOS of the incoming http
204
- # request. This is a temporary field to facilitate whitelisting and
205
- # experimentation by the bigstore agent only. For instance, this does not apply
206
- # to RTMP reads. WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.
207
- # Corresponds to the JSON property `trafficClassField`
208
- # @return [String]
209
- attr_accessor :traffic_class_field
210
-
211
- # Tells Scotty to verify hashes on the agent's behalf by parsing out the X-Goog-
212
- # Hash header.
213
- # Corresponds to the JSON property `verifyHashFromHeader`
214
- # @return [Boolean]
215
- attr_accessor :verify_hash_from_header
216
- alias_method :verify_hash_from_header?, :verify_hash_from_header
217
-
218
- def initialize(**args)
219
- update!(**args)
220
- end
221
-
222
- # Update properties of this object
223
- def update!(**args)
224
- @custom_data = args[:custom_data] if args.key?(:custom_data)
225
- @data_storage_transform = args[:data_storage_transform] if args.key?(:data_storage_transform)
226
- @destination_blob_mint_index = args[:destination_blob_mint_index] if args.key?(:destination_blob_mint_index)
227
- @dynamic_drop_target = args[:dynamic_drop_target] if args.key?(:dynamic_drop_target)
228
- @dynamic_dropzone = args[:dynamic_dropzone] if args.key?(:dynamic_dropzone)
229
- @media_for_diff = args[:media_for_diff] if args.key?(:media_for_diff)
230
- @original_object_blob_mint_index = args[:original_object_blob_mint_index] if args.key?(:original_object_blob_mint_index)
231
- @request_class = args[:request_class] if args.key?(:request_class)
232
- @scotty_agent_user_id = args[:scotty_agent_user_id] if args.key?(:scotty_agent_user_id)
233
- @scotty_customer_log = args[:scotty_customer_log] if args.key?(:scotty_customer_log)
234
- @traffic_class_field = args[:traffic_class_field] if args.key?(:traffic_class_field)
235
- @verify_hash_from_header = args[:verify_hash_from_header] if args.key?(:verify_hash_from_header)
236
- end
237
- end
238
-
239
- # Information to read/write to blobstore2.
240
- class GdataBlobstore2Info
241
- include Google::Apis::Core::Hashable
242
-
243
- # The blob generation id.
244
- # Corresponds to the JSON property `blobGeneration`
245
- # @return [Fixnum]
246
- attr_accessor :blob_generation
247
-
248
- # The blob id, e.g., /blobstore/prod/playground/scotty
249
- # Corresponds to the JSON property `blobId`
250
- # @return [String]
251
- attr_accessor :blob_id
252
-
253
- # Read handle passed from Bigstore -> Scotty for a GCS download. This is a
254
- # signed, serialized blobstore2.ReadHandle proto which must never be set outside
255
- # of Bigstore, and is not applicable to non-GCS media downloads.
256
- # Corresponds to the JSON property `downloadReadHandle`
257
- # NOTE: Values are automatically base64 encoded/decoded in the client library.
258
- # @return [String]
259
- attr_accessor :download_read_handle
260
-
261
- # The blob read token. Needed to read blobs that have not been replicated. Might
262
- # not be available until the final call.
263
- # Corresponds to the JSON property `readToken`
264
- # @return [String]
265
- attr_accessor :read_token
266
-
267
- # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a
268
- # signed, serialized blobstore2.BlobMetadataContainer proto which must never be
269
- # consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
270
- # Corresponds to the JSON property `uploadMetadataContainer`
271
- # NOTE: Values are automatically base64 encoded/decoded in the client library.
272
- # @return [String]
273
- attr_accessor :upload_metadata_container
274
-
275
- def initialize(**args)
276
- update!(**args)
277
- end
278
-
279
- # Update properties of this object
280
- def update!(**args)
281
- @blob_generation = args[:blob_generation] if args.key?(:blob_generation)
282
- @blob_id = args[:blob_id] if args.key?(:blob_id)
283
- @download_read_handle = args[:download_read_handle] if args.key?(:download_read_handle)
284
- @read_token = args[:read_token] if args.key?(:read_token)
285
- @upload_metadata_container = args[:upload_metadata_container] if args.key?(:upload_metadata_container)
286
- end
287
- end
288
-
289
- # A sequence of media data references representing composite data. Introduced to
290
- # support Bigstore composite objects. For details, visit http://go/bigstore-
291
- # composites.
292
- class GdataCompositeMedia
293
- include Google::Apis::Core::Hashable
294
-
295
- # Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be
296
- # the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating
297
- # v1, use blobstore2_info instead. For now, any v2 blob will also be represented
298
- # in this field as v1 BlobRef.
299
- # Corresponds to the JSON property `blobRef`
300
- # NOTE: Values are automatically base64 encoded/decoded in the client library.
301
- # @return [String]
302
- attr_accessor :blob_ref
303
-
304
- # Information to read/write to blobstore2.
305
- # Corresponds to the JSON property `blobstore2Info`
306
- # @return [Google::Apis::DiscoveryengineV1alpha::GdataBlobstore2Info]
307
- attr_accessor :blobstore2_info
308
-
309
- # A binary data reference for a media download. Serves as a technology-agnostic
310
- # binary reference in some Google infrastructure. This value is a serialized
311
- # storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get
312
- # around the fact that the cosmo proto (as well as others it includes) doesn't
313
- # support JavaScript. This prevents us from including the actual type of this
314
- # field.
315
- # Corresponds to the JSON property `cosmoBinaryReference`
316
- # NOTE: Values are automatically base64 encoded/decoded in the client library.
317
- # @return [String]
318
- attr_accessor :cosmo_binary_reference
319
-
320
- # crc32.c hash for the payload.
321
- # Corresponds to the JSON property `crc32cHash`
322
- # @return [Fixnum]
323
- attr_accessor :crc32c_hash
324
-
325
- # Media data, set if reference_type is INLINE
326
- # Corresponds to the JSON property `inline`
327
- # NOTE: Values are automatically base64 encoded/decoded in the client library.
328
- # @return [String]
329
- attr_accessor :inline
330
-
331
- # Size of the data, in bytes
332
- # Corresponds to the JSON property `length`
333
- # @return [Fixnum]
334
- attr_accessor :length
335
-
336
- # MD5 hash for the payload.
337
- # Corresponds to the JSON property `md5Hash`
338
- # NOTE: Values are automatically base64 encoded/decoded in the client library.
339
- # @return [String]
340
- attr_accessor :md5_hash
341
-
342
- # This is a copy of the tech.blob.ObjectId proto, which could not be used
343
- # directly here due to transitive closure issues with JavaScript support; see
344
- # http://b/8801763.
345
- # Corresponds to the JSON property `objectId`
346
- # @return [Google::Apis::DiscoveryengineV1alpha::GdataObjectId]
347
- attr_accessor :object_id_prop
348
-
349
- # Path to the data, set if reference_type is PATH
350
- # Corresponds to the JSON property `path`
351
- # @return [String]
352
- attr_accessor :path
353
-
354
- # Describes what the field reference contains.
355
- # Corresponds to the JSON property `referenceType`
356
- # @return [String]
357
- attr_accessor :reference_type
358
-
359
- # SHA-1 hash for the payload.
360
- # Corresponds to the JSON property `sha1Hash`
361
- # NOTE: Values are automatically base64 encoded/decoded in the client library.
362
- # @return [String]
363
- attr_accessor :sha1_hash
364
-
365
- def initialize(**args)
366
- update!(**args)
367
- end
368
-
369
- # Update properties of this object
370
- def update!(**args)
371
- @blob_ref = args[:blob_ref] if args.key?(:blob_ref)
372
- @blobstore2_info = args[:blobstore2_info] if args.key?(:blobstore2_info)
373
- @cosmo_binary_reference = args[:cosmo_binary_reference] if args.key?(:cosmo_binary_reference)
374
- @crc32c_hash = args[:crc32c_hash] if args.key?(:crc32c_hash)
375
- @inline = args[:inline] if args.key?(:inline)
376
- @length = args[:length] if args.key?(:length)
377
- @md5_hash = args[:md5_hash] if args.key?(:md5_hash)
378
- @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop)
379
- @path = args[:path] if args.key?(:path)
380
- @reference_type = args[:reference_type] if args.key?(:reference_type)
381
- @sha1_hash = args[:sha1_hash] if args.key?(:sha1_hash)
382
- end
383
- end
384
-
385
- # Detailed Content-Type information from Scotty. The Content-Type of the media
386
- # will typically be filled in by the header or Scotty's best_guess, but this
387
- # extended information provides the backend with more information so that it can
388
- # make a better decision if needed. This is only used on media upload requests
389
- # from Scotty.
390
- class GdataContentTypeInfo
391
- include Google::Apis::Core::Hashable
392
-
393
- # Scotty's best guess of what the content type of the file is.
394
- # Corresponds to the JSON property `bestGuess`
395
- # @return [String]
396
- attr_accessor :best_guess
397
-
398
- # The content type of the file derived by looking at specific bytes (i.e. "magic
399
- # bytes") of the actual file.
400
- # Corresponds to the JSON property `fromBytes`
401
- # @return [String]
402
- attr_accessor :from_bytes
403
-
404
- # The content type of the file derived from the file extension of the original
405
- # file name used by the client.
406
- # Corresponds to the JSON property `fromFileName`
407
- # @return [String]
408
- attr_accessor :from_file_name
409
-
410
- # The content type of the file as specified in the request headers, multipart
411
- # headers, or RUPIO start request.
412
- # Corresponds to the JSON property `fromHeader`
413
- # @return [String]
414
- attr_accessor :from_header
415
-
416
- # The content type of the file derived from the file extension of the URL path.
417
- # The URL path is assumed to represent a file name (which is typically only true
418
- # for agents that are providing a REST API).
419
- # Corresponds to the JSON property `fromUrlPath`
420
- # @return [String]
421
- attr_accessor :from_url_path
422
-
423
- def initialize(**args)
424
- update!(**args)
425
- end
426
-
427
- # Update properties of this object
428
- def update!(**args)
429
- @best_guess = args[:best_guess] if args.key?(:best_guess)
430
- @from_bytes = args[:from_bytes] if args.key?(:from_bytes)
431
- @from_file_name = args[:from_file_name] if args.key?(:from_file_name)
432
- @from_header = args[:from_header] if args.key?(:from_header)
433
- @from_url_path = args[:from_url_path] if args.key?(:from_url_path)
434
- end
435
- end
436
-
437
- # Backend response for a Diff get checksums response. For details on the Scotty
438
- # Diff protocol, visit http://go/scotty-diff-protocol.
439
- class GdataDiffChecksumsResponse
440
- include Google::Apis::Core::Hashable
441
-
442
- # A sequence of media data references representing composite data. Introduced to
443
- # support Bigstore composite objects. For details, visit http://go/bigstore-
444
- # composites.
445
- # Corresponds to the JSON property `checksumsLocation`
446
- # @return [Google::Apis::DiscoveryengineV1alpha::GdataCompositeMedia]
447
- attr_accessor :checksums_location
448
-
449
- # The chunk size of checksums. Must be a multiple of 256KB.
450
- # Corresponds to the JSON property `chunkSizeBytes`
451
- # @return [Fixnum]
452
- attr_accessor :chunk_size_bytes
453
-
454
- # A sequence of media data references representing composite data. Introduced to
455
- # support Bigstore composite objects. For details, visit http://go/bigstore-
456
- # composites.
457
- # Corresponds to the JSON property `objectLocation`
458
- # @return [Google::Apis::DiscoveryengineV1alpha::GdataCompositeMedia]
459
- attr_accessor :object_location
460
-
461
- # The total size of the server object.
462
- # Corresponds to the JSON property `objectSizeBytes`
463
- # @return [Fixnum]
464
- attr_accessor :object_size_bytes
465
-
466
- # The object version of the object the checksums are being returned for.
467
- # Corresponds to the JSON property `objectVersion`
468
- # @return [String]
469
- attr_accessor :object_version
470
-
471
- def initialize(**args)
472
- update!(**args)
473
- end
474
-
475
- # Update properties of this object
476
- def update!(**args)
477
- @checksums_location = args[:checksums_location] if args.key?(:checksums_location)
478
- @chunk_size_bytes = args[:chunk_size_bytes] if args.key?(:chunk_size_bytes)
479
- @object_location = args[:object_location] if args.key?(:object_location)
480
- @object_size_bytes = args[:object_size_bytes] if args.key?(:object_size_bytes)
481
- @object_version = args[:object_version] if args.key?(:object_version)
482
- end
483
- end
484
-
485
- # Backend response for a Diff download response. For details on the Scotty Diff
486
- # protocol, visit http://go/scotty-diff-protocol.
487
- class GdataDiffDownloadResponse
488
- include Google::Apis::Core::Hashable
489
-
490
- # A sequence of media data references representing composite data. Introduced to
491
- # support Bigstore composite objects. For details, visit http://go/bigstore-
492
- # composites.
493
- # Corresponds to the JSON property `objectLocation`
494
- # @return [Google::Apis::DiscoveryengineV1alpha::GdataCompositeMedia]
495
- attr_accessor :object_location
496
-
497
- def initialize(**args)
498
- update!(**args)
499
- end
500
-
501
- # Update properties of this object
502
- def update!(**args)
503
- @object_location = args[:object_location] if args.key?(:object_location)
504
- end
505
- end
506
-
507
- # A Diff upload request. For details on the Scotty Diff protocol, visit http://
508
- # go/scotty-diff-protocol.
509
- class GdataDiffUploadRequest
510
- include Google::Apis::Core::Hashable
511
-
512
- # A sequence of media data references representing composite data. Introduced to
513
- # support Bigstore composite objects. For details, visit http://go/bigstore-
514
- # composites.
515
- # Corresponds to the JSON property `checksumsInfo`
516
- # @return [Google::Apis::DiscoveryengineV1alpha::GdataCompositeMedia]
517
- attr_accessor :checksums_info
518
-
519
- # A sequence of media data references representing composite data. Introduced to
520
- # support Bigstore composite objects. For details, visit http://go/bigstore-
521
- # composites.
522
- # Corresponds to the JSON property `objectInfo`
523
- # @return [Google::Apis::DiscoveryengineV1alpha::GdataCompositeMedia]
524
- attr_accessor :object_info
525
-
526
- # The object version of the object that is the base version the incoming diff
527
- # script will be applied to. This field will always be filled in.
528
- # Corresponds to the JSON property `objectVersion`
529
- # @return [String]
530
- attr_accessor :object_version
531
-
532
- def initialize(**args)
533
- update!(**args)
534
- end
535
-
536
- # Update properties of this object
537
- def update!(**args)
538
- @checksums_info = args[:checksums_info] if args.key?(:checksums_info)
539
- @object_info = args[:object_info] if args.key?(:object_info)
540
- @object_version = args[:object_version] if args.key?(:object_version)
541
- end
542
- end
543
-
544
- # Backend response for a Diff upload request. For details on the Scotty Diff
545
- # protocol, visit http://go/scotty-diff-protocol.
546
- class GdataDiffUploadResponse
547
- include Google::Apis::Core::Hashable
548
-
549
- # The object version of the object at the server. Must be included in the end
550
- # notification response. The version in the end notification response must
551
- # correspond to the new version of the object that is now stored at the server,
552
- # after the upload.
553
- # Corresponds to the JSON property `objectVersion`
554
- # @return [String]
555
- attr_accessor :object_version
556
-
557
- # A sequence of media data references representing composite data. Introduced to
558
- # support Bigstore composite objects. For details, visit http://go/bigstore-
559
- # composites.
560
- # Corresponds to the JSON property `originalObject`
561
- # @return [Google::Apis::DiscoveryengineV1alpha::GdataCompositeMedia]
562
- attr_accessor :original_object
563
-
564
- def initialize(**args)
565
- update!(**args)
566
- end
567
-
568
- # Update properties of this object
569
- def update!(**args)
570
- @object_version = args[:object_version] if args.key?(:object_version)
571
- @original_object = args[:original_object] if args.key?(:original_object)
572
- end
573
- end
574
-
575
- # Backend response for a Diff get version response. For details on the Scotty
576
- # Diff protocol, visit http://go/scotty-diff-protocol.
577
- class GdataDiffVersionResponse
578
- include Google::Apis::Core::Hashable
579
-
580
- # The total size of the server object.
581
- # Corresponds to the JSON property `objectSizeBytes`
582
- # @return [Fixnum]
583
- attr_accessor :object_size_bytes
584
-
585
- # The version of the object stored at the server.
586
- # Corresponds to the JSON property `objectVersion`
587
- # @return [String]
588
- attr_accessor :object_version
589
-
590
- def initialize(**args)
591
- update!(**args)
592
- end
593
-
594
- # Update properties of this object
595
- def update!(**args)
596
- @object_size_bytes = args[:object_size_bytes] if args.key?(:object_size_bytes)
597
- @object_version = args[:object_version] if args.key?(:object_version)
598
- end
599
- end
600
-
601
- # Parameters specific to media downloads.
602
- class GdataDownloadParameters
603
- include Google::Apis::Core::Hashable
604
-
605
- # A boolean to be returned in the response to Scotty. Allows/disallows gzip
606
- # encoding of the payload content when the server thinks it's advantageous (
607
- # hence, does not guarantee compression) which allows Scotty to GZip the
608
- # response to the client.
609
- # Corresponds to the JSON property `allowGzipCompression`
610
- # @return [Boolean]
611
- attr_accessor :allow_gzip_compression
612
- alias_method :allow_gzip_compression?, :allow_gzip_compression
613
-
614
- # Determining whether or not Apiary should skip the inclusion of any Content-
615
- # Range header on its response to Scotty.
616
- # Corresponds to the JSON property `ignoreRange`
617
- # @return [Boolean]
618
- attr_accessor :ignore_range
619
- alias_method :ignore_range?, :ignore_range
620
-
621
- def initialize(**args)
622
- update!(**args)
623
- end
624
-
625
- # Update properties of this object
626
- def update!(**args)
627
- @allow_gzip_compression = args[:allow_gzip_compression] if args.key?(:allow_gzip_compression)
628
- @ignore_range = args[:ignore_range] if args.key?(:ignore_range)
629
- end
630
- end
631
-
632
- # A reference to data stored on the filesystem, on GFS or in blobstore.
633
- class GdataMedia
634
- include Google::Apis::Core::Hashable
635
-
636
- # Deprecated, use one of explicit hash type fields instead. Algorithm used for
637
- # calculating the hash. As of 2011/01/21, "MD5" is the only possible value for
638
- # this field. New values may be added at any time.
639
- # Corresponds to the JSON property `algorithm`
640
- # @return [String]
641
- attr_accessor :algorithm
642
-
643
- # Use object_id instead.
644
- # Corresponds to the JSON property `bigstoreObjectRef`
645
- # NOTE: Values are automatically base64 encoded/decoded in the client library.
646
- # @return [String]
647
- attr_accessor :bigstore_object_ref
648
-
649
- # Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be
650
- # the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating
651
- # v1, use blobstore2_info instead. For now, any v2 blob will also be represented
652
- # in this field as v1 BlobRef.
653
- # Corresponds to the JSON property `blobRef`
654
- # NOTE: Values are automatically base64 encoded/decoded in the client library.
655
- # @return [String]
656
- attr_accessor :blob_ref
657
-
658
- # Information to read/write to blobstore2.
659
- # Corresponds to the JSON property `blobstore2Info`
660
- # @return [Google::Apis::DiscoveryengineV1alpha::GdataBlobstore2Info]
661
- attr_accessor :blobstore2_info
662
-
663
- # A composite media composed of one or more media objects, set if reference_type
664
- # is COMPOSITE_MEDIA. The media length field must be set to the sum of the
665
- # lengths of all composite media objects. Note: All composite media must have
666
- # length specified.
667
- # Corresponds to the JSON property `compositeMedia`
668
- # @return [Array<Google::Apis::DiscoveryengineV1alpha::GdataCompositeMedia>]
669
- attr_accessor :composite_media
670
-
671
- # MIME type of the data
672
- # Corresponds to the JSON property `contentType`
673
- # @return [String]
674
- attr_accessor :content_type
675
-
676
- # Detailed Content-Type information from Scotty. The Content-Type of the media
677
- # will typically be filled in by the header or Scotty's best_guess, but this
678
- # extended information provides the backend with more information so that it can
679
- # make a better decision if needed. This is only used on media upload requests
680
- # from Scotty.
681
- # Corresponds to the JSON property `contentTypeInfo`
682
- # @return [Google::Apis::DiscoveryengineV1alpha::GdataContentTypeInfo]
683
- attr_accessor :content_type_info
684
-
685
- # A binary data reference for a media download. Serves as a technology-agnostic
686
- # binary reference in some Google infrastructure. This value is a serialized
687
- # storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get
688
- # around the fact that the cosmo proto (as well as others it includes) doesn't
689
- # support JavaScript. This prevents us from including the actual type of this
690
- # field.
691
- # Corresponds to the JSON property `cosmoBinaryReference`
692
- # NOTE: Values are automatically base64 encoded/decoded in the client library.
693
- # @return [String]
694
- attr_accessor :cosmo_binary_reference
695
-
696
- # For Scotty Uploads: Scotty-provided hashes for uploads For Scotty Downloads: (
697
- # WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.) A Hash provided
698
- # by the agent to be used to verify the data being downloaded. Currently only
699
- # supported for inline payloads. Further, only crc32c_hash is currently
700
- # supported.
701
- # Corresponds to the JSON property `crc32cHash`
702
- # @return [Fixnum]
703
- attr_accessor :crc32c_hash
704
-
705
- # Backend response for a Diff get checksums response. For details on the Scotty
706
- # Diff protocol, visit http://go/scotty-diff-protocol.
707
- # Corresponds to the JSON property `diffChecksumsResponse`
708
- # @return [Google::Apis::DiscoveryengineV1alpha::GdataDiffChecksumsResponse]
709
- attr_accessor :diff_checksums_response
710
-
711
- # Backend response for a Diff download response. For details on the Scotty Diff
712
- # protocol, visit http://go/scotty-diff-protocol.
713
- # Corresponds to the JSON property `diffDownloadResponse`
714
- # @return [Google::Apis::DiscoveryengineV1alpha::GdataDiffDownloadResponse]
715
- attr_accessor :diff_download_response
716
-
717
- # A Diff upload request. For details on the Scotty Diff protocol, visit http://
718
- # go/scotty-diff-protocol.
719
- # Corresponds to the JSON property `diffUploadRequest`
720
- # @return [Google::Apis::DiscoveryengineV1alpha::GdataDiffUploadRequest]
721
- attr_accessor :diff_upload_request
722
-
723
- # Backend response for a Diff upload request. For details on the Scotty Diff
724
- # protocol, visit http://go/scotty-diff-protocol.
725
- # Corresponds to the JSON property `diffUploadResponse`
726
- # @return [Google::Apis::DiscoveryengineV1alpha::GdataDiffUploadResponse]
727
- attr_accessor :diff_upload_response
728
-
729
- # Backend response for a Diff get version response. For details on the Scotty
730
- # Diff protocol, visit http://go/scotty-diff-protocol.
731
- # Corresponds to the JSON property `diffVersionResponse`
732
- # @return [Google::Apis::DiscoveryengineV1alpha::GdataDiffVersionResponse]
733
- attr_accessor :diff_version_response
734
-
735
- # Parameters specific to media downloads.
736
- # Corresponds to the JSON property `downloadParameters`
737
- # @return [Google::Apis::DiscoveryengineV1alpha::GdataDownloadParameters]
738
- attr_accessor :download_parameters
739
-
740
- # Original file name
741
- # Corresponds to the JSON property `filename`
742
- # @return [String]
743
- attr_accessor :filename
744
-
745
- # Deprecated, use one of explicit hash type fields instead. These two hash
746
- # related fields will only be populated on Scotty based media uploads and will
747
- # contain the content of the hash group in the NotificationRequest: http://cs/#
748
- # google3/blobstore2/api/scotty/service/proto/upload_listener.proto&q=class:Hash
749
- # Hex encoded hash value of the uploaded media.
750
- # Corresponds to the JSON property `hash`
751
- # @return [String]
752
- attr_accessor :hash_prop
753
-
754
- # For Scotty uploads only. If a user sends a hash code and the backend has
755
- # requested that Scotty verify the upload against the client hash, Scotty will
756
- # perform the check on behalf of the backend and will reject it if the hashes
757
- # don't match. This is set to true if Scotty performed this verification.
758
- # Corresponds to the JSON property `hashVerified`
759
- # @return [Boolean]
760
- attr_accessor :hash_verified
761
- alias_method :hash_verified?, :hash_verified
762
-
763
- # Media data, set if reference_type is INLINE
764
- # Corresponds to the JSON property `inline`
765
- # NOTE: Values are automatically base64 encoded/decoded in the client library.
766
- # @return [String]
767
- attr_accessor :inline
768
-
769
- # |is_potential_retry| is set false only when Scotty is certain that it has not
770
- # sent the request before. When a client resumes an upload, this field must be
771
- # set true in agent calls, because Scotty cannot be certain that it has never
772
- # sent the request before due to potential failure in the session state
773
- # persistence.
774
- # Corresponds to the JSON property `isPotentialRetry`
775
- # @return [Boolean]
776
- attr_accessor :is_potential_retry
777
- alias_method :is_potential_retry?, :is_potential_retry
778
-
779
- # Size of the data, in bytes
780
- # Corresponds to the JSON property `length`
781
- # @return [Fixnum]
782
- attr_accessor :length
783
-
784
- # Scotty-provided MD5 hash for an upload.
785
- # Corresponds to the JSON property `md5Hash`
786
- # NOTE: Values are automatically base64 encoded/decoded in the client library.
787
- # @return [String]
788
- attr_accessor :md5_hash
789
-
790
- # Media id to forward to the operation GetMedia. Can be set if reference_type is
791
- # GET_MEDIA.
792
- # Corresponds to the JSON property `mediaId`
793
- # NOTE: Values are automatically base64 encoded/decoded in the client library.
794
- # @return [String]
795
- attr_accessor :media_id
796
-
797
- # This is a copy of the tech.blob.ObjectId proto, which could not be used
798
- # directly here due to transitive closure issues with JavaScript support; see
799
- # http://b/8801763.
800
- # Corresponds to the JSON property `objectId`
801
- # @return [Google::Apis::DiscoveryengineV1alpha::GdataObjectId]
802
- attr_accessor :object_id_prop
803
-
804
- # Path to the data, set if reference_type is PATH
805
- # Corresponds to the JSON property `path`
806
- # @return [String]
807
- attr_accessor :path
808
-
809
- # Describes what the field reference contains.
810
- # Corresponds to the JSON property `referenceType`
811
- # @return [String]
812
- attr_accessor :reference_type
813
-
814
- # Scotty-provided SHA1 hash for an upload.
815
- # Corresponds to the JSON property `sha1Hash`
816
- # NOTE: Values are automatically base64 encoded/decoded in the client library.
817
- # @return [String]
818
- attr_accessor :sha1_hash
819
-
820
- # Scotty-provided SHA256 hash for an upload.
821
- # Corresponds to the JSON property `sha256Hash`
822
- # NOTE: Values are automatically base64 encoded/decoded in the client library.
823
- # @return [String]
824
- attr_accessor :sha256_hash
825
-
826
- # Time at which the media data was last updated, in milliseconds since UNIX
827
- # epoch
828
- # Corresponds to the JSON property `timestamp`
829
- # @return [Fixnum]
830
- attr_accessor :timestamp
831
-
832
- # A unique fingerprint/version id for the media data
833
- # Corresponds to the JSON property `token`
834
- # @return [String]
835
- attr_accessor :token
836
-
837
- def initialize(**args)
838
- update!(**args)
839
- end
840
-
841
- # Update properties of this object
842
- def update!(**args)
843
- @algorithm = args[:algorithm] if args.key?(:algorithm)
844
- @bigstore_object_ref = args[:bigstore_object_ref] if args.key?(:bigstore_object_ref)
845
- @blob_ref = args[:blob_ref] if args.key?(:blob_ref)
846
- @blobstore2_info = args[:blobstore2_info] if args.key?(:blobstore2_info)
847
- @composite_media = args[:composite_media] if args.key?(:composite_media)
848
- @content_type = args[:content_type] if args.key?(:content_type)
849
- @content_type_info = args[:content_type_info] if args.key?(:content_type_info)
850
- @cosmo_binary_reference = args[:cosmo_binary_reference] if args.key?(:cosmo_binary_reference)
851
- @crc32c_hash = args[:crc32c_hash] if args.key?(:crc32c_hash)
852
- @diff_checksums_response = args[:diff_checksums_response] if args.key?(:diff_checksums_response)
853
- @diff_download_response = args[:diff_download_response] if args.key?(:diff_download_response)
854
- @diff_upload_request = args[:diff_upload_request] if args.key?(:diff_upload_request)
855
- @diff_upload_response = args[:diff_upload_response] if args.key?(:diff_upload_response)
856
- @diff_version_response = args[:diff_version_response] if args.key?(:diff_version_response)
857
- @download_parameters = args[:download_parameters] if args.key?(:download_parameters)
858
- @filename = args[:filename] if args.key?(:filename)
859
- @hash_prop = args[:hash_prop] if args.key?(:hash_prop)
860
- @hash_verified = args[:hash_verified] if args.key?(:hash_verified)
861
- @inline = args[:inline] if args.key?(:inline)
862
- @is_potential_retry = args[:is_potential_retry] if args.key?(:is_potential_retry)
863
- @length = args[:length] if args.key?(:length)
864
- @md5_hash = args[:md5_hash] if args.key?(:md5_hash)
865
- @media_id = args[:media_id] if args.key?(:media_id)
866
- @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop)
867
- @path = args[:path] if args.key?(:path)
868
- @reference_type = args[:reference_type] if args.key?(:reference_type)
869
- @sha1_hash = args[:sha1_hash] if args.key?(:sha1_hash)
870
- @sha256_hash = args[:sha256_hash] if args.key?(:sha256_hash)
871
- @timestamp = args[:timestamp] if args.key?(:timestamp)
872
- @token = args[:token] if args.key?(:token)
873
- end
874
- end
875
-
876
- # This is a copy of the tech.blob.ObjectId proto, which could not be used
877
- # directly here due to transitive closure issues with JavaScript support; see
878
- # http://b/8801763.
879
- class GdataObjectId
880
- include Google::Apis::Core::Hashable
881
-
882
- # The name of the bucket to which this object belongs.
883
- # Corresponds to the JSON property `bucketName`
884
- # @return [String]
885
- attr_accessor :bucket_name
886
-
887
- # Generation of the object. Generations are monotonically increasing across
888
- # writes, allowing them to be be compared to determine which generation is newer.
889
- # If this is omitted in a request, then you are requesting the live object. See
890
- # http://go/bigstore-versions
891
- # Corresponds to the JSON property `generation`
892
- # @return [Fixnum]
893
- attr_accessor :generation
894
-
895
- # The name of the object.
896
- # Corresponds to the JSON property `objectName`
897
- # @return [String]
898
- attr_accessor :object_name
899
-
900
- def initialize(**args)
901
- update!(**args)
902
- end
903
-
904
- # Update properties of this object
905
- def update!(**args)
906
- @bucket_name = args[:bucket_name] if args.key?(:bucket_name)
907
- @generation = args[:generation] if args.key?(:generation)
908
- @object_name = args[:object_name] if args.key?(:object_name)
909
- end
910
- end
911
-
912
25
  # `Distribution` contains summary statistics for a population of values. It
913
26
  # optionally contains a histogram representing the distribution of those values
914
27
  # across a set of buckets. The summary statistics are the count, mean, sum of
@@ -1890,6 +1003,18 @@ module Google
1890
1003
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1AssistantCustomerPolicy]
1891
1004
  attr_accessor :customer_policy
1892
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
+
1893
1018
  # Optional. Note: not implemented yet. Use enabled_actions instead. The enabled
1894
1019
  # tools on this assistant. The keys are connector name, for example "projects/`
1895
1020
  # projectId`/locations/`locationId`/collections/`collectionId`/dataconnector The
@@ -1927,6 +1052,8 @@ module Google
1927
1052
  # Update properties of this object
1928
1053
  def update!(**args)
1929
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)
1930
1057
  @enabled_tools = args[:enabled_tools] if args.key?(:enabled_tools)
1931
1058
  @generation_config = args[:generation_config] if args.key?(:generation_config)
1932
1059
  @name = args[:name] if args.key?(:name)
@@ -2037,6 +1164,11 @@ module Google
2037
1164
  class GoogleCloudDiscoveryengineV1AssistantGenerationConfig
2038
1165
  include Google::Apis::Core::Hashable
2039
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
+
2040
1172
  # The default language to use for the generation of the assistant response. Use
2041
1173
  # an ISO 639-1 language code such as `en`. If not specified, the language will
2042
1174
  # be automatically detected.
@@ -2044,6 +1176,11 @@ module Google
2044
1176
  # @return [String]
2045
1177
  attr_accessor :default_language
2046
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
+
2047
1184
  # System instruction, also known as the prompt preamble for LLM calls.
2048
1185
  # Corresponds to the JSON property `systemInstruction`
2049
1186
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1AssistantGenerationConfigSystemInstruction]
@@ -2055,7 +1192,9 @@ module Google
2055
1192
 
2056
1193
  # Update properties of this object
2057
1194
  def update!(**args)
1195
+ @allowed_model_ids = args[:allowed_model_ids] if args.key?(:allowed_model_ids)
2058
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)
2059
1198
  @system_instruction = args[:system_instruction] if args.key?(:system_instruction)
2060
1199
  end
2061
1200
  end
@@ -4707,6 +3846,14 @@ module Google
4707
3846
  class GoogleCloudDiscoveryengineV1EngineSearchEngineConfig
4708
3847
  include Google::Apis::Core::Hashable
4709
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
+
4710
3857
  # The add-on that this search engine enables.
4711
3858
  # Corresponds to the JSON property `searchAddOns`
4712
3859
  # @return [Array<String>]
@@ -4725,6 +3872,7 @@ module Google
4725
3872
 
4726
3873
  # Update properties of this object
4727
3874
  def update!(**args)
3875
+ @required_subscription_tier = args[:required_subscription_tier] if args.key?(:required_subscription_tier)
4728
3876
  @search_add_ons = args[:search_add_ons] if args.key?(:search_add_ons)
4729
3877
  @search_tier = args[:search_tier] if args.key?(:search_tier)
4730
3878
  end
@@ -10178,6 +9326,25 @@ module Google
10178
9326
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAssistantCustomerPolicy]
10179
9327
  attr_accessor :customer_policy
10180
9328
 
9329
+ # Optional. Description for additional information. Expected to be shown on the
9330
+ # configuration UI, not to the users of the assistant.
9331
+ # Corresponds to the JSON property `description`
9332
+ # @return [String]
9333
+ attr_accessor :description
9334
+
9335
+ # Optional. Indicates whether to disable user location context. By default, user
9336
+ # location context is enabled.
9337
+ # Corresponds to the JSON property `disableLocationContext`
9338
+ # @return [Boolean]
9339
+ attr_accessor :disable_location_context
9340
+ alias_method :disable_location_context?, :disable_location_context
9341
+
9342
+ # Required. The assistant display name. It must be a UTF-8 encoded string with a
9343
+ # length limit of 128 characters.
9344
+ # Corresponds to the JSON property `displayName`
9345
+ # @return [String]
9346
+ attr_accessor :display_name
9347
+
10181
9348
  # Optional. Note: not implemented yet. Use enabled_actions instead. The enabled
10182
9349
  # tools on this assistant. The keys are connector name, for example "projects/`
10183
9350
  # projectId`/locations/`locationId`/collections/`collectionId`/dataconnector The
@@ -10215,6 +9382,9 @@ module Google
10215
9382
  # Update properties of this object
10216
9383
  def update!(**args)
10217
9384
  @customer_policy = args[:customer_policy] if args.key?(:customer_policy)
9385
+ @description = args[:description] if args.key?(:description)
9386
+ @disable_location_context = args[:disable_location_context] if args.key?(:disable_location_context)
9387
+ @display_name = args[:display_name] if args.key?(:display_name)
10218
9388
  @enabled_tools = args[:enabled_tools] if args.key?(:enabled_tools)
10219
9389
  @generation_config = args[:generation_config] if args.key?(:generation_config)
10220
9390
  @name = args[:name] if args.key?(:name)
@@ -10477,6 +9647,11 @@ module Google
10477
9647
  class GoogleCloudDiscoveryengineV1alphaAssistantGenerationConfig
10478
9648
  include Google::Apis::Core::Hashable
10479
9649
 
9650
+ # Optional. The list of models that are allowed to be used for assistant.
9651
+ # Corresponds to the JSON property `allowedModelIds`
9652
+ # @return [Array<String>]
9653
+ attr_accessor :allowed_model_ids
9654
+
10480
9655
  # The default language to use for the generation of the assistant response. Use
10481
9656
  # an ISO 639-1 language code such as `en`. If not specified, the language will
10482
9657
  # be automatically detected.
@@ -10484,6 +9659,11 @@ module Google
10484
9659
  # @return [String]
10485
9660
  attr_accessor :default_language
10486
9661
 
9662
+ # Optional. The default model to use for assistant.
9663
+ # Corresponds to the JSON property `defaultModelId`
9664
+ # @return [String]
9665
+ attr_accessor :default_model_id
9666
+
10487
9667
  # System instruction, also known as the prompt preamble for LLM calls.
10488
9668
  # Corresponds to the JSON property `systemInstruction`
10489
9669
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAssistantGenerationConfigSystemInstruction]
@@ -10495,7 +9675,9 @@ module Google
10495
9675
 
10496
9676
  # Update properties of this object
10497
9677
  def update!(**args)
9678
+ @allowed_model_ids = args[:allowed_model_ids] if args.key?(:allowed_model_ids)
10498
9679
  @default_language = args[:default_language] if args.key?(:default_language)
9680
+ @default_model_id = args[:default_model_id] if args.key?(:default_model_id)
10499
9681
  @system_instruction = args[:system_instruction] if args.key?(:system_instruction)
10500
9682
  end
10501
9683
  end
@@ -12817,97 +11999,6 @@ module Google
12817
11999
  end
12818
12000
  end
12819
12001
 
12820
- # Response for [EstimateBillingService.GetConfigurablePricingUsageStats] method.
12821
- class GoogleCloudDiscoveryengineV1alphaConfigurablePricingUsageStats
12822
- include Google::Apis::Core::Hashable
12823
-
12824
- # A list of metric usages, one for each requested resource type that has data in
12825
- # the requested time range.
12826
- # Corresponds to the JSON property `metricUsages`
12827
- # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConfigurablePricingUsageStatsMetricUsage>]
12828
- attr_accessor :metric_usages
12829
-
12830
- # Identifier. The name of the ConfigurablePricingUsageStats. Format: projects/`
12831
- # project`/locations/`location`/configurablePricingUsageStats
12832
- # Corresponds to the JSON property `name`
12833
- # @return [String]
12834
- attr_accessor :name
12835
-
12836
- def initialize(**args)
12837
- update!(**args)
12838
- end
12839
-
12840
- # Update properties of this object
12841
- def update!(**args)
12842
- @metric_usages = args[:metric_usages] if args.key?(:metric_usages)
12843
- @name = args[:name] if args.key?(:name)
12844
- end
12845
- end
12846
-
12847
- # A list of usages for a specific day.
12848
- class GoogleCloudDiscoveryengineV1alphaConfigurablePricingUsageStatsDatedUsage
12849
- include Google::Apis::Core::Hashable
12850
-
12851
- # Represents a whole or partial calendar date, such as a birthday. The time of
12852
- # day and time zone are either specified elsewhere or are insignificant. The
12853
- # date is relative to the Gregorian Calendar. This can represent one of the
12854
- # following: * A full date, with non-zero year, month, and day values. * A month
12855
- # and day, with a zero year (for example, an anniversary). * A year on its own,
12856
- # with a zero month and a zero day. * A year and month, with a zero day (for
12857
- # example, a credit card expiration date). Related types: * google.type.
12858
- # TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
12859
- # Corresponds to the JSON property `date`
12860
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleTypeDate]
12861
- attr_accessor :date
12862
-
12863
- # The usage value on the date.
12864
- # Corresponds to the JSON property `usage`
12865
- # @return [Float]
12866
- attr_accessor :usage
12867
-
12868
- def initialize(**args)
12869
- update!(**args)
12870
- end
12871
-
12872
- # Update properties of this object
12873
- def update!(**args)
12874
- @date = args[:date] if args.key?(:date)
12875
- @usage = args[:usage] if args.key?(:usage)
12876
- end
12877
- end
12878
-
12879
- # The usage of a metric over a list of days.
12880
- class GoogleCloudDiscoveryengineV1alphaConfigurablePricingUsageStatsMetricUsage
12881
- include Google::Apis::Core::Hashable
12882
-
12883
- # The list of usages for this resource type, chronologically sorted by date.
12884
- # This is populated for metrics with daily aggregation like DAILY_MDN_QPM.
12885
- # Corresponds to the JSON property `datedUsages`
12886
- # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConfigurablePricingUsageStatsDatedUsage>]
12887
- attr_accessor :dated_usages
12888
-
12889
- # The metric type.
12890
- # Corresponds to the JSON property `metricType`
12891
- # @return [String]
12892
- attr_accessor :metric_type
12893
-
12894
- # The list of total usages for this resource type
12895
- # Corresponds to the JSON property `totalUsages`
12896
- # @return [Array<Float>]
12897
- attr_accessor :total_usages
12898
-
12899
- def initialize(**args)
12900
- update!(**args)
12901
- end
12902
-
12903
- # Update properties of this object
12904
- def update!(**args)
12905
- @dated_usages = args[:dated_usages] if args.key?(:dated_usages)
12906
- @metric_type = args[:metric_type] if args.key?(:metric_type)
12907
- @total_usages = args[:total_usages] if args.key?(:total_usages)
12908
- end
12909
- end
12910
-
12911
12002
  # A data sync run of DataConnector. After DataConnector is successfully
12912
12003
  # initialized, data syncs are scheduled at DataConnector.refresh_interval. A
12913
12004
  # ConnectorRun represents a data sync either in the past or onging that the
@@ -16432,6 +15523,14 @@ module Google
16432
15523
  class GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig
16433
15524
  include Google::Apis::Core::Hashable
16434
15525
 
15526
+ # Optional. The required subscription tier of this engine. They cannot be
15527
+ # modified after engine creation. If the required subscription tier is search,
15528
+ # user with higher license tier like assist can still access the standalone app
15529
+ # associated with this engine.
15530
+ # Corresponds to the JSON property `requiredSubscriptionTier`
15531
+ # @return [String]
15532
+ attr_accessor :required_subscription_tier
15533
+
16435
15534
  # The add-on that this search engine enables.
16436
15535
  # Corresponds to the JSON property `searchAddOns`
16437
15536
  # @return [Array<String>]
@@ -16450,6 +15549,7 @@ module Google
16450
15549
 
16451
15550
  # Update properties of this object
16452
15551
  def update!(**args)
15552
+ @required_subscription_tier = args[:required_subscription_tier] if args.key?(:required_subscription_tier)
16453
15553
  @search_add_ons = args[:search_add_ons] if args.key?(:search_add_ons)
16454
15554
  @search_tier = args[:search_tier] if args.key?(:search_tier)
16455
15555
  end
@@ -17614,6 +16714,11 @@ module Google
17614
16714
  # @return [String]
17615
16715
  attr_accessor :external_identity
17616
16716
 
16717
+ # Optional. The name of the external identity.
16718
+ # Corresponds to the JSON property `externalIdentityName`
16719
+ # @return [String]
16720
+ attr_accessor :external_identity_name
16721
+
17617
16722
  # Group identifier. For Google Workspace user account, group_id should be the
17618
16723
  # google workspace group email. For non-google identity provider, group_id is
17619
16724
  # the mapped group identifier configured during the workforcepool config.
@@ -17635,6 +16740,7 @@ module Google
17635
16740
  # Update properties of this object
17636
16741
  def update!(**args)
17637
16742
  @external_identity = args[:external_identity] if args.key?(:external_identity)
16743
+ @external_identity_name = args[:external_identity_name] if args.key?(:external_identity_name)
17638
16744
  @group_id = args[:group_id] if args.key?(:group_id)
17639
16745
  @user_id = args[:user_id] if args.key?(:user_id)
17640
16746
  end
@@ -18903,6 +18009,32 @@ module Google
18903
18009
  end
18904
18010
  end
18905
18011
 
18012
+ # Response message for the AssistantService.ListAssistants method.
18013
+ class GoogleCloudDiscoveryengineV1alphaListAssistantsResponse
18014
+ include Google::Apis::Core::Hashable
18015
+
18016
+ # All the customer's Assistants.
18017
+ # Corresponds to the JSON property `assistants`
18018
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAssistant>]
18019
+ attr_accessor :assistants
18020
+
18021
+ # A token that can be sent as ListAssistantsRequest.page_token to retrieve the
18022
+ # next page. If this field is omitted, there are no subsequent pages.
18023
+ # Corresponds to the JSON property `nextPageToken`
18024
+ # @return [String]
18025
+ attr_accessor :next_page_token
18026
+
18027
+ def initialize(**args)
18028
+ update!(**args)
18029
+ end
18030
+
18031
+ # Update properties of this object
18032
+ def update!(**args)
18033
+ @assistants = args[:assistants] if args.key?(:assistants)
18034
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
18035
+ end
18036
+ end
18037
+
18906
18038
  # Response message for the AuthorizationService.ListAuthorizations method.
18907
18039
  class GoogleCloudDiscoveryengineV1alphaListAuthorizationsResponse
18908
18040
  include Google::Apis::Core::Hashable
@@ -20903,6 +20035,91 @@ module Google
20903
20035
  end
20904
20036
  end
20905
20037
 
20038
+ # Response for [ProjectService.QueryConfigurablePricingUsageStats] method.
20039
+ class GoogleCloudDiscoveryengineV1alphaQueryConfigurablePricingUsageStatsResponse
20040
+ include Google::Apis::Core::Hashable
20041
+
20042
+ # A list of metric usages, one for each requested resource type that has data in
20043
+ # the requested time range.
20044
+ # Corresponds to the JSON property `metricUsages`
20045
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaQueryConfigurablePricingUsageStatsResponseMetricUsage>]
20046
+ attr_accessor :metric_usages
20047
+
20048
+ def initialize(**args)
20049
+ update!(**args)
20050
+ end
20051
+
20052
+ # Update properties of this object
20053
+ def update!(**args)
20054
+ @metric_usages = args[:metric_usages] if args.key?(:metric_usages)
20055
+ end
20056
+ end
20057
+
20058
+ # A list of usages for a specific day.
20059
+ class GoogleCloudDiscoveryengineV1alphaQueryConfigurablePricingUsageStatsResponseDatedUsage
20060
+ include Google::Apis::Core::Hashable
20061
+
20062
+ # Represents a whole or partial calendar date, such as a birthday. The time of
20063
+ # day and time zone are either specified elsewhere or are insignificant. The
20064
+ # date is relative to the Gregorian Calendar. This can represent one of the
20065
+ # following: * A full date, with non-zero year, month, and day values. * A month
20066
+ # and day, with a zero year (for example, an anniversary). * A year on its own,
20067
+ # with a zero month and a zero day. * A year and month, with a zero day (for
20068
+ # example, a credit card expiration date). Related types: * google.type.
20069
+ # TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
20070
+ # Corresponds to the JSON property `date`
20071
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleTypeDate]
20072
+ attr_accessor :date
20073
+
20074
+ # The usage value on the date.
20075
+ # Corresponds to the JSON property `usage`
20076
+ # @return [Float]
20077
+ attr_accessor :usage
20078
+
20079
+ def initialize(**args)
20080
+ update!(**args)
20081
+ end
20082
+
20083
+ # Update properties of this object
20084
+ def update!(**args)
20085
+ @date = args[:date] if args.key?(:date)
20086
+ @usage = args[:usage] if args.key?(:usage)
20087
+ end
20088
+ end
20089
+
20090
+ # The usage of a metric over a list of days.
20091
+ class GoogleCloudDiscoveryengineV1alphaQueryConfigurablePricingUsageStatsResponseMetricUsage
20092
+ include Google::Apis::Core::Hashable
20093
+
20094
+ # The list of usages for this resource type, chronologically sorted by date.
20095
+ # This is populated for metrics with daily aggregation like DAILY_MDN_QPM.
20096
+ # Corresponds to the JSON property `datedUsages`
20097
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaQueryConfigurablePricingUsageStatsResponseDatedUsage>]
20098
+ attr_accessor :dated_usages
20099
+
20100
+ # The metric type.
20101
+ # Corresponds to the JSON property `metricType`
20102
+ # @return [String]
20103
+ attr_accessor :metric_type
20104
+
20105
+ # The total usage for this resource type. This is populated for metrics like
20106
+ # TOTAL_STORAGE.
20107
+ # Corresponds to the JSON property `totalUsage`
20108
+ # @return [Float]
20109
+ attr_accessor :total_usage
20110
+
20111
+ def initialize(**args)
20112
+ update!(**args)
20113
+ end
20114
+
20115
+ # Update properties of this object
20116
+ def update!(**args)
20117
+ @dated_usages = args[:dated_usages] if args.key?(:dated_usages)
20118
+ @metric_type = args[:metric_type] if args.key?(:metric_type)
20119
+ @total_usage = args[:total_usage] if args.key?(:total_usage)
20120
+ end
20121
+ end
20122
+
20906
20123
  # Request message for RankService.Rank method.
20907
20124
  class GoogleCloudDiscoveryengineV1alphaRankRequest
20908
20125
  include Google::Apis::Core::Hashable
@@ -22314,6 +21531,18 @@ module Google
22314
21531
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec]
22315
21532
  attr_accessor :content_search_spec
22316
21533
 
21534
+ # Optional. Crowding specifications for improving result diversity. If multiple
21535
+ # CrowdingSpecs are specified, crowding will be evaluated on each unique
21536
+ # combination of the `field` values, and max_count will be the maximum value of `
21537
+ # max_count` across all CrowdingSpecs. For example, if the first CrowdingSpec
21538
+ # has `field` = "color" and `max_count` = 3, and the second CrowdingSpec has `
21539
+ # field` = "size" and `max_count` = 2, then after 3 documents that share the
21540
+ # same color AND size have been returned, subsequent ones should be removed or
21541
+ # demoted.
21542
+ # Corresponds to the JSON property `crowdingSpecs`
21543
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec>]
21544
+ attr_accessor :crowding_specs
21545
+
22317
21546
  # Defines custom fine tuning spec.
22318
21547
  # Corresponds to the JSON property `customFineTuningSpec`
22319
21548
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec]
@@ -22406,6 +21635,20 @@ module Google
22406
21635
  # @return [String]
22407
21636
  attr_accessor :order_by
22408
21637
 
21638
+ # Optional. The categories associated with a category page. Must be set for
21639
+ # category navigation queries to achieve good search quality. The format should
21640
+ # be the same as UserEvent.PageInfo.page_category. This field is the equivalent
21641
+ # of the query for browse (navigation) queries. It's used by the browse model
21642
+ # when the query is empty. If the field is empty, it will not be used by the
21643
+ # browse model. To represent full path of a category, use '>' character to
21644
+ # separate different hierarchies. If '>' is part of the category name, replace
21645
+ # it with other character(s). For example, `Graphics Cards > RTX>4090 > Founders
21646
+ # Edition` where "RTX > 4090" represents one level, can be rewritten as `
21647
+ # Graphics Cards > RTX_4090 > Founders Edition`
21648
+ # Corresponds to the JSON property `pageCategories`
21649
+ # @return [Array<String>]
21650
+ attr_accessor :page_categories
21651
+
22409
21652
  # Maximum number of Documents to return. The maximum allowed value depends on
22410
21653
  # the data type. Values above the maximum value are coerced to the maximum value.
22411
21654
  # * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with
@@ -22638,6 +21881,7 @@ module Google
22638
21881
  @branch = args[:branch] if args.key?(:branch)
22639
21882
  @canonical_filter = args[:canonical_filter] if args.key?(:canonical_filter)
22640
21883
  @content_search_spec = args[:content_search_spec] if args.key?(:content_search_spec)
21884
+ @crowding_specs = args[:crowding_specs] if args.key?(:crowding_specs)
22641
21885
  @custom_fine_tuning_spec = args[:custom_fine_tuning_spec] if args.key?(:custom_fine_tuning_spec)
22642
21886
  @data_store_specs = args[:data_store_specs] if args.key?(:data_store_specs)
22643
21887
  @display_spec = args[:display_spec] if args.key?(:display_spec)
@@ -22650,6 +21894,7 @@ module Google
22650
21894
  @offset = args[:offset] if args.key?(:offset)
22651
21895
  @one_box_page_size = args[:one_box_page_size] if args.key?(:one_box_page_size)
22652
21896
  @order_by = args[:order_by] if args.key?(:order_by)
21897
+ @page_categories = args[:page_categories] if args.key?(:page_categories)
22653
21898
  @page_size = args[:page_size] if args.key?(:page_size)
22654
21899
  @page_token = args[:page_token] if args.key?(:page_token)
22655
21900
  @params = args[:params] if args.key?(:params)
@@ -23190,6 +22435,45 @@ module Google
23190
22435
  end
23191
22436
  end
23192
22437
 
22438
+ # Specification for crowding. Crowding improves the diversity of search results
22439
+ # by limiting the number of results that share the same field value. For example,
22440
+ # crowding on the color field with a max_count of 3 and mode
22441
+ # DROP_CROWDED_RESULTS will return at most 3 results with the same color across
22442
+ # all pages.
22443
+ class GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec
22444
+ include Google::Apis::Core::Hashable
22445
+
22446
+ # The field to use for crowding. Documents can be crowded by a field in the
22447
+ # Document object. Crowding field is case sensitive.
22448
+ # Corresponds to the JSON property `field`
22449
+ # @return [String]
22450
+ attr_accessor :field
22451
+
22452
+ # The maximum number of documents to keep per value of the field. Once there are
22453
+ # at least max_count previous results which contain the same value for the given
22454
+ # field (according to the order specified in `order_by`), later results with the
22455
+ # same value are "crowded away". If not specified, the default value is 1.
22456
+ # Corresponds to the JSON property `maxCount`
22457
+ # @return [Fixnum]
22458
+ attr_accessor :max_count
22459
+
22460
+ # Mode to use for documents that are crowded away.
22461
+ # Corresponds to the JSON property `mode`
22462
+ # @return [String]
22463
+ attr_accessor :mode
22464
+
22465
+ def initialize(**args)
22466
+ update!(**args)
22467
+ end
22468
+
22469
+ # Update properties of this object
22470
+ def update!(**args)
22471
+ @field = args[:field] if args.key?(:field)
22472
+ @max_count = args[:max_count] if args.key?(:max_count)
22473
+ @mode = args[:mode] if args.key?(:mode)
22474
+ end
22475
+ end
22476
+
23193
22477
  # A struct to define data stores to filter on in a search call and
23194
22478
  # configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error
23195
22479
  # is returned.
@@ -23794,6 +23078,11 @@ module Google
23794
23078
  # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion>]
23795
23079
  attr_accessor :search_link_promotions
23796
23080
 
23081
+ # Output only. Indicates the semantic state of the search response.
23082
+ # Corresponds to the JSON property `semanticState`
23083
+ # @return [String]
23084
+ attr_accessor :semantic_state
23085
+
23797
23086
  # Information about the session.
23798
23087
  # Corresponds to the JSON property `sessionInfo`
23799
23088
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseSessionInfo]
@@ -23839,6 +23128,7 @@ module Google
23839
23128
  @redirect_uri = args[:redirect_uri] if args.key?(:redirect_uri)
23840
23129
  @results = args[:results] if args.key?(:results)
23841
23130
  @search_link_promotions = args[:search_link_promotions] if args.key?(:search_link_promotions)
23131
+ @semantic_state = args[:semantic_state] if args.key?(:semantic_state)
23842
23132
  @session_info = args[:session_info] if args.key?(:session_info)
23843
23133
  @suggested_query = args[:suggested_query] if args.key?(:suggested_query)
23844
23134
  @summary = args[:summary] if args.key?(:summary)
@@ -25810,6 +25100,11 @@ module Google
25810
25100
  # @return [String]
25811
25101
  attr_accessor :assist_token
25812
25102
 
25103
+ # The tool names of the tools that were invoked.
25104
+ # Corresponds to the JSON property `invocationTools`
25105
+ # @return [Array<String>]
25106
+ attr_accessor :invocation_tools
25107
+
25813
25108
  # Information about the session.
25814
25109
  # Corresponds to the JSON property `sessionInfo`
25815
25110
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaStreamAssistResponseSessionInfo]
@@ -25823,6 +25118,7 @@ module Google
25823
25118
  def update!(**args)
25824
25119
  @answer = args[:answer] if args.key?(:answer)
25825
25120
  @assist_token = args[:assist_token] if args.key?(:assist_token)
25121
+ @invocation_tools = args[:invocation_tools] if args.key?(:invocation_tools)
25826
25122
  @session_info = args[:session_info] if args.key?(:session_info)
25827
25123
  end
25828
25124
  end
@@ -26467,120 +25763,6 @@ module Google
26467
25763
  end
26468
25764
  end
26469
25765
 
26470
- # Request message for the AgentService.UploadAgentFile method.
26471
- class GoogleCloudDiscoveryengineV1alphaUploadAgentFileRequest
26472
- include Google::Apis::Core::Hashable
26473
-
26474
- # A reference to data stored on the filesystem, on GFS or in blobstore.
26475
- # Corresponds to the JSON property `blob`
26476
- # @return [Google::Apis::DiscoveryengineV1alpha::GdataMedia]
26477
- attr_accessor :blob
26478
-
26479
- # Extra information added to operations that support Scotty media requests.
26480
- # Corresponds to the JSON property `mediaRequestInfo`
26481
- # @return [Google::Apis::DiscoveryengineV1alpha::ApiservingMediaRequestInfo]
26482
- attr_accessor :media_request_info
26483
-
26484
- def initialize(**args)
26485
- update!(**args)
26486
- end
26487
-
26488
- # Update properties of this object
26489
- def update!(**args)
26490
- @blob = args[:blob] if args.key?(:blob)
26491
- @media_request_info = args[:media_request_info] if args.key?(:media_request_info)
26492
- end
26493
- end
26494
-
26495
- # Response message for the AgentService.UploadAgentFile method.
26496
- class GoogleCloudDiscoveryengineV1alphaUploadAgentFileResponse
26497
- include Google::Apis::Core::Hashable
26498
-
26499
- # Describes a file used internally by an agent as a context on each invocation.
26500
- # Corresponds to the JSON property `agentFile`
26501
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAgentFile]
26502
- attr_accessor :agent_file
26503
-
26504
- # This message is for backends to pass their scotty media specific fields to ESF.
26505
- # Backend will include this in their response message to ESF. Example:
26506
- # ExportFile is an rpc defined for upload using scotty from ESF. rpc ExportFile(
26507
- # ExportFileRequest) returns (ExportFileResponse) Message ExportFileResponse
26508
- # will include apiserving.MediaResponseInfo to tell ESF about data like
26509
- # dynamic_dropzone it needs to pass to Scotty. message ExportFileResponse `
26510
- # optional gdata.Media blob = 1; optional apiserving.MediaResponseInfo
26511
- # media_response_info = 2 `
26512
- # Corresponds to the JSON property `mediaResponseInfo`
26513
- # @return [Google::Apis::DiscoveryengineV1alpha::ApiservingMediaResponseInfo]
26514
- attr_accessor :media_response_info
26515
-
26516
- def initialize(**args)
26517
- update!(**args)
26518
- end
26519
-
26520
- # Update properties of this object
26521
- def update!(**args)
26522
- @agent_file = args[:agent_file] if args.key?(:agent_file)
26523
- @media_response_info = args[:media_response_info] if args.key?(:media_response_info)
26524
- end
26525
- end
26526
-
26527
- # Request for the AssistantService.UploadSessionFile method.
26528
- class GoogleCloudDiscoveryengineV1alphaUploadSessionFileRequest
26529
- include Google::Apis::Core::Hashable
26530
-
26531
- # A reference to data stored on the filesystem, on GFS or in blobstore.
26532
- # Corresponds to the JSON property `blob`
26533
- # @return [Google::Apis::DiscoveryengineV1alpha::GdataMedia]
26534
- attr_accessor :blob
26535
-
26536
- # Extra information added to operations that support Scotty media requests.
26537
- # Corresponds to the JSON property `mediaRequestInfo`
26538
- # @return [Google::Apis::DiscoveryengineV1alpha::ApiservingMediaRequestInfo]
26539
- attr_accessor :media_request_info
26540
-
26541
- def initialize(**args)
26542
- update!(**args)
26543
- end
26544
-
26545
- # Update properties of this object
26546
- def update!(**args)
26547
- @blob = args[:blob] if args.key?(:blob)
26548
- @media_request_info = args[:media_request_info] if args.key?(:media_request_info)
26549
- end
26550
- end
26551
-
26552
- # Response for the AssistantService.UploadSessionFile method.
26553
- class GoogleCloudDiscoveryengineV1alphaUploadSessionFileResponse
26554
- include Google::Apis::Core::Hashable
26555
-
26556
- # The ID of the uploaded file.
26557
- # Corresponds to the JSON property `fileId`
26558
- # @return [String]
26559
- attr_accessor :file_id
26560
-
26561
- # This message is for backends to pass their scotty media specific fields to ESF.
26562
- # Backend will include this in their response message to ESF. Example:
26563
- # ExportFile is an rpc defined for upload using scotty from ESF. rpc ExportFile(
26564
- # ExportFileRequest) returns (ExportFileResponse) Message ExportFileResponse
26565
- # will include apiserving.MediaResponseInfo to tell ESF about data like
26566
- # dynamic_dropzone it needs to pass to Scotty. message ExportFileResponse `
26567
- # optional gdata.Media blob = 1; optional apiserving.MediaResponseInfo
26568
- # media_response_info = 2 `
26569
- # Corresponds to the JSON property `mediaResponseInfo`
26570
- # @return [Google::Apis::DiscoveryengineV1alpha::ApiservingMediaResponseInfo]
26571
- attr_accessor :media_response_info
26572
-
26573
- def initialize(**args)
26574
- update!(**args)
26575
- end
26576
-
26577
- # Update properties of this object
26578
- def update!(**args)
26579
- @file_id = args[:file_id] if args.key?(:file_id)
26580
- @media_response_info = args[:media_response_info] if args.key?(:media_response_info)
26581
- end
26582
- end
26583
-
26584
25766
  # Per-user annotations for an Agent, based on UserAnnotation.
26585
25767
  class GoogleCloudDiscoveryengineV1alphaUserAnnotations
26586
25768
  include Google::Apis::Core::Hashable
@@ -30109,6 +29291,14 @@ module Google
30109
29291
  class GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig
30110
29292
  include Google::Apis::Core::Hashable
30111
29293
 
29294
+ # Optional. The required subscription tier of this engine. They cannot be
29295
+ # modified after engine creation. If the required subscription tier is search,
29296
+ # user with higher license tier like assist can still access the standalone app
29297
+ # associated with this engine.
29298
+ # Corresponds to the JSON property `requiredSubscriptionTier`
29299
+ # @return [String]
29300
+ attr_accessor :required_subscription_tier
29301
+
30112
29302
  # The add-on that this search engine enables.
30113
29303
  # Corresponds to the JSON property `searchAddOns`
30114
29304
  # @return [Array<String>]
@@ -30127,6 +29317,7 @@ module Google
30127
29317
 
30128
29318
  # Update properties of this object
30129
29319
  def update!(**args)
29320
+ @required_subscription_tier = args[:required_subscription_tier] if args.key?(:required_subscription_tier)
30130
29321
  @search_add_ons = args[:search_add_ons] if args.key?(:search_add_ons)
30131
29322
  @search_tier = args[:search_tier] if args.key?(:search_tier)
30132
29323
  end
@@ -31637,6 +30828,18 @@ module Google
31637
30828
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec]
31638
30829
  attr_accessor :content_search_spec
31639
30830
 
30831
+ # Optional. Crowding specifications for improving result diversity. If multiple
30832
+ # CrowdingSpecs are specified, crowding will be evaluated on each unique
30833
+ # combination of the `field` values, and max_count will be the maximum value of `
30834
+ # max_count` across all CrowdingSpecs. For example, if the first CrowdingSpec
30835
+ # has `field` = "color" and `max_count` = 3, and the second CrowdingSpec has `
30836
+ # field` = "size" and `max_count` = 2, then after 3 documents that share the
30837
+ # same color AND size have been returned, subsequent ones should be removed or
30838
+ # demoted.
30839
+ # Corresponds to the JSON property `crowdingSpecs`
30840
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec>]
30841
+ attr_accessor :crowding_specs
30842
+
31640
30843
  # Specifications that define the specific DataStores to be searched, along with
31641
30844
  # configurations for those data stores. This is only considered for Engines with
31642
30845
  # multiple data stores. For engines with a single data store, the specs directly
@@ -31724,6 +30927,20 @@ module Google
31724
30927
  # @return [String]
31725
30928
  attr_accessor :order_by
31726
30929
 
30930
+ # Optional. The categories associated with a category page. Must be set for
30931
+ # category navigation queries to achieve good search quality. The format should
30932
+ # be the same as UserEvent.PageInfo.page_category. This field is the equivalent
30933
+ # of the query for browse (navigation) queries. It's used by the browse model
30934
+ # when the query is empty. If the field is empty, it will not be used by the
30935
+ # browse model. To represent full path of a category, use '>' character to
30936
+ # separate different hierarchies. If '>' is part of the category name, replace
30937
+ # it with other character(s). For example, `Graphics Cards > RTX>4090 > Founders
30938
+ # Edition` where "RTX > 4090" represents one level, can be rewritten as `
30939
+ # Graphics Cards > RTX_4090 > Founders Edition`
30940
+ # Corresponds to the JSON property `pageCategories`
30941
+ # @return [Array<String>]
30942
+ attr_accessor :page_categories
30943
+
31727
30944
  # Maximum number of Documents to return. The maximum allowed value depends on
31728
30945
  # the data type. Values above the maximum value are coerced to the maximum value.
31729
30946
  # * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with
@@ -31947,6 +31164,7 @@ module Google
31947
31164
  @branch = args[:branch] if args.key?(:branch)
31948
31165
  @canonical_filter = args[:canonical_filter] if args.key?(:canonical_filter)
31949
31166
  @content_search_spec = args[:content_search_spec] if args.key?(:content_search_spec)
31167
+ @crowding_specs = args[:crowding_specs] if args.key?(:crowding_specs)
31950
31168
  @data_store_specs = args[:data_store_specs] if args.key?(:data_store_specs)
31951
31169
  @display_spec = args[:display_spec] if args.key?(:display_spec)
31952
31170
  @embedding_spec = args[:embedding_spec] if args.key?(:embedding_spec)
@@ -31958,6 +31176,7 @@ module Google
31958
31176
  @offset = args[:offset] if args.key?(:offset)
31959
31177
  @one_box_page_size = args[:one_box_page_size] if args.key?(:one_box_page_size)
31960
31178
  @order_by = args[:order_by] if args.key?(:order_by)
31179
+ @page_categories = args[:page_categories] if args.key?(:page_categories)
31961
31180
  @page_size = args[:page_size] if args.key?(:page_size)
31962
31181
  @page_token = args[:page_token] if args.key?(:page_token)
31963
31182
  @params = args[:params] if args.key?(:params)
@@ -32497,6 +31716,45 @@ module Google
32497
31716
  end
32498
31717
  end
32499
31718
 
31719
+ # Specification for crowding. Crowding improves the diversity of search results
31720
+ # by limiting the number of results that share the same field value. For example,
31721
+ # crowding on the color field with a max_count of 3 and mode
31722
+ # DROP_CROWDED_RESULTS will return at most 3 results with the same color across
31723
+ # all pages.
31724
+ class GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec
31725
+ include Google::Apis::Core::Hashable
31726
+
31727
+ # The field to use for crowding. Documents can be crowded by a field in the
31728
+ # Document object. Crowding field is case sensitive.
31729
+ # Corresponds to the JSON property `field`
31730
+ # @return [String]
31731
+ attr_accessor :field
31732
+
31733
+ # The maximum number of documents to keep per value of the field. Once there are
31734
+ # at least max_count previous results which contain the same value for the given
31735
+ # field (according to the order specified in `order_by`), later results with the
31736
+ # same value are "crowded away". If not specified, the default value is 1.
31737
+ # Corresponds to the JSON property `maxCount`
31738
+ # @return [Fixnum]
31739
+ attr_accessor :max_count
31740
+
31741
+ # Mode to use for documents that are crowded away.
31742
+ # Corresponds to the JSON property `mode`
31743
+ # @return [String]
31744
+ attr_accessor :mode
31745
+
31746
+ def initialize(**args)
31747
+ update!(**args)
31748
+ end
31749
+
31750
+ # Update properties of this object
31751
+ def update!(**args)
31752
+ @field = args[:field] if args.key?(:field)
31753
+ @max_count = args[:max_count] if args.key?(:max_count)
31754
+ @mode = args[:mode] if args.key?(:mode)
31755
+ end
31756
+ end
31757
+
32500
31758
  # A struct to define data stores to filter on in a search call and
32501
31759
  # configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error
32502
31760
  # is returned.
@@ -34583,70 +33841,6 @@ module Google
34583
33841
  end
34584
33842
  end
34585
33843
 
34586
- # Request for the SourceService.UploadSourceFile method.
34587
- class GoogleCloudNotebooklmV1alphaUploadSourceFileRequest
34588
- include Google::Apis::Core::Hashable
34589
-
34590
- # A reference to data stored on the filesystem, on GFS or in blobstore.
34591
- # Corresponds to the JSON property `blob`
34592
- # @return [Google::Apis::DiscoveryengineV1alpha::GdataMedia]
34593
- attr_accessor :blob
34594
-
34595
- # Extra information added to operations that support Scotty media requests.
34596
- # Corresponds to the JSON property `mediaRequestInfo`
34597
- # @return [Google::Apis::DiscoveryengineV1alpha::ApiservingMediaRequestInfo]
34598
- attr_accessor :media_request_info
34599
-
34600
- # The source id of the associated file. If not set, a source id will be
34601
- # generated and a new tentative source will be created.
34602
- # Corresponds to the JSON property `sourceId`
34603
- # @return [String]
34604
- attr_accessor :source_id
34605
-
34606
- def initialize(**args)
34607
- update!(**args)
34608
- end
34609
-
34610
- # Update properties of this object
34611
- def update!(**args)
34612
- @blob = args[:blob] if args.key?(:blob)
34613
- @media_request_info = args[:media_request_info] if args.key?(:media_request_info)
34614
- @source_id = args[:source_id] if args.key?(:source_id)
34615
- end
34616
- end
34617
-
34618
- # Response for the SourceService.UploadSourceFile method.
34619
- class GoogleCloudNotebooklmV1alphaUploadSourceFileResponse
34620
- include Google::Apis::Core::Hashable
34621
-
34622
- # This message is for backends to pass their scotty media specific fields to ESF.
34623
- # Backend will include this in their response message to ESF. Example:
34624
- # ExportFile is an rpc defined for upload using scotty from ESF. rpc ExportFile(
34625
- # ExportFileRequest) returns (ExportFileResponse) Message ExportFileResponse
34626
- # will include apiserving.MediaResponseInfo to tell ESF about data like
34627
- # dynamic_dropzone it needs to pass to Scotty. message ExportFileResponse `
34628
- # optional gdata.Media blob = 1; optional apiserving.MediaResponseInfo
34629
- # media_response_info = 2 `
34630
- # Corresponds to the JSON property `mediaResponseInfo`
34631
- # @return [Google::Apis::DiscoveryengineV1alpha::ApiservingMediaResponseInfo]
34632
- attr_accessor :media_response_info
34633
-
34634
- # SourceId is the last segment of the source's resource name.
34635
- # Corresponds to the JSON property `sourceId`
34636
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudNotebooklmV1alphaSourceId]
34637
- attr_accessor :source_id
34638
-
34639
- def initialize(**args)
34640
- update!(**args)
34641
- end
34642
-
34643
- # Update properties of this object
34644
- def update!(**args)
34645
- @media_response_info = args[:media_response_info] if args.key?(:media_response_info)
34646
- @source_id = args[:source_id] if args.key?(:source_id)
34647
- end
34648
- end
34649
-
34650
33844
  # The "Content" messages refer to data the user wants to upload.
34651
33845
  class GoogleCloudNotebooklmV1alphaUserContent
34652
33846
  include Google::Apis::Core::Hashable
@@ -35117,8 +34311,9 @@ module Google
35117
34311
  attr_accessor :operations
35118
34312
 
35119
34313
  # Unordered list. Unreachable resources. Populated when the request sets `
35120
- # ListOperationsRequest.return_partial_success` and reads across collections e.g.
35121
- # when attempting to list all resources across all supported locations.
34314
+ # ListOperationsRequest.return_partial_success` and reads across collections.
34315
+ # For example, when attempting to list all resources across all supported
34316
+ # locations.
35122
34317
  # Corresponds to the JSON property `unreachable`
35123
34318
  # @return [Array<String>]
35124
34319
  attr_accessor :unreachable