google-apis-discoveryengine_v1 0.29.0 → 0.31.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.
@@ -1406,6 +1406,12 @@ module Google
1406
1406
  class GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpec
1407
1407
  include Google::Apis::Core::Hashable
1408
1408
 
1409
+ # Optional. Whether to disable spell correction. The default value is `false`.
1410
+ # Corresponds to the JSON property `disableSpellCorrection`
1411
+ # @return [Boolean]
1412
+ attr_accessor :disable_spell_correction
1413
+ alias_method :disable_spell_correction?, :disable_spell_correction
1414
+
1409
1415
  # Query classification specification.
1410
1416
  # Corresponds to the JSON property `queryClassificationSpec`
1411
1417
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec]
@@ -1422,6 +1428,7 @@ module Google
1422
1428
 
1423
1429
  # Update properties of this object
1424
1430
  def update!(**args)
1431
+ @disable_spell_correction = args[:disable_spell_correction] if args.key?(:disable_spell_correction)
1425
1432
  @query_classification_spec = args[:query_classification_spec] if args.key?(:query_classification_spec)
1426
1433
  @query_rephraser_spec = args[:query_rephraser_spec] if args.key?(:query_rephraser_spec)
1427
1434
  end
@@ -3254,6 +3261,11 @@ module Google
3254
3261
  # @return [String]
3255
3262
  attr_accessor :name
3256
3263
 
3264
+ # Output only. Whether the NotebookLM Corpus is ready to be used.
3265
+ # Corresponds to the JSON property `notebooklmState`
3266
+ # @return [String]
3267
+ attr_accessor :notebooklm_state
3268
+
3257
3269
  # Optional. Single-regional CMEKs that are required for some VAIS features.
3258
3270
  # Corresponds to the JSON property `singleRegionKeys`
3259
3271
  # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SingleRegionKey>]
@@ -3275,6 +3287,7 @@ module Google
3275
3287
  @kms_key_version = args[:kms_key_version] if args.key?(:kms_key_version)
3276
3288
  @last_rotation_timestamp_micros = args[:last_rotation_timestamp_micros] if args.key?(:last_rotation_timestamp_micros)
3277
3289
  @name = args[:name] if args.key?(:name)
3290
+ @notebooklm_state = args[:notebooklm_state] if args.key?(:notebooklm_state)
3278
3291
  @single_region_keys = args[:single_region_keys] if args.key?(:single_region_keys)
3279
3292
  @state = args[:state] if args.key?(:state)
3280
3293
  end
@@ -4326,6 +4339,17 @@ module Google
4326
4339
  class GoogleCloudDiscoveryengineV1DataStore
4327
4340
  include Google::Apis::Core::Hashable
4328
4341
 
4342
+ # Immutable. Whether data in the DataStore has ACL information. If set to `true`,
4343
+ # the source data must have ACL. ACL will be ingested when data is ingested by
4344
+ # DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore,
4345
+ # Document can't be accessed by calling DocumentService.GetDocument or
4346
+ # DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC`
4347
+ # industry vertical with non-`PUBLIC_WEBSITE` content config.
4348
+ # Corresponds to the JSON property `aclEnabled`
4349
+ # @return [Boolean]
4350
+ attr_accessor :acl_enabled
4351
+ alias_method :acl_enabled?, :acl_enabled
4352
+
4329
4353
  # Configuration data for advance site search.
4330
4354
  # Corresponds to the JSON property `advancedSiteSearchConfig`
4331
4355
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig]
@@ -4440,6 +4464,7 @@ module Google
4440
4464
 
4441
4465
  # Update properties of this object
4442
4466
  def update!(**args)
4467
+ @acl_enabled = args[:acl_enabled] if args.key?(:acl_enabled)
4443
4468
  @advanced_site_search_config = args[:advanced_site_search_config] if args.key?(:advanced_site_search_config)
4444
4469
  @billing_estimation = args[:billing_estimation] if args.key?(:billing_estimation)
4445
4470
  @cmek_config = args[:cmek_config] if args.key?(:cmek_config)
@@ -6628,6 +6653,25 @@ module Google
6628
6653
  end
6629
6654
  end
6630
6655
 
6656
+ # Response message for CmekConfigService.ListCmekConfigs method.
6657
+ class GoogleCloudDiscoveryengineV1ListCmekConfigsResponse
6658
+ include Google::Apis::Core::Hashable
6659
+
6660
+ # All the customer's CmekConfigs.
6661
+ # Corresponds to the JSON property `cmekConfigs`
6662
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CmekConfig>]
6663
+ attr_accessor :cmek_configs
6664
+
6665
+ def initialize(**args)
6666
+ update!(**args)
6667
+ end
6668
+
6669
+ # Update properties of this object
6670
+ def update!(**args)
6671
+ @cmek_configs = args[:cmek_configs] if args.key?(:cmek_configs)
6672
+ end
6673
+ end
6674
+
6631
6675
  # Response for ListControls method.
6632
6676
  class GoogleCloudDiscoveryengineV1ListControlsResponse
6633
6677
  include Google::Apis::Core::Hashable
@@ -8093,7 +8137,8 @@ module Google
8093
8137
  # @return [String]
