google-apis-discoveryengine_v1beta 0.58.0 → 0.59.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.
@@ -867,6 +867,11 @@ module Google
867
867
  # @return [String]
868
868
  attr_accessor :name
869
869
 
870
+ # Output only. Whether the NotebookLM Corpus is ready to be used.
871
+ # Corresponds to the JSON property `notebooklmState`
872
+ # @return [String]
873
+ attr_accessor :notebooklm_state
874
+
870
875
  # Optional. Single-regional CMEKs that are required for some VAIS features.
871
876
  # Corresponds to the JSON property `singleRegionKeys`
872
877
  # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1SingleRegionKey>]
@@ -888,6 +893,7 @@ module Google
888
893
  @kms_key_version = args[:kms_key_version] if args.key?(:kms_key_version)
889
894
  @last_rotation_timestamp_micros = args[:last_rotation_timestamp_micros] if args.key?(:last_rotation_timestamp_micros)
890
895
  @name = args[:name] if args.key?(:name)
896
+ @notebooklm_state = args[:notebooklm_state] if args.key?(:notebooklm_state)
891
897
  @single_region_keys = args[:single_region_keys] if args.key?(:single_region_keys)
892
898
  @state = args[:state] if args.key?(:state)
893
899
  end
@@ -1446,6 +1452,17 @@ module Google
1446
1452
  class GoogleCloudDiscoveryengineV1DataStore
1447
1453
  include Google::Apis::Core::Hashable
1448
1454
 
1455
+ # Immutable. Whether data in the DataStore has ACL information. If set to `true`,
1456
+ # the source data must have ACL. ACL will be ingested when data is ingested by
1457
+ # DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore,
1458
+ # Document can't be accessed by calling DocumentService.GetDocument or
1459
+ # DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC`
1460
+ # industry vertical with non-`PUBLIC_WEBSITE` content config.
1461
+ # Corresponds to the JSON property `aclEnabled`
1462
+ # @return [Boolean]
1463
+ attr_accessor :acl_enabled
1464
+ alias_method :acl_enabled?, :acl_enabled
1465
+
1449
1466
  # Configuration data for advance site search.
1450
1467
  # Corresponds to the JSON property `advancedSiteSearchConfig`
1451
1468
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig]
@@ -1560,6 +1577,7 @@ module Google
1560
1577
 
1561
1578
  # Update properties of this object
1562
1579
  def update!(**args)
1580
+ @acl_enabled = args[:acl_enabled] if args.key?(:acl_enabled)
1563
1581
  @advanced_site_search_config = args[:advanced_site_search_config] if args.key?(:advanced_site_search_config)
1564
1582
  @billing_estimation = args[:billing_estimation] if args.key?(:billing_estimation)
1565
1583
  @cmek_config = args[:cmek_config] if args.key?(:cmek_config)
@@ -4161,6 +4179,14 @@ module Google
4161
4179
  attr_accessor :is_action_configured
4162
4180
  alias_method :is_action_configured?, :is_action_configured
4163
4181
 
4182
+ # Optional. The Service Directory resource name (projects/*/locations/*/
4183
+ # namespaces/*/services/*) representing a VPC network endpoint used to connect
4184
+ # to the data source's `instance_uri`, defined in DataConnector.params. Required
4185
+ # when VPC Service Controls are enabled.
4186
+ # Corresponds to the JSON property `serviceName`
4187
+ # @return [String]
4188
+ attr_accessor :service_name
4189
+
4164
4190
  def initialize(**args)
4165
4191
  update!(**args)
4166
4192
  end
@@ -4169,6 +4195,7 @@ module Google
4169
4195
  def update!(**args)
4170
4196
  @action_params = args[:action_params] if args.key?(:action_params)
4171
4197
  @is_action_configured = args[:is_action_configured] if args.key?(:is_action_configured)
4198
+ @service_name = args[:service_name] if args.key?(:service_name)
4172
4199
  end
4173
4200
  end
4174
4201
 
@@ -4264,6 +4291,11 @@ module Google
4264
4291
  # @return [String]
4265
4292
  attr_accessor :answer_text
4266
4293
 
4294
+ # List of blob attachments in the answer.
4295
+ # Corresponds to the JSON property `blobAttachments`
4296
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachment>]
4297
+ attr_accessor :blob_attachments
4298
+
4267
4299
  # Citations.
4268
4300
  # Corresponds to the JSON property `citations`
4269
4301
  # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaAnswerCitation>]
@@ -4334,6 +4366,7 @@ module Google
4334
4366
  def update!(**args)
4335
4367
  @answer_skipped_reasons = args[:answer_skipped_reasons] if args.key?(:answer_skipped_reasons)
4336
4368
  @answer_text = args[:answer_text] if args.key?(:answer_text)
4369
+ @blob_attachments = args[:blob_attachments] if args.key?(:blob_attachments)
4337
4370
  @citations = args[:citations] if args.key?(:citations)
4338
4371
  @complete_time = args[:complete_time] if args.key?(:complete_time)
4339
4372
  @create_time = args[:create_time] if args.key?(:create_time)
@@ -4349,6 +4382,57 @@ module Google
4349
4382
  end
4350
4383
  end
4351
4384
 
