google-apis-discoveryengine_v1alpha 0.34.0 → 0.35.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: be0c46d43095e5fa21901064ef36cc07c5b9335314f1d8935d41052ba1f88fbd
4
- data.tar.gz: edc3f3acb0355baf98d19fba820e45b4706d0d9a4636414f28a9e290ab86e6e5
3
+ metadata.gz: aca559c779f266b01b2162bf2959477c9f81d810d9f210997a263e14d4ba7be2
4
+ data.tar.gz: 8529f7ce92599aebaa251f14cd9508cf164136c6c6235f8c02c7b833ad425a76
5
5
  SHA512:
6
- metadata.gz: b0212532e0877f11a2e0ab631285deb2a511cd7861e2c4023f66d9a36a8062825978645d1d1c38ed556fc9a53f56558f02ce6b70f5ba0077541146d62c09efc8
7
- data.tar.gz: d921fe2918c33867fd15447587c67d2d91862bfd6e46d0e92d982c769b8de42604ad705b0f8374b7d3cdb04237f19cb8f1a6b49952079b1c97813484c03cd965
6
+ metadata.gz: 992b790bde5a44e21d8f255e9a7af7b24ce3cbbedf99a631ee2e4773da936e737312a667db6e775f2b1879b4b763d7fbddd7dd9a0b0b9b7763c99be058098cf5
7
+ data.tar.gz: 83b7e2f7fcfd2e7440eb0baccbe2bc03087849b5fa5af22dcad8bcea1007335e5d4b4c4069fd0e91fa5919fc45da3cb29bb6a04d89568b84224f0d9090cb9f2e
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release history for google-apis-discoveryengine_v1alpha
2
2
 
3
+ ### v0.35.0 (2024-02-11)
4
+
5
+ * Regenerated from discovery document revision 20240206
6
+
3
7
  ### v0.34.0 (2024-02-04)
4
8
 
5
9
  * Regenerated from discovery document revision 20240129
@@ -2225,6 +2225,26 @@ module Google
2225
2225
  end
2226
2226
  end
2227
2227
 
2228
+ # Defines custom fine tuning spec.
2229
+ class GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec
2230
+ include Google::Apis::Core::Hashable
2231
+
2232
+ # Whether or not to enable and include custom fine tuned search adaptor model.
2233
+ # Corresponds to the JSON property `enableSearchAdaptor`
2234
+ # @return [Boolean]
2235
+ attr_accessor :enable_search_adaptor
2236
+ alias_method :enable_search_adaptor?, :enable_search_adaptor
2237
+
2238
+ def initialize(**args)
2239
+ update!(**args)
2240
+ end
2241
+
2242
+ # Update properties of this object
2243
+ def update!(**args)
2244
+ @enable_search_adaptor = args[:enable_search_adaptor] if args.key?(:enable_search_adaptor)
2245
+ end
2246
+ end
2247
+
2228
2248
  # DataStore captures global settings and configs at the DataStore level.
2229
2249
  class GoogleCloudDiscoveryengineV1alphaDataStore
2230
2250
  include Google::Apis::Core::Hashable
@@ -2724,6 +2744,25 @@ module Google
2724
2744
  end
2725
2745
  end
2726
2746
 
2747
+ # Defines embedding config, used for bring your own embeddings feature.
2748
+ class GoogleCloudDiscoveryengineV1alphaEmbeddingConfig
2749
+ include Google::Apis::Core::Hashable
2750
+
2751
+ # Full field path in the schema mapped as embedding field.
2752
+ # Corresponds to the JSON property `fieldPath`
2753
+ # @return [String]
2754
+ attr_accessor :field_path
2755
+
2756
+ def initialize(**args)
2757
+ update!(**args)
2758
+ end
2759
+
2760
+ # Update properties of this object
2761
+ def update!(**args)
2762
+ @field_path = args[:field_path] if args.key?(:field_path)
2763
+ end
2764
+ end
2765
+
2727
2766
  # Metadata related to the progress of the SiteSearchEngineService.
2728
2767
  # EnableAdvancedSiteSearch operation. This will be returned by the google.
2729
2768
  # longrunning.Operation.metadata field.
@@ -3518,6 +3557,41 @@ module Google
3518
3557
  end
3519
3558
  end
3520
3559
 
3560
+ # Defines guided search spec.
3561
+ class GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec
3562
+ include Google::Apis::Core::Hashable
3563
+
3564
+ # Whether or not to enable and include refinement attributes in gudied search
3565
+ # result.
3566
+ # Corresponds to the JSON property `enableRefinementAttributes`
3567
+ # @return [Boolean]
3568
+ attr_accessor :enable_refinement_attributes
3569
+ alias_method :enable_refinement_attributes?, :enable_refinement_attributes
3570
+
3571
+ # Whether or not to enable and include related questions in search response.
3572
+ # Corresponds to the JSON property `enableRelatedQuestions`
3573
+ # @return [Boolean]
3574
+ attr_accessor :enable_related_questions
3575
+ alias_method :enable_related_questions?, :enable_related_questions
3576
+
3577
+ # Max number of related questions to be returned. The valid range is [1, 5]. If
3578
+ # enable_related_questions is true, the default value is 3.
3579
+ # Corresponds to the JSON property `maxRelatedQuestions`
3580
+ # @return [Fixnum]
3581
+ attr_accessor :max_related_questions
3582
+
3583
+ def initialize(**args)
3584
+ update!(**args)
3585
+ end
3586
+
3587
+ # Update properties of this object
3588
+ def update!(**args)
3589
+ @enable_refinement_attributes = args[:enable_refinement_attributes] if args.key?(:enable_refinement_attributes)
3590
+ @enable_related_questions = args[:enable_related_questions] if args.key?(:enable_related_questions)
3591
+ @max_related_questions = args[:max_related_questions] if args.key?(:max_related_questions)
3592
+ end
3593
+ end
3594
+
3521
3595
  # Metadata related to the progress of the ImportDocuments operation. This is