8094
8138
  attr_accessor :title
8095
8139
 
8096
- # Required. The URL for the page the user wants to promote.
8140
+ # Optional. The URL for the page the user wants to promote. Must be set for site
8141
+ # search. For other verticals, this is optional.
8097
8142
  # Corresponds to the JSON property `uri`
8098
8143
  # @return [String]
8099
8144
  attr_accessor :uri
@@ -8146,14 +8191,19 @@ module Google
8146
8191
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec]
8147
8192
  attr_accessor :content_search_spec
8148
8193
 
8149
- # Specifications that define the specific [DataStore]s to be searched, along
8150
- # with configurations for those data stores. This is only considered for Engines
8151
- # with multiple data stores. For engines with a single data store, the specs
8152
- # directly under SearchRequest should be used.
8194
+ # Specifications that define the specific DataStores to be searched, along with
8195
+ # configurations for those data stores. This is only considered for Engines with
8196
+ # multiple data stores. For engines with a single data store, the specs directly
8197
+ # under SearchRequest should be used.
8153
8198
  # Corresponds to the JSON property `dataStoreSpecs`
8154
8199
  # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec>]
8155
8200
  attr_accessor :data_store_specs
8156
8201
 
8202
+ # Specifies features for display, like match highlighting.
8203
+ # Corresponds to the JSON property `displaySpec`
8204
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestDisplaySpec]
8205
+ attr_accessor :display_spec
8206
+
8157
8207
  # Facet specifications for faceted search. If empty, no facets are returned. A
8158
8208
  # maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is
8159
8209
  # returned.
@@ -8354,6 +8404,7 @@ module Google
8354
8404
  @canonical_filter = args[:canonical_filter] if args.key?(:canonical_filter)
8355
8405
  @content_search_spec = args[:content_search_spec] if args.key?(:content_search_spec)
8356
8406
  @data_store_specs = args[:data_store_specs] if args.key?(:data_store_specs)
8407
+ @display_spec = args[:display_spec] if args.key?(:display_spec)
8357
8408
  @facet_specs = args[:facet_specs] if args.key?(:facet_specs)
8358
8409
  @filter = args[:filter] if args.key?(:filter)
8359
8410
  @image_query = args[:image_query] if args.key?(:image_query)
@@ -8384,7 +8435,7 @@ module Google
8384
8435
  include Google::Apis::Core::Hashable
8385
8436
 
8386
8437
  # Condition boost specifications. If a document matches multiple conditions in
8387
- # the specifictions, boost scores from these specifications are all applied and
8438
+ # the specifications, boost scores from these specifications are all applied and
8388
8439
  # combined in a non-linear way. Maximum number of specifications is 20.
8389
8440
  # Corresponds to the JSON property `conditionBoostSpecs`
8390
8441
  # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpec>]
@@ -8903,6 +8954,25 @@ module Google
8903
8954
  end
8904
8955
  end
8905
8956
 
8957
+ # Specifies features for display, like match highlighting.
8958
+ class GoogleCloudDiscoveryengineV1SearchRequestDisplaySpec
8959
+ include Google::Apis::Core::Hashable
8960
+
8961
+ # The condition under which match highlighting should occur.
8962
+ # Corresponds to the JSON property `matchHighlightingCondition`
8963
+ # @return [String]
8964
+ attr_accessor :match_highlighting_condition
8965
+
8966
+ def initialize(**args)
8967
+ update!(**args)
8968
+ end
8969
+
8970
+ # Update properties of this object
8971
+ def update!(**args)
8972
+ @match_highlighting_condition = args[:match_highlighting_condition] if args.key?(:match_highlighting_condition)
8973
+ end
8974
+ end
8975
+
8906
8976
  # A facet specification to perform faceted search.
8907
8977
  class GoogleCloudDiscoveryengineV1SearchRequestFacetSpec
8908
8978
  include Google::Apis::Core::Hashable
@@ -11028,6 +11098,14 @@ module Google
11028
11098
  attr_accessor :is_action_configured
11029
11099
  alias_method :is_action_configured?, :is_action_configured
11030
11100
 
11101
+ # Optional. The Service Directory resource name (projects/*/locations/*/
11102
+ # namespaces/*/services/*) representing a VPC network endpoint used to connect
11103
+ # to the data source's `instance_uri`, defined in DataConnector.params. Required
11104
+ # when VPC Service Controls are enabled.
11105
+ # Corresponds to the JSON property `serviceName`
11106
+ # @return [String]
11107
+ attr_accessor :service_name
11108
+
11031
11109
  def initialize(**args)
11032
11110
  update!(**args)
11033
11111
  end
@@ -11036,6 +11114,7 @@ module Google
11036
11114
  def update!(**args)
11037
11115
  @action_params = args[:action_params] if args.key?(:action_params)
11038
11116
  @is_action_configured = args[:is_action_configured] if args.key?(:is_action_configured)
11117
+ @service_name = args[:service_name] if args.key?(:service_name)
11039
11118
  end
11040
11119
  end
11041
11120
 
@@ -11066,6 +11145,56 @@ module Google
11066
11145
  end
11067
11146
  end
11068
11147
 