4385
+ # Stores binarydata attached to text answer, e.g. image, video, audio, etc.
4386
+ class GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachment
4387
+ include Google::Apis::Core::Hashable
4388
+
4389
+ # Output only. The attribution type of the blob.
4390
+ # Corresponds to the JSON property `attributionType`
4391
+ # @return [String]
4392
+ attr_accessor :attribution_type
4393
+
4394
+ # The media type and data of the blob.
4395
+ # Corresponds to the JSON property `data`
4396
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachmentBlob]
4397
+ attr_accessor :data
4398
+
4399
+ def initialize(**args)
4400
+ update!(**args)
4401
+ end
4402
+
4403
+ # Update properties of this object
4404
+ def update!(**args)
4405
+ @attribution_type = args[:attribution_type] if args.key?(:attribution_type)
4406
+ @data = args[:data] if args.key?(:data)
4407
+ end
4408
+ end
4409
+
4410
+ # The media type and data of the blob.
4411
+ class GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachmentBlob
4412
+ include Google::Apis::Core::Hashable
4413
+
4414
+ # Output only. Raw bytes.
4415
+ # Corresponds to the JSON property `data`
4416
+ # NOTE: Values are automatically base64 encoded/decoded in the client library.
4417
+ # @return [String]
4418
+ attr_accessor :data
4419
+
4420
+ # Output only. The media type (MIME type) of the generated or retrieved data.
4421
+ # Corresponds to the JSON property `mimeType`
4422
+ # @return [String]
4423
+ attr_accessor :mime_type
4424
+
4425
+ def initialize(**args)
4426
+ update!(**args)
4427
+ end
4428
+
4429
+ # Update properties of this object
4430
+ def update!(**args)
4431
+ @data = args[:data] if args.key?(:data)
4432
+ @mime_type = args[:mime_type] if args.key?(:mime_type)
4433
+ end
4434
+ end
4435
+
4352
4436
  # Citation info for a segment.
4353
4437
  class GoogleCloudDiscoveryengineV1alphaAnswerCitation
4354
4438
  include Google::Apis::Core::Hashable
@@ -4533,6 +4617,11 @@ module Google
4533
4617
  class GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo
4534
4618
  include Google::Apis::Core::Hashable
4535
4619
 
4620
+ # Output only. Stores indexes of blobattachments linked to this chunk.
4621
+ # Corresponds to the JSON property `blobAttachmentIndexes`
4622
+ # @return [Array<Fixnum>]
4623
+ attr_accessor :blob_attachment_indexes
4624
+
4536
4625
  # Chunk resource name.
4537
4626
  # Corresponds to the JSON property `chunk`
4538
4627
  # @return [String]
@@ -4562,6 +4651,7 @@ module Google
4562
4651
 
4563
4652
  # Update properties of this object
4564
4653
  def update!(**args)
4654
+ @blob_attachment_indexes = args[:blob_attachment_indexes] if args.key?(:blob_attachment_indexes)
4565
4655
  @chunk = args[:chunk] if args.key?(:chunk)
4566
4656
  @content = args[:content] if args.key?(:content)
4567
4657
  @document_metadata = args[:document_metadata] if args.key?(:document_metadata)
@@ -4698,6 +4788,11 @@ module Google
4698
4788
  class GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent
4699
4789
  include Google::Apis::Core::Hashable
4700
4790
 
4791
+ # Output only. Stores indexes of blobattachments linked to this chunk.
4792
+ # Corresponds to the JSON property `blobAttachmentIndexes`
4793
+ # @return [Array<Fixnum>]
4794
+ attr_accessor :blob_attachment_indexes
4795
+
4701
4796
  # Chunk textual content.
4702
4797
  # Corresponds to the JSON property `content`
4703
4798
  # @return [String]
@@ -4722,6 +4817,7 @@ module Google
4722
4817
 
4723
4818
  # Update properties of this object
4724
4819
  def update!(**args)
4820
+ @blob_attachment_indexes = args[:blob_attachment_indexes] if args.key?(:blob_attachment_indexes)
4725
4821
  @content = args[:content] if args.key?(:content)
4726
4822
  @page_identifier = args[:page_identifier] if args.key?(:page_identifier)
4727
4823
  @relevance_score = args[:relevance_score] if args.key?(:relevance_score)
@@ -5039,6 +5135,11 @@ module Google
5039
5135
  # @return [String]
5040
5136
  attr_accessor :name
5041
5137
 
5138
+ # Output only. Whether the NotebookLM Corpus is ready to be used.
5139
+ # Corresponds to the JSON property `notebooklmState`
5140
+ # @return [String]
5141
+ attr_accessor :notebooklm_state
5142
+
5042
5143
  # Optional. Single-regional CMEKs that are required for some VAIS features.
5043
5144
  # Corresponds to the JSON property `singleRegionKeys`
5044
5145
  # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaSingleRegionKey>]
@@ -5060,6 +5161,7 @@ module Google
5060
5161
  @kms_key_version = args[:kms_key_version] if args.key?(:kms_key_version)
5061
5162
  @last_rotation_timestamp_micros = args[:last_rotation_timestamp_micros] if args.key?(:last_rotation_timestamp_micros)
5062
5163
  @name = args[:name] if args.key?(:name)
5164
+ @notebooklm_state = args[:notebooklm_state] if args.key?(:notebooklm_state)
5063
5165
  @single_region_keys = args[:single_region_keys] if args.key?(:single_region_keys)
