google-apis-discoveryengine_v1beta 0.62.0 → 0.63.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.
@@ -786,6 +786,87 @@ module Google
|
|
786
786
|
end
|
787
787
|
end
|
788
788
|
|
789
|
+
# The specification for answer generation.
|
790
|
+
class GoogleCloudDiscoveryengineV1AnswerGenerationSpec
|
791
|
+
include Google::Apis::Core::Hashable
|
792
|
+
|
793
|
+
# The specification for user defined classifier.
|
794
|
+
# Corresponds to the JSON property `userDefinedClassifierSpec`
|
795
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec]
|
796
|
+
attr_accessor :user_defined_classifier_spec
|
797
|
+
|
798
|
+
def initialize(**args)
|
799
|
+
update!(**args)
|
800
|
+
end
|
801
|
+
|
802
|
+
# Update properties of this object
|
803
|
+
def update!(**args)
|
804
|
+
@user_defined_classifier_spec = args[:user_defined_classifier_spec] if args.key?(:user_defined_classifier_spec)
|
805
|
+
end
|
806
|
+
end
|
807
|
+
|
808
|
+
# The specification for user defined classifier.
|
809
|
+
class GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec
|
810
|
+
include Google::Apis::Core::Hashable
|
811
|
+
|
812
|
+
# Optional. Whether or not to enable and include user defined classifier.
|
813
|
+
# Corresponds to the JSON property `enableUserDefinedClassifier`
|
814
|
+
# @return [Boolean]
|
815
|
+
attr_accessor :enable_user_defined_classifier
|
816
|
+
alias_method :enable_user_defined_classifier?, :enable_user_defined_classifier
|
817
|
+
|
818
|
+
# Optional. The model id to be used for the user defined classifier.
|
819
|
+
# Corresponds to the JSON property `modelId`
|
820
|
+
# @return [String]
|
821
|
+
attr_accessor :model_id
|
822
|
+
|
823
|
+
# Optional. The preamble to be used for the user defined classifier.
|
824
|
+
# Corresponds to the JSON property `preamble`
|
825
|
+
# @return [String]
|
826
|
+
attr_accessor :preamble
|
827
|
+
|
828
|
+
# Optional. The seed value to be used for the user defined classifier.
|
829
|
+
# Corresponds to the JSON property `seed`
|
830
|
+
# @return [Fixnum]
|
831
|
+
attr_accessor :seed
|
832
|
+
|
833
|
+
# Optional. The task marker to be used for the user defined classifier.
|
834
|
+
# Corresponds to the JSON property `taskMarker`
|
835
|
+
# @return [String]
|
836
|
+
attr_accessor :task_marker
|
837
|
+
|
838
|
+
# Optional. The temperature value to be used for the user defined classifier.
|
839
|
+
# Corresponds to the JSON property `temperature`
|
840
|
+
# @return [Float]
|
841
|
+
attr_accessor :temperature
|
842
|
+
|
843
|
+
# Optional. The top-k value to be used for the user defined classifier.
|
844
|
+
# Corresponds to the JSON property `topK`
|
845
|
+
# @return [Fixnum]
|
846
|
+
attr_accessor :top_k
|
847
|
+
|
848
|
+
# Optional. The top-p value to be used for the user defined classifier.
|
849
|
+
# Corresponds to the JSON property `topP`
|
850
|
+
# @return [Float]
|
851
|
+
attr_accessor :top_p
|
852
|
+
|
853
|
+
def initialize(**args)
|
854
|
+
update!(**args)
|
855
|
+
end
|
856
|
+
|
857
|
+
# Update properties of this object
|
858
|
+
def update!(**args)
|
859
|
+
@enable_user_defined_classifier = args[:enable_user_defined_classifier] if args.key?(:enable_user_defined_classifier)
|
860
|
+
@model_id = args[:model_id] if args.key?(:model_id)
|
861
|
+
@preamble = args[:preamble] if args.key?(:preamble)
|
862
|
+
@seed = args[:seed] if args.key?(:seed)
|
863
|
+
@task_marker = args[:task_marker] if args.key?(:task_marker)
|
864
|
+
@temperature = args[:temperature] if args.key?(:temperature)
|
865
|
+
@top_k = args[:top_k] if args.key?(:top_k)
|
866
|
+
@top_p = args[:top_p] if args.key?(:top_p)
|
867
|
+
end
|
868
|
+
end
|
869
|
+
|
789
870
|
# Metadata related to the progress of the SiteSearchEngineService.
|
790
871
|
# BatchCreateTargetSites operation. This will be returned by the google.
|
791
872
|
# longrunning.Operation.metadata field.
|
@@ -2061,6 +2142,21 @@ module Google
|
|
2061
2142
|
attr_accessor :enable_table_annotation
|
2062
2143
|
alias_method :enable_table_annotation?, :enable_table_annotation
|
2063
2144
|
|
2145
|
+
# Optional. List of HTML classes to exclude from the parsed content.
|
2146
|
+
# Corresponds to the JSON property `excludeHtmlClasses`
|
2147
|
+
# @return [Array<String>]
|
2148
|
+
attr_accessor :exclude_html_classes
|
2149
|
+
|
2150
|
+
# Optional. List of HTML elements to exclude from the parsed content.
|
2151
|
+
# Corresponds to the JSON property `excludeHtmlElements`
|
2152
|
+
# @return [Array<String>]
|
2153
|
+
attr_accessor :exclude_html_elements
|
2154
|
+
|
2155
|
+
# Optional. List of HTML ids to exclude from the parsed content.
|
2156
|
+
# Corresponds to the JSON property `excludeHtmlIds`
|
2157
|
+
# @return [Array<String>]
|
2158
|
+
attr_accessor :exclude_html_ids
|
2159
|
+
|
2064
2160
|
def initialize(**args)
|
2065
2161
|
update!(**args)
|
2066
2162
|
end
|
@@ -2069,6 +2165,9 @@ module Google
|
|
2069
2165
|
def update!(**args)
|
2070
2166
|
@enable_image_annotation = args[:enable_image_annotation] if args.key?(:enable_image_annotation)
|
2071
2167
|
@enable_table_annotation = args[:enable_table_annotation] if args.key?(:enable_table_annotation)
|
2168
|
+
@exclude_html_classes = args[:exclude_html_classes] if args.key?(:exclude_html_classes)
|
2169
|
+
@exclude_html_elements = args[:exclude_html_elements] if args.key?(:exclude_html_elements)
|
2170
|
+
@exclude_html_ids = args[:exclude_html_ids] if args.key?(:exclude_html_ids)
|
2072
2171
|
end
|
2073
2172
|
end
|
2074
2173
|
|
@@ -2195,6 +2294,11 @@ module Google
|
|
2195
2294
|
# @return [String]
|
2196
2295
|
attr_accessor :industry_vertical
|
2197
2296
|
|
2297
|
+
# Additional config specs for a Media Recommendation engine.
|
2298
|
+
# Corresponds to the JSON property `mediaRecommendationEngineConfig`
|
2299
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig]
|
2300
|
+
attr_accessor :media_recommendation_engine_config
|
2301
|
+
|
2198
2302
|
# Immutable. The fully qualified resource name of the engine. This field must be
|
2199
2303
|
# a UTF-8 encoded string with a length limit of 1024 characters. Format: `
|
2200
2304
|
# projects/`project`/locations/`location`/collections/`collection`/engines/`
|
@@ -2233,6 +2337,7 @@ module Google
|
|
2233
2337
|
@disable_analytics = args[:disable_analytics] if args.key?(:disable_analytics)
|
2234
2338
|
@display_name = args[:display_name] if args.key?(:display_name)
|
2235
2339
|
@industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
|
2340
|
+
@media_recommendation_engine_config = args[:media_recommendation_engine_config] if args.key?(:media_recommendation_engine_config)
|
2236
2341
|
@name = args[:name] if args.key?(:name)
|
2237
2342
|
@search_engine_config = args[:search_engine_config] if args.key?(:search_engine_config)
|
2238
2343
|
@solution_type = args[:solution_type] if args.key?(:solution_type)
|
@@ -2374,6 +2479,157 @@ module Google
|
|
2374
2479
|
end
|
2375
2480
|
end
|
2376
2481
|
|
2482
|
+
# Additional config specs for a Media Recommendation engine.
|
2483
|
+
class GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig
|
2484
|
+
include Google::Apis::Core::Hashable
|
2485
|
+
|
2486
|
+
# More feature configs of the selected engine type.
|
2487
|
+
# Corresponds to the JSON property `engineFeaturesConfig`
|
2488
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigEngineFeaturesConfig]
|
2489
|
+
attr_accessor :engine_features_config
|
2490
|
+
|
2491
|
+
# The optimization objective. e.g., `cvr`. This field together with
|
2492
|
+
# optimization_objective describe engine metadata to use to control engine
|
2493
|
+
# training and serving. Currently supported values: `ctr`, `cvr`. If not
|
2494
|
+
# specified, we choose default based on engine type. Default depends on type of
|
2495
|
+
# recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr`
|
2496
|
+
# Corresponds to the JSON property `optimizationObjective`
|
2497
|
+
# @return [String]
|
2498
|
+
attr_accessor :optimization_objective
|
2499
|
+
|
2500
|
+
# Custom threshold for `cvr` optimization_objective.
|
2501
|
+
# Corresponds to the JSON property `optimizationObjectiveConfig`
|
2502
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigOptimizationObjectiveConfig]
|
2503
|
+
attr_accessor :optimization_objective_config
|
2504
|
+
|
2505
|
+
# The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). Since
|
2506
|
+
# part of the cost of running the service is frequency of training - this can be
|
2507
|
+
# used to determine when to train engine in order to control cost. If not
|
2508
|
+
# specified: the default value for `CreateEngine` method is `TRAINING`. The
|
2509
|
+
# default value for `UpdateEngine` method is to keep the state the same as
|
2510
|
+
# before.
|
2511
|
+
# Corresponds to the JSON property `trainingState`
|
2512
|
+
# @return [String]
|
2513
|
+
attr_accessor :training_state
|
2514
|
+
|
2515
|
+
# Required. The type of engine. e.g., `recommended-for-you`. This field together
|
2516
|
+
# with optimization_objective describe engine metadata to use to control engine
|
2517
|
+
# training and serving. Currently supported values: `recommended-for-you`, `
|
2518
|
+
# others-you-may-like`, `more-like-this`, `most-popular-items`.
|
2519
|
+
# Corresponds to the JSON property `type`
|
2520
|
+
# @return [String]
|
2521
|
+
attr_accessor :type
|
2522
|
+
|
2523
|
+
def initialize(**args)
|
2524
|
+
update!(**args)
|
2525
|
+
end
|
2526
|
+
|
2527
|
+
# Update properties of this object
|
2528
|
+
def update!(**args)
|
2529
|
+
@engine_features_config = args[:engine_features_config] if args.key?(:engine_features_config)
|
2530
|
+
@optimization_objective = args[:optimization_objective] if args.key?(:optimization_objective)
|
2531
|
+
@optimization_objective_config = args[:optimization_objective_config] if args.key?(:optimization_objective_config)
|
2532
|
+
@training_state = args[:training_state] if args.key?(:training_state)
|
2533
|
+
@type = args[:type] if args.key?(:type)
|
2534
|
+
end
|
2535
|
+
end
|
2536
|
+
|
2537
|
+
# More feature configs of the selected engine type.
|
2538
|
+
class GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigEngineFeaturesConfig
|
2539
|
+
include Google::Apis::Core::Hashable
|
2540
|
+
|
2541
|
+
# Feature configurations that are required for creating a Most Popular engine.
|
2542
|
+
# Corresponds to the JSON property `mostPopularConfig`
|
2543
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigMostPopularFeatureConfig]
|
2544
|
+
attr_accessor :most_popular_config
|
2545
|
+
|
2546
|
+
# Additional feature configurations for creating a `recommended-for-you` engine.
|
2547
|
+
# Corresponds to the JSON property `recommendedForYouConfig`
|
2548
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig]
|
2549
|
+
attr_accessor :recommended_for_you_config
|
2550
|
+
|
2551
|
+
def initialize(**args)
|
2552
|
+
update!(**args)
|
2553
|
+
end
|
2554
|
+
|
2555
|
+
# Update properties of this object
|
2556
|
+
def update!(**args)
|
2557
|
+
@most_popular_config = args[:most_popular_config] if args.key?(:most_popular_config)
|
2558
|
+
@recommended_for_you_config = args[:recommended_for_you_config] if args.key?(:recommended_for_you_config)
|
2559
|
+
end
|
2560
|
+
end
|
2561
|
+
|
2562
|
+
# Feature configurations that are required for creating a Most Popular engine.
|
2563
|
+
class GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigMostPopularFeatureConfig
|
2564
|
+
include Google::Apis::Core::Hashable
|
2565
|
+
|
2566
|
+
# The time window of which the engine is queried at training and prediction time.
|
2567
|
+
# Positive integers only. The value translates to the last X days of events.
|
2568
|
+
# Currently required for the `most-popular-items` engine.
|
2569
|
+
# Corresponds to the JSON property `timeWindowDays`
|
2570
|
+
# @return [Fixnum]
|
2571
|
+
attr_accessor :time_window_days
|
2572
|
+
|
2573
|
+
def initialize(**args)
|
2574
|
+
update!(**args)
|
2575
|
+
end
|
2576
|
+
|
2577
|
+
# Update properties of this object
|
2578
|
+
def update!(**args)
|
2579
|
+
@time_window_days = args[:time_window_days] if args.key?(:time_window_days)
|
2580
|
+
end
|
2581
|
+
end
|
2582
|
+
|
2583
|
+
# Custom threshold for `cvr` optimization_objective.
|
2584
|
+
class GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigOptimizationObjectiveConfig
|
2585
|
+
include Google::Apis::Core::Hashable
|
2586
|
+
|
2587
|
+
# Required. The name of the field to target. Currently supported values: `watch-
|
2588
|
+
# percentage`, `watch-time`.
|
2589
|
+
# Corresponds to the JSON property `targetField`
|
2590
|
+
# @return [String]
|
2591
|
+
attr_accessor :target_field
|
2592
|
+
|
2593
|
+
# Required. The threshold to be applied to the target (e.g., 0.5).
|
2594
|
+
# Corresponds to the JSON property `targetFieldValueFloat`
|
2595
|
+
# @return [Float]
|
2596
|
+
attr_accessor :target_field_value_float
|
2597
|
+
|
2598
|
+
def initialize(**args)
|
2599
|
+
update!(**args)
|
2600
|
+
end
|
2601
|
+
|
2602
|
+
# Update properties of this object
|
2603
|
+
def update!(**args)
|
2604
|
+
@target_field = args[:target_field] if args.key?(:target_field)
|
2605
|
+
@target_field_value_float = args[:target_field_value_float] if args.key?(:target_field_value_float)
|
2606
|
+
end
|
2607
|
+
end
|
2608
|
+
|
2609
|
+
# Additional feature configurations for creating a `recommended-for-you` engine.
|
2610
|
+
class GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig
|
2611
|
+
include Google::Apis::Core::Hashable
|
2612
|
+
|
2613
|
+
# The type of event with which the engine is queried at prediction time. If set
|
2614
|
+
# to `generic`, only `view-item`, `media-play`,and `media-complete` will be used
|
2615
|
+
# as `context-event` in engine training. If set to `view-home-page`, `view-home-
|
2616
|
+
# page` will also be used as `context-events` in addition to `view-item`, `media-
|
2617
|
+
# play`, and `media-complete`. Currently supported for the `recommended-for-you`
|
2618
|
+
# engine. Currently supported values: `view-home-page`, `generic`.
|
2619
|
+
# Corresponds to the JSON property `contextEventType`
|
2620
|
+
# @return [String]
|
2621
|
+
attr_accessor :context_event_type
|
2622
|
+
|
2623
|
+
def initialize(**args)
|
2624
|
+
update!(**args)
|
2625
|
+
end
|
2626
|
+
|
2627
|
+
# Update properties of this object
|
2628
|
+
def update!(**args)
|
2629
|
+
@context_event_type = args[:context_event_type] if args.key?(:context_event_type)
|
2630
|
+
end
|
2631
|
+
end
|
2632
|
+
|
2377
2633
|
# Configurations for a Search Engine.
|
2378
2634
|
class GoogleCloudDiscoveryengineV1EngineSearchEngineConfig
|
2379
2635
|
include Google::Apis::Core::Hashable
|
@@ -3496,6 +3752,11 @@ module Google
|
|
3496
3752
|
class GoogleCloudDiscoveryengineV1ServingConfig
|
3497
3753
|
include Google::Apis::Core::Hashable
|
3498
3754
|
|
3755
|
+
# The specification for answer generation.
|
3756
|
+
# Corresponds to the JSON property `answerGenerationSpec`
|
3757
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1AnswerGenerationSpec]
|
3758
|
+
attr_accessor :answer_generation_spec
|
3759
|
+
|
3499
3760
|
# Boost controls to use in serving path. All triggered boost controls will be
|
3500
3761
|
# applied. Boost controls must be in the same data store as the serving config.
|
3501
3762
|
# Maximum of 20 boost controls.
|
@@ -3652,6 +3913,7 @@ module Google
|
|
3652
3913
|
|
3653
3914
|
# Update properties of this object
|
3654
3915
|
def update!(**args)
|
3916
|
+
@answer_generation_spec = args[:answer_generation_spec] if args.key?(:answer_generation_spec)
|
3655
3917
|
@boost_control_ids = args[:boost_control_ids] if args.key?(:boost_control_ids)
|
3656
3918
|
@create_time = args[:create_time] if args.key?(:create_time)
|
3657
3919
|
@display_name = args[:display_name] if args.key?(:display_name)
|
@@ -6046,6 +6308,13 @@ module Google
|
|
6046
6308
|
class GoogleCloudDiscoveryengineV1alphaDataConnector
|
6047
6309
|
include Google::Apis::Core::Hashable
|
6048
6310
|
|
6311
|
+
# Optional. Whether the connector will be created with an ACL config. Currently
|
6312
|
+
# this field only affects Cloud Storage and BigQuery connectors.
|
6313
|
+
# Corresponds to the JSON property `aclEnabled`
|
6314
|
+
# @return [Boolean]
|
6315
|
+
attr_accessor :acl_enabled
|
6316
|
+
alias_method :acl_enabled?, :acl_enabled
|
6317
|
+
|
6049
6318
|
# Informations to support actions on the connector.
|
6050
6319
|
# Corresponds to the JSON property `actionConfig`
|
6051
6320
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaActionConfig]
|
@@ -6074,6 +6343,12 @@ module Google
|
|
6074
6343
|
# @return [Array<String>]
|
6075
6344
|
attr_accessor :blocking_reasons
|
6076
6345
|
|
6346
|
+
# Optional. The modes enabled for this connector. Default state is
|
6347
|
+
# CONNECTOR_MODE_UNSPECIFIED.
|
6348
|
+
# Corresponds to the JSON property `connectorModes`
|
6349
|
+
# @return [Array<String>]
|
6350
|
+
attr_accessor :connector_modes
|
6351
|
+
|
6077
6352
|
# Output only. The type of connector. Each source can only map to one type. For
|
6078
6353
|
# example, salesforce, confluence and jira have THIRD_PARTY connector type. It
|
6079
6354
|
# is notmutable once set by system.
|
@@ -6097,6 +6372,11 @@ module Google
|
|
6097
6372
|
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaDestinationConfig>]
|
6098
6373
|
attr_accessor :destination_configs
|
6099
6374
|
|
6375
|
+
# Any params and credentials used specifically for EUA connectors.
|
6376
|
+
# Corresponds to the JSON property `endUserConfig`
|
6377
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig]
|
6378
|
+
attr_accessor :end_user_config
|
6379
|
+
|
6100
6380
|
# List of entities from the connected data source to ingest.
|
6101
6381
|
# Corresponds to the JSON property `entities`
|
6102
6382
|
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity>]
|
@@ -6250,15 +6530,18 @@ module Google
|
|
6250
6530
|
|
6251
6531
|
# Update properties of this object
|
6252
6532
|
def update!(**args)
|
6533
|
+
@acl_enabled = args[:acl_enabled] if args.key?(:acl_enabled)
|
6253
6534
|
@action_config = args[:action_config] if args.key?(:action_config)
|
6254
6535
|
@alert_policy_configs = args[:alert_policy_configs] if args.key?(:alert_policy_configs)
|
6255
6536
|
@auto_run_disabled = args[:auto_run_disabled] if args.key?(:auto_run_disabled)
|
6256
6537
|
@bap_config = args[:bap_config] if args.key?(:bap_config)
|
6257
6538
|
@blocking_reasons = args[:blocking_reasons] if args.key?(:blocking_reasons)
|
6539
|
+
@connector_modes = args[:connector_modes] if args.key?(:connector_modes)
|
6258
6540
|
@connector_type = args[:connector_type] if args.key?(:connector_type)
|
6259
6541
|
@create_time = args[:create_time] if args.key?(:create_time)
|
6260
6542
|
@data_source = args[:data_source] if args.key?(:data_source)
|
6261
6543
|
@destination_configs = args[:destination_configs] if args.key?(:destination_configs)
|
6544
|
+
@end_user_config = args[:end_user_config] if args.key?(:end_user_config)
|
6262
6545
|
@entities = args[:entities] if args.key?(:entities)
|
6263
6546
|
@errors = args[:errors] if args.key?(:errors)
|
6264
6547
|
@identity_refresh_interval = args[:identity_refresh_interval] if args.key?(:identity_refresh_interval)
|
@@ -6281,6 +6564,31 @@ module Google
|
|
6281
6564
|
end
|
6282
6565
|
end
|
6283
6566
|
|
6567
|
+
# Any params and credentials used specifically for EUA connectors.
|
6568
|
+
class GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig
|
6569
|
+
include Google::Apis::Core::Hashable
|
6570
|
+
|
6571
|
+
# Optional. Any additional parameters needed for EUA.
|
6572
|
+
# Corresponds to the JSON property `additionalParams`
|
6573
|
+
# @return [Hash<String,Object>]
|
6574
|
+
attr_accessor :additional_params
|
6575
|
+
|
6576
|
+
# Optional. Any authentication parameters specific to EUA connectors.
|
6577
|
+
# Corresponds to the JSON property `authParams`
|
6578
|
+
# @return [Hash<String,Object>]
|
6579
|
+
attr_accessor :auth_params
|
6580
|
+
|
6581
|
+
def initialize(**args)
|
6582
|
+
update!(**args)
|
6583
|
+
end
|
6584
|
+
|
6585
|
+
# Update properties of this object
|
6586
|
+
def update!(**args)
|
6587
|
+
@additional_params = args[:additional_params] if args.key?(:additional_params)
|
6588
|
+
@auth_params = args[:auth_params] if args.key?(:auth_params)
|
6589
|
+
end
|
6590
|
+
end
|
6591
|
+
|
6284
6592
|
# The configuration for realtime sync to store additional params for realtime
|
6285
6593
|
# sync.
|
6286
6594
|
class GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig
|
@@ -7144,6 +7452,21 @@ module Google
|
|
7144
7452
|
attr_accessor :enable_table_annotation
|
7145
7453
|
alias_method :enable_table_annotation?, :enable_table_annotation
|
7146
7454
|
|
7455
|
+
# Optional. List of HTML classes to exclude from the parsed content.
|
7456
|
+
# Corresponds to the JSON property `excludeHtmlClasses`
|
7457
|
+
# @return [Array<String>]
|
7458
|
+
attr_accessor :exclude_html_classes
|
7459
|
+
|
7460
|
+
# Optional. List of HTML elements to exclude from the parsed content.
|
7461
|
+
# Corresponds to the JSON property `excludeHtmlElements`
|
7462
|
+
# @return [Array<String>]
|
7463
|
+
attr_accessor :exclude_html_elements
|
7464
|
+
|
7465
|
+
# Optional. List of HTML ids to exclude from the parsed content.
|
7466
|
+
# Corresponds to the JSON property `excludeHtmlIds`
|
7467
|
+
# @return [Array<String>]
|
7468
|
+
attr_accessor :exclude_html_ids
|
7469
|
+
|
7147
7470
|
def initialize(**args)
|
7148
7471
|
update!(**args)
|
7149
7472
|
end
|
@@ -7152,6 +7475,9 @@ module Google
|
|
7152
7475
|
def update!(**args)
|
7153
7476
|
@enable_image_annotation = args[:enable_image_annotation] if args.key?(:enable_image_annotation)
|
7154
7477
|
@enable_table_annotation = args[:enable_table_annotation] if args.key?(:enable_table_annotation)
|
7478
|
+
@exclude_html_classes = args[:exclude_html_classes] if args.key?(:exclude_html_classes)
|
7479
|
+
@exclude_html_elements = args[:exclude_html_elements] if args.key?(:exclude_html_elements)
|
7480
|
+
@exclude_html_ids = args[:exclude_html_ids] if args.key?(:exclude_html_ids)
|
7155
7481
|
end
|
7156
7482
|
end
|
7157
7483
|
|
@@ -7479,6 +7805,11 @@ module Google
|
|
7479
7805
|
class GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig
|
7480
7806
|
include Google::Apis::Core::Hashable
|
7481
7807
|
|
7808
|
+
# More feature configs of the selected engine type.
|
7809
|
+
# Corresponds to the JSON property `engineFeaturesConfig`
|
7810
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigEngineFeaturesConfig]
|
7811
|
+
attr_accessor :engine_features_config
|
7812
|
+
|
7482
7813
|
# The optimization objective. e.g., `cvr`. This field together with
|
7483
7814
|
# optimization_objective describe engine metadata to use to control engine
|
7484
7815
|
# training and serving. Currently supported values: `ctr`, `cvr`. If not
|
@@ -7517,6 +7848,7 @@ module Google
|
|
7517
7848
|
|
7518
7849
|
# Update properties of this object
|
7519
7850
|
def update!(**args)
|
7851
|
+
@engine_features_config = args[:engine_features_config] if args.key?(:engine_features_config)
|
7520
7852
|
@optimization_objective = args[:optimization_objective] if args.key?(:optimization_objective)
|
7521
7853
|
@optimization_objective_config = args[:optimization_objective_config] if args.key?(:optimization_objective_config)
|
7522
7854
|
@training_state = args[:training_state] if args.key?(:training_state)
|
@@ -7524,6 +7856,52 @@ module Google
|
|
7524
7856
|
end
|
7525
7857
|
end
|
7526
7858
|
|
7859
|
+
# More feature configs of the selected engine type.
|
7860
|
+
class GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigEngineFeaturesConfig
|
7861
|
+
include Google::Apis::Core::Hashable
|
7862
|
+
|
7863
|
+
# Feature configurations that are required for creating a Most Popular engine.
|
7864
|
+
# Corresponds to the JSON property `mostPopularConfig`
|
7865
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig]
|
7866
|
+
attr_accessor :most_popular_config
|
7867
|
+
|
7868
|
+
# Additional feature configurations for creating a `recommended-for-you` engine.
|
7869
|
+
# Corresponds to the JSON property `recommendedForYouConfig`
|
7870
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig]
|
7871
|
+
attr_accessor :recommended_for_you_config
|
7872
|
+
|
7873
|
+
def initialize(**args)
|
7874
|
+
update!(**args)
|
7875
|
+
end
|
7876
|
+
|
7877
|
+
# Update properties of this object
|
7878
|
+
def update!(**args)
|
7879
|
+
@most_popular_config = args[:most_popular_config] if args.key?(:most_popular_config)
|
7880
|
+
@recommended_for_you_config = args[:recommended_for_you_config] if args.key?(:recommended_for_you_config)
|
7881
|
+
end
|
7882
|
+
end
|
7883
|
+
|
7884
|
+
# Feature configurations that are required for creating a Most Popular engine.
|
7885
|
+
class GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig
|
7886
|
+
include Google::Apis::Core::Hashable
|
7887
|
+
|
7888
|
+
# The time window of which the engine is queried at training and prediction time.
|
7889
|
+
# Positive integers only. The value translates to the last X days of events.
|
7890
|
+
# Currently required for the `most-popular-items` engine.
|
7891
|
+
# Corresponds to the JSON property `timeWindowDays`
|
7892
|
+
# @return [Fixnum]
|
7893
|
+
attr_accessor :time_window_days
|
7894
|
+
|
7895
|
+
def initialize(**args)
|
7896
|
+
update!(**args)
|
7897
|
+
end
|
7898
|
+
|
7899
|
+
# Update properties of this object
|
7900
|
+
def update!(**args)
|
7901
|
+
@time_window_days = args[:time_window_days] if args.key?(:time_window_days)
|
7902
|
+
end
|
7903
|
+
end
|
7904
|
+
|
7527
7905
|
# Custom threshold for `cvr` optimization_objective.
|
7528
7906
|
class GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig
|
7529
7907
|
include Google::Apis::Core::Hashable
|
@@ -7550,6 +7928,30 @@ module Google
|
|
7550
7928
|
end
|
7551
7929
|
end
|
7552
7930
|
|
7931
|
+
# Additional feature configurations for creating a `recommended-for-you` engine.
|
7932
|
+
class GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig
|
7933
|
+
include Google::Apis::Core::Hashable
|
7934
|
+
|
7935
|
+
# The type of event with which the engine is queried at prediction time. If set
|
7936
|
+
# to `generic`, only `view-item`, `media-play`,and `media-complete` will be used
|
7937
|
+
# as `context-event` in engine training. If set to `view-home-page`, `view-home-
|
7938
|
+
# page` will also be used as `context-events` in addition to `view-item`, `media-
|
7939
|
+
# play`, and `media-complete`. Currently supported for the `recommended-for-you`
|
7940
|
+
# engine. Currently supported values: `view-home-page`, `generic`.
|
7941
|
+
# Corresponds to the JSON property `contextEventType`
|
7942
|
+
# @return [String]
|
7943
|
+
attr_accessor :context_event_type
|
7944
|
+
|
7945
|
+
def initialize(**args)
|
7946
|
+
update!(**args)
|
7947
|
+
end
|
7948
|
+
|
7949
|
+
# Update properties of this object
|
7950
|
+
def update!(**args)
|
7951
|
+
@context_event_type = args[:context_event_type] if args.key?(:context_event_type)
|
7952
|
+
end
|
7953
|
+
end
|
7954
|
+
|
7553
7955
|
# Additional information of a recommendation engine.
|
7554
7956
|
class GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata
|
7555
7957
|
include Google::Apis::Core::Hashable
|
@@ -11676,6 +12078,11 @@ module Google
|
|
11676
12078
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequestBoostSpec]
|
11677
12079
|
attr_accessor :boost_spec
|
11678
12080
|
|
12081
|
+
# Optional. Experiment ids for this request.
|
12082
|
+
# Corresponds to the JSON property `experimentIds`
|
12083
|
+
# @return [Array<String>]
|
12084
|
+
attr_accessor :experiment_ids
|
12085
|
+
|
11679
12086
|
# Indicates if tail suggestions should be returned if there are no suggestions
|
11680
12087
|
# that match the full query. Even if set to true, if there are suggestions that
|
11681
12088
|
# match the full query, those are returned and no tail suggestions are returned.
|
@@ -11743,6 +12150,7 @@ module Google
|
|
11743
12150
|
# Update properties of this object
|
11744
12151
|
def update!(**args)
|
11745
12152
|
@boost_spec = args[:boost_spec] if args.key?(:boost_spec)
|
12153
|
+
@experiment_ids = args[:experiment_ids] if args.key?(:experiment_ids)
|
11746
12154
|
@include_tail_suggestions = args[:include_tail_suggestions] if args.key?(:include_tail_suggestions)
|
11747
12155
|
@query = args[:query] if args.key?(:query)
|
11748
12156
|
@query_model = args[:query_model] if args.key?(:query_model)
|
@@ -12362,6 +12770,87 @@ module Google
|
|
12362
12770
|
end
|
12363
12771
|
end
|
12364
12772
|
|
12773
|
+
# The specification for answer generation.
|
12774
|
+
class GoogleCloudDiscoveryengineV1betaAnswerGenerationSpec
|
12775
|
+
include Google::Apis::Core::Hashable
|
12776
|
+
|
12777
|
+
# The specification for user defined classifier.
|
12778
|
+
# Corresponds to the JSON property `userDefinedClassifierSpec`
|
12779
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerGenerationSpecUserDefinedClassifierSpec]
|
12780
|
+
attr_accessor :user_defined_classifier_spec
|
12781
|
+
|
12782
|
+
def initialize(**args)
|
12783
|
+
update!(**args)
|
12784
|
+
end
|
12785
|
+
|
12786
|
+
# Update properties of this object
|
12787
|
+
def update!(**args)
|
12788
|
+
@user_defined_classifier_spec = args[:user_defined_classifier_spec] if args.key?(:user_defined_classifier_spec)
|
12789
|
+
end
|
12790
|
+
end
|
12791
|
+
|
12792
|
+
# The specification for user defined classifier.
|
12793
|
+
class GoogleCloudDiscoveryengineV1betaAnswerGenerationSpecUserDefinedClassifierSpec
|
12794
|
+
include Google::Apis::Core::Hashable
|
12795
|
+
|
12796
|
+
# Optional. Whether or not to enable and include user defined classifier.
|
12797
|
+
# Corresponds to the JSON property `enableUserDefinedClassifier`
|
12798
|
+
# @return [Boolean]
|
12799
|
+
attr_accessor :enable_user_defined_classifier
|
12800
|
+
alias_method :enable_user_defined_classifier?, :enable_user_defined_classifier
|
12801
|
+
|
12802
|
+
# Optional. The model id to be used for the user defined classifier.
|
12803
|
+
# Corresponds to the JSON property `modelId`
|
12804
|
+
# @return [String]
|
12805
|
+
attr_accessor :model_id
|
12806
|
+
|
12807
|
+
# Optional. The preamble to be used for the user defined classifier.
|
12808
|
+
# Corresponds to the JSON property `preamble`
|
12809
|
+
# @return [String]
|
12810
|
+
attr_accessor :preamble
|
12811
|
+
|
12812
|
+
# Optional. The seed value to be used for the user defined classifier.
|
12813
|
+
# Corresponds to the JSON property `seed`
|
12814
|
+
# @return [Fixnum]
|
12815
|
+
attr_accessor :seed
|
12816
|
+
|
12817
|
+
# Optional. The task marker to be used for the user defined classifier.
|
12818
|
+
# Corresponds to the JSON property `taskMarker`
|
12819
|
+
# @return [String]
|
12820
|
+
attr_accessor :task_marker
|
12821
|
+
|
12822
|
+
# Optional. The temperature value to be used for the user defined classifier.
|
12823
|
+
# Corresponds to the JSON property `temperature`
|
12824
|
+
# @return [Float]
|
12825
|
+
attr_accessor :temperature
|
12826
|
+
|
12827
|
+
# Optional. The top-k value to be used for the user defined classifier.
|
12828
|
+
# Corresponds to the JSON property `topK`
|
12829
|
+
# @return [Fixnum]
|
12830
|
+
attr_accessor :top_k
|
12831
|
+
|
12832
|
+
# Optional. The top-p value to be used for the user defined classifier.
|
12833
|
+
# Corresponds to the JSON property `topP`
|
12834
|
+
# @return [Float]
|
12835
|
+
attr_accessor :top_p
|
12836
|
+
|
12837
|
+
def initialize(**args)
|
12838
|
+
update!(**args)
|
12839
|
+
end
|
12840
|
+
|
12841
|
+
# Update properties of this object
|
12842
|
+
def update!(**args)
|
12843
|
+
@enable_user_defined_classifier = args[:enable_user_defined_classifier] if args.key?(:enable_user_defined_classifier)
|
12844
|
+
@model_id = args[:model_id] if args.key?(:model_id)
|
12845
|
+
@preamble = args[:preamble] if args.key?(:preamble)
|
12846
|
+
@seed = args[:seed] if args.key?(:seed)
|
12847
|
+
@task_marker = args[:task_marker] if args.key?(:task_marker)
|
12848
|
+
@temperature = args[:temperature] if args.key?(:temperature)
|
12849
|
+
@top_k = args[:top_k] if args.key?(:top_k)
|
12850
|
+
@top_p = args[:top_p] if args.key?(:top_p)
|
12851
|
+
end
|
12852
|
+
end
|
12853
|
+
|
12365
12854
|
# Grounding support for a claim in `answer_text`.
|
12366
12855
|
class GoogleCloudDiscoveryengineV1betaAnswerGroundingSupport
|
12367
12856
|
include Google::Apis::Core::Hashable
|
@@ -14372,6 +14861,12 @@ module Google
|
|
14372
14861
|
attr_accessor :grounding_check_required
|
14373
14862
|
alias_method :grounding_check_required?, :grounding_check_required
|
14374
14863
|
|
14864
|
+
# Confidence score for the claim in the answer candidate, in the range of [0, 1].
|
14865
|
+
# This is set only when enable_claim_level_score is true.
|
14866
|
+
# Corresponds to the JSON property `score`
|
14867
|
+
# @return [Float]
|
14868
|
+
attr_accessor :score
|
14869
|
+
|
14375
14870
|
# Position indicating the start of the claim in the answer candidate, measured
|
14376
14871
|
# in bytes. Note that this is not measured in characters and, therefore, must be
|
14377
14872
|
# rendered in the user interface keeping in mind that some characters may take
|
@@ -14393,6 +14888,7 @@ module Google
|
|
14393
14888
|
@claim_text = args[:claim_text] if args.key?(:claim_text)
|
14394
14889
|
@end_pos = args[:end_pos] if args.key?(:end_pos)
|
14395
14890
|
@grounding_check_required = args[:grounding_check_required] if args.key?(:grounding_check_required)
|
14891
|
+
@score = args[:score] if args.key?(:score)
|
14396
14892
|
@start_pos = args[:start_pos] if args.key?(:start_pos)
|
14397
14893
|
end
|
14398
14894
|
end
|
@@ -14410,6 +14906,12 @@ module Google
|
|
14410
14906
|
# @return [Float]
|
14411
14907
|
attr_accessor :citation_threshold
|
14412
14908
|
|
14909
|
+
# The control flag that enables claim-level grounding score in the response.
|
14910
|
+
# Corresponds to the JSON property `enableClaimLevelScore`
|
14911
|
+
# @return [Boolean]
|
14912
|
+
attr_accessor :enable_claim_level_score
|
14913
|
+
alias_method :enable_claim_level_score?, :enable_claim_level_score
|
14914
|
+
|
14413
14915
|
def initialize(**args)
|
14414
14916
|
update!(**args)
|
14415
14917
|
end
|
@@ -14417,6 +14919,7 @@ module Google
|
|
14417
14919
|
# Update properties of this object
|
14418
14920
|
def update!(**args)
|
14419
14921
|
@citation_threshold = args[:citation_threshold] if args.key?(:citation_threshold)
|
14922
|
+
@enable_claim_level_score = args[:enable_claim_level_score] if args.key?(:enable_claim_level_score)
|
14420
14923
|
end
|
14421
14924
|
end
|
14422
14925
|
|
@@ -16442,15 +16945,15 @@ module Google
|
|
16442
16945
|
|
16443
16946
|
# The MIME type of the content. Supported types: * `application/pdf` (PDF, only
|
16444
16947
|
# native PDFs are supported for now) * `text/html` (HTML) * `text/plain` (TXT) *
|
16445
|
-
# `text/xml` (XML) * `application/json` (JSON) * `
|
16446
|
-
# officedocument.wordprocessingml.document` (DOCX)
|
16447
|
-
# openxmlformats-officedocument.presentationml.presentation`
|
16448
|
-
# application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` (
|
16449
|
-
# application/vnd.ms-excel.sheet.macroenabled.12` (XLSM) The following
|
16450
|
-
# supported only if layout parser is enabled in the data store: * `
|
16451
|
-
# BMP) * `image/gif` (GIF) * `image/jpeg` (JPEG) * `image/png` (PNG)
|
16452
|
-
# tiff` (TIFF) See https://www.iana.org/assignments/media-types/media-
|
16453
|
-
# xhtml.
|
16948
|
+
# `application/xml` or `text/xml` (XML) * `application/json` (JSON) * `
|
16949
|
+
# application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX)
|
16950
|
+
# * `application/vnd.openxmlformats-officedocument.presentationml.presentation`
|
16951
|
+
# (PPTX) * `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` (
|
16952
|
+
# XLSX) * `application/vnd.ms-excel.sheet.macroenabled.12` (XLSM) The following
|
16953
|
+
# types are supported only if layout parser is enabled in the data store: * `
|
16954
|
+
# image/bmp` (BMP) * `image/gif` (GIF) * `image/jpeg` (JPEG) * `image/png` (PNG)
|
16955
|
+
# * `image/tiff` (TIFF) See https://www.iana.org/assignments/media-types/media-
|
16956
|
+
# types.xhtml.
|
16454
16957
|
# Corresponds to the JSON property `mimeType`
|
16455
16958
|
# @return [String]
|
16456
16959
|
attr_accessor :mime_type
|
@@ -16742,6 +17245,21 @@ module Google
|
|
16742
17245
|
attr_accessor :enable_table_annotation
|
16743
17246
|
alias_method :enable_table_annotation?, :enable_table_annotation
|
16744
17247
|
|
17248
|
+
# Optional. List of HTML classes to exclude from the parsed content.
|
17249
|
+
# Corresponds to the JSON property `excludeHtmlClasses`
|
17250
|
+
# @return [Array<String>]
|
17251
|
+
attr_accessor :exclude_html_classes
|
17252
|
+
|
17253
|
+
# Optional. List of HTML elements to exclude from the parsed content.
|
17254
|
+
# Corresponds to the JSON property `excludeHtmlElements`
|
17255
|
+
# @return [Array<String>]
|
17256
|
+
attr_accessor :exclude_html_elements
|
17257
|
+
|
17258
|
+
# Optional. List of HTML ids to exclude from the parsed content.
|
17259
|
+
# Corresponds to the JSON property `excludeHtmlIds`
|
17260
|
+
# @return [Array<String>]
|
17261
|
+
attr_accessor :exclude_html_ids
|
17262
|
+
|
16745
17263
|
def initialize(**args)
|
16746
17264
|
update!(**args)
|
16747
17265
|
end
|
@@ -16750,6 +17268,9 @@ module Google
|
|
16750
17268
|
def update!(**args)
|
16751
17269
|
@enable_image_annotation = args[:enable_image_annotation] if args.key?(:enable_image_annotation)
|
16752
17270
|
@enable_table_annotation = args[:enable_table_annotation] if args.key?(:enable_table_annotation)
|
17271
|
+
@exclude_html_classes = args[:exclude_html_classes] if args.key?(:exclude_html_classes)
|
17272
|
+
@exclude_html_elements = args[:exclude_html_elements] if args.key?(:exclude_html_elements)
|
17273
|
+
@exclude_html_ids = args[:exclude_html_ids] if args.key?(:exclude_html_ids)
|
16753
17274
|
end
|
16754
17275
|
end
|
16755
17276
|
|
@@ -16927,6 +17448,11 @@ module Google
|
|
16927
17448
|
# @return [String]
|
16928
17449
|
attr_accessor :industry_vertical
|
16929
17450
|
|
17451
|
+
# Additional config specs for a Media Recommendation engine.
|
17452
|
+
# Corresponds to the JSON property `mediaRecommendationEngineConfig`
|
17453
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig]
|
17454
|
+
attr_accessor :media_recommendation_engine_config
|
17455
|
+
|
16930
17456
|
# Immutable. The fully qualified resource name of the engine. This field must be
|
16931
17457
|
# a UTF-8 encoded string with a length limit of 1024 characters. Format: `
|
16932
17458
|
# projects/`project`/locations/`location`/collections/`collection`/engines/`
|
@@ -16965,6 +17491,7 @@ module Google
|
|
16965
17491
|
@disable_analytics = args[:disable_analytics] if args.key?(:disable_analytics)
|
16966
17492
|
@display_name = args[:display_name] if args.key?(:display_name)
|
16967
17493
|
@industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
|
17494
|
+
@media_recommendation_engine_config = args[:media_recommendation_engine_config] if args.key?(:media_recommendation_engine_config)
|
16968
17495
|
@name = args[:name] if args.key?(:name)
|
16969
17496
|
@search_engine_config = args[:search_engine_config] if args.key?(:search_engine_config)
|
16970
17497
|
@solution_type = args[:solution_type] if args.key?(:solution_type)
|
@@ -17106,6 +17633,157 @@ module Google
|
|
17106
17633
|
end
|
17107
17634
|
end
|
17108
17635
|
|
17636
|
+
# Additional config specs for a Media Recommendation engine.
|
17637
|
+
class GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig
|
17638
|
+
include Google::Apis::Core::Hashable
|
17639
|
+
|
17640
|
+
# More feature configs of the selected engine type.
|
17641
|
+
# Corresponds to the JSON property `engineFeaturesConfig`
|
17642
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigEngineFeaturesConfig]
|
17643
|
+
attr_accessor :engine_features_config
|
17644
|
+
|
17645
|
+
# The optimization objective. e.g., `cvr`. This field together with
|
17646
|
+
# optimization_objective describe engine metadata to use to control engine
|
17647
|
+
# training and serving. Currently supported values: `ctr`, `cvr`. If not
|
17648
|
+
# specified, we choose default based on engine type. Default depends on type of
|
17649
|
+
# recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr`
|
17650
|
+
# Corresponds to the JSON property `optimizationObjective`
|
17651
|
+
# @return [String]
|
17652
|
+
attr_accessor :optimization_objective
|
17653
|
+
|
17654
|
+
# Custom threshold for `cvr` optimization_objective.
|
17655
|
+
# Corresponds to the JSON property `optimizationObjectiveConfig`
|
17656
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig]
|
17657
|
+
attr_accessor :optimization_objective_config
|
17658
|
+
|
17659
|
+
# The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). Since
|
17660
|
+
# part of the cost of running the service is frequency of training - this can be
|
17661
|
+
# used to determine when to train engine in order to control cost. If not
|
17662
|
+
# specified: the default value for `CreateEngine` method is `TRAINING`. The
|
17663
|
+
# default value for `UpdateEngine` method is to keep the state the same as
|
17664
|
+
# before.
|
17665
|
+
# Corresponds to the JSON property `trainingState`
|
17666
|
+
# @return [String]
|
17667
|
+
attr_accessor :training_state
|
17668
|
+
|
17669
|
+
# Required. The type of engine. e.g., `recommended-for-you`. This field together
|
17670
|
+
# with optimization_objective describe engine metadata to use to control engine
|
17671
|
+
# training and serving. Currently supported values: `recommended-for-you`, `
|
17672
|
+
# others-you-may-like`, `more-like-this`, `most-popular-items`.
|
17673
|
+
# Corresponds to the JSON property `type`
|
17674
|
+
# @return [String]
|
17675
|
+
attr_accessor :type
|
17676
|
+
|
17677
|
+
def initialize(**args)
|
17678
|
+
update!(**args)
|
17679
|
+
end
|
17680
|
+
|
17681
|
+
# Update properties of this object
|
17682
|
+
def update!(**args)
|
17683
|
+
@engine_features_config = args[:engine_features_config] if args.key?(:engine_features_config)
|
17684
|
+
@optimization_objective = args[:optimization_objective] if args.key?(:optimization_objective)
|
17685
|
+
@optimization_objective_config = args[:optimization_objective_config] if args.key?(:optimization_objective_config)
|
17686
|
+
@training_state = args[:training_state] if args.key?(:training_state)
|
17687
|
+
@type = args[:type] if args.key?(:type)
|
17688
|
+
end
|
17689
|
+
end
|
17690
|
+
|
17691
|
+
# More feature configs of the selected engine type.
|
17692
|
+
class GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigEngineFeaturesConfig
|
17693
|
+
include Google::Apis::Core::Hashable
|
17694
|
+
|
17695
|
+
# Feature configurations that are required for creating a Most Popular engine.
|
17696
|
+
# Corresponds to the JSON property `mostPopularConfig`
|
17697
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig]
|
17698
|
+
attr_accessor :most_popular_config
|
17699
|
+
|
17700
|
+
# Additional feature configurations for creating a `recommended-for-you` engine.
|
17701
|
+
# Corresponds to the JSON property `recommendedForYouConfig`
|
17702
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig]
|
17703
|
+
attr_accessor :recommended_for_you_config
|
17704
|
+
|
17705
|
+
def initialize(**args)
|
17706
|
+
update!(**args)
|
17707
|
+
end
|
17708
|
+
|
17709
|
+
# Update properties of this object
|
17710
|
+
def update!(**args)
|
17711
|
+
@most_popular_config = args[:most_popular_config] if args.key?(:most_popular_config)
|
17712
|
+
@recommended_for_you_config = args[:recommended_for_you_config] if args.key?(:recommended_for_you_config)
|
17713
|
+
end
|
17714
|
+
end
|
17715
|
+
|
17716
|
+
# Feature configurations that are required for creating a Most Popular engine.
|
17717
|
+
class GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig
|
17718
|
+
include Google::Apis::Core::Hashable
|
17719
|
+
|
17720
|
+
# The time window of which the engine is queried at training and prediction time.
|
17721
|
+
# Positive integers only. The value translates to the last X days of events.
|
17722
|
+
# Currently required for the `most-popular-items` engine.
|
17723
|
+
# Corresponds to the JSON property `timeWindowDays`
|
17724
|
+
# @return [Fixnum]
|
17725
|
+
attr_accessor :time_window_days
|
17726
|
+
|
17727
|
+
def initialize(**args)
|
17728
|
+
update!(**args)
|
17729
|
+
end
|
17730
|
+
|
17731
|
+
# Update properties of this object
|
17732
|
+
def update!(**args)
|
17733
|
+
@time_window_days = args[:time_window_days] if args.key?(:time_window_days)
|
17734
|
+
end
|
17735
|
+
end
|
17736
|
+
|
17737
|
+
# Custom threshold for `cvr` optimization_objective.
|
17738
|
+
class GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig
|
17739
|
+
include Google::Apis::Core::Hashable
|
17740
|
+
|
17741
|
+
# Required. The name of the field to target. Currently supported values: `watch-
|
17742
|
+
# percentage`, `watch-time`.
|
17743
|
+
# Corresponds to the JSON property `targetField`
|
17744
|
+
# @return [String]
|
17745
|
+
attr_accessor :target_field
|
17746
|
+
|
17747
|
+
# Required. The threshold to be applied to the target (e.g., 0.5).
|
17748
|
+
# Corresponds to the JSON property `targetFieldValueFloat`
|
17749
|
+
# @return [Float]
|
17750
|
+
attr_accessor :target_field_value_float
|
17751
|
+
|
17752
|
+
def initialize(**args)
|
17753
|
+
update!(**args)
|
17754
|
+
end
|
17755
|
+
|
17756
|
+
# Update properties of this object
|
17757
|
+
def update!(**args)
|
17758
|
+
@target_field = args[:target_field] if args.key?(:target_field)
|
17759
|
+
@target_field_value_float = args[:target_field_value_float] if args.key?(:target_field_value_float)
|
17760
|
+
end
|
17761
|
+
end
|
17762
|
+
|
17763
|
+
# Additional feature configurations for creating a `recommended-for-you` engine.
|
17764
|
+
class GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig
|
17765
|
+
include Google::Apis::Core::Hashable
|
17766
|
+
|
17767
|
+
# The type of event with which the engine is queried at prediction time. If set
|
17768
|
+
# to `generic`, only `view-item`, `media-play`,and `media-complete` will be used
|
17769
|
+
# as `context-event` in engine training. If set to `view-home-page`, `view-home-
|
17770
|
+
# page` will also be used as `context-events` in addition to `view-item`, `media-
|
17771
|
+
# play`, and `media-complete`. Currently supported for the `recommended-for-you`
|
17772
|
+
# engine. Currently supported values: `view-home-page`, `generic`.
|
17773
|
+
# Corresponds to the JSON property `contextEventType`
|
17774
|
+
# @return [String]
|
17775
|
+
attr_accessor :context_event_type
|
17776
|
+
|
17777
|
+
def initialize(**args)
|
17778
|
+
update!(**args)
|
17779
|
+
end
|
17780
|
+
|
17781
|
+
# Update properties of this object
|
17782
|
+
def update!(**args)
|
17783
|
+
@context_event_type = args[:context_event_type] if args.key?(:context_event_type)
|
17784
|
+
end
|
17785
|
+
end
|
17786
|
+
|
17109
17787
|
# Configurations for a Search Engine.
|
17110
17788
|
class GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig
|
17111
17789
|
include Google::Apis::Core::Hashable
|
@@ -17257,6 +17935,11 @@ module Google
|
|
17257
17935
|
# @return [String]
|
17258
17936
|
attr_accessor :chunk_text
|
17259
17937
|
|
17938
|
+
# The domain of the source.
|
17939
|
+
# Corresponds to the JSON property `domain`
|
17940
|
+
# @return [String]
|
17941
|
+
attr_accessor :domain
|
17942
|
+
|
17260
17943
|
# The index of this chunk. Currently, only used for the streaming mode.
|
17261
17944
|
# Corresponds to the JSON property `index`
|
17262
17945
|
# @return [Fixnum]
|
@@ -17274,6 +17957,16 @@ module Google
|
|
17274
17957
|
# @return [Hash<String,String>]
|
17275
17958
|
attr_accessor :source_metadata
|
17276
17959
|
|
17960
|
+
# The title of the source.
|
17961
|
+
# Corresponds to the JSON property `title`
|
17962
|
+
# @return [String]
|
17963
|
+
attr_accessor :title
|
17964
|
+
|
17965
|
+
# The URI of the source.
|
17966
|
+
# Corresponds to the JSON property `uri`
|
17967
|
+
# @return [String]
|
17968
|
+
attr_accessor :uri
|
17969
|
+
|
17277
17970
|
def initialize(**args)
|
17278
17971
|
update!(**args)
|
17279
17972
|
end
|
@@ -17281,9 +17974,12 @@ module Google
|
|
17281
17974
|
# Update properties of this object
|
17282
17975
|
def update!(**args)
|
17283
17976
|
@chunk_text = args[:chunk_text] if args.key?(:chunk_text)
|
17977
|
+
@domain = args[:domain] if args.key?(:domain)
|
17284
17978
|
@index = args[:index] if args.key?(:index)
|
17285
17979
|
@source = args[:source] if args.key?(:source)
|
17286
17980
|
@source_metadata = args[:source_metadata] if args.key?(:source_metadata)
|
17981
|
+
@title = args[:title] if args.key?(:title)
|
17982
|
+
@uri = args[:uri] if args.key?(:uri)
|
17287
17983
|
end
|
17288
17984
|
end
|
17289
17985
|
|
@@ -23021,6 +23717,11 @@ module Google
|
|
23021
23717
|
class GoogleCloudDiscoveryengineV1betaServingConfig
|
23022
23718
|
include Google::Apis::Core::Hashable
|
23023
23719
|
|
23720
|
+
# The specification for answer generation.
|
23721
|
+
# Corresponds to the JSON property `answerGenerationSpec`
|
23722
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerGenerationSpec]
|
23723
|
+
attr_accessor :answer_generation_spec
|
23724
|
+
|
23024
23725
|
# Boost controls to use in serving path. All triggered boost controls will be
|
23025
23726
|
# applied. Boost controls must be in the same data store as the serving config.
|
23026
23727
|
# Maximum of 20 boost controls.
|
@@ -23187,6 +23888,7 @@ module Google
|
|
23187
23888
|
|
23188
23889
|
# Update properties of this object
|
23189
23890
|
def update!(**args)
|
23891
|
+
@answer_generation_spec = args[:answer_generation_spec] if args.key?(:answer_generation_spec)
|
23190
23892
|
@boost_control_ids = args[:boost_control_ids] if args.key?(:boost_control_ids)
|
23191
23893
|
@create_time = args[:create_time] if args.key?(:create_time)
|
23192
23894
|
@display_name = args[:display_name] if args.key?(:display_name)
|