11148
+ # The connector level alert config.
11149
+ class GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig
11150
+ include Google::Apis::Core::Hashable
11151
+
11152
+ # Optional. The enrollment states of each alert.
11153
+ # Corresponds to the JSON property `alertEnrollments`
11154
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment>]
11155
+ attr_accessor :alert_enrollments
11156
+
11157
+ # Immutable. The fully qualified resource name of the AlertPolicy.
11158
+ # Corresponds to the JSON property `alertPolicyName`
11159
+ # @return [String]
11160
+ attr_accessor :alert_policy_name
11161
+
11162
+ def initialize(**args)
11163
+ update!(**args)
11164
+ end
11165
+
11166
+ # Update properties of this object
11167
+ def update!(**args)
11168
+ @alert_enrollments = args[:alert_enrollments] if args.key?(:alert_enrollments)
11169
+ @alert_policy_name = args[:alert_policy_name] if args.key?(:alert_policy_name)
11170
+ end
11171
+ end
11172
+
11173
+ # The alert enrollment status.
11174
+ class GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment
11175
+ include Google::Apis::Core::Hashable
11176
+
11177
+ # Immutable. The id of an alert.
11178
+ # Corresponds to the JSON property `alertId`
11179
+ # @return [String]
11180
+ attr_accessor :alert_id
11181
+
11182
+ # Required. The enrollment status of a customer.
11183
+ # Corresponds to the JSON property `enrollState`
11184
+ # @return [String]
11185
+ attr_accessor :enroll_state
11186
+
11187
+ def initialize(**args)
11188
+ update!(**args)
11189
+ end
11190
+
11191
+ # Update properties of this object
11192
+ def update!(**args)
11193
+ @alert_id = args[:alert_id] if args.key?(:alert_id)
11194
+ @enroll_state = args[:enroll_state] if args.key?(:enroll_state)
11195
+ end
11196
+ end
11197
+
11069
11198
  # Defines an answer.
11070
11199
  class GoogleCloudDiscoveryengineV1alphaAnswer
11071
11200
  include Google::Apis::Core::Hashable
@@ -11081,6 +11210,11 @@ module Google
11081
11210
  # @return [String]
11082
11211
  attr_accessor :answer_text
11083
11212
 
11213
+ # List of blob attachments in the answer.
11214
+ # Corresponds to the JSON property `blobAttachments`
11215
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachment>]
11216
+ attr_accessor :blob_attachments
11217
+
11084
11218
  # Citations.
11085
11219
  # Corresponds to the JSON property `citations`
11086
11220
  # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaAnswerCitation>]
@@ -11151,6 +11285,7 @@ module Google
11151
11285
  def update!(**args)
11152
11286
  @answer_skipped_reasons = args[:answer_skipped_reasons] if args.key?(:answer_skipped_reasons)
11153
11287
  @answer_text = args[:answer_text] if args.key?(:answer_text)
11288
+ @blob_attachments = args[:blob_attachments] if args.key?(:blob_attachments)
11154
11289
  @citations = args[:citations] if args.key?(:citations)
11155
11290
  @complete_time = args[:complete_time] if args.key?(:complete_time)
11156
11291
  @create_time = args[:create_time] if args.key?(:create_time)
@@ -11166,6 +11301,57 @@ module Google
11166
11301
  end
11167
11302
  end
11168
11303
 
11304
+ # Stores binarydata attached to text answer, e.g. image, video, audio, etc.
11305
+ class GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachment
11306
+ include Google::Apis::Core::Hashable
11307
+
11308
+ # Output only. The attribution type of the blob.
11309
+ # Corresponds to the JSON property `attributionType`
11310
+ # @return [String]
11311
+ attr_accessor :attribution_type
11312
+
11313
+ # The media type and data of the blob.
11314
+ # Corresponds to the JSON property `data`
11315
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachmentBlob]
11316
+ attr_accessor :data
11317
+
11318
+ def initialize(**args)
11319
+ update!(**args)
11320
+ end
11321
+
11322
+ # Update properties of this object
11323
+ def update!(**args)
11324
+ @attribution_type = args[:attribution_type] if args.key?(:attribution_type)
11325
+ @data = args[:data] if args.key?(:data)
11326
+ end
11327
+ end
11328
+
11329
+ # The media type and data of the blob.
11330
+ class GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachmentBlob
11331
+ include Google::Apis::Core::Hashable
11332
+
11333
+ # Output only. Raw bytes.
11334
+ # Corresponds to the JSON property `data`
11335
+ # NOTE: Values are automatically base64 encoded/decoded in the client library.
11336
+ # @return [String]
11337
+ attr_accessor :data
11338
+
11339
+ # Output only. The media type (MIME type) of the generated or retrieved data.
11340
+ # Corresponds to the JSON property `mimeType`
11341
+ # @return [String]
11342
+ attr_accessor :mime_type
11343
+
11344
+ def initialize(**args)
11345
+ update!(**args)
11346
+ end
11347
+
11348
+ # Update properties of this object
11349
+ def update!(**args)
11350
+ @data = args[:data] if args.key?(:data)
11351
+ @mime_type = args[:mime_type] if args.key?(:mime_type)
11352
+ end
11353
+ end
11354
+
11169
11355
  # Citation info for a segment.