3522
3596
  # returned by the google.longrunning.Operation.metadata field.
3523
3597
  class GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata
@@ -4117,6 +4191,31 @@ module Google
4117
4191
  end
4118
4192
  end
4119
4193
 
4194
+ # Response for ListServingConfigs method.
4195
+ class GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse
4196
+ include Google::Apis::Core::Hashable
4197
+
4198
+ # Pagination token, if not returned indicates the last page.
4199
+ # Corresponds to the JSON property `nextPageToken`
4200
+ # @return [String]
4201
+ attr_accessor :next_page_token
4202
+
4203
+ # All the ServingConfigs for a given dataStore.
4204
+ # Corresponds to the JSON property `servingConfigs`
4205
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaServingConfig>]
4206
+ attr_accessor :serving_configs
4207
+
4208
+ def initialize(**args)
4209
+ update!(**args)
4210
+ end
4211
+
4212
+ # Update properties of this object
4213
+ def update!(**args)
4214
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
4215
+ @serving_configs = args[:serving_configs] if args.key?(:serving_configs)
4216
+ end
4217
+ end
4218
+
4120
4219
  # Response message for SiteSearchEngineService.ListTargetSites method.
4121
4220
  class GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse
4122
4221
  include Google::Apis::Core::Hashable
@@ -6429,6 +6528,267 @@ module Google
6429
6528
  end
6430
6529
  end
6431
6530
 