5064
5166
  @state = args[:state] if args.key?(:state)
5065
5167
  end
@@ -9458,10 +9560,10 @@ module Google
9458
9560
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec]
9459
9561
  attr_accessor :custom_fine_tuning_spec
9460
9562
 
9461
- # Specifications that define the specific [DataStore]s to be searched, along
9462
- # with configurations for those data stores. This is only considered for Engines
9463
- # with multiple data stores. For engines with a single data store, the specs
9464
- # directly under SearchRequest should be used.
9563
+ # Specifications that define the specific DataStores to be searched, along with
9564
+ # configurations for those data stores. This is only considered for Engines with
9565
+ # multiple data stores. For engines with a single data store, the specs directly
9566
+ # under SearchRequest should be used.
9465
9567
  # Corresponds to the JSON property `dataStoreSpecs`
9466
9568
  # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec>]
9467
9569
  attr_accessor :data_store_specs
@@ -9592,29 +9694,30 @@ module Google
9592
9694
  # This overrides ServingConfig.ranking_expression. The syntax and supported
9593
9695
  # features depend on the ranking_expression_backend value. If
9594
9696
  # ranking_expression_backend is not provided, it defaults to BYOE. === BYOE ===
9595
- # If ranking expression is not provided or set to BYOE, it should be a single
9596
- # function or multiple functions that are joined by "+". * ranking_expression =
9597
- # function, ` " + ", function `; Supported functions: * double * relevance_score
9598
- # * double * dotProduct(embedding_field_path) Function variables: * `
9599
- # relevance_score`: pre-defined keywords, used for measure relevance between
9600
- # query and document. * `embedding_field_path`: the document embedding field
9601
- # used with query embedding vector. * `dotProduct`: embedding function between
9602
- # embedding_field_path and query embedding vector. Example ranking expression:
9603
- # If document has an embedding field doc_embedding, the ranking expression could
9604
- # be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. === CLEARBOX ===
9605
- # If ranking expression is set to CLEARBOX, the following expression types (and
9606
- # combinations of those chained using + or * operators) are supported: * double *
9607
- # signal * log(signal) * exp(signal) * rr(signal, double > 0) -- reciprocal
9608
- # rank transformation with second argument being a denominator constant. *
9609
- # is_nan(signal) -- returns 0 if signal is NaN, 1 otherwise. * fill_nan(signal1,
9610
- # signal2 | double) -- if signal1 is NaN, returns signal2 | double, else returns
9611
- # signal1. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(
9612
- # fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score,
9613
- # 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: *
9614
- # gecko_score -- semantic similarity adjustment * bm25_score -- keyword match
9615
- # adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank --
9616
- # predicted conversion rate adjustment as a rank * freshness_rank -- freshness
9617
- # adjustment as a rank * base_rank -- the default rank of the result
9697
+ # If ranking_expression_backend is not provided or set to `BYOE`, it should be a
9698
+ # single function or multiple functions that are joined by "+". *
9699
+ # ranking_expression = function, ` " + ", function `; Supported functions: *
9700
+ # double * relevance_score * double * dotProduct(embedding_field_path) Function
9701
+ # variables: * `relevance_score`: pre-defined keywords, used for measure
9702
+ # relevance between query and document. * `embedding_field_path`: the document
9703
+ # embedding field used with query embedding vector. * `dotProduct`: embedding
9704
+ # function between embedding_field_path and query embedding vector. Example
9705
+ # ranking expression: If document has an embedding field doc_embedding, the
9706
+ # ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(
9707
+ # doc_embedding)`. === CLEARBOX === If ranking_expression_backend is set to `
9708
+ # CLEARBOX`, the following expression types (and combinations of those chained
9709
+ # using + or * operators) are supported: * double * signal * log(signal) * exp(
9710
+ # signal) * rr(signal, double > 0) -- reciprocal rank transformation with second
9711
+ # argument being a denominator constant. * is_nan(signal) -- returns 0 if signal
9712
+ # is NaN, 1 otherwise. * fill_nan(signal1, signal2 | double) -- if signal1 is
9713
+ # NaN, returns signal2 | double, else returns signal1. Examples: * 0.2 *
9714
+ # gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.
9715
+ # 3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32)
9716
+ # The following signals are supported: * gecko_score -- semantic similarity
9717
+ # adjustment * bm25_score -- keyword match adjustment * jetstream_score --
9718
+ # semantic relevance adjustment * pctr_rank -- predicted conversion rate
9719
+ # adjustment as a rank * freshness_rank -- freshness adjustment as a rank *
9720
+ # base_rank -- the default rank of the result
9618
9721
  # Corresponds to the JSON property `rankingExpression`
9619
9722
  # @return [String]
9620
9723
  attr_accessor :ranking_expression
@@ -9781,7 +9884,7 @@ module Google
9781
9884
  include Google::Apis::Core::Hashable
9782
9885
 
9783
9886
  # Condition boost specifications. If a document matches multiple conditions in
9784
- # the specifictions, boost scores from these specifications are all applied and
9887
+ # the specifications, boost scores from these specifications are all applied and
9785
9888
  # combined in a non-linear way. Maximum number of specifications is 20.
9786
9889
  # Corresponds to the JSON property `conditionBoostSpecs`
9787
9890
  # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec>]