11170
11356
  class GoogleCloudDiscoveryengineV1alphaAnswerCitation
11171
11357
  include Google::Apis::Core::Hashable
@@ -11350,6 +11536,11 @@ module Google
11350
11536
  class GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo
11351
11537
  include Google::Apis::Core::Hashable
11352
11538
 
11539
+ # Output only. Stores indexes of blobattachments linked to this chunk.
11540
+ # Corresponds to the JSON property `blobAttachmentIndexes`
11541
+ # @return [Array<Fixnum>]
11542
+ attr_accessor :blob_attachment_indexes
11543
+
11353
11544
  # Chunk resource name.
11354
11545
  # Corresponds to the JSON property `chunk`
11355
11546
  # @return [String]
@@ -11379,6 +11570,7 @@ module Google
11379
11570
 
11380
11571
  # Update properties of this object
11381
11572
  def update!(**args)
11573
+ @blob_attachment_indexes = args[:blob_attachment_indexes] if args.key?(:blob_attachment_indexes)
11382
11574
  @chunk = args[:chunk] if args.key?(:chunk)
11383
11575
  @content = args[:content] if args.key?(:content)
11384
11576
  @document_metadata = args[:document_metadata] if args.key?(:document_metadata)
@@ -11515,6 +11707,11 @@ module Google
11515
11707
  class GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent
11516
11708
  include Google::Apis::Core::Hashable
11517
11709
 
11710
+ # Output only. Stores indexes of blobattachments linked to this chunk.
11711
+ # Corresponds to the JSON property `blobAttachmentIndexes`
11712
+ # @return [Array<Fixnum>]
11713
+ attr_accessor :blob_attachment_indexes
11714
+
11518
11715
  # Chunk textual content.
11519
11716
  # Corresponds to the JSON property `content`
11520
11717
  # @return [String]
@@ -11539,6 +11736,7 @@ module Google
11539
11736
 
11540
11737
  # Update properties of this object
11541
11738
  def update!(**args)
11739
+ @blob_attachment_indexes = args[:blob_attachment_indexes] if args.key?(:blob_attachment_indexes)
11542
11740
  @content = args[:content] if args.key?(:content)
11543
11741
  @page_identifier = args[:page_identifier] if args.key?(:page_identifier)
11544
11742
  @relevance_score = args[:relevance_score] if args.key?(:relevance_score)
@@ -11856,6 +12054,11 @@ module Google
11856
12054
  # @return [String]
11857
12055
  attr_accessor :name
11858
12056
 
12057
+ # Output only. Whether the NotebookLM Corpus is ready to be used.
12058
+ # Corresponds to the JSON property `notebooklmState`
12059
+ # @return [String]
12060
+ attr_accessor :notebooklm_state
12061
+
11859
12062
  # Optional. Single-regional CMEKs that are required for some VAIS features.
11860
12063
  # Corresponds to the JSON property `singleRegionKeys`
11861
12064
  # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaSingleRegionKey>]
@@ -11877,6 +12080,7 @@ module Google
11877
12080
  @kms_key_version = args[:kms_key_version] if args.key?(:kms_key_version)
11878
12081
  @last_rotation_timestamp_micros = args[:last_rotation_timestamp_micros] if args.key?(:last_rotation_timestamp_micros)
11879
12082
  @name = args[:name] if args.key?(:name)
12083
+ @notebooklm_state = args[:notebooklm_state] if args.key?(:notebooklm_state)
11880
12084
  @single_region_keys = args[:single_region_keys] if args.key?(:single_region_keys)
11881
12085
  @state = args[:state] if args.key?(:state)
11882
12086
  end
@@ -12741,6 +12945,11 @@ module Google
12741
12945
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaActionConfig]
12742
12946
  attr_accessor :action_config
12743
12947
 
12948
+ # Optional. The connector level alert config.
12949
+ # Corresponds to the JSON property `alertPolicyConfigs`
12950
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig>]
12951
+ attr_accessor :alert_policy_configs
12952
+
12744
12953
  # Indicates whether the connector is disabled for auto run. It can be used to
12745
12954
  # pause periodical and real time sync.
12746
12955
  # Corresponds to the JSON property `autoRunDisabled`
@@ -12930,6 +13139,7 @@ module Google
12930
13139
  # Update properties of this object
12931
13140
  def update!(**args)
12932
13141
  @action_config = args[:action_config] if args.key?(:action_config)
13142
+ @alert_policy_configs = args[:alert_policy_configs] if args.key?(:alert_policy_configs)
12933
13143
  @auto_run_disabled = args[:auto_run_disabled] if args.key?(:auto_run_disabled)
12934
13144
  @bap_config = args[:bap_config] if args.key?(:bap_config)
12935
13145
  @blocking_reasons = args[:blocking_reasons] if args.key?(:blocking_reasons)
@@ -16210,7 +16420,8 @@ module Google
16210
16420
  # @return [String]
16211
16421
  attr_accessor :title
16212
16422
 