6531
+ # Configures metadata that is used to generate serving time results (e.g. search
6532
+ # results or recommendation predictions). The ServingConfig is passed in the
6533
+ # search and predict request and generates results.
6534
+ class GoogleCloudDiscoveryengineV1alphaServingConfig
6535
+ include Google::Apis::Core::Hashable
6536
+
6537
+ # Boost controls to use in serving path. All triggered boost controls will be
6538
+ # applied. Boost controls must be in the same data store as the serving config.
6539
+ # Maximum of 20 boost controls.
6540
+ # Corresponds to the JSON property `boostControlIds`
6541
+ # @return [Array<String>]
6542
+ attr_accessor :boost_control_ids
6543
+
6544
+ # Output only. ServingConfig created timestamp.
6545
+ # Corresponds to the JSON property `createTime`
6546
+ # @return [String]
6547
+ attr_accessor :create_time
6548
+
6549
+ # Defines custom fine tuning spec.
6550
+ # Corresponds to the JSON property `customFineTuningSpec`
6551
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec]
6552
+ attr_accessor :custom_fine_tuning_spec
6553
+
6554
+ # Required. The human readable serving config display name. Used in Discovery UI.
6555
+ # This field must be a UTF-8 encoded string with a length limit of 128
6556
+ # characters. Otherwise, an INVALID_ARGUMENT error is returned.
6557
+ # Corresponds to the JSON property `displayName`
6558
+ # @return [String]
6559
+ attr_accessor :display_name
6560
+
6561
+ # Condition do not associate specifications. If multiple do not associate
6562
+ # conditions match, all matching do not associate controls in the list will
6563
+ # execute. Order does not matter. Maximum number of specifications is 100. Can
6564
+ # only be set if SolutionType is SOLUTION_TYPE_SEARCH.
6565
+ # Corresponds to the JSON property `dissociateControlIds`
6566
+ # @return [Array<String>]
6567
+ attr_accessor :dissociate_control_ids
6568
+
6569
+ # How much diversity to use in recommendation model results e.g. `medium-
6570
+ # diversity` or `high-diversity`. Currently supported values: * `no-diversity` *
6571
+ # `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` If
6572
+ # not specified, we choose default based on recommendation model type. Default
6573
+ # value: `no-diversity`. Can only be set if SolutionType is
6574
+ # SOLUTION_TYPE_RECOMMENDATION.
6575
+ # Corresponds to the JSON property `diversityLevel`
6576
+ # @return [String]
6577
+ attr_accessor :diversity_level
6578
+
6579
+ # Defines embedding config, used for bring your own embeddings feature.
6580
+ # Corresponds to the JSON property `embeddingConfig`
6581
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEmbeddingConfig]
6582
+ attr_accessor :embedding_config
6583
+
6584
+ # Filter controls to use in serving path. All triggered filter controls will be
6585
+ # applied. Filter controls must be in the same data store as the serving config.
6586
+ # Maximum of 20 filter controls.
6587
+ # Corresponds to the JSON property `filterControlIds`
6588
+ # @return [Array<String>]
6589
+ attr_accessor :filter_control_ids
6590
+
6591
+ # Specifies the configurations needed for Generic Discovery.Currently we support:
6592
+ # * `content_search_spec`: configuration for generic content search.
6593
+ # Corresponds to the JSON property `genericConfig`
6594
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig]
6595
+ attr_accessor :generic_config
6596
+
6597
+ # Defines guided search spec.
6598
+ # Corresponds to the JSON property `guidedSearchSpec`
6599
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec]
6600
+ attr_accessor :guided_search_spec
6601
+
6602
+ # Condition ignore specifications. If multiple ignore conditions match, all
6603
+ # matching ignore controls in the list will execute. Order does not matter.
6604
+ # Maximum number of specifications is 100.
6605
+ # Corresponds to the JSON property `ignoreControlIds`
6606
+ # @return [Array<String>]
6607
+ attr_accessor :ignore_control_ids
6608
+
6609
+ # Specifies the configurations needed for Media Discovery. Currently we support:
6610
+ # * `demote_content_watched`: Threshold for watched content demotion. Customers
6611
+ # can specify if using watched content demotion or use viewed detail page. Using
6612
+ # the content watched demotion, customers need to specify the watched minutes or
6613
+ # percentage exceeds the threshold, the content will be demoted in the
6614
+ # recommendation result. * `promote_fresh_content`: cutoff days for fresh
6615
+ # content promotion. Customers can specify if using content freshness promotion.
6616
+ # If the content was published within the cutoff days, the content will be
6617
+ # promoted in the recommendation result. Can only be set if SolutionType is
6618
+ # SOLUTION_TYPE_RECOMMENDATION.
6619
+ # Corresponds to the JSON property `mediaConfig`
6620
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig]
6621
+ attr_accessor :media_config
6622
+
6623
+ # The id of the model to use at serving time. Currently only
6624
+ # RecommendationModels are supported. Can be changed but only to a compatible
6625
+ # model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when
6626
+ # SolutionType is SOLUTION_TYPE_RECOMMENDATION.
6627
+ # Corresponds to the JSON property `modelId`
6628
+ # @return [String]
6629
+ attr_accessor :model_id
6630
+
6631
+ # Immutable. Fully qualified name `projects/`project`/locations/`location`/
6632
+ # collections/`collection_id`/dataStores/`data_store_id`/servingConfigs/`
6633
+ # serving_config_id``
6634
+ # Corresponds to the JSON property `name`
6635
+ # @return [String]
6636
+ attr_accessor :name
6637
+
6638
+ # Condition oneway synonyms specifications. If multiple oneway synonyms
6639
+ # conditions match, all matching oneway synonyms controls in the list will
6640
+ # execute. Maximum number of specifications is 100. Can only be set if
6641
+ # SolutionType is SOLUTION_TYPE_SEARCH.
6642
+ # Corresponds to the JSON property `onewaySynonymsControlIds`
6643
+ # @return [Array<String>]
6644
+ attr_accessor :oneway_synonyms_control_ids
6645
+
6646
+ #
6647
+ # Corresponds to the JSON property `rankingExpression`
6648
+ # @return [String]
6649
+ attr_accessor :ranking_expression
6650
+
6651
+ # IDs of the redirect controls. Only the first triggered redirect action is
6652
+ # applied, even if multiple apply. Maximum number of specifications is 100. Can
6653
+ # only be set if SolutionType is SOLUTION_TYPE_SEARCH.
6654
+ # Corresponds to the JSON property `redirectControlIds`
6655
+ # @return [Array<String>]
6656
+ attr_accessor :redirect_control_ids
6657
+
6658
+ # Condition replacement specifications. Applied according to the order in the
6659
+ # list. A previously replaced term can not be re-replaced. Maximum number of
6660
+ # specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
6661
+ # Corresponds to the JSON property `replacementControlIds`
6662
+ # @return [Array<String>]
6663
+ attr_accessor :replacement_control_ids
6664
+
6665
+ # Required. Immutable. Specifies the solution type that a serving config can be
6666
+ # associated with.
6667
+ # Corresponds to the JSON property `solutionType`
6668
+ # @return [String]
6669
+ attr_accessor :solution_type
6670
+
6671
+ # Condition synonyms specifications. If multiple synonyms conditions match, all
6672
+ # matching synonyms controls in the list will execute. Maximum number of
6673
+ # specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
6674
+ # Corresponds to the JSON property `synonymsControlIds`
6675
+ # @return [Array<String>]
6676
+ attr_accessor :synonyms_control_ids
6677
+
6678
+ # Output only. ServingConfig updated timestamp.
6679
+ # Corresponds to the JSON property `updateTime`
6680
+ # @return [String]
6681
+ attr_accessor :update_time
6682
+
6683
+ def initialize(**args)
6684
+ update!(**args)
6685
+ end
6686
+
6687
+ # Update properties of this object
6688
+ def update!(**args)
6689
+ @boost_control_ids = args[:boost_control_ids] if args.key?(:boost_control_ids)
6690
+ @create_time = args[:create_time] if args.key?(:create_time)
6691
+ @custom_fine_tuning_spec = args[:custom_fine_tuning_spec] if args.key?(:custom_fine_tuning_spec)
6692
+ @display_name = args[:display_name] if args.key?(:display_name)
6693
+ @dissociate_control_ids = args[:dissociate_control_ids] if args.key?(:dissociate_control_ids)
6694
+ @diversity_level = args[:diversity_level] if args.key?(:diversity_level)
6695
+ @embedding_config = args[:embedding_config] if args.key?(:embedding_config)
6696
+ @filter_control_ids = args[:filter_control_ids] if args.key?(:filter_control_ids)
6697
+ @generic_config = args[:generic_config] if args.key?(:generic_config)
6698
+ @guided_search_spec = args[:guided_search_spec] if args.key?(:guided_search_spec)
6699
+ @ignore_control_ids = args[:ignore_control_ids] if args.key?(:ignore_control_ids)
6700
+ @media_config = args[:media_config] if args.key?(:media_config)
6701
+ @model_id = args[:model_id] if args.key?(:model_id)
6702
+ @name = args[:name] if args.key?(:name)
6703
+ @oneway_synonyms_control_ids = args[:oneway_synonyms_control_ids] if args.key?(:oneway_synonyms_control_ids)
6704
+ @ranking_expression = args[:ranking_expression] if args.key?(:ranking_expression)
6705
+ @redirect_control_ids = args[:redirect_control_ids] if args.key?(:redirect_control_ids)
6706
+ @replacement_control_ids = args[:replacement_control_ids] if args.key?(:replacement_control_ids)
6707
+ @solution_type = args[:solution_type] if args.key?(:solution_type)
6708
+ @synonyms_control_ids = args[:synonyms_control_ids] if args.key?(:synonyms_control_ids)
6709
+ @update_time = args[:update_time] if args.key?(:update_time)
6710
+ end
6711
+ end
6712
+
6713
+ # Specifies the configurations needed for Generic Discovery.Currently we support:
6714
+ # * `content_search_spec`: configuration for generic content search.
6715
+ class GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig
6716
+ include Google::Apis::Core::Hashable
6717
+
6718
+ # A specification for configuring the behavior of content search.
6719
+ # Corresponds to the JSON property `contentSearchSpec`
6720
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec]
6721
+ attr_accessor :content_search_spec
6722
+
6723
+ def initialize(**args)
6724
+ update!(**args)
6725
+ end
6726
+
6727
+ # Update properties of this object
6728
+ def update!(**args)
6729
+ @content_search_spec = args[:content_search_spec] if args.key?(:content_search_spec)
6730
+ end
6731
+ end
6732
+
6733
+ # Specifies the configurations needed for Media Discovery. Currently we support:
6734
+ # * `demote_content_watched`: Threshold for watched content demotion. Customers
6735
+ # can specify if using watched content demotion or use viewed detail page. Using
6736
+ # the content watched demotion, customers need to specify the watched minutes or
6737
+ # percentage exceeds the threshold, the content will be demoted in the
6738
+ # recommendation result. * `promote_fresh_content`: cutoff days for fresh
6739
+ # content promotion. Customers can specify if using content freshness promotion.
6740
+ # If the content was published within the cutoff days, the content will be
6741
+ # promoted in the recommendation result. Can only be set if SolutionType is
6742
+ # SOLUTION_TYPE_RECOMMENDATION.
6743
+ class GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig
6744
+ include Google::Apis::Core::Hashable
6745
+
6746
+ # Specifies the content freshness used for recommendation result. Contents will
6747
+ # be demoted if contents were published for more than content freshness cutoff
6748
+ # days.
6749
+ # Corresponds to the JSON property `contentFreshnessCutoffDays`
6750
+ # @return [Fixnum]
6751
+ attr_accessor :content_freshness_cutoff_days
6752
+
6753
+ # Specifies the content watched minutes threshold for demotion.
6754
+ # Corresponds to the JSON property `contentWatchedMinutesThreshold`
6755
+ # @return [Float]
6756
+ attr_accessor :content_watched_minutes_threshold
6757
+
6758
+ # Specifies the content watched percentage threshold for demotion. Threshold
6759
+ # value must be between [0, 1.0] inclusive.
6760
+ # Corresponds to the JSON property `contentWatchedPercentageThreshold`
6761
+ # @return [Float]
6762
+ attr_accessor :content_watched_percentage_threshold
6763
+
6764
+ # Specifies the content watched minutes threshold for demotion.
6765
+ # Corresponds to the JSON property `contentWatchedSecondsThreshold`
6766
+ # @return [Float]
6767
+ attr_accessor :content_watched_seconds_threshold
6768
+
6769
+ # Specifies the event type used for demoting recommendation result. Currently
6770
+ # supported values: * `view-item`: Item viewed. * `media-play`: Start/resume
6771
+ # watching a video, playing a song, etc. * `media-complete`: Finished or stopped
6772
+ # midway through a video, song, etc. If unset, watch history demotion will not
6773
+ # be applied. Content freshness demotion will still be applied.
6774
+ # Corresponds to the JSON property `demotionEventType`
6775
+ # @return [String]
6776
+ attr_accessor :demotion_event_type
6777
+
6778
+ def initialize(**args)
6779
+ update!(**args)
6780
+ end
6781
+
6782
+ # Update properties of this object
6783
+ def update!(**args)
6784
+ @content_freshness_cutoff_days = args[:content_freshness_cutoff_days] if args.key?(:content_freshness_cutoff_days)
6785
+ @content_watched_minutes_threshold = args[:content_watched_minutes_threshold] if args.key?(:content_watched_minutes_threshold)
6786
+ @content_watched_percentage_threshold = args[:content_watched_percentage_threshold] if args.key?(:content_watched_percentage_threshold)
6787
+ @content_watched_seconds_threshold = args[:content_watched_seconds_threshold] if args.key?(:content_watched_seconds_threshold)
6788
+ @demotion_event_type = args[:demotion_event_type] if args.key?(:demotion_event_type)
6789
+ end
6790
+ end
6791
+
6432
6792
  # SiteSearchEngine captures DataStore level site search persisting