@@ -10180,6 +10283,12 @@ module Google
10180
10283
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec]
10181
10284
  attr_accessor :model_spec
10182
10285
 
10286
+ # Multimodal specification: Will return an image from specified source. If
10287
+ # multiple sources are specified, the pick is a quality based decision.
10288
+ # Corresponds to the JSON property `multimodalSpec`
10289
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecMultiModalSpec]
10290
+ attr_accessor :multimodal_spec
10291
+
10183
10292
  # The number of top results to generate the summary from. If the number of
10184
10293
  # results returned is less than `summaryResultCount`, the summary is generated
10185
10294
  # from all of the results. At most 10 results for documents mode, or 50 for
@@ -10213,6 +10322,7 @@ module Google
10213
10322
  @language_code = args[:language_code] if args.key?(:language_code)
10214
10323
  @model_prompt_spec = args[:model_prompt_spec] if args.key?(:model_prompt_spec)
10215
10324
  @model_spec = args[:model_spec] if args.key?(:model_spec)
10325
+ @multimodal_spec = args[:multimodal_spec] if args.key?(:multimodal_spec)
10216
10326
  @summary_result_count = args[:summary_result_count] if args.key?(:summary_result_count)
10217
10327
  @use_semantic_chunks = args[:use_semantic_chunks] if args.key?(:use_semantic_chunks)
10218
10328
  end
@@ -10264,6 +10374,26 @@ module Google
10264
10374
  end
10265
10375
  end
10266
10376
 
10377
+ # Multimodal specification: Will return an image from specified source. If
10378
+ # multiple sources are specified, the pick is a quality based decision.
10379
+ class GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecMultiModalSpec
10380
+ include Google::Apis::Core::Hashable
10381
+
10382
+ # Optional. Source of image returned in the answer.
10383
+ # Corresponds to the JSON property `imageSource`
10384
+ # @return [String]
10385
+ attr_accessor :image_source
10386
+
10387
+ def initialize(**args)
10388
+ update!(**args)
10389
+ end
10390
+
10391
+ # Update properties of this object
10392
+ def update!(**args)
10393
+ @image_source = args[:image_source] if args.key?(:image_source)
10394
+ end
10395
+ end
10396
+
10267
10397
  # A struct to define data stores to filter on in a search call and
10268
10398
  # configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error
10269
10399
  # is returned.
@@ -11540,7 +11670,7 @@ module Google
11540
11670
  include Google::Apis::Core::Hashable
11541
11671
 
11542
11672
  # Condition boost specifications. If a suggestion matches multiple conditions in
11543
- # the specifictions, boost values from these specifications are all applied and
11673
+ # the specifications, boost values from these specifications are all applied and
11544
11674
  # combined in a non-linear way. Maximum number of specifications is 20. Note:
11545
11675
  # Currently only support language condition boost.
11546
11676
  # Corresponds to the JSON property `conditionBoostSpecs`
@@ -11948,6 +12078,11 @@ module Google
11948
12078
  # @return [String]
11949
12079
  attr_accessor :answer_text
11950
12080
 
12081
+ # List of blob attachments in the answer.
12082
+ # Corresponds to the JSON property `blobAttachments`
12083
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerBlobAttachment>]
12084
+ attr_accessor :blob_attachments
12085
+
11951
12086
  # Citations.
11952
12087
  # Corresponds to the JSON property `citations`
11953
12088
  # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerCitation>]
@@ -12018,6 +12153,7 @@ module Google
12018
12153
  def update!(**args)
12019
12154
  @answer_skipped_reasons = args[:answer_skipped_reasons] if args.key?(:answer_skipped_reasons)
12020
12155
  @answer_text = args[:answer_text] if args.key?(:answer_text)
12156
+ @blob_attachments = args[:blob_attachments] if args.key?(:blob_attachments)
12021
12157
  @citations = args[:citations] if args.key?(:citations)
12022
12158
  @complete_time = args[:complete_time] if args.key?(:complete_time)
12023
12159
  @create_time = args[:create_time] if args.key?(:create_time)
@@ -12033,6 +12169,57 @@ module Google
12033
12169
  end
12034
12170
  end
12035
12171
 
12172
+ # Stores binarydata attached to text answer, e.g. image, video, audio, etc.
12173
+ class GoogleCloudDiscoveryengineV1betaAnswerBlobAttachment
12174
+ include Google::Apis::Core::Hashable
12175
+
12176
+ # Output only. The attribution type of the blob.
12177
+ # Corresponds to the JSON property `attributionType`
12178
+ # @return [String]
12179
+ attr_accessor :attribution_type
12180
+
12181
+ # The media type and data of the blob.
12182
+ # Corresponds to the JSON property `data`
12183
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerBlobAttachmentBlob]
12184
+ attr_accessor :data
12185
+
12186
+ def initialize(**args)
12187
+ update!(**args)
12188
+ end
12189
+
12190
+ # Update properties of this object
12191
+ def update!(**args)
12192
+ @attribution_type = args[:attribution_type] if args.key?(:attribution_type)
12193
+ @data = args[:data] if args.key?(:data)
12194
+ end
12195
+ end
12196
+
12197
+ # The media type and data of the blob.
12198
+ class GoogleCloudDiscoveryengineV1betaAnswerBlobAttachmentBlob
12199
+ include Google::Apis::Core::Hashable
12200
+
12201
+ # Output only. Raw bytes.
12202
+ # Corresponds to the JSON property `data`
12203
+ # NOTE: Values are automatically base64 encoded/decoded in the client library.
12204
+ # @return [String]
12205
+ attr_accessor :data
12206
+
12207
+ # Output only. The media type (MIME type) of the generated or retrieved data.
12208
+ # Corresponds to the JSON property `mimeType`
12209
+ # @return [String]
12210
+ attr_accessor :mime_type
12211
+
12212
+ def initialize(**args)
12213
+ update!(**args)
12214
+ end
12215
+
12216
+ # Update properties of this object
12217
+ def update!(**args)
12218
+ @data = args[:data] if args.key?(:data)
12219
+ @mime_type = args[:mime_type] if args.key?(:mime_type)
12220
+ end
12221
+ end
12222
+
12036
12223
  # Citation info for a segment.