16213
- # Required. The URL for the page the user wants to promote.
16423
+ # Optional. The URL for the page the user wants to promote. Must be set for site
16424
+ # search. For other verticals, this is optional.
16214
16425
  # Corresponds to the JSON property `uri`
16215
16426
  # @return [String]
16216
16427
  attr_accessor :uri
@@ -16268,10 +16479,10 @@ module Google
16268
16479
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec]
16269
16480
  attr_accessor :custom_fine_tuning_spec
16270
16481
 
16271
- # Specifications that define the specific [DataStore]s to be searched, along
16272
- # with configurations for those data stores. This is only considered for Engines
16273
- # with multiple data stores. For engines with a single data store, the specs
16274
- # directly under SearchRequest should be used.
16482
+ # Specifications that define the specific DataStores to be searched, along with
16483
+ # configurations for those data stores. This is only considered for Engines with
16484
+ # multiple data stores. For engines with a single data store, the specs directly
16485
+ # under SearchRequest should be used.
16275
16486
  # Corresponds to the JSON property `dataStoreSpecs`
16276
16487
  # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec>]
16277
16488
  attr_accessor :data_store_specs
@@ -16402,29 +16613,30 @@ module Google
16402
16613
  # This overrides ServingConfig.ranking_expression. The syntax and supported
16403
16614
  # features depend on the ranking_expression_backend value. If
16404
16615
  # ranking_expression_backend is not provided, it defaults to BYOE. === BYOE ===
16405
- # If ranking expression is not provided or set to BYOE, it should be a single
16406
- # function or multiple functions that are joined by "+". * ranking_expression =
16407
- # function, ` " + ", function `; Supported functions: * double * relevance_score
16408
- # * double * dotProduct(embedding_field_path) Function variables: * `
16409
- # relevance_score`: pre-defined keywords, used for measure relevance between
16410
- # query and document. * `embedding_field_path`: the document embedding field
16411
- # used with query embedding vector. * `dotProduct`: embedding function between
16412
- # embedding_field_path and query embedding vector. Example ranking expression:
16413
- # If document has an embedding field doc_embedding, the ranking expression could
16414
- # be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. === CLEARBOX ===
16415
- # If ranking expression is set to CLEARBOX, the following expression types (and
16416
- # combinations of those chained using + or * operators) are supported: * double *
16417
- # signal * log(signal) * exp(signal) * rr(signal, double > 0) -- reciprocal
16418
- # rank transformation with second argument being a denominator constant. *
16419
- # is_nan(signal) -- returns 0 if signal is NaN, 1 otherwise. * fill_nan(signal1,
16420
- # signal2 | double) -- if signal1 is NaN, returns signal2 | double, else returns
16421
- # signal1. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(
16422
- # fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score,
16423
- # 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: *
16424
- # gecko_score -- semantic similarity adjustment * bm25_score -- keyword match
16425
- # adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank --
16426
- # predicted conversion rate adjustment as a rank * freshness_rank -- freshness
16427
- # adjustment as a rank * base_rank -- the default rank of the result
16616
+ # If ranking_expression_backend is not provided or set to `BYOE`, it should be a
16617
+ # single function or multiple functions that are joined by "+". *
16618
+ # ranking_expression = function, ` " + ", function `; Supported functions: *
16619
+ # double * relevance_score * double * dotProduct(embedding_field_path) Function
16620
+ # variables: * `relevance_score`: pre-defined keywords, used for measure
16621
+ # relevance between query and document. * `embedding_field_path`: the document
16622
+ # embedding field used with query embedding vector. * `dotProduct`: embedding
16623
+ # function between embedding_field_path and query embedding vector. Example
16624
+ # ranking expression: If document has an embedding field doc_embedding, the
16625
+ # ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(
16626
+ # doc_embedding)`. === CLEARBOX === If ranking_expression_backend is set to `
16627
+ # CLEARBOX`, the following expression types (and combinations of those chained
16628
+ # using + or * operators) are supported: * double * signal * log(signal) * exp(
16629
+ # signal) * rr(signal, double > 0) -- reciprocal rank transformation with second
16630
+ # argument being a denominator constant. * is_nan(signal) -- returns 0 if signal
16631
+ # is NaN, 1 otherwise. * fill_nan(signal1, signal2 | double) -- if signal1 is
16632
+ # NaN, returns signal2 | double, else returns signal1. Examples: * 0.2 *
16633
+ # gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.
16634
+ # 3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32)
16635
+ # The following signals are supported: * gecko_score -- semantic similarity
16636
+ # adjustment * bm25_score -- keyword match adjustment * jetstream_score --
16637
+ # semantic relevance adjustment * pctr_rank -- predicted conversion rate
16638
+ # adjustment as a rank * freshness_rank -- freshness adjustment as a rank *
16639
+ # base_rank -- the default rank of the result
16428
16640
  # Corresponds to the JSON property `rankingExpression`
16429
16641
  # @return [String]
16430
16642
  attr_accessor :ranking_expression
@@ -16591,7 +16803,7 @@ module Google
16591
16803
  include Google::Apis::Core::Hashable
16592
16804
 
16593
16805
  # Condition boost specifications. If a document matches multiple conditions in
