google-apis-discoveryengine_v1beta 0.57.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +8 -0
- data/lib/google/apis/discoveryengine_v1beta/classes.rb +505 -60
- data/lib/google/apis/discoveryengine_v1beta/gem_version.rb +2 -2
- data/lib/google/apis/discoveryengine_v1beta/representations.rb +210 -0
- data/lib/google/apis/discoveryengine_v1beta/service.rb +243 -0
- metadata +3 -3
@@ -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)
|
@@ -3088,7 +3106,8 @@ module Google
|
|
3088
3106
|
# @return [String]
|
3089
3107
|
attr_accessor :title
|
3090
3108
|
|
3091
|
-
#
|
3109
|
+
# Optional. The URL for the page the user wants to promote. Must be set for site
|
3110
|
+
# search. For other verticals, this is optional.
|
3092
3111
|
# Corresponds to the JSON property `uri`
|
3093
3112
|
# @return [String]
|
3094
3113
|
attr_accessor :uri
|
@@ -4160,6 +4179,14 @@ module Google
|
|
4160
4179
|
attr_accessor :is_action_configured
|
4161
4180
|
alias_method :is_action_configured?, :is_action_configured
|
4162
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
|
+
|
4163
4190
|
def initialize(**args)
|
4164
4191
|
update!(**args)
|
4165
4192
|
end
|
@@ -4168,6 +4195,7 @@ module Google
|
|
4168
4195
|
def update!(**args)
|
4169
4196
|
@action_params = args[:action_params] if args.key?(:action_params)
|
4170
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)
|
4171
4199
|
end
|
4172
4200
|
end
|
4173
4201
|
|
@@ -4198,6 +4226,56 @@ module Google
|
|
4198
4226
|
end
|
4199
4227
|
end
|
4200
4228
|
|
4229
|
+
# The connector level alert config.
|
4230
|
+
class GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig
|
4231
|
+
include Google::Apis::Core::Hashable
|
4232
|
+
|
4233
|
+
# Optional. The enrollment states of each alert.
|
4234
|
+
# Corresponds to the JSON property `alertEnrollments`
|
4235
|
+
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment>]
|
4236
|
+
attr_accessor :alert_enrollments
|
4237
|
+
|
4238
|
+
# Immutable. The fully qualified resource name of the AlertPolicy.
|
4239
|
+
# Corresponds to the JSON property `alertPolicyName`
|
4240
|
+
# @return [String]
|
4241
|
+
attr_accessor :alert_policy_name
|
4242
|
+
|
4243
|
+
def initialize(**args)
|
4244
|
+
update!(**args)
|
4245
|
+
end
|
4246
|
+
|
4247
|
+
# Update properties of this object
|
4248
|
+
def update!(**args)
|
4249
|
+
@alert_enrollments = args[:alert_enrollments] if args.key?(:alert_enrollments)
|
4250
|
+
@alert_policy_name = args[:alert_policy_name] if args.key?(:alert_policy_name)
|
4251
|
+
end
|
4252
|
+
end
|
4253
|
+
|
4254
|
+
# The alert enrollment status.
|
4255
|
+
class GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment
|
4256
|
+
include Google::Apis::Core::Hashable
|
4257
|
+
|
4258
|
+
# Immutable. The id of an alert.
|
4259
|
+
# Corresponds to the JSON property `alertId`
|
4260
|
+
# @return [String]
|
4261
|
+
attr_accessor :alert_id
|
4262
|
+
|
4263
|
+
# Required. The enrollment status of a customer.
|
4264
|
+
# Corresponds to the JSON property `enrollState`
|
4265
|
+
# @return [String]
|
4266
|
+
attr_accessor :enroll_state
|
4267
|
+
|
4268
|
+
def initialize(**args)
|
4269
|
+
update!(**args)
|
4270
|
+
end
|
4271
|
+
|
4272
|
+
# Update properties of this object
|
4273
|
+
def update!(**args)
|
4274
|
+
@alert_id = args[:alert_id] if args.key?(:alert_id)
|
4275
|
+
@enroll_state = args[:enroll_state] if args.key?(:enroll_state)
|
4276
|
+
end
|
4277
|
+
end
|
4278
|
+
|
4201
4279
|
# Defines an answer.
|
4202
4280
|
class GoogleCloudDiscoveryengineV1alphaAnswer
|
4203
4281
|
include Google::Apis::Core::Hashable
|
@@ -4213,6 +4291,11 @@ module Google
|
|
4213
4291
|
# @return [String]
|
4214
4292
|
attr_accessor :answer_text
|
4215
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
|
+
|
4216
4299
|
# Citations.
|
4217
4300
|
# Corresponds to the JSON property `citations`
|
4218
4301
|
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaAnswerCitation>]
|
@@ -4283,6 +4366,7 @@ module Google
|
|
4283
4366
|
def update!(**args)
|
4284
4367
|
@answer_skipped_reasons = args[:answer_skipped_reasons] if args.key?(:answer_skipped_reasons)
|
4285
4368
|
@answer_text = args[:answer_text] if args.key?(:answer_text)
|
4369
|
+
@blob_attachments = args[:blob_attachments] if args.key?(:blob_attachments)
|
4286
4370
|
@citations = args[:citations] if args.key?(:citations)
|
4287
4371
|
@complete_time = args[:complete_time] if args.key?(:complete_time)
|
4288
4372
|
@create_time = args[:create_time] if args.key?(:create_time)
|
@@ -4298,6 +4382,57 @@ module Google
|
|
4298
4382
|
end
|
4299
4383
|
end
|
4300
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
|
+
|
4301
4436
|
# Citation info for a segment.
|
4302
4437
|
class GoogleCloudDiscoveryengineV1alphaAnswerCitation
|
4303
4438
|
include Google::Apis::Core::Hashable
|
@@ -4482,6 +4617,11 @@ module Google
|
|
4482
4617
|
class GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo
|
4483
4618
|
include Google::Apis::Core::Hashable
|
4484
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
|
+
|
4485
4625
|
# Chunk resource name.
|
4486
4626
|
# Corresponds to the JSON property `chunk`
|
4487
4627
|
# @return [String]
|
@@ -4511,6 +4651,7 @@ module Google
|
|
4511
4651
|
|
4512
4652
|
# Update properties of this object
|
4513
4653
|
def update!(**args)
|
4654
|
+
@blob_attachment_indexes = args[:blob_attachment_indexes] if args.key?(:blob_attachment_indexes)
|
4514
4655
|
@chunk = args[:chunk] if args.key?(:chunk)
|
4515
4656
|
@content = args[:content] if args.key?(:content)
|
4516
4657
|
@document_metadata = args[:document_metadata] if args.key?(:document_metadata)
|
@@ -4647,6 +4788,11 @@ module Google
|
|
4647
4788
|
class GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent
|
4648
4789
|
include Google::Apis::Core::Hashable
|
4649
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
|
+
|
4650
4796
|
# Chunk textual content.
|
4651
4797
|
# Corresponds to the JSON property `content`
|
4652
4798
|
# @return [String]
|
@@ -4671,6 +4817,7 @@ module Google
|
|
4671
4817
|
|
4672
4818
|
# Update properties of this object
|
4673
4819
|
def update!(**args)
|
4820
|
+
@blob_attachment_indexes = args[:blob_attachment_indexes] if args.key?(:blob_attachment_indexes)
|
4674
4821
|
@content = args[:content] if args.key?(:content)
|
4675
4822
|
@page_identifier = args[:page_identifier] if args.key?(:page_identifier)
|
4676
4823
|
@relevance_score = args[:relevance_score] if args.key?(:relevance_score)
|
@@ -4988,6 +5135,11 @@ module Google
|
|
4988
5135
|
# @return [String]
|
4989
5136
|
attr_accessor :name
|
4990
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
|
+
|
4991
5143
|
# Optional. Single-regional CMEKs that are required for some VAIS features.
|
4992
5144
|
# Corresponds to the JSON property `singleRegionKeys`
|
4993
5145
|
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaSingleRegionKey>]
|
@@ -5009,6 +5161,7 @@ module Google
|
|
5009
5161
|
@kms_key_version = args[:kms_key_version] if args.key?(:kms_key_version)
|
5010
5162
|
@last_rotation_timestamp_micros = args[:last_rotation_timestamp_micros] if args.key?(:last_rotation_timestamp_micros)
|
5011
5163
|
@name = args[:name] if args.key?(:name)
|
5164
|
+
@notebooklm_state = args[:notebooklm_state] if args.key?(:notebooklm_state)
|
5012
5165
|
@single_region_keys = args[:single_region_keys] if args.key?(:single_region_keys)
|
5013
5166
|
@state = args[:state] if args.key?(:state)
|
5014
5167
|
end
|
@@ -5873,6 +6026,11 @@ module Google
|
|
5873
6026
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaActionConfig]
|
5874
6027
|
attr_accessor :action_config
|
5875
6028
|
|
6029
|
+
# Optional. The connector level alert config.
|
6030
|
+
# Corresponds to the JSON property `alertPolicyConfigs`
|
6031
|
+
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig>]
|
6032
|
+
attr_accessor :alert_policy_configs
|
6033
|
+
|
5876
6034
|
# Indicates whether the connector is disabled for auto run. It can be used to
|
5877
6035
|
# pause periodical and real time sync.
|
5878
6036
|
# Corresponds to the JSON property `autoRunDisabled`
|
@@ -6062,6 +6220,7 @@ module Google
|
|
6062
6220
|
# Update properties of this object
|
6063
6221
|
def update!(**args)
|
6064
6222
|
@action_config = args[:action_config] if args.key?(:action_config)
|
6223
|
+
@alert_policy_configs = args[:alert_policy_configs] if args.key?(:alert_policy_configs)
|
6065
6224
|
@auto_run_disabled = args[:auto_run_disabled] if args.key?(:auto_run_disabled)
|
6066
6225
|
@bap_config = args[:bap_config] if args.key?(:bap_config)
|
6067
6226
|
@blocking_reasons = args[:blocking_reasons] if args.key?(:blocking_reasons)
|
@@ -9342,7 +9501,8 @@ module Google
|
|
9342
9501
|
# @return [String]
|
9343
9502
|
attr_accessor :title
|
9344
9503
|
|
9345
|
-
#
|
9504
|
+
# Optional. The URL for the page the user wants to promote. Must be set for site
|
9505
|
+
# search. For other verticals, this is optional.
|
9346
9506
|
# Corresponds to the JSON property `uri`
|
9347
9507
|
# @return [String]
|
9348
9508
|
attr_accessor :uri
|
@@ -9400,10 +9560,10 @@ module Google
|
|
9400
9560
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec]
|
9401
9561
|
attr_accessor :custom_fine_tuning_spec
|
9402
9562
|
|
9403
|
-
# Specifications that define the specific
|
9404
|
-
#
|
9405
|
-
#
|
9406
|
-
#
|
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.
|
9407
9567
|
# Corresponds to the JSON property `dataStoreSpecs`
|
9408
9568
|
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec>]
|
9409
9569
|
attr_accessor :data_store_specs
|
@@ -9534,29 +9694,30 @@ module Google
|
|
9534
9694
|
# This overrides ServingConfig.ranking_expression. The syntax and supported
|
9535
9695
|
# features depend on the ranking_expression_backend value. If
|
9536
9696
|
# ranking_expression_backend is not provided, it defaults to BYOE. === BYOE ===
|
9537
|
-
# If
|
9538
|
-
# function or multiple functions that are joined by "+". *
|
9539
|
-
# function, ` " + ", function `; Supported functions: *
|
9540
|
-
# * double * dotProduct(embedding_field_path) Function
|
9541
|
-
# relevance_score`: pre-defined keywords, used for measure
|
9542
|
-
# query and document. * `embedding_field_path`: the document
|
9543
|
-
# used with query embedding vector. * `dotProduct`: embedding
|
9544
|
-
# embedding_field_path and query embedding vector. Example
|
9545
|
-
# If document has an embedding field doc_embedding, the
|
9546
|
-
# be `0.5 * relevance_score + 0.3 * dotProduct(
|
9547
|
-
# If
|
9548
|
-
#
|
9549
|
-
#
|
9550
|
-
#
|
9551
|
-
# is_nan(signal) -- returns 0 if signal
|
9552
|
-
#
|
9553
|
-
#
|
9554
|
-
#
|
9555
|
-
# 16) + 0.8 * rr(bm25_score, 32)
|
9556
|
-
#
|
9557
|
-
# adjustment *
|
9558
|
-
#
|
9559
|
-
# adjustment as a rank *
|
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
|
9560
9721
|
# Corresponds to the JSON property `rankingExpression`
|
9561
9722
|
# @return [String]
|
9562
9723
|
attr_accessor :ranking_expression
|
@@ -9723,7 +9884,7 @@ module Google
|
|
9723
9884
|
include Google::Apis::Core::Hashable
|
9724
9885
|
|
9725
9886
|
# Condition boost specifications. If a document matches multiple conditions in
|
9726
|
-
# the
|
9887
|
+
# the specifications, boost scores from these specifications are all applied and
|
9727
9888
|
# combined in a non-linear way. Maximum number of specifications is 20.
|
9728
9889
|
# Corresponds to the JSON property `conditionBoostSpecs`
|
9729
9890
|
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec>]
|
@@ -10122,6 +10283,12 @@ module Google
|
|
10122
10283
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec]
|
10123
10284
|
attr_accessor :model_spec
|
10124
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
|
+
|
10125
10292
|
# The number of top results to generate the summary from. If the number of
|
10126
10293
|
# results returned is less than `summaryResultCount`, the summary is generated
|
10127
10294
|
# from all of the results. At most 10 results for documents mode, or 50 for
|
@@ -10155,6 +10322,7 @@ module Google
|
|
10155
10322
|
@language_code = args[:language_code] if args.key?(:language_code)
|
10156
10323
|
@model_prompt_spec = args[:model_prompt_spec] if args.key?(:model_prompt_spec)
|
10157
10324
|
@model_spec = args[:model_spec] if args.key?(:model_spec)
|
10325
|
+
@multimodal_spec = args[:multimodal_spec] if args.key?(:multimodal_spec)
|
10158
10326
|
@summary_result_count = args[:summary_result_count] if args.key?(:summary_result_count)
|
10159
10327
|
@use_semantic_chunks = args[:use_semantic_chunks] if args.key?(:use_semantic_chunks)
|
10160
10328
|
end
|
@@ -10206,6 +10374,26 @@ module Google
|
|
10206
10374
|
end
|
10207
10375
|
end
|
10208
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
|
+
|
10209
10397
|
# A struct to define data stores to filter on in a search call and
|
10210
10398
|
# configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error
|
10211
10399
|
# is returned.
|
@@ -11482,7 +11670,7 @@ module Google
|
|
11482
11670
|
include Google::Apis::Core::Hashable
|
11483
11671
|
|
11484
11672
|
# Condition boost specifications. If a suggestion matches multiple conditions in
|
11485
|
-
# the
|
11673
|
+
# the specifications, boost values from these specifications are all applied and
|
11486
11674
|
# combined in a non-linear way. Maximum number of specifications is 20. Note:
|
11487
11675
|
# Currently only support language condition boost.
|
11488
11676
|
# Corresponds to the JSON property `conditionBoostSpecs`
|
@@ -11890,6 +12078,11 @@ module Google
|
|
11890
12078
|
# @return [String]
|
11891
12079
|
attr_accessor :answer_text
|
11892
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
|
+
|
11893
12086
|
# Citations.
|
11894
12087
|
# Corresponds to the JSON property `citations`
|
11895
12088
|
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerCitation>]
|
@@ -11960,6 +12153,7 @@ module Google
|
|
11960
12153
|
def update!(**args)
|
11961
12154
|
@answer_skipped_reasons = args[:answer_skipped_reasons] if args.key?(:answer_skipped_reasons)
|
11962
12155
|
@answer_text = args[:answer_text] if args.key?(:answer_text)
|
12156
|
+
@blob_attachments = args[:blob_attachments] if args.key?(:blob_attachments)
|
11963
12157
|
@citations = args[:citations] if args.key?(:citations)
|
11964
12158
|
@complete_time = args[:complete_time] if args.key?(:complete_time)
|
11965
12159
|
@create_time = args[:create_time] if args.key?(:create_time)
|
@@ -11975,6 +12169,57 @@ module Google
|
|
11975
12169
|
end
|
11976
12170
|
end
|
11977
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
|
+
|
11978
12223
|
# Citation info for a segment.
|
11979
12224
|
class GoogleCloudDiscoveryengineV1betaAnswerCitation
|
11980
12225
|
include Google::Apis::Core::Hashable
|
@@ -12259,6 +12504,12 @@ module Google
|
|
12259
12504
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecModelSpec]
|
12260
12505
|
attr_accessor :model_spec
|
12261
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
|
+
|
12262
12513
|
# Answer generation prompt specification.
|
12263
12514
|
# Corresponds to the JSON property `promptSpec`
|
12264
12515
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecPromptSpec]
|
@@ -12277,6 +12528,7 @@ module Google
|
|
12277
12528
|
@ignore_non_answer_seeking_query = args[:ignore_non_answer_seeking_query] if args.key?(:ignore_non_answer_seeking_query)
|
12278
12529
|
@include_citations = args[:include_citations] if args.key?(:include_citations)
|
12279
12530
|
@model_spec = args[:model_spec] if args.key?(:model_spec)
|
12531
|
+
@multimodal_spec = args[:multimodal_spec] if args.key?(:multimodal_spec)
|
12280
12532
|
@prompt_spec = args[:prompt_spec] if args.key?(:prompt_spec)
|
12281
12533
|
end
|
12282
12534
|
end
|
@@ -12301,6 +12553,26 @@ module Google
|
|
12301
12553
|
end
|
12302
12554
|
end
|
12303
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
|
+
|
12304
12576
|
# Answer generation prompt specification.
|
12305
12577
|
class GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecPromptSpec
|
12306
12578
|
include Google::Apis::Core::Hashable
|
@@ -12437,6 +12709,12 @@ module Google
|
|
12437
12709
|
class GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpec
|
12438
12710
|
include Google::Apis::Core::Hashable
|
12439
12711
|
|
12712
|
+
# Optional. Whether to disable spell correction. The default value is `false`.
|
12713
|
+
# Corresponds to the JSON property `disableSpellCorrection`
|
12714
|
+
# @return [Boolean]
|
12715
|
+
attr_accessor :disable_spell_correction
|
12716
|
+
alias_method :disable_spell_correction?, :disable_spell_correction
|
12717
|
+
|
12440
12718
|
# Query classification specification.
|
12441
12719
|
# Corresponds to the JSON property `queryClassificationSpec`
|
12442
12720
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec]
|
@@ -12453,6 +12731,7 @@ module Google
|
|
12453
12731
|
|
12454
12732
|
# Update properties of this object
|
12455
12733
|
def update!(**args)
|
12734
|
+
@disable_spell_correction = args[:disable_spell_correction] if args.key?(:disable_spell_correction)
|
12456
12735
|
@query_classification_spec = args[:query_classification_spec] if args.key?(:query_classification_spec)
|
12457
12736
|
@query_rephraser_spec = args[:query_rephraser_spec] if args.key?(:query_rephraser_spec)
|
12458
12737
|
end
|
@@ -13050,6 +13329,11 @@ module Google
|
|
13050
13329
|
class GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfo
|
13051
13330
|
include Google::Apis::Core::Hashable
|
13052
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
|
+
|
13053
13337
|
# Chunk resource name.
|
13054
13338
|
# Corresponds to the JSON property `chunk`
|
13055
13339
|
# @return [String]
|
@@ -13079,6 +13363,7 @@ module Google
|
|
13079
13363
|
|
13080
13364
|
# Update properties of this object
|
13081
13365
|
def update!(**args)
|
13366
|
+
@blob_attachment_indexes = args[:blob_attachment_indexes] if args.key?(:blob_attachment_indexes)
|
13082
13367
|
@chunk = args[:chunk] if args.key?(:chunk)
|
13083
13368
|
@content = args[:content] if args.key?(:content)
|
13084
13369
|
@document_metadata = args[:document_metadata] if args.key?(:document_metadata)
|
@@ -13215,6 +13500,11 @@ module Google
|
|
13215
13500
|
class GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfoChunkContent
|
13216
13501
|
include Google::Apis::Core::Hashable
|
13217
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
|
+
|
13218
13508
|
# Chunk textual content.
|
13219
13509
|
# Corresponds to the JSON property `content`
|
13220
13510
|
# @return [String]
|
@@ -13239,6 +13529,7 @@ module Google
|
|
13239
13529
|
|
13240
13530
|
# Update properties of this object
|
13241
13531
|
def update!(**args)
|
13532
|
+
@blob_attachment_indexes = args[:blob_attachment_indexes] if args.key?(:blob_attachment_indexes)
|
13242
13533
|
@content = args[:content] if args.key?(:content)
|
13243
13534
|
@page_identifier = args[:page_identifier] if args.key?(:page_identifier)
|
13244
13535
|
@relevance_score = args[:relevance_score] if args.key?(:relevance_score)
|
@@ -14292,6 +14583,11 @@ module Google
|
|
14292
14583
|
# @return [String]
|
14293
14584
|
attr_accessor :name
|
14294
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
|
+
|
14295
14591
|
# Optional. Single-regional CMEKs that are required for some VAIS features.
|
14296
14592
|
# Corresponds to the JSON property `singleRegionKeys`
|
14297
14593
|
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSingleRegionKey>]
|
@@ -14313,6 +14609,7 @@ module Google
|
|
14313
14609
|
@kms_key_version = args[:kms_key_version] if args.key?(:kms_key_version)
|
14314
14610
|
@last_rotation_timestamp_micros = args[:last_rotation_timestamp_micros] if args.key?(:last_rotation_timestamp_micros)
|
14315
14611
|
@name = args[:name] if args.key?(:name)
|
14612
|
+
@notebooklm_state = args[:notebooklm_state] if args.key?(:notebooklm_state)
|
14316
14613
|
@single_region_keys = args[:single_region_keys] if args.key?(:single_region_keys)
|
14317
14614
|
@state = args[:state] if args.key?(:state)
|
14318
14615
|
end
|
@@ -15405,6 +15702,17 @@ module Google
|
|
15405
15702
|
class GoogleCloudDiscoveryengineV1betaDataStore
|
15406
15703
|
include Google::Apis::Core::Hashable
|
15407
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
|
+
|
15408
15716
|
# Configuration data for advance site search.
|
15409
15717
|
# Corresponds to the JSON property `advancedSiteSearchConfig`
|
15410
15718
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig]
|
@@ -15529,6 +15837,7 @@ module Google
|
|
15529
15837
|
|
15530
15838
|
# Update properties of this object
|
15531
15839
|
def update!(**args)
|
15840
|
+
@acl_enabled = args[:acl_enabled] if args.key?(:acl_enabled)
|
15532
15841
|
@advanced_site_search_config = args[:advanced_site_search_config] if args.key?(:advanced_site_search_config)
|
15533
15842
|
@billing_estimation = args[:billing_estimation] if args.key?(:billing_estimation)
|
15534
15843
|
@cmek_config = args[:cmek_config] if args.key?(:cmek_config)
|
@@ -18033,6 +18342,25 @@ module Google
|
|
18033
18342
|
end
|
18034
18343
|
end
|
18035
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
|
+
|
18036
18364
|
# Response for ListControls method.
|
18037
18365
|
class GoogleCloudDiscoveryengineV1betaListControlsResponse
|
18038
18366
|
include Google::Apis::Core::Hashable
|
@@ -20156,7 +20484,8 @@ module Google
|
|
20156
20484
|
# @return [String]
|
20157
20485
|
attr_accessor :title
|
20158
20486
|
|
20159
|
-
#
|
20487
|
+
# Optional. The URL for the page the user wants to promote. Must be set for site
|
20488
|
+
# search. For other verticals, this is optional.
|
20160
20489
|
# Corresponds to the JSON property `uri`
|
20161
20490
|
# @return [String]
|
20162
20491
|
attr_accessor :uri
|
@@ -20209,14 +20538,19 @@ module Google
|
|
20209
20538
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec]
|
20210
20539
|
attr_accessor :content_search_spec
|
20211
20540
|
|
20212
|
-
# Specifications that define the specific
|
20213
|
-
#
|
20214
|
-
#
|
20215
|
-
#
|
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.
|
20216
20545
|
# Corresponds to the JSON property `dataStoreSpecs`
|
20217
20546
|
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec>]
|
20218
20547
|
attr_accessor :data_store_specs
|
20219
20548
|
|
20549
|
+
# Specifies features for display, like match highlighting.
|
20550
|
+
# Corresponds to the JSON property `displaySpec`
|
20551
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec]
|
20552
|
+
attr_accessor :display_spec
|
20553
|
+
|
20220
20554
|
# The specification that uses customized query embedding vector to do semantic
|
20221
20555
|
# document retrieval.
|
20222
20556
|
# Corresponds to the JSON property `embeddingSpec`
|
@@ -20338,29 +20672,30 @@ module Google
|
|
20338
20672
|
# This overrides ServingConfig.ranking_expression. The syntax and supported
|
20339
20673
|
# features depend on the ranking_expression_backend value. If
|
20340
20674
|
# ranking_expression_backend is not provided, it defaults to BYOE. === BYOE ===
|
20341
|
-
# If
|
20342
|
-
# function or multiple functions that are joined by "+". *
|
20343
|
-
# function, ` " + ", function `; Supported functions: *
|
20344
|
-
# * double * dotProduct(embedding_field_path) Function
|
20345
|
-
# relevance_score`: pre-defined keywords, used for measure
|
20346
|
-
# query and document. * `embedding_field_path`: the document
|
20347
|
-
# used with query embedding vector. * `dotProduct`: embedding
|
20348
|
-
# embedding_field_path and query embedding vector. Example
|
20349
|
-
# If document has an embedding field doc_embedding, the
|
20350
|
-
# be `0.5 * relevance_score + 0.3 * dotProduct(
|
20351
|
-
# If
|
20352
|
-
#
|
20353
|
-
#
|
20354
|
-
#
|
20355
|
-
# is_nan(signal) -- returns 0 if signal
|
20356
|
-
#
|
20357
|
-
#
|
20358
|
-
#
|
20359
|
-
# 16) + 0.8 * rr(bm25_score, 32)
|
20360
|
-
#
|
20361
|
-
# adjustment *
|
20362
|
-
#
|
20363
|
-
# adjustment as a rank *
|
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
|
20364
20699
|
# Corresponds to the JSON property `rankingExpression`
|
20365
20700
|
# @return [String]
|
20366
20701
|
attr_accessor :ranking_expression
|
@@ -20488,6 +20823,7 @@ module Google
|
|
20488
20823
|
@canonical_filter = args[:canonical_filter] if args.key?(:canonical_filter)
|
20489
20824
|
@content_search_spec = args[:content_search_spec] if args.key?(:content_search_spec)
|
20490
20825
|
@data_store_specs = args[:data_store_specs] if args.key?(:data_store_specs)
|
20826
|
+
@display_spec = args[:display_spec] if args.key?(:display_spec)
|
20491
20827
|
@embedding_spec = args[:embedding_spec] if args.key?(:embedding_spec)
|
20492
20828
|
@facet_specs = args[:facet_specs] if args.key?(:facet_specs)
|
20493
20829
|
@filter = args[:filter] if args.key?(:filter)
|
@@ -20525,7 +20861,7 @@ module Google
|
|
20525
20861
|
include Google::Apis::Core::Hashable
|
20526
20862
|
|
20527
20863
|
# Condition boost specifications. If a document matches multiple conditions in
|
20528
|
-
# the
|
20864
|
+
# the specifications, boost scores from these specifications are all applied and
|
20529
20865
|
# combined in a non-linear way. Maximum number of specifications is 20.
|
20530
20866
|
# Corresponds to the JSON property `conditionBoostSpecs`
|
20531
20867
|
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec>]
|
@@ -20924,6 +21260,12 @@ module Google
|
|
20924
21260
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec]
|
20925
21261
|
attr_accessor :model_spec
|
20926
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
|
+
|
20927
21269
|
# The number of top results to generate the summary from. If the number of
|
20928
21270
|
# results returned is less than `summaryResultCount`, the summary is generated
|
20929
21271
|
# from all of the results. At most 10 results for documents mode, or 50 for
|
@@ -20957,6 +21299,7 @@ module Google
|
|
20957
21299
|
@language_code = args[:language_code] if args.key?(:language_code)
|
20958
21300
|
@model_prompt_spec = args[:model_prompt_spec] if args.key?(:model_prompt_spec)
|
20959
21301
|
@model_spec = args[:model_spec] if args.key?(:model_spec)
|
21302
|
+
@multimodal_spec = args[:multimodal_spec] if args.key?(:multimodal_spec)
|
20960
21303
|
@summary_result_count = args[:summary_result_count] if args.key?(:summary_result_count)
|
20961
21304
|
@use_semantic_chunks = args[:use_semantic_chunks] if args.key?(:use_semantic_chunks)
|
20962
21305
|
end
|
@@ -21008,6 +21351,26 @@ module Google
|
|
21008
21351
|
end
|
21009
21352
|
end
|
21010
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
|
+
|
21011
21374
|
# A struct to define data stores to filter on in a search call and
|
21012
21375
|
# configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error
|
21013
21376
|
# is returned.
|
@@ -21044,6 +21407,25 @@ module Google
|
|
21044
21407
|
end
|
21045
21408
|
end
|
21046
21409
|
|
21410
|
+
# Specifies features for display, like match highlighting.
|
21411
|
+
class GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec
|
21412
|
+
include Google::Apis::Core::Hashable
|
21413
|
+
|
21414
|
+
# The condition under which match highlighting should occur.
|
21415
|
+
# Corresponds to the JSON property `matchHighlightingCondition`
|
21416
|
+
# @return [String]
|
21417
|
+
attr_accessor :match_highlighting_condition
|
21418
|
+
|
21419
|
+
def initialize(**args)
|
21420
|
+
update!(**args)
|
21421
|
+
end
|
21422
|
+
|
21423
|
+
# Update properties of this object
|
21424
|
+
def update!(**args)
|
21425
|
+
@match_highlighting_condition = args[:match_highlighting_condition] if args.key?(:match_highlighting_condition)
|
21426
|
+
end
|
21427
|
+
end
|
21428
|
+
|
21047
21429
|
# The specification that uses customized query embedding vector to do semantic
|
21048
21430
|
# document retrieval.
|
21049
21431
|
class GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec
|
@@ -22157,6 +22539,57 @@ module Google
|
|
22157
22539
|
end
|
22158
22540
|
end
|
22159
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
|
+
|
22160
22593
|
# Citation info for a segment.
|
22161
22594
|
class GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitation
|
22162
22595
|
include Google::Apis::Core::Hashable
|
@@ -22270,6 +22703,11 @@ module Google
|
|
22270
22703
|
class GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReferenceChunkContent
|
22271
22704
|
include Google::Apis::Core::Hashable
|
22272
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
|
+
|
22273
22711
|
# Chunk textual content.
|
22274
22712
|
# Corresponds to the JSON property `content`
|
22275
22713
|
# @return [String]
|
@@ -22286,6 +22724,7 @@ module Google
|
|
22286
22724
|
|
22287
22725
|
# Update properties of this object
|
22288
22726
|
def update!(**args)
|
22727
|
+
@blob_attachment_indexes = args[:blob_attachment_indexes] if args.key?(:blob_attachment_indexes)
|
22289
22728
|
@content = args[:content] if args.key?(:content)
|
22290
22729
|
@page_identifier = args[:page_identifier] if args.key?(:page_identifier)
|
22291
22730
|
end
|
@@ -22322,6 +22761,11 @@ module Google
|
|
22322
22761
|
class GoogleCloudDiscoveryengineV1betaSearchResponseSummarySummaryWithMetadata
|
22323
22762
|
include Google::Apis::Core::Hashable
|
22324
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
|
+
|
22325
22769
|
# Citation metadata.
|
22326
22770
|
# Corresponds to the JSON property `citationMetadata`
|
22327
22771
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationMetadata]
|
@@ -22343,6 +22787,7 @@ module Google
|
|
22343
22787
|
|
22344
22788
|
# Update properties of this object
|
22345
22789
|
def update!(**args)
|
22790
|
+
@blob_attachments = args[:blob_attachments] if args.key?(:blob_attachments)
|
22346
22791
|
@citation_metadata = args[:citation_metadata] if args.key?(:citation_metadata)
|
22347
22792
|
@references = args[:references] if args.key?(:references)
|
22348
22793
|
@summary = args[:summary] if args.key?(:summary)
|