12037
12224
  class GoogleCloudDiscoveryengineV1betaAnswerCitation
12038
12225
  include Google::Apis::Core::Hashable
@@ -12317,6 +12504,12 @@ module Google
12317
12504
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecModelSpec]
12318
12505
  attr_accessor :model_spec
12319
12506
 
12507
+ # Multimodal specification: Will return an image from specified source. If
12508
+ # multiple sources are specified, the pick is a quality based decision.
12509
+ # Corresponds to the JSON property `multimodalSpec`
12510
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecMultimodalSpec]
12511
+ attr_accessor :multimodal_spec
12512
+
12320
12513
  # Answer generation prompt specification.
12321
12514
  # Corresponds to the JSON property `promptSpec`
12322
12515
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecPromptSpec]
@@ -12335,6 +12528,7 @@ module Google
12335
12528
  @ignore_non_answer_seeking_query = args[:ignore_non_answer_seeking_query] if args.key?(:ignore_non_answer_seeking_query)
12336
12529
  @include_citations = args[:include_citations] if args.key?(:include_citations)
12337
12530
  @model_spec = args[:model_spec] if args.key?(:model_spec)
12531
+ @multimodal_spec = args[:multimodal_spec] if args.key?(:multimodal_spec)
12338
12532
  @prompt_spec = args[:prompt_spec] if args.key?(:prompt_spec)
12339
12533
  end
12340
12534
  end
@@ -12359,6 +12553,26 @@ module Google
12359
12553
  end
12360
12554
  end
12361
12555
 
12556
+ # Multimodal specification: Will return an image from specified source. If
12557
+ # multiple sources are specified, the pick is a quality based decision.
12558
+ class GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecMultimodalSpec
12559
+ include Google::Apis::Core::Hashable
12560
+
12561
+ # Optional. Source of image returned in the answer.
12562
+ # Corresponds to the JSON property `imageSource`
12563
+ # @return [String]
12564
+ attr_accessor :image_source
12565
+
12566
+ def initialize(**args)
12567
+ update!(**args)
12568
+ end
12569
+
12570
+ # Update properties of this object
12571
+ def update!(**args)
12572
+ @image_source = args[:image_source] if args.key?(:image_source)
12573
+ end
12574
+ end
12575
+
12362
12576
  # Answer generation prompt specification.
12363
12577
  class GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecPromptSpec
12364
12578
  include Google::Apis::Core::Hashable
@@ -13115,6 +13329,11 @@ module Google
13115
13329
  class GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfo
13116
13330
  include Google::Apis::Core::Hashable
13117
13331
 
13332
+ # Output only. Stores indexes of blobattachments linked to this chunk.
13333
+ # Corresponds to the JSON property `blobAttachmentIndexes`
13334
+ # @return [Array<Fixnum>]
13335
+ attr_accessor :blob_attachment_indexes
13336
+
13118
13337
  # Chunk resource name.
13119
13338
  # Corresponds to the JSON property `chunk`
13120
13339
  # @return [String]
@@ -13144,6 +13363,7 @@ module Google
13144
13363
 
13145
13364
  # Update properties of this object
13146
13365
  def update!(**args)
13366
+ @blob_attachment_indexes = args[:blob_attachment_indexes] if args.key?(:blob_attachment_indexes)
13147
13367
  @chunk = args[:chunk] if args.key?(:chunk)
13148
13368
  @content = args[:content] if args.key?(:content)
13149
13369
  @document_metadata = args[:document_metadata] if args.key?(:document_metadata)
@@ -13280,6 +13500,11 @@ module Google
13280
13500
  class GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfoChunkContent
13281
13501
  include Google::Apis::Core::Hashable
13282
13502
 
13503
+ # Output only. Stores indexes of blobattachments linked to this chunk.
13504
+ # Corresponds to the JSON property `blobAttachmentIndexes`
13505
+ # @return [Array<Fixnum>]
13506
+ attr_accessor :blob_attachment_indexes
13507
+
13283
13508
  # Chunk textual content.
13284
13509
  # Corresponds to the JSON property `content`
13285
13510
  # @return [String]
@@ -13304,6 +13529,7 @@ module Google
13304
13529
 
13305
13530
  # Update properties of this object
13306
13531
  def update!(**args)
13532
+ @blob_attachment_indexes = args[:blob_attachment_indexes] if args.key?(:blob_attachment_indexes)
13307
13533
  @content = args[:content] if args.key?(:content)
13308
13534
  @page_identifier = args[:page_identifier] if args.key?(:page_identifier)