6433
6793
  # configurations. It is a singleton value per data store.
6434
6794
  class GoogleCloudDiscoveryengineV1alphaSiteSearchEngine
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module DiscoveryengineV1alpha
18
18
  # Version of the google-apis-discoveryengine_v1alpha gem
19
- GEM_VERSION = "0.34.0"
19
+ GEM_VERSION = "0.35.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.13.1"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20240129"
25
+ REVISION = "20240206"
26
26
  end
27
27
  end
28
28
  end
@@ -424,6 +424,12 @@ module Google
424
424
  include Google::Apis::Core::JsonObjectSupport
425
425
  end
426
426
 
427
+ class GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec
428
+ class Representation < Google::Apis::Core::JsonRepresentation; end
429
+
430
+ include Google::Apis::Core::JsonObjectSupport
431
+ end
432
+
427
433
  class GoogleCloudDiscoveryengineV1alphaDataStore
428
434
  class Representation < Google::Apis::Core::JsonRepresentation; end
429
435
 
@@ -514,6 +520,12 @@ module Google
514
520
  include Google::Apis::Core::JsonObjectSupport
515
521
  end
516
522
 
523
+ class GoogleCloudDiscoveryengineV1alphaEmbeddingConfig
524
+ class Representation < Google::Apis::Core::JsonRepresentation; end
525
+
526
+ include Google::Apis::Core::JsonObjectSupport
527
+ end
528
+
517
529
  class GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata
518
530
  class Representation < Google::Apis::Core::JsonRepresentation; end
519
531
 
@@ -646,6 +658,12 @@ module Google
646
658
  include Google::Apis::Core::JsonObjectSupport
647
659
  end
648
660
 
661
+ class GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec
662
+ class Representation < Google::Apis::Core::JsonRepresentation; end
663
+
664
+ include Google::Apis::Core::JsonObjectSupport
665
+ end
666
+
649
667
  class GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata
650
668
  class Representation < Google::Apis::Core::JsonRepresentation; end
651
669
 
@@ -766,6 +784,12 @@ module Google
766
784
  include Google::Apis::Core::JsonObjectSupport
767
785
  end
768
786
 
787
+ class GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse
788
+ class Representation < Google::Apis::Core::JsonRepresentation; end
789
+
790
+ include Google::Apis::Core::JsonObjectSupport
791
+ end
792
+
769
793
  class GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse
770
794
  class Representation < Google::Apis::Core::JsonRepresentation; end
771
795
 
@@ -1138,6 +1162,24 @@ module Google
1138
1162
  include Google::Apis::Core::JsonObjectSupport
1139
1163
  end
1140
1164
 
1165
+ class GoogleCloudDiscoveryengineV1alphaServingConfig
1166
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1167
+
1168
+ include Google::Apis::Core::JsonObjectSupport
1169
+ end
1170
+
1171
+ class GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig
1172
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1173
+
1174
+ include Google::Apis::Core::JsonObjectSupport
1175
+ end
1176
+
1177
+ class GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig
1178
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1179
+
1180
+ include Google::Apis::Core::JsonObjectSupport
1181
+ end
1182
+
1141
1183
  class GoogleCloudDiscoveryengineV1alphaSiteSearchEngine
1142
1184
  class Representation < Google::Apis::Core::JsonRepresentation; end
1143
1185
 
@@ -2191,6 +2233,13 @@ module Google
2191
2233
  end
2192
2234
  end
2193
2235
 
2236
+ class GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec
2237
+ # @private
2238
+ class Representation < Google::Apis::Core::JsonRepresentation
2239
+ property :enable_search_adaptor, as: 'enableSearchAdaptor'
2240
+ end
2241
+ end
2242
+
2194
2243
  class GoogleCloudDiscoveryengineV1alphaDataStore
2195
2244
  # @private
2196
2245
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2329,6 +2378,13 @@ module Google
2329
2378
  end
2330
2379
  end
2331
2380
 
2381
+ class GoogleCloudDiscoveryengineV1alphaEmbeddingConfig
2382
+ # @private
2383
+ class Representation < Google::Apis::Core::JsonRepresentation
2384
+ property :field_path, as: 'fieldPath'
2385
+ end
2386
+ end
2387
+
2332
2388
  class GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata
2333
2389
  # @private
2334
2390
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2537,6 +2593,15 @@ module Google
2537
2593
  end
2538
2594
  end
2539
2595
 
2596
+ class GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec
2597
+ # @private
2598
+ class Representation < Google::Apis::Core::JsonRepresentation
2599
+ property :enable_refinement_attributes, as: 'enableRefinementAttributes'
2600
+ property :enable_related_questions, as: 'enableRelatedQuestions'
2601
+ property :max_related_questions, as: 'maxRelatedQuestions'
2602
+ end
2603
+ end
2604
+
2540
2605
  class GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata
2541
2606
  # @private
2542
2607
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2730,6 +2795,15 @@ module Google
2730
2795
  end
2731
2796
  end
2732
2797
 
2798
+ class GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse
2799
+ # @private
2800
+ class Representation < Google::Apis::Core::JsonRepresentation
2801
+ property :next_page_token, as: 'nextPageToken'
2802
+ collection :serving_configs, as: 'servingConfigs', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaServingConfig, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaServingConfig::Representation
2803
+
2804
+ end
2805
+ end
2806
+
2733
2807
  class GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse
2734
2808
  # @private
2735
2809
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -3335,6 +3409,57 @@ module Google
3335
3409
  end
3336
3410
  end
3337
3411
 
3412
+ class GoogleCloudDiscoveryengineV1alphaServingConfig
3413
+ # @private
3414
+ class Representation < Google::Apis::Core::JsonRepresentation
3415
+ collection :boost_control_ids, as: 'boostControlIds'
3416
+ property :create_time, as: 'createTime'
3417
+ property :custom_fine_tuning_spec, as: 'customFineTuningSpec', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec::Representation
3418
+
3419
+ property :display_name, as: 'displayName'
3420
+ collection :dissociate_control_ids, as: 'dissociateControlIds'
3421
+ property :diversity_level, as: 'diversityLevel'
3422
+ property :embedding_config, as: 'embeddingConfig', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEmbeddingConfig, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEmbeddingConfig::Representation
3423
+
3424
+ collection :filter_control_ids, as: 'filterControlIds'
3425
+ property :generic_config, as: 'genericConfig', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig::Representation
3426
+
3427
+ property :guided_search_spec, as: 'guidedSearchSpec', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec::Representation
3428
+
3429
+ collection :ignore_control_ids, as: 'ignoreControlIds'
3430
+ property :media_config, as: 'mediaConfig', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig::Representation
3431
+
3432
+ property :model_id, as: 'modelId'
3433
+ property :name, as: 'name'
3434
+ collection :oneway_synonyms_control_ids, as: 'onewaySynonymsControlIds'
3435
+ property :ranking_expression, as: 'rankingExpression'
3436
+ collection :redirect_control_ids, as: 'redirectControlIds'
3437
+ collection :replacement_control_ids, as: 'replacementControlIds'
3438
+ property :solution_type, as: 'solutionType'
3439
+ collection :synonyms_control_ids, as: 'synonymsControlIds'
3440
+ property :update_time, as: 'updateTime'
3441
+ end
3442
+ end
3443
+
3444
+ class GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig
3445
+ # @private
3446
+ class Representation < Google::Apis::Core::JsonRepresentation
3447
+ property :content_search_spec, as: 'contentSearchSpec', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec::Representation
3448
+
3449
+ end
3450
+ end
3451
+
3452
+ class GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig
3453
+ # @private
3454
+ class Representation < Google::Apis::Core::JsonRepresentation
3455
+ property :content_freshness_cutoff_days, as: 'contentFreshnessCutoffDays'
3456
+ property :content_watched_minutes_threshold, as: 'contentWatchedMinutesThreshold'
3457
+ property :content_watched_percentage_threshold, as: 'contentWatchedPercentageThreshold'
3458
+ property :content_watched_seconds_threshold, as: 'contentWatchedSecondsThreshold'
3459
+ property :demotion_event_type, as: 'demotionEventType'
3460
+ end
3461
+ end
3462
+
3338
3463
  class GoogleCloudDiscoveryengineV1alphaSiteSearchEngine