16594
- # the specifictions, boost scores from these specifications are all applied and
16806
+ # the specifications, boost scores from these specifications are all applied and
16595
16807
  # combined in a non-linear way. Maximum number of specifications is 20.
16596
16808
  # Corresponds to the JSON property `conditionBoostSpecs`
16597
16809
  # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec>]
@@ -16990,6 +17202,12 @@ module Google
16990
17202
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec]
16991
17203
  attr_accessor :model_spec
16992
17204
 
17205
+ # Multimodal specification: Will return an image from specified source. If
17206
+ # multiple sources are specified, the pick is a quality based decision.
17207
+ # Corresponds to the JSON property `multimodalSpec`
17208
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecMultiModalSpec]
17209
+ attr_accessor :multimodal_spec
17210
+
16993
17211
  # The number of top results to generate the summary from. If the number of
16994
17212
  # results returned is less than `summaryResultCount`, the summary is generated
16995
17213
  # from all of the results. At most 10 results for documents mode, or 50 for
@@ -17023,6 +17241,7 @@ module Google
17023
17241
  @language_code = args[:language_code] if args.key?(:language_code)
17024
17242
  @model_prompt_spec = args[:model_prompt_spec] if args.key?(:model_prompt_spec)
17025
17243
  @model_spec = args[:model_spec] if args.key?(:model_spec)
17244
+ @multimodal_spec = args[:multimodal_spec] if args.key?(:multimodal_spec)
17026
17245
  @summary_result_count = args[:summary_result_count] if args.key?(:summary_result_count)
17027
17246
  @use_semantic_chunks = args[:use_semantic_chunks] if args.key?(:use_semantic_chunks)
17028
17247
  end
@@ -17074,6 +17293,26 @@ module Google
17074
17293
  end
17075
17294
  end
17076
17295
 
17296
+ # Multimodal specification: Will return an image from specified source. If
17297
+ # multiple sources are specified, the pick is a quality based decision.
17298
+ class GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecMultiModalSpec
17299
+ include Google::Apis::Core::Hashable
17300
+
17301
+ # Optional. Source of image returned in the answer.
17302
+ # Corresponds to the JSON property `imageSource`
17303
+ # @return [String]
17304
+ attr_accessor :image_source
17305
+
17306
+ def initialize(**args)
17307
+ update!(**args)
17308
+ end
17309
+
17310
+ # Update properties of this object
17311
+ def update!(**args)
17312
+ @image_source = args[:image_source] if args.key?(:image_source)
17313
+ end
17314
+ end
17315
+
17077
17316
  # A struct to define data stores to filter on in a search call and
17078
17317
  # configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error
17079
17318
  # is returned.
@@ -18367,6 +18606,11 @@ module Google
18367
18606
  # @return [String]
18368
18607
  attr_accessor :name
18369
18608
 
18609
+ # Output only. Whether the NotebookLM Corpus is ready to be used.
18610
+ # Corresponds to the JSON property `notebooklmState`
18611
+ # @return [String]
18612
+ attr_accessor :notebooklm_state
18613
+
18370
18614
  # Optional. Single-regional CMEKs that are required for some VAIS features.
18371
18615
  # Corresponds to the JSON property `singleRegionKeys`
18372
18616
  # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaSingleRegionKey>]
@@ -18388,6 +18632,7 @@ module Google
18388
18632
  @kms_key_version = args[:kms_key_version] if args.key?(:kms_key_version)
18389
18633
  @last_rotation_timestamp_micros = args[:last_rotation_timestamp_micros] if args.key?(:last_rotation_timestamp_micros)
18390
18634
  @name = args[:name] if args.key?(:name)
18635
+ @notebooklm_state = args[:notebooklm_state] if args.key?(:notebooklm_state)
18391
18636
  @single_region_keys = args[:single_region_keys] if args.key?(:single_region_keys)
18392
18637
  @state = args[:state] if args.key?(:state)
18393
18638
  end
@@ -18981,6 +19226,17 @@ module Google
18981
19226
  class GoogleCloudDiscoveryengineV1betaDataStore
18982
19227
  include Google::Apis::Core::Hashable
18983
19228
 
19229
+ # Immutable. Whether data in the DataStore has ACL information. If set to `true`,
19230
+ # the source data must have ACL. ACL will be ingested when data is ingested by
19231
+ # DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore,
19232
+ # Document can't be accessed by calling DocumentService.GetDocument or
19233
+ # DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC`
19234
+ # industry vertical with non-`PUBLIC_WEBSITE` content config.
19235
+ # Corresponds to the JSON property `aclEnabled`
19236
+ # @return [Boolean]
19237
+ attr_accessor :acl_enabled
19238
+ alias_method :acl_enabled?, :acl_enabled
19239
+
18984
19240
  # Configuration data for advance site search.
18985
19241
  # Corresponds to the JSON property `advancedSiteSearchConfig`
18986
19242
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig]
@@ -19105,6 +19361,7 @@ module Google
19105
19361
 
19106
19362
  # Update properties of this object
19107
19363
  def update!(**args)
19364
+ @acl_enabled = args[:acl_enabled] if args.key?(:acl_enabled)
19108
19365
  @advanced_site_search_config = args[:advanced_site_search_config] if args.key?(:advanced_site_search_config)