13309
13535
  @relevance_score = args[:relevance_score] if args.key?(:relevance_score)
@@ -14357,6 +14583,11 @@ module Google
14357
14583
  # @return [String]
14358
14584
  attr_accessor :name
14359
14585
 
14586
+ # Output only. Whether the NotebookLM Corpus is ready to be used.
14587
+ # Corresponds to the JSON property `notebooklmState`
14588
+ # @return [String]
14589
+ attr_accessor :notebooklm_state
14590
+
14360
14591
  # Optional. Single-regional CMEKs that are required for some VAIS features.
14361
14592
  # Corresponds to the JSON property `singleRegionKeys`
14362
14593
  # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSingleRegionKey>]
@@ -14378,6 +14609,7 @@ module Google
14378
14609
  @kms_key_version = args[:kms_key_version] if args.key?(:kms_key_version)
14379
14610
  @last_rotation_timestamp_micros = args[:last_rotation_timestamp_micros] if args.key?(:last_rotation_timestamp_micros)
14380
14611
  @name = args[:name] if args.key?(:name)
14612
+ @notebooklm_state = args[:notebooklm_state] if args.key?(:notebooklm_state)
14381
14613
  @single_region_keys = args[:single_region_keys] if args.key?(:single_region_keys)
14382
14614
  @state = args[:state] if args.key?(:state)
14383
14615
  end
@@ -15470,6 +15702,17 @@ module Google
15470
15702
  class GoogleCloudDiscoveryengineV1betaDataStore
15471
15703
  include Google::Apis::Core::Hashable
15472
15704
 
15705
+ # Immutable. Whether data in the DataStore has ACL information. If set to `true`,
15706
+ # the source data must have ACL. ACL will be ingested when data is ingested by
15707
+ # DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore,
15708
+ # Document can't be accessed by calling DocumentService.GetDocument or
15709
+ # DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC`
15710
+ # industry vertical with non-`PUBLIC_WEBSITE` content config.
15711
+ # Corresponds to the JSON property `aclEnabled`
15712
+ # @return [Boolean]
15713
+ attr_accessor :acl_enabled
15714
+ alias_method :acl_enabled?, :acl_enabled
15715
+
15473
15716
  # Configuration data for advance site search.
15474
15717
  # Corresponds to the JSON property `advancedSiteSearchConfig`
15475
15718
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig]
@@ -15594,6 +15837,7 @@ module Google
15594
15837
 
15595
15838
  # Update properties of this object
15596
15839
  def update!(**args)
15840
+ @acl_enabled = args[:acl_enabled] if args.key?(:acl_enabled)
15597
15841
  @advanced_site_search_config = args[:advanced_site_search_config] if args.key?(:advanced_site_search_config)
15598
15842
  @billing_estimation = args[:billing_estimation] if args.key?(:billing_estimation)
15599
15843
  @cmek_config = args[:cmek_config] if args.key?(:cmek_config)
@@ -18098,6 +18342,25 @@ module Google
18098
18342
  end
18099
18343
  end
18100
18344
 
18345
+ # Response message for CmekConfigService.ListCmekConfigs method.
18346
+ class GoogleCloudDiscoveryengineV1betaListCmekConfigsResponse
18347
+ include Google::Apis::Core::Hashable
18348
+
18349
+ # All the customer's CmekConfigs.
18350
+ # Corresponds to the JSON property `cmekConfigs`
18351
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCmekConfig>]
18352
+ attr_accessor :cmek_configs
18353
+
18354
+ def initialize(**args)
18355
+ update!(**args)
18356
+ end
18357
+
18358
+ # Update properties of this object
18359
+ def update!(**args)
18360
+ @cmek_configs = args[:cmek_configs] if args.key?(:cmek_configs)
18361
+ end
18362
+ end
18363
+
18101
18364
  # Response for ListControls method.
18102
18365
  class GoogleCloudDiscoveryengineV1betaListControlsResponse
18103
18366
  include Google::Apis::Core::Hashable
@@ -20275,10 +20538,10 @@ module Google
20275
20538
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec]
20276
20539
  attr_accessor :content_search_spec
20277
20540
 
20278
- # Specifications that define the specific [DataStore]s to be searched, along
20279
- # with configurations for those data stores. This is only considered for Engines
20280
- # with multiple data stores. For engines with a single data store, the specs
20281
- # directly under SearchRequest should be used.
20541
+ # Specifications that define the specific DataStores to be searched, along with
20542
+ # configurations for those data stores. This is only considered for Engines with
20543
+ # multiple data stores. For engines with a single data store, the specs directly
20544
+ # under SearchRequest should be used.
20282
20545
  # Corresponds to the JSON property `dataStoreSpecs`
20283
20546
  # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec>]
20284
20547
  attr_accessor :data_store_specs
@@ -20409,29 +20672,30 @@ module Google
20409
20672
  # This overrides ServingConfig.ranking_expression. The syntax and supported
20410
20673
  # features depend on the ranking_expression_backend value. If
20411
20674
  # ranking_expression_backend is not provided, it defaults to BYOE. === BYOE ===