3339
3464
  # @private
3340
3465
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1682,6 +1682,119 @@ module Google
1682
1682
  execute_or_queue_command(command, &block)
1683
1683
  end
1684
1684
 
1685
+ # Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not
1686
+ # exist.
1687
+ # @param [String] name
1688
+ # Required. The resource name of the ServingConfig to get. Format: `projects/`
1689
+ # project_number`/locations/`location`/collections/`collection`/dataStores/`
1690
+ # data_store`/servingConfigs/`serving_config_id``
1691
+ # @param [String] fields
1692
+ # Selector specifying which fields to include in a partial response.
1693
+ # @param [String] quota_user
1694
+ # Available to use for quota purposes for server-side applications. Can be any
1695
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1696
+ # @param [Google::Apis::RequestOptions] options
1697
+ # Request-specific options
1698
+ #
1699
+ # @yield [result, err] Result & error if block supplied
1700
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaServingConfig] parsed result object
1701
+ # @yieldparam err [StandardError] error object if request failed
1702
+ #
1703
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaServingConfig]
1704
+ #
1705
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1706
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1707
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1708
+ def get_project_location_collection_data_store_serving_config(name, fields: nil, quota_user: nil, options: nil, &block)
1709
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
1710
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaServingConfig::Representation
1711
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaServingConfig
1712
+ command.params['name'] = name unless name.nil?
1713
+ command.query['fields'] = fields unless fields.nil?
1714
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1715
+ execute_or_queue_command(command, &block)
1716
+ end
1717
+
1718
+ # Lists all ServingConfigs linked to this dataStore.
1719
+ # @param [String] parent
1720
+ # Required. The dataStore resource name. Format: `projects/`project_number`/
1721
+ # locations/`location`/collections/`collection`/dataStores/`data_store``
1722
+ # @param [Fixnum] page_size
1723
+ # Optional. Maximum number of results to return. If unspecified, defaults to 100.
1724
+ # If a value greater than 100 is provided, at most 100 results are returned.
1725
+ # @param [String] page_token
1726
+ # Optional. A page token, received from a previous `ListServingConfigs` call.
1727
+ # Provide this to retrieve the subsequent page.
1728
+ # @param [String] fields
1729
+ # Selector specifying which fields to include in a partial response.
1730
+ # @param [String] quota_user
1731
+ # Available to use for quota purposes for server-side applications. Can be any
1732
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1733
+ # @param [Google::Apis::RequestOptions] options
1734
+ # Request-specific options
1735
+ #
1736
+ # @yield [result, err] Result & error if block supplied
1737
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse] parsed result object
1738
+ # @yieldparam err [StandardError] error object if request failed
1739
+ #
1740
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse]
1741
+ #
1742
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1743
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1744
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1745
+ def list_project_location_collection_data_store_serving_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1746
+ command = make_simple_command(:get, 'v1alpha/{+parent}/servingConfigs', options)
1747
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse::Representation
1748
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse
1749
+ command.params['parent'] = parent unless parent.nil?
1750
+ command.query['pageSize'] = page_size unless page_size.nil?
1751
+ command.query['pageToken'] = page_token unless page_token.nil?
1752
+ command.query['fields'] = fields unless fields.nil?
1753
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1754
+ execute_or_queue_command(command, &block)
1755
+ end
1756
+
1757
+ # Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does
1758
+ # not exist.
1759
+ # @param [String] name
1760
+ # Immutable. Fully qualified name `projects/`project`/locations/`location`/
1761
+ # collections/`collection_id`/dataStores/`data_store_id`/servingConfigs/`
1762
+ # serving_config_id``
1763
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaServingConfig] google_cloud_discoveryengine_v1alpha_serving_config_object
1764
+ # @param [String] update_mask
1765
+ # Indicates which fields in the provided ServingConfig to update. The following
1766
+ # are NOT supported: * ServingConfig.name If not set, all supported fields are
1767
+ # updated.
1768
+ # @param [String] fields
1769
+ # Selector specifying which fields to include in a partial response.
1770
+ # @param [String] quota_user
1771
+ # Available to use for quota purposes for server-side applications. Can be any
1772
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1773
+ # @param [Google::Apis::RequestOptions] options
1774
+ # Request-specific options
1775
+ #
1776
+ # @yield [result, err] Result & error if block supplied
1777
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaServingConfig] parsed result object
1778
+ # @yieldparam err [StandardError] error object if request failed
1779
+ #
1780
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaServingConfig]
1781
+ #
1782
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1783
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1784
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1785
+ def patch_project_location_collection_data_store_serving_config(name, google_cloud_discoveryengine_v1alpha_serving_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
1786
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
1787
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaServingConfig::Representation
1788
+ command.request_object = google_cloud_discoveryengine_v1alpha_serving_config_object
1789
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaServingConfig::Representation
1790
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaServingConfig
1791
+ command.params['name'] = name unless name.nil?
1792
+ command.query['updateMask'] = update_mask unless update_mask.nil?
1793
+ command.query['fields'] = fields unless fields.nil?
1794
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1795
+ execute_or_queue_command(command, &block)
1796
+ end
1797
+
1685
1798
  # Makes a recommendation, which requires a contextual user event.
1686
1799
  # @param [String] serving_config
1687
1800
  # Required. Full resource name of a ServingConfig: `projects/*/locations/global/
@@ -3125,6 +3238,119 @@ module Google
3125
3238
  execute_or_queue_command(command, &block)
3126
3239
  end
3127
3240
 
3241
+ # Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not
3242
+ # exist.
3243
+ # @param [String] name
3244
+ # Required. The resource name of the ServingConfig to get. Format: `projects/`
3245
+ # project_number`/locations/`location`/collections/`collection`/dataStores/`
3246
+ # data_store`/servingConfigs/`serving_config_id``
3247
+ # @param [String] fields
3248
+ # Selector specifying which fields to include in a partial response.
3249
+ # @param [String] quota_user
3250
+ # Available to use for quota purposes for server-side applications. Can be any
3251
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3252
+ # @param [Google::Apis::RequestOptions] options
3253
+ # Request-specific options
3254
+ #
3255
+ # @yield [result, err] Result & error if block supplied
3256
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaServingConfig] parsed result object
3257
+ # @yieldparam err [StandardError] error object if request failed
3258
+ #
3259
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaServingConfig]
3260
+ #
3261
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3262
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3263
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3264
+ def get_project_location_collection_engine_serving_config(name, fields: nil, quota_user: nil, options: nil, &block)
3265
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
3266
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaServingConfig::Representation
3267
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaServingConfig
3268
+ command.params['name'] = name unless name.nil?
3269
+ command.query['fields'] = fields unless fields.nil?
3270
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3271
+ execute_or_queue_command(command, &block)
3272
+ end
3273
+
3274
+ # Lists all ServingConfigs linked to this dataStore.
3275
+ # @param [String] parent
3276
+ # Required. The dataStore resource name. Format: `projects/`project_number`/
3277
+ # locations/`location`/collections/`collection`/dataStores/`data_store``
3278
+ # @param [Fixnum] page_size
3279
+ # Optional. Maximum number of results to return. If unspecified, defaults to 100.
3280
+ # If a value greater than 100 is provided, at most 100 results are returned.
3281
+ # @param [String] page_token
3282
+ # Optional. A page token, received from a previous `ListServingConfigs` call.
3283
+ # Provide this to retrieve the subsequent page.
3284
+ # @param [String] fields
3285
+ # Selector specifying which fields to include in a partial response.
3286
+ # @param [String] quota_user
3287
+ # Available to use for quota purposes for server-side applications. Can be any
3288
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3289
+ # @param [Google::Apis::RequestOptions] options
3290
+ # Request-specific options
3291
+ #
3292
+ # @yield [result, err] Result & error if block supplied
3293
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse] parsed result object
3294
+ # @yieldparam err [StandardError] error object if request failed
3295
+ #
3296
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse]
3297
+ #
3298
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3299
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3300
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3301
+ def list_project_location_collection_engine_serving_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
3302
+ command = make_simple_command(:get, 'v1alpha/{+parent}/servingConfigs', options)
3303
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse::Representation
3304
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse
3305
+ command.params['parent'] = parent unless parent.nil?
3306
+ command.query['pageSize'] = page_size unless page_size.nil?
3307
+ command.query['pageToken'] = page_token unless page_token.nil?
3308
+ command.query['fields'] = fields unless fields.nil?
3309
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3310
+ execute_or_queue_command(command, &block)
3311
+ end
3312
+
3313
+ # Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does
3314
+ # not exist.
3315
+ # @param [String] name
3316
+ # Immutable. Fully qualified name `projects/`project`/locations/`location`/
3317
+ # collections/`collection_id`/dataStores/`data_store_id`/servingConfigs/`
3318
+ # serving_config_id``
3319
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaServingConfig] google_cloud_discoveryengine_v1alpha_serving_config_object
3320
+ # @param [String] update_mask
3321
+ # Indicates which fields in the provided ServingConfig to update. The following
3322
+ # are NOT supported: * ServingConfig.name If not set, all supported fields are
3323
+ # updated.
3324
+ # @param [String] fields
3325
+ # Selector specifying which fields to include in a partial response.
3326
+ # @param [String] quota_user
3327
+ # Available to use for quota purposes for server-side applications. Can be any
3328
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3329
+ # @param [Google::Apis::RequestOptions] options
3330
+ # Request-specific options
3331
+ #
3332
+ # @yield [result, err] Result & error if block supplied
3333
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaServingConfig] parsed result object
3334
+ # @yieldparam err [StandardError] error object if request failed
3335
+ #
3336
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaServingConfig]
3337
+ #
3338
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3339
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3340
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3341
+ def patch_project_location_collection_engine_serving_config(name, google_cloud_discoveryengine_v1alpha_serving_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
3342
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
3343
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaServingConfig::Representation
3344
+ command.request_object = google_cloud_discoveryengine_v1alpha_serving_config_object
3345
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaServingConfig::Representation
3346
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaServingConfig
3347
+ command.params['name'] = name unless name.nil?
3348
+ command.query['updateMask'] = update_mask unless update_mask.nil?
3349
+ command.query['fields'] = fields unless fields.nil?
3350
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3351
+ execute_or_queue_command(command, &block)
3352
+ end
3353
+
3128
3354
  # Makes a recommendation, which requires a contextual user event.
3129
3355
  # @param [String] serving_config
3130
3356
  # Required. Full resource name of a ServingConfig: `projects/*/locations/global/
@@ -4553,6 +4779,119 @@ module Google
4553
4779
  execute_or_queue_command(command, &block)
4554
4780
  end
4555
4781
 
4782
+ # Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not
4783
+ # exist.
4784
+ # @param [String] name
4785
+ # Required. The resource name of the ServingConfig to get. Format: `projects/`
4786
+ # project_number`/locations/`location`/collections/`collection`/dataStores/`
4787
+ # data_store`/servingConfigs/`serving_config_id``
4788
+ # @param [String] fields
4789
+ # Selector specifying which fields to include in a partial response.
4790
+ # @param [String] quota_user
4791
+ # Available to use for quota purposes for server-side applications. Can be any
4792
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4793
+ # @param [Google::Apis::RequestOptions] options
4794
+ # Request-specific options
4795
+ #
4796
+ # @yield [result, err] Result & error if block supplied
4797
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaServingConfig] parsed result object
4798
+ # @yieldparam err [StandardError] error object if request failed
4799
+ #
4800
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaServingConfig]
4801
+ #
4802
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4803
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4804
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4805
+ def get_project_location_data_store_serving_config(name, fields: nil, quota_user: nil, options: nil, &block)
4806
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
4807
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaServingConfig::Representation
4808
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaServingConfig
4809
+ command.params['name'] = name unless name.nil?
4810
+ command.query['fields'] = fields unless fields.nil?
4811
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4812
+ execute_or_queue_command(command, &block)
4813
+ end
4814
+
4815
+ # Lists all ServingConfigs linked to this dataStore.
4816
+ # @param [String] parent
4817
+ # Required. The dataStore resource name. Format: `projects/`project_number`/
4818
+ # locations/`location`/collections/`collection`/dataStores/`data_store``
4819
+ # @param [Fixnum] page_size
4820
+ # Optional. Maximum number of results to return. If unspecified, defaults to 100.
4821
+ # If a value greater than 100 is provided, at most 100 results are returned.
4822
+ # @param [String] page_token
4823
+ # Optional. A page token, received from a previous `ListServingConfigs` call.
4824
+ # Provide this to retrieve the subsequent page.
4825
+ # @param [String] fields
4826
+ # Selector specifying which fields to include in a partial response.
4827
+ # @param [String] quota_user
4828
+ # Available to use for quota purposes for server-side applications. Can be any
4829
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4830
+ # @param [Google::Apis::RequestOptions] options
4831
+ # Request-specific options
4832
+ #
4833
+ # @yield [result, err] Result & error if block supplied
4834
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse] parsed result object
4835
+ # @yieldparam err [StandardError] error object if request failed
4836
+ #
4837
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse]
4838
+ #
4839
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4840
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4841
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4842
+ def list_project_location_data_store_serving_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
4843
+ command = make_simple_command(:get, 'v1alpha/{+parent}/servingConfigs', options)
4844
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse::Representation
4845
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse
4846
+ command.params['parent'] = parent unless parent.nil?
4847
+ command.query['pageSize'] = page_size unless page_size.nil?
4848
+ command.query['pageToken'] = page_token unless page_token.nil?
4849
+ command.query['fields'] = fields unless fields.nil?
4850
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4851
+ execute_or_queue_command(command, &block)
4852
+ end
4853
+
4854
+ # Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does
4855
+ # not exist.
4856
+ # @param [String] name
4857
+ # Immutable. Fully qualified name `projects/`project`/locations/`location`/
4858
+ # collections/`collection_id`/dataStores/`data_store_id`/servingConfigs/`
4859
+ # serving_config_id``
4860
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaServingConfig] google_cloud_discoveryengine_v1alpha_serving_config_object
4861
+ # @param [String] update_mask
4862
+ # Indicates which fields in the provided ServingConfig to update. The following
4863
+ # are NOT supported: * ServingConfig.name If not set, all supported fields are
4864
+ # updated.
4865
+ # @param [String] fields
4866
+ # Selector specifying which fields to include in a partial response.
4867
+ # @param [String] quota_user
4868
+ # Available to use for quota purposes for server-side applications. Can be any
4869
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4870
+ # @param [Google::Apis::RequestOptions] options
4871
+ # Request-specific options
4872
+ #
4873
+ # @yield [result, err] Result & error if block supplied
4874
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaServingConfig] parsed result object
4875
+ # @yieldparam err [StandardError] error object if request failed
4876
+ #
4877
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaServingConfig]
4878
+ #
4879
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4880
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4881
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4882
+ def patch_project_location_data_store_serving_config(name, google_cloud_discoveryengine_v1alpha_serving_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
4883
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
4884
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaServingConfig::Representation
4885
+ command.request_object = google_cloud_discoveryengine_v1alpha_serving_config_object
4886
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaServingConfig::Representation
4887
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaServingConfig
4888
+ command.params['name'] = name unless name.nil?
4889
+ command.query['updateMask'] = update_mask unless update_mask.nil?
4890
+ command.query['fields'] = fields unless fields.nil?
4891
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4892
+ execute_or_queue_command(command, &block)
4893
+ end
4894
+
4556
4895
  # Makes a recommendation, which requires a contextual user event.
4557
4896
  # @param [String] serving_config
4558
4897
  # Required. Full resource name of a ServingConfig: `projects/*/locations/global/
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-discoveryengine_v1alpha
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.34.0
4
+ version: 0.35.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-02-04 00:00:00.000000000 Z
11
+ date: 2024-02-11 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1alpha/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1alpha/v0.34.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1alpha/v0.35.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1alpha
63
63
  post_install_message:
64
64
  rdoc_options: []