google-apis-discoveryengine_v1beta 0.56.0 → 0.58.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 +185 -600
- data/lib/google/apis/discoveryengine_v1beta/gem_version.rb +2 -2
- data/lib/google/apis/discoveryengine_v1beta/representations.rb +75 -300
- data/lib/google/apis/discoveryengine_v1beta/service.rb +0 -33
- metadata +3 -3
@@ -3088,7 +3088,8 @@ module Google
|
|
3088
3088
|
# @return [String]
|
3089
3089
|
attr_accessor :title
|
3090
3090
|
|
3091
|
-
#
|
3091
|
+
# Optional. The URL for the page the user wants to promote. Must be set for site
|
3092
|
+
# search. For other verticals, this is optional.
|
3092
3093
|
# Corresponds to the JSON property `uri`
|
3093
3094
|
# @return [String]
|
3094
3095
|
attr_accessor :uri
|
@@ -4198,6 +4199,56 @@ module Google
|
|
4198
4199
|
end
|
4199
4200
|
end
|
4200
4201
|
|
4202
|
+
# The connector level alert config.
|
4203
|
+
class GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig
|
4204
|
+
include Google::Apis::Core::Hashable
|
4205
|
+
|
4206
|
+
# Optional. The enrollment states of each alert.
|
4207
|
+
# Corresponds to the JSON property `alertEnrollments`
|
4208
|
+
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment>]
|
4209
|
+
attr_accessor :alert_enrollments
|
4210
|
+
|
4211
|
+
# Immutable. The fully qualified resource name of the AlertPolicy.
|
4212
|
+
# Corresponds to the JSON property `alertPolicyName`
|
4213
|
+
# @return [String]
|
4214
|
+
attr_accessor :alert_policy_name
|
4215
|
+
|
4216
|
+
def initialize(**args)
|
4217
|
+
update!(**args)
|
4218
|
+
end
|
4219
|
+
|
4220
|
+
# Update properties of this object
|
4221
|
+
def update!(**args)
|
4222
|
+
@alert_enrollments = args[:alert_enrollments] if args.key?(:alert_enrollments)
|
4223
|
+
@alert_policy_name = args[:alert_policy_name] if args.key?(:alert_policy_name)
|
4224
|
+
end
|
4225
|
+
end
|
4226
|
+
|
4227
|
+
# The alert enrollment status.
|
4228
|
+
class GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment
|
4229
|
+
include Google::Apis::Core::Hashable
|
4230
|
+
|
4231
|
+
# Immutable. The id of an alert.
|
4232
|
+
# Corresponds to the JSON property `alertId`
|
4233
|
+
# @return [String]
|
4234
|
+
attr_accessor :alert_id
|
4235
|
+
|
4236
|
+
# Required. The enrollment status of a customer.
|
4237
|
+
# Corresponds to the JSON property `enrollState`
|
4238
|
+
# @return [String]
|
4239
|
+
attr_accessor :enroll_state
|
4240
|
+
|
4241
|
+
def initialize(**args)
|
4242
|
+
update!(**args)
|
4243
|
+
end
|
4244
|
+
|
4245
|
+
# Update properties of this object
|
4246
|
+
def update!(**args)
|
4247
|
+
@alert_id = args[:alert_id] if args.key?(:alert_id)
|
4248
|
+
@enroll_state = args[:enroll_state] if args.key?(:enroll_state)
|
4249
|
+
end
|
4250
|
+
end
|
4251
|
+
|
4201
4252
|
# Defines an answer.
|
4202
4253
|
class GoogleCloudDiscoveryengineV1alphaAnswer
|
4203
4254
|
include Google::Apis::Core::Hashable
|
@@ -5259,6 +5310,11 @@ module Google
|
|
5259
5310
|
# @return [Fixnum]
|
5260
5311
|
attr_accessor :indexed_record_count
|
5261
5312
|
|
5313
|
+
# Represents the progress of a sync run.
|
5314
|
+
# Corresponds to the JSON property `progress`
|
5315
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress]
|
5316
|
+
attr_accessor :progress
|
5317
|
+
|
5262
5318
|
# The number of requests sent to 3p API.
|
5263
5319
|
# Corresponds to the JSON property `sourceApiRequestCount`
|
5264
5320
|
# @return [Fixnum]
|
@@ -5297,6 +5353,7 @@ module Google
|
|
5297
5353
|
@errors = args[:errors] if args.key?(:errors)
|
5298
5354
|
@extracted_record_count = args[:extracted_record_count] if args.key?(:extracted_record_count)
|
5299
5355
|
@indexed_record_count = args[:indexed_record_count] if args.key?(:indexed_record_count)
|
5356
|
+
@progress = args[:progress] if args.key?(:progress)
|
5300
5357
|
@source_api_request_count = args[:source_api_request_count] if args.key?(:source_api_request_count)
|
5301
5358
|
@state = args[:state] if args.key?(:state)
|
5302
5359
|
@state_update_time = args[:state_update_time] if args.key?(:state_update_time)
|
@@ -5305,6 +5362,38 @@ module Google
|
|
5305
5362
|
end
|
5306
5363
|
end
|
5307
5364
|
|
5365
|
+
# Represents the progress of a sync run.
|
5366
|
+
class GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress
|
5367
|
+
include Google::Apis::Core::Hashable
|
5368
|
+
|
5369
|
+
# The current progress.
|
5370
|
+
# Corresponds to the JSON property `currentCount`
|
5371
|
+
# @return [Fixnum]
|
5372
|
+
attr_accessor :current_count
|
5373
|
+
|
5374
|
+
# Derived. The percentile of the progress.current_count / total_count. The value
|
5375
|
+
# is between [0, 1.0] inclusive.
|
5376
|
+
# Corresponds to the JSON property `percentile`
|
5377
|
+
# @return [Float]
|
5378
|
+
attr_accessor :percentile
|
5379
|
+
|
5380
|
+
# The total.
|
5381
|
+
# Corresponds to the JSON property `totalCount`
|
5382
|
+
# @return [Fixnum]
|
5383
|
+
attr_accessor :total_count
|
5384
|
+
|
5385
|
+
def initialize(**args)
|
5386
|
+
update!(**args)
|
5387
|
+
end
|
5388
|
+
|
5389
|
+
# Update properties of this object
|
5390
|
+
def update!(**args)
|
5391
|
+
@current_count = args[:current_count] if args.key?(:current_count)
|
5392
|
+
@percentile = args[:percentile] if args.key?(:percentile)
|
5393
|
+
@total_count = args[:total_count] if args.key?(:total_count)
|
5394
|
+
end
|
5395
|
+
end
|
5396
|
+
|
5308
5397
|
# Defines a conditioned behavior to employ during serving. Must be attached to a
|
5309
5398
|
# ServingConfig to be considered at serving time. Permitted actions dependent on
|
5310
5399
|
# `SolutionType`.
|
@@ -5835,6 +5924,11 @@ module Google
|
|
5835
5924
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaActionConfig]
|
5836
5925
|
attr_accessor :action_config
|
5837
5926
|
|
5927
|
+
# Optional. The connector level alert config.
|
5928
|
+
# Corresponds to the JSON property `alertPolicyConfigs`
|
5929
|
+
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig>]
|
5930
|
+
attr_accessor :alert_policy_configs
|
5931
|
+
|
5838
5932
|
# Indicates whether the connector is disabled for auto run. It can be used to
|
5839
5933
|
# pause periodical and real time sync.
|
5840
5934
|
# Corresponds to the JSON property `autoRunDisabled`
|
@@ -5853,6 +5947,13 @@ module Google
|
|
5853
5947
|
# @return [Array<String>]
|
5854
5948
|
attr_accessor :blocking_reasons
|
5855
5949
|
|
5950
|
+
# Output only. The type of connector. Each source can only map to one type. For
|
5951
|
+
# example, salesforce, confluence and jira have THIRD_PARTY connector type. It
|
5952
|
+
# is notmutable once set by system.
|
5953
|
+
# Corresponds to the JSON property `connectorType`
|
5954
|
+
# @return [String]
|
5955
|
+
attr_accessor :connector_type
|
5956
|
+
|
5856
5957
|
# Output only. Timestamp the DataConnector was created at.
|
5857
5958
|
# Corresponds to the JSON property `createTime`
|
5858
5959
|
# @return [String]
|
@@ -5972,6 +6073,11 @@ module Google
|
|
5972
6073
|
# @return [String]
|
5973
6074
|
attr_accessor :private_connectivity_project_id
|
5974
6075
|
|
6076
|
+
# Output only. real-time sync state
|
6077
|
+
# Corresponds to the JSON property `realtimeState`
|
6078
|
+
# @return [String]
|
6079
|
+
attr_accessor :realtime_state
|
6080
|
+
|
5975
6081
|
# Required. The refresh interval for data sync. If duration is set to 0, the
|
5976
6082
|
# data will be synced in real time. The streaming feature is not supported yet.
|
5977
6083
|
# The minimum is 30 minutes and maximum is 7 days.
|
@@ -6012,9 +6118,11 @@ module Google
|
|
6012
6118
|
# Update properties of this object
|
6013
6119
|
def update!(**args)
|
6014
6120
|
@action_config = args[:action_config] if args.key?(:action_config)
|
6121
|
+
@alert_policy_configs = args[:alert_policy_configs] if args.key?(:alert_policy_configs)
|
6015
6122
|
@auto_run_disabled = args[:auto_run_disabled] if args.key?(:auto_run_disabled)
|
6016
6123
|
@bap_config = args[:bap_config] if args.key?(:bap_config)
|
6017
6124
|
@blocking_reasons = args[:blocking_reasons] if args.key?(:blocking_reasons)
|
6125
|
+
@connector_type = args[:connector_type] if args.key?(:connector_type)
|
6018
6126
|
@create_time = args[:create_time] if args.key?(:create_time)
|
6019
6127
|
@data_source = args[:data_source] if args.key?(:data_source)
|
6020
6128
|
@destination_configs = args[:destination_configs] if args.key?(:destination_configs)
|
@@ -6029,6 +6137,7 @@ module Google
|
|
6029
6137
|
@next_sync_time = args[:next_sync_time] if args.key?(:next_sync_time)
|
6030
6138
|
@params = args[:params] if args.key?(:params)
|
6031
6139
|
@private_connectivity_project_id = args[:private_connectivity_project_id] if args.key?(:private_connectivity_project_id)
|
6140
|
+
@realtime_state = args[:realtime_state] if args.key?(:realtime_state)
|
6032
6141
|
@refresh_interval = args[:refresh_interval] if args.key?(:refresh_interval)
|
6033
6142
|
@state = args[:state] if args.key?(:state)
|
6034
6143
|
@static_ip_addresses = args[:static_ip_addresses] if args.key?(:static_ip_addresses)
|
@@ -6344,11 +6453,21 @@ module Google
|
|
6344
6453
|
class GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries
|
6345
6454
|
include Google::Apis::Core::Hashable
|
6346
6455
|
|
6456
|
+
# The historical crawl rate timeseries data, used for monitoring.
|
6457
|
+
# Corresponds to the JSON property `autoRefreshCrawlErrorRate`
|
6458
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries]
|
6459
|
+
attr_accessor :auto_refresh_crawl_error_rate
|
6460
|
+
|
6347
6461
|
# The historical crawl rate timeseries data, used for monitoring.
|
6348
6462
|
# Corresponds to the JSON property `autoRefreshCrawlRate`
|
6349
6463
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries]
|
6350
6464
|
attr_accessor :auto_refresh_crawl_rate
|
6351
6465
|
|
6466
|
+
# The historical crawl rate timeseries data, used for monitoring.
|
6467
|
+
# Corresponds to the JSON property `userTriggeredCrawlErrorRate`
|
6468
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries]
|
6469
|
+
attr_accessor :user_triggered_crawl_error_rate
|
6470
|
+
|
6352
6471
|
# The historical crawl rate timeseries data, used for monitoring.
|
6353
6472
|
# Corresponds to the JSON property `userTriggeredCrawlRate`
|
6354
6473
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries]
|
@@ -6360,7 +6479,9 @@ module Google
|
|
6360
6479
|
|
6361
6480
|
# Update properties of this object
|
6362
6481
|
def update!(**args)
|
6482
|
+
@auto_refresh_crawl_error_rate = args[:auto_refresh_crawl_error_rate] if args.key?(:auto_refresh_crawl_error_rate)
|
6363
6483
|
@auto_refresh_crawl_rate = args[:auto_refresh_crawl_rate] if args.key?(:auto_refresh_crawl_rate)
|
6484
|
+
@user_triggered_crawl_error_rate = args[:user_triggered_crawl_error_rate] if args.key?(:user_triggered_crawl_error_rate)
|
6364
6485
|
@user_triggered_crawl_rate = args[:user_triggered_crawl_rate] if args.key?(:user_triggered_crawl_rate)
|
6365
6486
|
end
|
6366
6487
|
end
|
@@ -9278,7 +9399,8 @@ module Google
|
|
9278
9399
|
# @return [String]
|
9279
9400
|
attr_accessor :title
|
9280
9401
|
|
9281
|
-
#
|
9402
|
+
# Optional. The URL for the page the user wants to promote. Must be set for site
|
9403
|
+
# search. For other verticals, this is optional.
|
9282
9404
|
# Corresponds to the JSON property `uri`
|
9283
9405
|
# @return [String]
|
9284
9406
|
attr_accessor :uri
|
@@ -9336,10 +9458,10 @@ module Google
|
|
9336
9458
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec]
|
9337
9459
|
attr_accessor :custom_fine_tuning_spec
|
9338
9460
|
|
9339
|
-
#
|
9340
|
-
# those data stores. This is only considered for Engines
|
9341
|
-
# stores. For engines with a single data store, the specs
|
9342
|
-
# SearchRequest should be used.
|
9461
|
+
# Specifications that define the specific [DataStore]s to be searched, along
|
9462
|
+
# with configurations for those data stores. This is only considered for Engines
|
9463
|
+
# with multiple data stores. For engines with a single data store, the specs
|
9464
|
+
# directly under SearchRequest should be used.
|
9343
9465
|
# Corresponds to the JSON property `dataStoreSpecs`
|
9344
9466
|
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec>]
|
9345
9467
|
attr_accessor :data_store_specs
|
@@ -12373,6 +12495,12 @@ module Google
|
|
12373
12495
|
class GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpec
|
12374
12496
|
include Google::Apis::Core::Hashable
|
12375
12497
|
|
12498
|
+
# Optional. Whether to disable spell correction. The default value is `false`.
|
12499
|
+
# Corresponds to the JSON property `disableSpellCorrection`
|
12500
|
+
# @return [Boolean]
|
12501
|
+
attr_accessor :disable_spell_correction
|
12502
|
+
alias_method :disable_spell_correction?, :disable_spell_correction
|
12503
|
+
|
12376
12504
|
# Query classification specification.
|
12377
12505
|
# Corresponds to the JSON property `queryClassificationSpec`
|
12378
12506
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec]
|
@@ -12389,6 +12517,7 @@ module Google
|
|
12389
12517
|
|
12390
12518
|
# Update properties of this object
|
12391
12519
|
def update!(**args)
|
12520
|
+
@disable_spell_correction = args[:disable_spell_correction] if args.key?(:disable_spell_correction)
|
12392
12521
|
@query_classification_spec = args[:query_classification_spec] if args.key?(:query_classification_spec)
|
12393
12522
|
@query_rephraser_spec = args[:query_rephraser_spec] if args.key?(:query_rephraser_spec)
|
12394
12523
|
end
|
@@ -15563,11 +15692,21 @@ module Google
|
|
15563
15692
|
class GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries
|
15564
15693
|
include Google::Apis::Core::Hashable
|
15565
15694
|
|
15695
|
+
# The historical crawl rate timeseries data, used for monitoring.
|
15696
|
+
# Corresponds to the JSON property `autoRefreshCrawlErrorRate`
|
15697
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries]
|
15698
|
+
attr_accessor :auto_refresh_crawl_error_rate
|
15699
|
+
|
15566
15700
|
# The historical crawl rate timeseries data, used for monitoring.
|
15567
15701
|
# Corresponds to the JSON property `autoRefreshCrawlRate`
|
15568
15702
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries]
|
15569
15703
|
attr_accessor :auto_refresh_crawl_rate
|
15570
15704
|
|
15705
|
+
# The historical crawl rate timeseries data, used for monitoring.
|
15706
|
+
# Corresponds to the JSON property `userTriggeredCrawlErrorRate`
|
15707
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries]
|
15708
|
+
attr_accessor :user_triggered_crawl_error_rate
|
15709
|
+
|
15571
15710
|
# The historical crawl rate timeseries data, used for monitoring.
|
15572
15711
|
# Corresponds to the JSON property `userTriggeredCrawlRate`
|
15573
15712
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries]
|
@@ -15579,7 +15718,9 @@ module Google
|
|
15579
15718
|
|
15580
15719
|
# Update properties of this object
|
15581
15720
|
def update!(**args)
|
15721
|
+
@auto_refresh_crawl_error_rate = args[:auto_refresh_crawl_error_rate] if args.key?(:auto_refresh_crawl_error_rate)
|
15582
15722
|
@auto_refresh_crawl_rate = args[:auto_refresh_crawl_rate] if args.key?(:auto_refresh_crawl_rate)
|
15723
|
+
@user_triggered_crawl_error_rate = args[:user_triggered_crawl_error_rate] if args.key?(:user_triggered_crawl_error_rate)
|
15583
15724
|
@user_triggered_crawl_rate = args[:user_triggered_crawl_rate] if args.key?(:user_triggered_crawl_rate)
|
15584
15725
|
end
|
15585
15726
|
end
|
@@ -16925,594 +17066,6 @@ module Google
|
|
16925
17066
|
end
|
16926
17067
|
end
|
16927
17068
|
|
16928
|
-
# Top-level message sent by the client for the `GenerateGroundedContent` method.
|
16929
|
-
class GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequest
|
16930
|
-
include Google::Apis::Core::Hashable
|
16931
|
-
|
16932
|
-
# Content of the current conversation with the model. For single-turn queries,
|
16933
|
-
# this is a single instance. For multi-turn queries, this is a repeated field
|
16934
|
-
# that contains conversation history + latest request.
|
16935
|
-
# Corresponds to the JSON property `contents`
|
16936
|
-
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGroundedGenerationContent>]
|
16937
|
-
attr_accessor :contents
|
16938
|
-
|
16939
|
-
# Content generation specification.
|
16940
|
-
# Corresponds to the JSON property `generationSpec`
|
16941
|
-
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGenerationSpec]
|
16942
|
-
attr_accessor :generation_spec
|
16943
|
-
|
16944
|
-
# Grounding specification.
|
16945
|
-
# Corresponds to the JSON property `groundingSpec`
|
16946
|
-
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSpec]
|
16947
|
-
attr_accessor :grounding_spec
|
16948
|
-
|
16949
|
-
# Base structured datatype containing multi-part content of a message.
|
16950
|
-
# Corresponds to the JSON property `systemInstruction`
|
16951
|
-
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGroundedGenerationContent]
|
16952
|
-
attr_accessor :system_instruction
|
16953
|
-
|
16954
|
-
# The user labels applied to a resource must meet the following requirements: *
|
16955
|
-
# Each resource can have multiple labels, up to a maximum of 64. * Each label
|
16956
|
-
# must be a key-value pair. * Keys have a minimum length of 1 character and a
|
16957
|
-
# maximum length of 63 characters and cannot be empty. Values can be empty and
|
16958
|
-
# have a maximum length of 63 characters. * Keys and values can contain only
|
16959
|
-
# lowercase letters, numeric characters, underscores, and dashes. All characters
|
16960
|
-
# must use UTF-8 encoding, and international characters are allowed. * The key
|
16961
|
-
# portion of a label must be unique. However, you can use the same key with
|
16962
|
-
# multiple resources. * Keys must start with a lowercase letter or international
|
16963
|
-
# character. See [Google Cloud Document](https://cloud.google.com/resource-
|
16964
|
-
# manager/docs/creating-managing-labels#requirements) for more details.
|
16965
|
-
# Corresponds to the JSON property `userLabels`
|
16966
|
-
# @return [Hash<String,String>]
|
16967
|
-
attr_accessor :user_labels
|
16968
|
-
|
16969
|
-
def initialize(**args)
|
16970
|
-
update!(**args)
|
16971
|
-
end
|
16972
|
-
|
16973
|
-
# Update properties of this object
|
16974
|
-
def update!(**args)
|
16975
|
-
@contents = args[:contents] if args.key?(:contents)
|
16976
|
-
@generation_spec = args[:generation_spec] if args.key?(:generation_spec)
|
16977
|
-
@grounding_spec = args[:grounding_spec] if args.key?(:grounding_spec)
|
16978
|
-
@system_instruction = args[:system_instruction] if args.key?(:system_instruction)
|
16979
|
-
@user_labels = args[:user_labels] if args.key?(:user_labels)
|
16980
|
-
end
|
16981
|
-
end
|
16982
|
-
|
16983
|
-
# Describes the options to customize dynamic retrieval.
|
16984
|
-
class GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestDynamicRetrievalConfiguration
|
16985
|
-
include Google::Apis::Core::Hashable
|
16986
|
-
|
16987
|
-
# Describes the predictor settings for dynamic retrieval.
|
16988
|
-
# Corresponds to the JSON property `predictor`
|
16989
|
-
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor]
|
16990
|
-
attr_accessor :predictor
|
16991
|
-
|
16992
|
-
def initialize(**args)
|
16993
|
-
update!(**args)
|
16994
|
-
end
|
16995
|
-
|
16996
|
-
# Update properties of this object
|
16997
|
-
def update!(**args)
|
16998
|
-
@predictor = args[:predictor] if args.key?(:predictor)
|
16999
|
-
end
|
17000
|
-
end
|
17001
|
-
|
17002
|
-
# Describes the predictor settings for dynamic retrieval.
|
17003
|
-
class GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor
|
17004
|
-
include Google::Apis::Core::Hashable
|
17005
|
-
|
17006
|
-
# The value of the threshold. If the predictor will predict a value smaller than
|
17007
|
-
# this, it would suppress grounding in the source.
|
17008
|
-
# Corresponds to the JSON property `threshold`
|
17009
|
-
# @return [Float]
|
17010
|
-
attr_accessor :threshold
|
17011
|
-
|
17012
|
-
# The version of the predictor to be used in dynamic retrieval.
|
17013
|
-
# Corresponds to the JSON property `version`
|
17014
|
-
# @return [String]
|
17015
|
-
attr_accessor :version
|
17016
|
-
|
17017
|
-
def initialize(**args)
|
17018
|
-
update!(**args)
|
17019
|
-
end
|
17020
|
-
|
17021
|
-
# Update properties of this object
|
17022
|
-
def update!(**args)
|
17023
|
-
@threshold = args[:threshold] if args.key?(:threshold)
|
17024
|
-
@version = args[:version] if args.key?(:version)
|
17025
|
-
end
|
17026
|
-
end
|
17027
|
-
|
17028
|
-
# Content generation specification.
|
17029
|
-
class GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGenerationSpec
|
17030
|
-
include Google::Apis::Core::Hashable
|
17031
|
-
|
17032
|
-
# If specified, custom value for frequency penalty will be used.
|
17033
|
-
# Corresponds to the JSON property `frequencyPenalty`
|
17034
|
-
# @return [Float]
|
17035
|
-
attr_accessor :frequency_penalty
|
17036
|
-
|
17037
|
-
# Language code for content. Use language tags defined by [BCP47](https://www.
|
17038
|
-
# rfc-editor.org/rfc/bcp/bcp47.txt).
|
17039
|
-
# Corresponds to the JSON property `languageCode`
|
17040
|
-
# @return [String]
|
17041
|
-
attr_accessor :language_code
|
17042
|
-
|
17043
|
-
# If specified, custom value for max output tokens will be used.
|
17044
|
-
# Corresponds to the JSON property `maxOutputTokens`
|
17045
|
-
# @return [Fixnum]
|
17046
|
-
attr_accessor :max_output_tokens
|
17047
|
-
|
17048
|
-
# Specifies which Vertex model id to use for generation.
|
17049
|
-
# Corresponds to the JSON property `modelId`
|
17050
|
-
# @return [String]
|
17051
|
-
attr_accessor :model_id
|
17052
|
-
|
17053
|
-
# If specified, custom value for presence penalty will be used.
|
17054
|
-
# Corresponds to the JSON property `presencePenalty`
|
17055
|
-
# @return [Float]
|
17056
|
-
attr_accessor :presence_penalty
|
17057
|
-
|
17058
|
-
# If specified, custom value for the seed will be used.
|
17059
|
-
# Corresponds to the JSON property `seed`
|
17060
|
-
# @return [Fixnum]
|
17061
|
-
attr_accessor :seed
|
17062
|
-
|
17063
|
-
# If specified, custom value for the temperature will be used.
|
17064
|
-
# Corresponds to the JSON property `temperature`
|
17065
|
-
# @return [Float]
|
17066
|
-
attr_accessor :temperature
|
17067
|
-
|
17068
|
-
# If specified, custom value for top-k sampling will be used.
|
17069
|
-
# Corresponds to the JSON property `topK`
|
17070
|
-
# @return [Fixnum]
|
17071
|
-
attr_accessor :top_k
|
17072
|
-
|
17073
|
-
# If specified, custom value for nucleus sampling will be used.
|
17074
|
-
# Corresponds to the JSON property `topP`
|
17075
|
-
# @return [Float]
|
17076
|
-
attr_accessor :top_p
|
17077
|
-
|
17078
|
-
def initialize(**args)
|
17079
|
-
update!(**args)
|
17080
|
-
end
|
17081
|
-
|
17082
|
-
# Update properties of this object
|
17083
|
-
def update!(**args)
|
17084
|
-
@frequency_penalty = args[:frequency_penalty] if args.key?(:frequency_penalty)
|
17085
|
-
@language_code = args[:language_code] if args.key?(:language_code)
|
17086
|
-
@max_output_tokens = args[:max_output_tokens] if args.key?(:max_output_tokens)
|
17087
|
-
@model_id = args[:model_id] if args.key?(:model_id)
|
17088
|
-
@presence_penalty = args[:presence_penalty] if args.key?(:presence_penalty)
|
17089
|
-
@seed = args[:seed] if args.key?(:seed)
|
17090
|
-
@temperature = args[:temperature] if args.key?(:temperature)
|
17091
|
-
@top_k = args[:top_k] if args.key?(:top_k)
|
17092
|
-
@top_p = args[:top_p] if args.key?(:top_p)
|
17093
|
-
end
|
17094
|
-
end
|
17095
|
-
|
17096
|
-
# Grounding source.
|
17097
|
-
class GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSource
|
17098
|
-
include Google::Apis::Core::Hashable
|
17099
|
-
|
17100
|
-
# Google Search config parameters.
|
17101
|
-
# Corresponds to the JSON property `googleSearchSource`
|
17102
|
-
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceGoogleSearchSource]
|
17103
|
-
attr_accessor :google_search_source
|
17104
|
-
|
17105
|
-
# Message to be used for grounding based on inline content.
|
17106
|
-
# Corresponds to the JSON property `inlineSource`
|
17107
|
-
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceInlineSource]
|
17108
|
-
attr_accessor :inline_source
|
17109
|
-
|
17110
|
-
# Message to be used for grounding with Vertex AI Search.
|
17111
|
-
# Corresponds to the JSON property `searchSource`
|
17112
|
-
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceSearchSource]
|
17113
|
-
attr_accessor :search_source
|
17114
|
-
|
17115
|
-
def initialize(**args)
|
17116
|
-
update!(**args)
|
17117
|
-
end
|
17118
|
-
|
17119
|
-
# Update properties of this object
|
17120
|
-
def update!(**args)
|
17121
|
-
@google_search_source = args[:google_search_source] if args.key?(:google_search_source)
|
17122
|
-
@inline_source = args[:inline_source] if args.key?(:inline_source)
|
17123
|
-
@search_source = args[:search_source] if args.key?(:search_source)
|
17124
|
-
end
|
17125
|
-
end
|
17126
|
-
|
17127
|
-
# Google Search config parameters.
|
17128
|
-
class GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceGoogleSearchSource
|
17129
|
-
include Google::Apis::Core::Hashable
|
17130
|
-
|
17131
|
-
# Describes the options to customize dynamic retrieval.
|
17132
|
-
# Corresponds to the JSON property `dynamicRetrievalConfig`
|
17133
|
-
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestDynamicRetrievalConfiguration]
|
17134
|
-
attr_accessor :dynamic_retrieval_config
|
17135
|
-
|
17136
|
-
def initialize(**args)
|
17137
|
-
update!(**args)
|
17138
|
-
end
|
17139
|
-
|
17140
|
-
# Update properties of this object
|
17141
|
-
def update!(**args)
|
17142
|
-
@dynamic_retrieval_config = args[:dynamic_retrieval_config] if args.key?(:dynamic_retrieval_config)
|
17143
|
-
end
|
17144
|
-
end
|
17145
|
-
|
17146
|
-
# Message to be used for grounding based on inline content.
|
17147
|
-
class GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceInlineSource
|
17148
|
-
include Google::Apis::Core::Hashable
|
17149
|
-
|
17150
|
-
# Attributes associated with the content. Common attributes include `source` (
|
17151
|
-
# indicating where the content was sourced from) and `author` (indicating the
|
17152
|
-
# author of the content).
|
17153
|
-
# Corresponds to the JSON property `attributes`
|
17154
|
-
# @return [Hash<String,String>]
|
17155
|
-
attr_accessor :attributes
|
17156
|
-
|
17157
|
-
# List of facts to be used for grounding.
|
17158
|
-
# Corresponds to the JSON property `groundingFacts`
|
17159
|
-
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGroundingFact>]
|
17160
|
-
attr_accessor :grounding_facts
|
17161
|
-
|
17162
|
-
def initialize(**args)
|
17163
|
-
update!(**args)
|
17164
|
-
end
|
17165
|
-
|
17166
|
-
# Update properties of this object
|
17167
|
-
def update!(**args)
|
17168
|
-
@attributes = args[:attributes] if args.key?(:attributes)
|
17169
|
-
@grounding_facts = args[:grounding_facts] if args.key?(:grounding_facts)
|
17170
|
-
end
|
17171
|
-
end
|
17172
|
-
|
17173
|
-
# Message to be used for grounding with Vertex AI Search.
|
17174
|
-
class GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceSearchSource
|
17175
|
-
include Google::Apis::Core::Hashable
|
17176
|
-
|
17177
|
-
# Filter expression to be applied to the search. The syntax is the same as
|
17178
|
-
# SearchRequest.filter.
|
17179
|
-
# Corresponds to the JSON property `filter`
|
17180
|
-
# @return [String]
|
17181
|
-
attr_accessor :filter
|
17182
|
-
|
17183
|
-
# Number of search results to return. The default value is 10. The maximumm
|
17184
|
-
# allowed value is 10.
|
17185
|
-
# Corresponds to the JSON property `maxResultCount`
|
17186
|
-
# @return [Fixnum]
|
17187
|
-
attr_accessor :max_result_count
|
17188
|
-
|
17189
|
-
# If set, safe search is enabled in Vertex AI Search requests.
|
17190
|
-
# Corresponds to the JSON property `safeSearch`
|
17191
|
-
# @return [Boolean]
|
17192
|
-
attr_accessor :safe_search
|
17193
|
-
alias_method :safe_search?, :safe_search
|
17194
|
-
|
17195
|
-
# The resource name of the Engine to use. Format: `projects/`project`/locations/`
|
17196
|
-
# location`/collections/`collection_id`/engines/`engine_id`/servingConfigs/`
|
17197
|
-
# serving_config_id``
|
17198
|
-
# Corresponds to the JSON property `servingConfig`
|
17199
|
-
# @return [String]
|
17200
|
-
attr_accessor :serving_config
|
17201
|
-
|
17202
|
-
def initialize(**args)
|
17203
|
-
update!(**args)
|
17204
|
-
end
|
17205
|
-
|
17206
|
-
# Update properties of this object
|
17207
|
-
def update!(**args)
|
17208
|
-
@filter = args[:filter] if args.key?(:filter)
|
17209
|
-
@max_result_count = args[:max_result_count] if args.key?(:max_result_count)
|
17210
|
-
@safe_search = args[:safe_search] if args.key?(:safe_search)
|
17211
|
-
@serving_config = args[:serving_config] if args.key?(:serving_config)
|
17212
|
-
end
|
17213
|
-
end
|
17214
|
-
|
17215
|
-
# Grounding specification.
|
17216
|
-
class GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSpec
|
17217
|
-
include Google::Apis::Core::Hashable
|
17218
|
-
|
17219
|
-
# Grounding sources.
|
17220
|
-
# Corresponds to the JSON property `groundingSources`
|
17221
|
-
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSource>]
|
17222
|
-
attr_accessor :grounding_sources
|
17223
|
-
|
17224
|
-
def initialize(**args)
|
17225
|
-
update!(**args)
|
17226
|
-
end
|
17227
|
-
|
17228
|
-
# Update properties of this object
|
17229
|
-
def update!(**args)
|
17230
|
-
@grounding_sources = args[:grounding_sources] if args.key?(:grounding_sources)
|
17231
|
-
end
|
17232
|
-
end
|
17233
|
-
|
17234
|
-
# Response for the `GenerateGroundedContent` method.
|
17235
|
-
class GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponse
|
17236
|
-
include Google::Apis::Core::Hashable
|
17237
|
-
|
17238
|
-
# Generated candidates.
|
17239
|
-
# Corresponds to the JSON property `candidates`
|
17240
|
-
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidate>]
|
17241
|
-
attr_accessor :candidates
|
17242
|
-
|
17243
|
-
def initialize(**args)
|
17244
|
-
update!(**args)
|
17245
|
-
end
|
17246
|
-
|
17247
|
-
# Update properties of this object
|
17248
|
-
def update!(**args)
|
17249
|
-
@candidates = args[:candidates] if args.key?(:candidates)
|
17250
|
-
end
|
17251
|
-
end
|
17252
|
-
|
17253
|
-
# A response candidate generated from the model.
|
17254
|
-
class GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidate
|
17255
|
-
include Google::Apis::Core::Hashable
|
17256
|
-
|
17257
|
-
# Base structured datatype containing multi-part content of a message.
|
17258
|
-
# Corresponds to the JSON property `content`
|
17259
|
-
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGroundedGenerationContent]
|
17260
|
-
attr_accessor :content
|
17261
|
-
|
17262
|
-
# Citation for the generated content.
|
17263
|
-
# Corresponds to the JSON property `groundingMetadata`
|
17264
|
-
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadata]
|
17265
|
-
attr_accessor :grounding_metadata
|
17266
|
-
|
17267
|
-
# The overall grounding score for the candidate, in the range of [0, 1].
|
17268
|
-
# Corresponds to the JSON property `groundingScore`
|
17269
|
-
# @return [Float]
|
17270
|
-
attr_accessor :grounding_score
|
17271
|
-
|
17272
|
-
# Index of the candidate.
|
17273
|
-
# Corresponds to the JSON property `index`
|
17274
|
-
# @return [Fixnum]
|
17275
|
-
attr_accessor :index
|
17276
|
-
|
17277
|
-
def initialize(**args)
|
17278
|
-
update!(**args)
|
17279
|
-
end
|
17280
|
-
|
17281
|
-
# Update properties of this object
|
17282
|
-
def update!(**args)
|
17283
|
-
@content = args[:content] if args.key?(:content)
|
17284
|
-
@grounding_metadata = args[:grounding_metadata] if args.key?(:grounding_metadata)
|
17285
|
-
@grounding_score = args[:grounding_score] if args.key?(:grounding_score)
|
17286
|
-
@index = args[:index] if args.key?(:index)
|
17287
|
-
end
|
17288
|
-
end
|
17289
|
-
|
17290
|
-
# Citation for the generated content.
|
17291
|
-
class GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadata
|
17292
|
-
include Google::Apis::Core::Hashable
|
17293
|
-
|
17294
|
-
# GroundingSupport across all claims in the answer candidate. An support to a
|
17295
|
-
# fact indicates that the claim is supported by the fact.
|
17296
|
-
# Corresponds to the JSON property `groundingSupport`
|
17297
|
-
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport>]
|
17298
|
-
attr_accessor :grounding_support
|
17299
|
-
|
17300
|
-
# Retrieval metadata to provide an understanding in the retrieval steps
|
17301
|
-
# performed by the model. There can be multiple such messages which can
|
17302
|
-
# correspond to different parts of the retrieval. This is a mechanism used to
|
17303
|
-
# ensure transparency to our users.
|
17304
|
-
# Corresponds to the JSON property `retrievalMetadata`
|
17305
|
-
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata>]
|
17306
|
-
attr_accessor :retrieval_metadata
|
17307
|
-
|
17308
|
-
# Google search entry point.
|
17309
|
-
# Corresponds to the JSON property `searchEntryPoint`
|
17310
|
-
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint]
|
17311
|
-
attr_accessor :search_entry_point
|
17312
|
-
|
17313
|
-
# List of chunks to be attributed across all claims in the candidate. These are
|
17314
|
-
# derived from the grounding sources supplied in the request.
|
17315
|
-
# Corresponds to the JSON property `supportChunks`
|
17316
|
-
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaFactChunk>]
|
17317
|
-
attr_accessor :support_chunks
|
17318
|
-
|
17319
|
-
# Web search queries for the following-up web search.
|
17320
|
-
# Corresponds to the JSON property `webSearchQueries`
|
17321
|
-
# @return [Array<String>]
|
17322
|
-
attr_accessor :web_search_queries
|
17323
|
-
|
17324
|
-
def initialize(**args)
|
17325
|
-
update!(**args)
|
17326
|
-
end
|
17327
|
-
|
17328
|
-
# Update properties of this object
|
17329
|
-
def update!(**args)
|
17330
|
-
@grounding_support = args[:grounding_support] if args.key?(:grounding_support)
|
17331
|
-
@retrieval_metadata = args[:retrieval_metadata] if args.key?(:retrieval_metadata)
|
17332
|
-
@search_entry_point = args[:search_entry_point] if args.key?(:search_entry_point)
|
17333
|
-
@support_chunks = args[:support_chunks] if args.key?(:support_chunks)
|
17334
|
-
@web_search_queries = args[:web_search_queries] if args.key?(:web_search_queries)
|
17335
|
-
end
|
17336
|
-
end
|
17337
|
-
|
17338
|
-
# Describes the metadata about dynamic retrieval.
|
17339
|
-
class GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalMetadata
|
17340
|
-
include Google::Apis::Core::Hashable
|
17341
|
-
|
17342
|
-
# Describes the metadata about the dynamic retrieval predictor.
|
17343
|
-
# Corresponds to the JSON property `predictorMetadata`
|
17344
|
-
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata]
|
17345
|
-
attr_accessor :predictor_metadata
|
17346
|
-
|
17347
|
-
def initialize(**args)
|
17348
|
-
update!(**args)
|
17349
|
-
end
|
17350
|
-
|
17351
|
-
# Update properties of this object
|
17352
|
-
def update!(**args)
|
17353
|
-
@predictor_metadata = args[:predictor_metadata] if args.key?(:predictor_metadata)
|
17354
|
-
end
|
17355
|
-
end
|
17356
|
-
|
17357
|
-
# Describes the metadata about the dynamic retrieval predictor.
|
17358
|
-
class GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata
|
17359
|
-
include Google::Apis::Core::Hashable
|
17360
|
-
|
17361
|
-
# The value of the predictor. This should be between [0, 1] where a value of 0
|
17362
|
-
# means that the query would not benefit from grounding, while a value of 1.0
|
17363
|
-
# means that the query would benefit the most. In between values allow to
|
17364
|
-
# differentiate between different usefulness scores for grounding.
|
17365
|
-
# Corresponds to the JSON property `prediction`
|
17366
|
-
# @return [Float]
|
17367
|
-
attr_accessor :prediction
|
17368
|
-
|
17369
|
-
# The version of the predictor which was used in dynamic retrieval.
|
17370
|
-
# Corresponds to the JSON property `version`
|
17371
|
-
# @return [String]
|
17372
|
-
attr_accessor :version
|
17373
|
-
|
17374
|
-
def initialize(**args)
|
17375
|
-
update!(**args)
|
17376
|
-
end
|
17377
|
-
|
17378
|
-
# Update properties of this object
|
17379
|
-
def update!(**args)
|
17380
|
-
@prediction = args[:prediction] if args.key?(:prediction)
|
17381
|
-
@version = args[:version] if args.key?(:version)
|
17382
|
-
end
|
17383
|
-
end
|
17384
|
-
|
17385
|
-
# Grounding info for a claim in the candidate and its support.
|
17386
|
-
class GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport
|
17387
|
-
include Google::Apis::Core::Hashable
|
17388
|
-
|
17389
|
-
# Text for the claim in the candidate. Always provided when a support is found.
|
17390
|
-
# Corresponds to the JSON property `claimText`
|
17391
|
-
# @return [String]
|
17392
|
-
attr_accessor :claim_text
|
17393
|
-
|
17394
|
-
# A list of indices (into 'support_chunks') specifying the citations associated
|
17395
|
-
# with the claim. For instance [1,3,4] means that support_chunks[1],
|
17396
|
-
# support_chunks[3], support_chunks[4] are the chunks attributed to the claim.
|
17397
|
-
# Corresponds to the JSON property `supportChunkIndices`
|
17398
|
-
# @return [Array<Fixnum>]
|
17399
|
-
attr_accessor :support_chunk_indices
|
17400
|
-
|
17401
|
-
# A score in the range of [0, 1] describing how grounded is a specific claim in
|
17402
|
-
# the support chunks indicated. Higher value means that the claim is better
|
17403
|
-
# supported by the chunks.
|
17404
|
-
# Corresponds to the JSON property `supportScore`
|
17405
|
-
# @return [Float]
|
17406
|
-
attr_accessor :support_score
|
17407
|
-
|
17408
|
-
def initialize(**args)
|
17409
|
-
update!(**args)
|
17410
|
-
end
|
17411
|
-
|
17412
|
-
# Update properties of this object
|
17413
|
-
def update!(**args)
|
17414
|
-
@claim_text = args[:claim_text] if args.key?(:claim_text)
|
17415
|
-
@support_chunk_indices = args[:support_chunk_indices] if args.key?(:support_chunk_indices)
|
17416
|
-
@support_score = args[:support_score] if args.key?(:support_score)
|
17417
|
-
end
|
17418
|
-
end
|
17419
|
-
|
17420
|
-
# Describes the metadata associated with a retrieval step.
|
17421
|
-
class GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata
|
17422
|
-
include Google::Apis::Core::Hashable
|
17423
|
-
|
17424
|
-
# Describes the metadata about dynamic retrieval.
|
17425
|
-
# Corresponds to the JSON property `dynamicRetrievalMetadata`
|
17426
|
-
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalMetadata]
|
17427
|
-
attr_accessor :dynamic_retrieval_metadata
|
17428
|
-
|
17429
|
-
# Describes the source to which the metadata is referring to.
|
17430
|
-
# Corresponds to the JSON property `source`
|
17431
|
-
# @return [String]
|
17432
|
-
attr_accessor :source
|
17433
|
-
|
17434
|
-
def initialize(**args)
|
17435
|
-
update!(**args)
|
17436
|
-
end
|
17437
|
-
|
17438
|
-
# Update properties of this object
|
17439
|
-
def update!(**args)
|
17440
|
-
@dynamic_retrieval_metadata = args[:dynamic_retrieval_metadata] if args.key?(:dynamic_retrieval_metadata)
|
17441
|
-
@source = args[:source] if args.key?(:source)
|
17442
|
-
end
|
17443
|
-
end
|
17444
|
-
|
17445
|
-
# Google search entry point.
|
17446
|
-
class GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint
|
17447
|
-
include Google::Apis::Core::Hashable
|
17448
|
-
|
17449
|
-
# Web content snippet that can be embedded in a web page or an app webview.
|
17450
|
-
# Corresponds to the JSON property `renderedContent`
|
17451
|
-
# @return [String]
|
17452
|
-
attr_accessor :rendered_content
|
17453
|
-
|
17454
|
-
# Base64 encoded JSON representing array of tuple.
|
17455
|
-
# Corresponds to the JSON property `sdkBlob`
|
17456
|
-
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
17457
|
-
# @return [String]
|
17458
|
-
attr_accessor :sdk_blob
|
17459
|
-
|
17460
|
-
def initialize(**args)
|
17461
|
-
update!(**args)
|
17462
|
-
end
|
17463
|
-
|
17464
|
-
# Update properties of this object
|
17465
|
-
def update!(**args)
|
17466
|
-
@rendered_content = args[:rendered_content] if args.key?(:rendered_content)
|
17467
|
-
@sdk_blob = args[:sdk_blob] if args.key?(:sdk_blob)
|
17468
|
-
end
|
17469
|
-
end
|
17470
|
-
|
17471
|
-
# Base structured datatype containing multi-part content of a message.
|
17472
|
-
class GoogleCloudDiscoveryengineV1betaGroundedGenerationContent
|
17473
|
-
include Google::Apis::Core::Hashable
|
17474
|
-
|
17475
|
-
# Ordered `Parts` that constitute a single message.
|
17476
|
-
# Corresponds to the JSON property `parts`
|
17477
|
-
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGroundedGenerationContentPart>]
|
17478
|
-
attr_accessor :parts
|
17479
|
-
|
17480
|
-
# Producer of the content. Must be either `user` or `model`. Intended to be used
|
17481
|
-
# for multi-turn conversations. Otherwise, it can be left unset.
|
17482
|
-
# Corresponds to the JSON property `role`
|
17483
|
-
# @return [String]
|
17484
|
-
attr_accessor :role
|
17485
|
-
|
17486
|
-
def initialize(**args)
|
17487
|
-
update!(**args)
|
17488
|
-
end
|
17489
|
-
|
17490
|
-
# Update properties of this object
|
17491
|
-
def update!(**args)
|
17492
|
-
@parts = args[:parts] if args.key?(:parts)
|
17493
|
-
@role = args[:role] if args.key?(:role)
|
17494
|
-
end
|
17495
|
-
end
|
17496
|
-
|
17497
|
-
# Single part of content.
|
17498
|
-
class GoogleCloudDiscoveryengineV1betaGroundedGenerationContentPart
|
17499
|
-
include Google::Apis::Core::Hashable
|
17500
|
-
|
17501
|
-
# Inline text.
|
17502
|
-
# Corresponds to the JSON property `text`
|
17503
|
-
# @return [String]
|
17504
|
-
attr_accessor :text
|
17505
|
-
|
17506
|
-
def initialize(**args)
|
17507
|
-
update!(**args)
|
17508
|
-
end
|
17509
|
-
|
17510
|
-
# Update properties of this object
|
17511
|
-
def update!(**args)
|
17512
|
-
@text = args[:text] if args.key?(:text)
|
17513
|
-
end
|
17514
|
-
end
|
17515
|
-
|
17516
17069
|
# Grounding Fact.
|
17517
17070
|
class GoogleCloudDiscoveryengineV1betaGroundingFact
|
17518
17071
|
include Google::Apis::Core::Hashable
|
@@ -19839,7 +19392,7 @@ module Google
|
|
19839
19392
|
alias_method :ignore_record_details_in_response?, :ignore_record_details_in_response
|
19840
19393
|
|
19841
19394
|
# The identifier of the model to use. It is one of: * `semantic-ranker-512@
|
19842
|
-
# latest`: Semantic ranking model with
|
19395
|
+
# latest`: Semantic ranking model with maximum input token size 512. It is set
|
19843
19396
|
# to `semantic-ranker-512@latest` by default if unspecified.
|
19844
19397
|
# Corresponds to the JSON property `model`
|
19845
19398
|
# @return [String]
|
@@ -20668,7 +20221,8 @@ module Google
|
|
20668
20221
|
# @return [String]
|
20669
20222
|
attr_accessor :title
|
20670
20223
|
|
20671
|
-
#
|
20224
|
+
# Optional. The URL for the page the user wants to promote. Must be set for site
|
20225
|
+
# search. For other verticals, this is optional.
|
20672
20226
|
# Corresponds to the JSON property `uri`
|
20673
20227
|
# @return [String]
|
20674
20228
|
attr_accessor :uri
|
@@ -20721,14 +20275,19 @@ module Google
|
|
20721
20275
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec]
|
20722
20276
|
attr_accessor :content_search_spec
|
20723
20277
|
|
20724
|
-
#
|
20725
|
-
# those data stores. This is only considered for Engines
|
20726
|
-
# stores. For engines with a single data store, the specs
|
20727
|
-
# SearchRequest should be used.
|
20278
|
+
# Specifications that define the specific [DataStore]s to be searched, along
|
20279
|
+
# with configurations for those data stores. This is only considered for Engines
|
20280
|
+
# with multiple data stores. For engines with a single data store, the specs
|
20281
|
+
# directly under SearchRequest should be used.
|
20728
20282
|
# Corresponds to the JSON property `dataStoreSpecs`
|
20729
20283
|
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec>]
|
20730
20284
|
attr_accessor :data_store_specs
|
20731
20285
|
|
20286
|
+
# Specifies features for display, like match highlighting.
|
20287
|
+
# Corresponds to the JSON property `displaySpec`
|
20288
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec]
|
20289
|
+
attr_accessor :display_spec
|
20290
|
+
|
20732
20291
|
# The specification that uses customized query embedding vector to do semantic
|
20733
20292
|
# document retrieval.
|
20734
20293
|
# Corresponds to the JSON property `embeddingSpec`
|
@@ -21000,6 +20559,7 @@ module Google
|
|
21000
20559
|
@canonical_filter = args[:canonical_filter] if args.key?(:canonical_filter)
|
21001
20560
|
@content_search_spec = args[:content_search_spec] if args.key?(:content_search_spec)
|
21002
20561
|
@data_store_specs = args[:data_store_specs] if args.key?(:data_store_specs)
|
20562
|
+
@display_spec = args[:display_spec] if args.key?(:display_spec)
|
21003
20563
|
@embedding_spec = args[:embedding_spec] if args.key?(:embedding_spec)
|
21004
20564
|
@facet_specs = args[:facet_specs] if args.key?(:facet_specs)
|
21005
20565
|
@filter = args[:filter] if args.key?(:filter)
|
@@ -21556,6 +21116,25 @@ module Google
|
|
21556
21116
|
end
|
21557
21117
|
end
|
21558
21118
|
|
21119
|
+
# Specifies features for display, like match highlighting.
|
21120
|
+
class GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec
|
21121
|
+
include Google::Apis::Core::Hashable
|
21122
|
+
|
21123
|
+
# The condition under which match highlighting should occur.
|
21124
|
+
# Corresponds to the JSON property `matchHighlightingCondition`
|
21125
|
+
# @return [String]
|
21126
|
+
attr_accessor :match_highlighting_condition
|
21127
|
+
|
21128
|
+
def initialize(**args)
|
21129
|
+
update!(**args)
|
21130
|
+
end
|
21131
|
+
|
21132
|
+
# Update properties of this object
|
21133
|
+
def update!(**args)
|
21134
|
+
@match_highlighting_condition = args[:match_highlighting_condition] if args.key?(:match_highlighting_condition)
|
21135
|
+
end
|
21136
|
+
end
|
21137
|
+
|
21559
21138
|
# The specification that uses customized query embedding vector to do semantic
|
21560
21139
|
# document retrieval.
|
21561
21140
|
class GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec
|
@@ -22229,6 +21808,11 @@ module Google
|
|
22229
21808
|
class GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfo
|
22230
21809
|
include Google::Apis::Core::Hashable
|
22231
21810
|
|
21811
|
+
# The classified intents from the input query.
|
21812
|
+
# Corresponds to the JSON property `classifiedIntents`
|
21813
|
+
# @return [Array<String>]
|
21814
|
+
attr_accessor :classified_intents
|
21815
|
+
|
22232
21816
|
# The filters that were extracted from the input query.
|
22233
21817
|
# Corresponds to the JSON property `extractedFilters`
|
22234
21818
|
# @return [String]
|
@@ -22257,6 +21841,7 @@ module Google
|
|
22257
21841
|
|
22258
21842
|
# Update properties of this object
|
22259
21843
|
def update!(**args)
|
21844
|
+
@classified_intents = args[:classified_intents] if args.key?(:classified_intents)
|
22260
21845
|
@extracted_filters = args[:extracted_filters] if args.key?(:extracted_filters)
|
22261
21846
|
@rewritten_query = args[:rewritten_query] if args.key?(:rewritten_query)
|
22262
21847
|
@sql_request = args[:sql_request] if args.key?(:sql_request)
|