20412
- # If ranking expression is not provided or set to BYOE, it should be a single
20413
- # function or multiple functions that are joined by "+". * ranking_expression =
20414
- # function, ` " + ", function `; Supported functions: * double * relevance_score
20415
- # * double * dotProduct(embedding_field_path) Function variables: * `
20416
- # relevance_score`: pre-defined keywords, used for measure relevance between
20417
- # query and document. * `embedding_field_path`: the document embedding field
20418
- # used with query embedding vector. * `dotProduct`: embedding function between
20419
- # embedding_field_path and query embedding vector. Example ranking expression:
20420
- # If document has an embedding field doc_embedding, the ranking expression could
20421
- # be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. === CLEARBOX ===
20422
- # If ranking expression is set to CLEARBOX, the following expression types (and
20423
- # combinations of those chained using + or * operators) are supported: * double *
20424
- # signal * log(signal) * exp(signal) * rr(signal, double > 0) -- reciprocal
20425
- # rank transformation with second argument being a denominator constant. *
20426
- # is_nan(signal) -- returns 0 if signal is NaN, 1 otherwise. * fill_nan(signal1,
20427
- # signal2 | double) -- if signal1 is NaN, returns signal2 | double, else returns
20428
- # signal1. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(
20429
- # fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score,
20430
- # 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: *
20431
- # gecko_score -- semantic similarity adjustment * bm25_score -- keyword match
20432
- # adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank --
20433
- # predicted conversion rate adjustment as a rank * freshness_rank -- freshness
20434
- # adjustment as a rank * base_rank -- the default rank of the result
20675
+ # If ranking_expression_backend is not provided or set to `BYOE`, it should be a
20676
+ # single function or multiple functions that are joined by "+". *
20677
+ # ranking_expression = function, ` " + ", function `; Supported functions: *
20678
+ # double * relevance_score * double * dotProduct(embedding_field_path) Function
20679
+ # variables: * `relevance_score`: pre-defined keywords, used for measure
20680
+ # relevance between query and document. * `embedding_field_path`: the document
20681
+ # embedding field used with query embedding vector. * `dotProduct`: embedding
20682
+ # function between embedding_field_path and query embedding vector. Example
20683
+ # ranking expression: If document has an embedding field doc_embedding, the
20684
+ # ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(
20685
+ # doc_embedding)`. === CLEARBOX === If ranking_expression_backend is set to `
20686
+ # CLEARBOX`, the following expression types (and combinations of those chained
20687
+ # using + or * operators) are supported: * double * signal * log(signal) * exp(
20688
+ # signal) * rr(signal, double > 0) -- reciprocal rank transformation with second
20689
+ # argument being a denominator constant. * is_nan(signal) -- returns 0 if signal
20690
+ # is NaN, 1 otherwise. * fill_nan(signal1, signal2 | double) -- if signal1 is
20691
+ # NaN, returns signal2 | double, else returns signal1. Examples: * 0.2 *
20692
+ # gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.
20693
+ # 3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32)
20694
+ # The following signals are supported: * gecko_score -- semantic similarity
20695
+ # adjustment * bm25_score -- keyword match adjustment * jetstream_score --
20696
+ # semantic relevance adjustment * pctr_rank -- predicted conversion rate
20697
+ # adjustment as a rank * freshness_rank -- freshness adjustment as a rank *
20698
+ # base_rank -- the default rank of the result
20435
20699
  # Corresponds to the JSON property `rankingExpression`
20436
20700
  # @return [String]
20437
20701
  attr_accessor :ranking_expression
@@ -20597,7 +20861,7 @@ module Google
20597
20861
  include Google::Apis::Core::Hashable
20598
20862
 
20599
20863
  # Condition boost specifications. If a document matches multiple conditions in
20600
- # the specifictions, boost scores from these specifications are all applied and
20864
+ # the specifications, boost scores from these specifications are all applied and
20601
20865
  # combined in a non-linear way. Maximum number of specifications is 20.
20602
20866
  # Corresponds to the JSON property `conditionBoostSpecs`
20603
20867
  # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec>]
@@ -20996,6 +21260,12 @@ module Google
20996
21260
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec]
20997
21261
  attr_accessor :model_spec
20998
21262
 
21263
+ # Multimodal specification: Will return an image from specified source. If
21264
+ # multiple sources are specified, the pick is a quality based decision.
21265
+ # Corresponds to the JSON property `multimodalSpec`
21266
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecMultiModalSpec]
21267
+ attr_accessor :multimodal_spec
21268
+
20999
21269
  # The number of top results to generate the summary from. If the number of
21000
21270
  # results returned is less than `summaryResultCount`, the summary is generated
21001
21271
  # from all of the results. At most 10 results for documents mode, or 50 for
@@ -21029,6 +21299,7 @@ module Google
21029
21299
  @language_code = args[:language_code] if args.key?(:language_code)
21030
21300
  @model_prompt_spec = args[:model_prompt_spec] if args.key?(:model_prompt_spec)
21031
21301
  @model_spec = args[:model_spec] if args.key?(:model_spec)
21302
+ @multimodal_spec = args[:multimodal_spec] if args.key?(:multimodal_spec)
21032
21303
  @summary_result_count = args[:summary_result_count] if args.key?(:summary_result_count)
21033
21304
  @use_semantic_chunks = args[:use_semantic_chunks] if args.key?(:use_semantic_chunks)
21034
21305
  end
@@ -21080,6 +21351,26 @@ module Google
21080
21351
  end
21081
21352
  end
21082
21353
 