19109
19366
  @billing_estimation = args[:billing_estimation] if args.key?(:billing_estimation)
19110
19367
  @cmek_config = args[:cmek_config] if args.key?(:cmek_config)
@@ -21095,7 +21352,8 @@ module Google
21095
21352
  # @return [String]
21096
21353
  attr_accessor :title
21097
21354
 
21098
- # Required. The URL for the page the user wants to promote.
21355
+ # Optional. The URL for the page the user wants to promote. Must be set for site
21356
+ # search. For other verticals, this is optional.
21099
21357
  # Corresponds to the JSON property `uri`
21100
21358
  # @return [String]
21101
21359
  attr_accessor :uri
@@ -21148,14 +21406,19 @@ module Google
21148
21406
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec]
21149
21407
  attr_accessor :content_search_spec
21150
21408
 
21151
- # Specifications that define the specific [DataStore]s to be searched, along
21152
- # with configurations for those data stores. This is only considered for Engines
21153
- # with multiple data stores. For engines with a single data store, the specs
21154
- # directly under SearchRequest should be used.
21409
+ # Specifications that define the specific DataStores to be searched, along with
21410
+ # configurations for those data stores. This is only considered for Engines with
21411
+ # multiple data stores. For engines with a single data store, the specs directly
21412
+ # under SearchRequest should be used.
21155
21413
  # Corresponds to the JSON property `dataStoreSpecs`
21156
21414
  # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec>]
21157
21415
  attr_accessor :data_store_specs
21158
21416
 
21417
+ # Specifies features for display, like match highlighting.
21418
+ # Corresponds to the JSON property `displaySpec`
21419
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec]
21420
+ attr_accessor :display_spec
21421
+
21159
21422
  # The specification that uses customized query embedding vector to do semantic
21160
21423
  # document retrieval.
21161
21424
  # Corresponds to the JSON property `embeddingSpec`
@@ -21277,29 +21540,30 @@ module Google
21277
21540
  # This overrides ServingConfig.ranking_expression. The syntax and supported
21278
21541
  # features depend on the ranking_expression_backend value. If
21279
21542
  # ranking_expression_backend is not provided, it defaults to BYOE. === BYOE ===
21280
- # If ranking expression is not provided or set to BYOE, it should be a single
21281
- # function or multiple functions that are joined by "+". * ranking_expression =
21282
- # function, ` " + ", function `; Supported functions: * double * relevance_score
21283
- # * double * dotProduct(embedding_field_path) Function variables: * `
21284
- # relevance_score`: pre-defined keywords, used for measure relevance between
21285
- # query and document. * `embedding_field_path`: the document embedding field
21286
- # used with query embedding vector. * `dotProduct`: embedding function between
21287
- # embedding_field_path and query embedding vector. Example ranking expression:
21288
- # If document has an embedding field doc_embedding, the ranking expression could
21289
- # be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. === CLEARBOX ===
21290
- # If ranking expression is set to CLEARBOX, the following expression types (and
21291
- # combinations of those chained using + or * operators) are supported: * double *
21292
- # signal * log(signal) * exp(signal) * rr(signal, double > 0) -- reciprocal
21293
- # rank transformation with second argument being a denominator constant. *
21294
- # is_nan(signal) -- returns 0 if signal is NaN, 1 otherwise. * fill_nan(signal1,
21295
- # signal2 | double) -- if signal1 is NaN, returns signal2 | double, else returns
21296
- # signal1. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(
21297
- # fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score,
21298
- # 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: *
21299
- # gecko_score -- semantic similarity adjustment * bm25_score -- keyword match
21300
- # adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank --
21301
- # predicted conversion rate adjustment as a rank * freshness_rank -- freshness
21302
- # adjustment as a rank * base_rank -- the default rank of the result
21543
+ # If ranking_expression_backend is not provided or set to `BYOE`, it should be a
21544
+ # single function or multiple functions that are joined by "+". *
21545
+ # ranking_expression = function, ` " + ", function `; Supported functions: *
21546
+ # double * relevance_score * double * dotProduct(embedding_field_path) Function
21547
+ # variables: * `relevance_score`: pre-defined keywords, used for measure
21548
+ # relevance between query and document. * `embedding_field_path`: the document
21549
+ # embedding field used with query embedding vector. * `dotProduct`: embedding
21550
+ # function between embedding_field_path and query embedding vector. Example
21551
+ # ranking expression: If document has an embedding field doc_embedding, the
21552
+ # ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(
21553
+ # doc_embedding)`. === CLEARBOX === If ranking_expression_backend is set to `
21554
+ # CLEARBOX`, the following expression types (and combinations of those chained
21555
+ # using + or * operators) are supported: * double * signal * log(signal) * exp(
21556
+ # signal) * rr(signal, double > 0) -- reciprocal rank transformation with second
21557
+ # argument being a denominator constant. * is_nan(signal) -- returns 0 if signal
21558
+ # is NaN, 1 otherwise. * fill_nan(signal1, signal2 | double) -- if signal1 is
21559
+ # NaN, returns signal2 | double, else returns signal1. Examples: * 0.2 *
21560
+ # gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.
21561
+ # 3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32)
21562
+ # The following signals are supported: * gecko_score -- semantic similarity
21563
+ # adjustment * bm25_score -- keyword match adjustment * jetstream_score --
21564
+ # semantic relevance adjustment * pctr_rank -- predicted conversion rate
21565
+ # adjustment as a rank * freshness_rank -- freshness adjustment as a rank *
21566
+ # base_rank -- the default rank of the result
21303
21567
  # Corresponds to the JSON property `rankingExpression`