21354
+ # Multimodal specification: Will return an image from specified source. If
21355
+ # multiple sources are specified, the pick is a quality based decision.
21356
+ class GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecMultiModalSpec
21357
+ include Google::Apis::Core::Hashable
21358
+
21359
+ # Optional. Source of image returned in the answer.
21360
+ # Corresponds to the JSON property `imageSource`
21361
+ # @return [String]
21362
+ attr_accessor :image_source
21363
+
21364
+ def initialize(**args)
21365
+ update!(**args)
21366
+ end
21367
+
21368
+ # Update properties of this object
21369
+ def update!(**args)
21370
+ @image_source = args[:image_source] if args.key?(:image_source)
21371
+ end
21372
+ end
21373
+
21083
21374
  # A struct to define data stores to filter on in a search call and
21084
21375
  # configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error
21085
21376
  # is returned.
@@ -22248,6 +22539,57 @@ module Google
22248
22539
  end
22249
22540
  end
22250
22541
 
22542
+ # Stores binarydata attached to text answer, e.g. image, video, audio, etc.
22543
+ class GoogleCloudDiscoveryengineV1betaSearchResponseSummaryBlobAttachment
22544
+ include Google::Apis::Core::Hashable
22545
+
22546
+ # Output only. The attribution type of the blob.
22547
+ # Corresponds to the JSON property `attributionType`
22548
+ # @return [String]
22549
+ attr_accessor :attribution_type
22550
+
22551
+ # Stores type and data of the blob.
22552
+ # Corresponds to the JSON property `data`
22553
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseSummaryBlobAttachmentBlob]
22554
+ attr_accessor :data
22555
+
22556
+ def initialize(**args)
22557
+ update!(**args)
22558
+ end
22559
+
22560
+ # Update properties of this object
22561
+ def update!(**args)
22562
+ @attribution_type = args[:attribution_type] if args.key?(:attribution_type)
22563
+ @data = args[:data] if args.key?(:data)
22564
+ end
22565
+ end
22566
+
22567
+ # Stores type and data of the blob.
22568
+ class GoogleCloudDiscoveryengineV1betaSearchResponseSummaryBlobAttachmentBlob
22569
+ include Google::Apis::Core::Hashable
22570
+
22571
+ # Output only. Raw bytes.
22572
+ # Corresponds to the JSON property `data`
22573
+ # NOTE: Values are automatically base64 encoded/decoded in the client library.
22574
+ # @return [String]
22575
+ attr_accessor :data
22576
+
22577
+ # Output only. The media type (MIME type) of the generated data.
22578
+ # Corresponds to the JSON property `mimeType`
22579
+ # @return [String]
22580
+ attr_accessor :mime_type
22581
+
22582
+ def initialize(**args)
22583
+ update!(**args)
22584
+ end
22585
+
22586
+ # Update properties of this object
22587
+ def update!(**args)
22588
+ @data = args[:data] if args.key?(:data)
22589
+ @mime_type = args[:mime_type] if args.key?(:mime_type)
22590
+ end
22591
+ end
22592
+
22251
22593
  # Citation info for a segment.
22252
22594
  class GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitation
22253
22595
  include Google::Apis::Core::Hashable
@@ -22361,6 +22703,11 @@ module Google
22361
22703
  class GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReferenceChunkContent
22362
22704
  include Google::Apis::Core::Hashable
22363
22705
 
22706
+ # Output only. Stores indexes of blobattachments linked to this chunk.
22707
+ # Corresponds to the JSON property `blobAttachmentIndexes`
22708
+ # @return [Array<Fixnum>]
22709
+ attr_accessor :blob_attachment_indexes
22710
+
22364
22711
  # Chunk textual content.
22365
22712
  # Corresponds to the JSON property `content`
22366
22713
  # @return [String]
@@ -22377,6 +22724,7 @@ module Google
22377
22724
 
22378
22725
  # Update properties of this object
22379
22726
  def update!(**args)
22727
+ @blob_attachment_indexes = args[:blob_attachment_indexes] if args.key?(:blob_attachment_indexes)
22380
22728
  @content = args[:content] if args.key?(:content)
22381
22729
  @page_identifier = args[:page_identifier] if args.key?(:page_identifier)
22382
22730
  end
@@ -22413,6 +22761,11 @@ module Google
22413
22761
  class GoogleCloudDiscoveryengineV1betaSearchResponseSummarySummaryWithMetadata
22414
22762
  include Google::Apis::Core::Hashable
22415
22763
 
22764
+ # Output only. Store multimodal data for answer enhancement.
22765
+ # Corresponds to the JSON property `blobAttachments`
22766
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseSummaryBlobAttachment>]
22767
+ attr_accessor :blob_attachments
22768
+
22416
22769
  # Citation metadata.
22417
22770
  # Corresponds to the JSON property `citationMetadata`
22418
22771
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationMetadata]
@@ -22434,6 +22787,7 @@ module Google
22434
22787
 
22435
22788
  # Update properties of this object
22436
22789
  def update!(**args)
22790
+ @blob_attachments = args[:blob_attachments] if args.key?(:blob_attachments)
22437
22791
  @citation_metadata = args[:citation_metadata] if args.key?(:citation_metadata)
22438
22792
  @references = args[:references] if args.key?(:references)
22439
22793
  @summary = args[:summary] if args.key?(:summary)