21304
21568
  # @return [String]
21305
21569
  attr_accessor :ranking_expression
@@ -21427,6 +21691,7 @@ module Google
21427
21691
  @canonical_filter = args[:canonical_filter] if args.key?(:canonical_filter)
21428
21692
  @content_search_spec = args[:content_search_spec] if args.key?(:content_search_spec)
21429
21693
  @data_store_specs = args[:data_store_specs] if args.key?(:data_store_specs)
21694
+ @display_spec = args[:display_spec] if args.key?(:display_spec)
21430
21695
  @embedding_spec = args[:embedding_spec] if args.key?(:embedding_spec)
21431
21696
  @facet_specs = args[:facet_specs] if args.key?(:facet_specs)
21432
21697
  @filter = args[:filter] if args.key?(:filter)
@@ -21464,7 +21729,7 @@ module Google
21464
21729
  include Google::Apis::Core::Hashable
21465
21730
 
21466
21731
  # Condition boost specifications. If a document matches multiple conditions in
21467
- # the specifictions, boost scores from these specifications are all applied and
21732
+ # the specifications, boost scores from these specifications are all applied and
21468
21733
  # combined in a non-linear way. Maximum number of specifications is 20.
21469
21734
  # Corresponds to the JSON property `conditionBoostSpecs`
21470
21735
  # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec>]
@@ -21863,6 +22128,12 @@ module Google
21863
22128
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec]
21864
22129
  attr_accessor :model_spec
21865
22130
 
22131
+ # Multimodal specification: Will return an image from specified source. If
22132
+ # multiple sources are specified, the pick is a quality based decision.
22133
+ # Corresponds to the JSON property `multimodalSpec`
22134
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecMultiModalSpec]
22135
+ attr_accessor :multimodal_spec
22136
+
21866
22137
  # The number of top results to generate the summary from. If the number of
21867
22138
  # results returned is less than `summaryResultCount`, the summary is generated
21868
22139
  # from all of the results. At most 10 results for documents mode, or 50 for
@@ -21896,6 +22167,7 @@ module Google
21896
22167
  @language_code = args[:language_code] if args.key?(:language_code)
21897
22168
  @model_prompt_spec = args[:model_prompt_spec] if args.key?(:model_prompt_spec)
21898
22169
  @model_spec = args[:model_spec] if args.key?(:model_spec)
22170
+ @multimodal_spec = args[:multimodal_spec] if args.key?(:multimodal_spec)
21899
22171
  @summary_result_count = args[:summary_result_count] if args.key?(:summary_result_count)
21900
22172
  @use_semantic_chunks = args[:use_semantic_chunks] if args.key?(:use_semantic_chunks)
21901
22173
  end
@@ -21947,6 +22219,26 @@ module Google
21947
22219
  end
21948
22220
  end
21949
22221
 
22222
+ # Multimodal specification: Will return an image from specified source. If
22223
+ # multiple sources are specified, the pick is a quality based decision.
22224
+ class GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecMultiModalSpec
22225
+ include Google::Apis::Core::Hashable
22226
+
22227
+ # Optional. Source of image returned in the answer.
22228
+ # Corresponds to the JSON property `imageSource`
22229
+ # @return [String]
22230
+ attr_accessor :image_source
22231
+
22232
+ def initialize(**args)
22233
+ update!(**args)
22234
+ end
22235
+
22236
+ # Update properties of this object
22237
+ def update!(**args)
22238
+ @image_source = args[:image_source] if args.key?(:image_source)
22239
+ end
22240
+ end
22241
+
21950
22242
  # A struct to define data stores to filter on in a search call and
21951
22243
  # configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error
21952
22244
  # is returned.
@@ -21983,6 +22275,25 @@ module Google
21983
22275
  end
21984
22276
  end
21985
22277
 
22278
+ # Specifies features for display, like match highlighting.
22279
+ class GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec
22280
+ include Google::Apis::Core::Hashable
22281
+
22282
+ # The condition under which match highlighting should occur.
22283
+ # Corresponds to the JSON property `matchHighlightingCondition`
22284
+ # @return [String]
22285
+ attr_accessor :match_highlighting_condition
22286
+
22287
+ def initialize(**args)
22288
+ update!(**args)
22289
+ end
22290
+
22291
+ # Update properties of this object
22292
+ def update!(**args)
22293
+ @match_highlighting_condition = args[:match_highlighting_condition] if args.key?(:match_highlighting_condition)
22294
+ end
22295
+ end
22296
+
21986
22297
  # The specification that uses customized query embedding vector to do semantic
21987
22298
  # document retrieval.
21988
22299
  class GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec