google-apis-discoveryengine_v1beta 0.33.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 +4 -4
- data/CHANGELOG.md +8 -0
- data/lib/google/apis/discoveryengine_v1beta/classes.rb +309 -3
- data/lib/google/apis/discoveryengine_v1beta/gem_version.rb +2 -2
- data/lib/google/apis/discoveryengine_v1beta/representations.rb +93 -0
- data/lib/google/apis/discoveryengine_v1beta/service.rb +339 -0
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 41fd480f71256022ce11404b2e11978a7108c30da9d4848ef62221b7abd8e79f
|
4
|
+
data.tar.gz: 78c9b1135bf5ffc4f57948ee8244154717e707bdb62c3aa6bf154c33e78456a0
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 543b816a056325ae0f143d48ec7c7fb02df11a2239ac4bd0864bd79eb1b1e95f2674ab19cfec9a19b0838b7c0d4723020105766044e9ef8de533965d5f405282
|
7
|
+
data.tar.gz: 9128cd4c30d28f40475112ba14da6a689d152f27d264b0cec35d0636723eaa45733293fbc8b06acd92ce2ce198343b29fccb606feccfe11e058fae5c4d61f069
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,13 @@
|
|
1
1
|
# Release history for google-apis-discoveryengine_v1beta
|
2
2
|
|
3
|
+
### v0.35.0 (2024-02-18)
|
4
|
+
|
5
|
+
* Regenerated from discovery document revision 20240213
|
6
|
+
|
7
|
+
### v0.34.0 (2024-02-11)
|
8
|
+
|
9
|
+
* Regenerated from discovery document revision 20240206
|
10
|
+
|
3
11
|
### v0.33.0 (2024-02-04)
|
4
12
|
|
5
13
|
* Regenerated from discovery document revision 20240129
|
@@ -1429,7 +1429,7 @@ module Google
|
|
1429
1429
|
end
|
1430
1430
|
end
|
1431
1431
|
|
1432
|
-
#
|
1432
|
+
# Failed due to insufficient quota.
|
1433
1433
|
class GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure
|
1434
1434
|
include Google::Apis::Core::Hashable
|
1435
1435
|
|
@@ -3342,7 +3342,7 @@ module Google
|
|
3342
3342
|
end
|
3343
3343
|
end
|
3344
3344
|
|
3345
|
-
#
|
3345
|
+
# Failed due to insufficient quota.
|
3346
3346
|
class GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure
|
3347
3347
|
include Google::Apis::Core::Hashable
|
3348
3348
|
|
@@ -4549,6 +4549,25 @@ module Google
|
|
4549
4549
|
end
|
4550
4550
|
end
|
4551
4551
|
|
4552
|
+
# Defines embedding config, used for bring your own embeddings feature.
|
4553
|
+
class GoogleCloudDiscoveryengineV1betaEmbeddingConfig
|
4554
|
+
include Google::Apis::Core::Hashable
|
4555
|
+
|
4556
|
+
# Full field path in the schema mapped as embedding field.
|
4557
|
+
# Corresponds to the JSON property `fieldPath`
|
4558
|
+
# @return [String]
|
4559
|
+
attr_accessor :field_path
|
4560
|
+
|
4561
|
+
def initialize(**args)
|
4562
|
+
update!(**args)
|
4563
|
+
end
|
4564
|
+
|
4565
|
+
# Update properties of this object
|
4566
|
+
def update!(**args)
|
4567
|
+
@field_path = args[:field_path] if args.key?(:field_path)
|
4568
|
+
end
|
4569
|
+
end
|
4570
|
+
|
4552
4571
|
# Metadata related to the progress of the SiteSearchEngineService.
|
4553
4572
|
# EnableAdvancedSiteSearch operation. This will be returned by the google.
|
4554
4573
|
# longrunning.Operation.metadata field.
|
@@ -5505,6 +5524,31 @@ module Google
|
|
5505
5524
|
end
|
5506
5525
|
end
|
5507
5526
|
|
5527
|
+
# Response for ListServingConfigs method.
|
5528
|
+
class GoogleCloudDiscoveryengineV1betaListServingConfigsResponse
|
5529
|
+
include Google::Apis::Core::Hashable
|
5530
|
+
|
5531
|
+
# Pagination token, if not returned indicates the last page.
|
5532
|
+
# Corresponds to the JSON property `nextPageToken`
|
5533
|
+
# @return [String]
|
5534
|
+
attr_accessor :next_page_token
|
5535
|
+
|
5536
|
+
# All the ServingConfigs for a given dataStore.
|
5537
|
+
# Corresponds to the JSON property `servingConfigs`
|
5538
|
+
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaServingConfig>]
|
5539
|
+
attr_accessor :serving_configs
|
5540
|
+
|
5541
|
+
def initialize(**args)
|
5542
|
+
update!(**args)
|
5543
|
+
end
|
5544
|
+
|
5545
|
+
# Update properties of this object
|
5546
|
+
def update!(**args)
|
5547
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
5548
|
+
@serving_configs = args[:serving_configs] if args.key?(:serving_configs)
|
5549
|
+
end
|
5550
|
+
end
|
5551
|
+
|
5508
5552
|
# Response message for SiteSearchEngineService.ListTargetSites method.
|
5509
5553
|
class GoogleCloudDiscoveryengineV1betaListTargetSitesResponse
|
5510
5554
|
include Google::Apis::Core::Hashable
|
@@ -7434,6 +7478,268 @@ module Google
|
|
7434
7478
|
end
|
7435
7479
|
end
|
7436
7480
|
|
7481
|
+
# Configures metadata that is used to generate serving time results (e.g. search
|
7482
|
+
# results or recommendation predictions). The ServingConfig is passed in the
|
7483
|
+
# search and predict request and generates results.
|
7484
|
+
class GoogleCloudDiscoveryengineV1betaServingConfig
|
7485
|
+
include Google::Apis::Core::Hashable
|
7486
|
+
|
7487
|
+
# Boost controls to use in serving path. All triggered boost controls will be
|
7488
|
+
# applied. Boost controls must be in the same data store as the serving config.
|
7489
|
+
# Maximum of 20 boost controls.
|
7490
|
+
# Corresponds to the JSON property `boostControlIds`
|
7491
|
+
# @return [Array<String>]
|
7492
|
+
attr_accessor :boost_control_ids
|
7493
|
+
|
7494
|
+
# Output only. ServingConfig created timestamp.
|
7495
|
+
# Corresponds to the JSON property `createTime`
|
7496
|
+
# @return [String]
|
7497
|
+
attr_accessor :create_time
|
7498
|
+
|
7499
|
+
# Required. The human readable serving config display name. Used in Discovery UI.
|
7500
|
+
# This field must be a UTF-8 encoded string with a length limit of 128
|
7501
|
+
# characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
7502
|
+
# Corresponds to the JSON property `displayName`
|
7503
|
+
# @return [String]
|
7504
|
+
attr_accessor :display_name
|
7505
|
+
|
7506
|
+
# Condition do not associate specifications. If multiple do not associate
|
7507
|
+
# conditions match, all matching do not associate controls in the list will
|
7508
|
+
# execute. Order does not matter. Maximum number of specifications is 100. Can
|
7509
|
+
# only be set if SolutionType is SOLUTION_TYPE_SEARCH.
|
7510
|
+
# Corresponds to the JSON property `dissociateControlIds`
|
7511
|
+
# @return [Array<String>]
|
7512
|
+
attr_accessor :dissociate_control_ids
|
7513
|
+
|
7514
|
+
# How much diversity to use in recommendation model results e.g. `medium-
|
7515
|
+
# diversity` or `high-diversity`. Currently supported values: * `no-diversity` *
|
7516
|
+
# `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` If
|
7517
|
+
# not specified, we choose default based on recommendation model type. Default
|
7518
|
+
# value: `no-diversity`. Can only be set if SolutionType is
|
7519
|
+
# SOLUTION_TYPE_RECOMMENDATION.
|
7520
|
+
# Corresponds to the JSON property `diversityLevel`
|
7521
|
+
# @return [String]
|
7522
|
+
attr_accessor :diversity_level
|
7523
|
+
|
7524
|
+
# Defines embedding config, used for bring your own embeddings feature.
|
7525
|
+
# Corresponds to the JSON property `embeddingConfig`
|
7526
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEmbeddingConfig]
|
7527
|
+
attr_accessor :embedding_config
|
7528
|
+
|
7529
|
+
# Filter controls to use in serving path. All triggered filter controls will be
|
7530
|
+
# applied. Filter controls must be in the same data store as the serving config.
|
7531
|
+
# Maximum of 20 filter controls.
|
7532
|
+
# Corresponds to the JSON property `filterControlIds`
|
7533
|
+
# @return [Array<String>]
|
7534
|
+
attr_accessor :filter_control_ids
|
7535
|
+
|
7536
|
+
# Specifies the configurations needed for Generic Discovery.Currently we support:
|
7537
|
+
# * `content_search_spec`: configuration for generic content search.
|
7538
|
+
# Corresponds to the JSON property `genericConfig`
|
7539
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaServingConfigGenericConfig]
|
7540
|
+
attr_accessor :generic_config
|
7541
|
+
|
7542
|
+
# Condition ignore specifications. If multiple ignore conditions match, all
|
7543
|
+
# matching ignore controls in the list will execute. Order does not matter.
|
7544
|
+
# Maximum number of specifications is 100.
|
7545
|
+
# Corresponds to the JSON property `ignoreControlIds`
|
7546
|
+
# @return [Array<String>]
|
7547
|
+
attr_accessor :ignore_control_ids
|
7548
|
+
|
7549
|
+
# Specifies the configurations needed for Media Discovery. Currently we support:
|
7550
|
+
# * `demote_content_watched`: Threshold for watched content demotion. Customers
|
7551
|
+
# can specify if using watched content demotion or use viewed detail page. Using
|
7552
|
+
# the content watched demotion, customers need to specify the watched minutes or
|
7553
|
+
# percentage exceeds the threshold, the content will be demoted in the
|
7554
|
+
# recommendation result. * `promote_fresh_content`: cutoff days for fresh
|
7555
|
+
# content promotion. Customers can specify if using content freshness promotion.
|
7556
|
+
# If the content was published within the cutoff days, the content will be
|
7557
|
+
# promoted in the recommendation result. Can only be set if SolutionType is
|
7558
|
+
# SOLUTION_TYPE_RECOMMENDATION.
|
7559
|
+
# Corresponds to the JSON property `mediaConfig`
|
7560
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig]
|
7561
|
+
attr_accessor :media_config
|
7562
|
+
|
7563
|
+
# The id of the model to use at serving time. Currently only
|
7564
|
+
# RecommendationModels are supported. Can be changed but only to a compatible
|
7565
|
+
# model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when
|
7566
|
+
# SolutionType is SOLUTION_TYPE_RECOMMENDATION.
|
7567
|
+
# Corresponds to the JSON property `modelId`
|
7568
|
+
# @return [String]
|
7569
|
+
attr_accessor :model_id
|
7570
|
+
|
7571
|
+
# Immutable. Fully qualified name `projects/`project`/locations/`location`/
|
7572
|
+
# collections/`collection_id`/dataStores/`data_store_id`/servingConfigs/`
|
7573
|
+
# serving_config_id``
|
7574
|
+
# Corresponds to the JSON property `name`
|
7575
|
+
# @return [String]
|
7576
|
+
attr_accessor :name
|
7577
|
+
|
7578
|
+
# Condition oneway synonyms specifications. If multiple oneway synonyms
|
7579
|
+
# conditions match, all matching oneway synonyms controls in the list will
|
7580
|
+
# execute. Maximum number of specifications is 100. Can only be set if
|
7581
|
+
# SolutionType is SOLUTION_TYPE_SEARCH.
|
7582
|
+
# Corresponds to the JSON property `onewaySynonymsControlIds`
|
7583
|
+
# @return [Array<String>]
|
7584
|
+
attr_accessor :oneway_synonyms_control_ids
|
7585
|
+
|
7586
|
+
# The ranking expression controls the customized ranking on retrieval documents.
|
7587
|
+
# To leverage this, document embedding is required. The ranking expression
|
7588
|
+
# setting in ServingConfig applies to all search requests served by the serving
|
7589
|
+
# config. However, if SearchRequest.ranking_expression is specified, it
|
7590
|
+
# overrides the ServingConfig ranking expression. The ranking expression is a
|
7591
|
+
# single function or multiple functions that are joined by "+". *
|
7592
|
+
# ranking_expression = function, ` " + ", function `; Supported functions: *
|
7593
|
+
# double * relevance_score * double * dotProduct(embedding_field_path) Function
|
7594
|
+
# variables: relevance_score: pre-defined keywords, used for measure relevance
|
7595
|
+
# between query and document. embedding_field_path: the document embedding field
|
7596
|
+
# used with query embedding vector. dotProduct: embedding function between
|
7597
|
+
# embedding_field_path and query embedding vector. Example ranking expression:
|
7598
|
+
# If document has an embedding field doc_embedding, the ranking expression could
|
7599
|
+
# be 0.5 * relevance_score + 0.3 * dotProduct(doc_embedding).
|
7600
|
+
# Corresponds to the JSON property `rankingExpression`
|
7601
|
+
# @return [String]
|
7602
|
+
attr_accessor :ranking_expression
|
7603
|
+
|
7604
|
+
# IDs of the redirect controls. Only the first triggered redirect action is
|
7605
|
+
# applied, even if multiple apply. Maximum number of specifications is 100. Can
|
7606
|
+
# only be set if SolutionType is SOLUTION_TYPE_SEARCH.
|
7607
|
+
# Corresponds to the JSON property `redirectControlIds`
|
7608
|
+
# @return [Array<String>]
|
7609
|
+
attr_accessor :redirect_control_ids
|
7610
|
+
|
7611
|
+
# Condition replacement specifications. Applied according to the order in the
|
7612
|
+
# list. A previously replaced term can not be re-replaced. Maximum number of
|
7613
|
+
# specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
|
7614
|
+
# Corresponds to the JSON property `replacementControlIds`
|
7615
|
+
# @return [Array<String>]
|
7616
|
+
attr_accessor :replacement_control_ids
|
7617
|
+
|
7618
|
+
# Required. Immutable. Specifies the solution type that a serving config can be
|
7619
|
+
# associated with.
|
7620
|
+
# Corresponds to the JSON property `solutionType`
|
7621
|
+
# @return [String]
|
7622
|
+
attr_accessor :solution_type
|
7623
|
+
|
7624
|
+
# Condition synonyms specifications. If multiple synonyms conditions match, all
|
7625
|
+
# matching synonyms controls in the list will execute. Maximum number of
|
7626
|
+
# specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
|
7627
|
+
# Corresponds to the JSON property `synonymsControlIds`
|
7628
|
+
# @return [Array<String>]
|
7629
|
+
attr_accessor :synonyms_control_ids
|
7630
|
+
|
7631
|
+
# Output only. ServingConfig updated timestamp.
|
7632
|
+
# Corresponds to the JSON property `updateTime`
|
7633
|
+
# @return [String]
|
7634
|
+
attr_accessor :update_time
|
7635
|
+
|
7636
|
+
def initialize(**args)
|
7637
|
+
update!(**args)
|
7638
|
+
end
|
7639
|
+
|
7640
|
+
# Update properties of this object
|
7641
|
+
def update!(**args)
|
7642
|
+
@boost_control_ids = args[:boost_control_ids] if args.key?(:boost_control_ids)
|
7643
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
7644
|
+
@display_name = args[:display_name] if args.key?(:display_name)
|
7645
|
+
@dissociate_control_ids = args[:dissociate_control_ids] if args.key?(:dissociate_control_ids)
|
7646
|
+
@diversity_level = args[:diversity_level] if args.key?(:diversity_level)
|
7647
|
+
@embedding_config = args[:embedding_config] if args.key?(:embedding_config)
|
7648
|
+
@filter_control_ids = args[:filter_control_ids] if args.key?(:filter_control_ids)
|
7649
|
+
@generic_config = args[:generic_config] if args.key?(:generic_config)
|
7650
|
+
@ignore_control_ids = args[:ignore_control_ids] if args.key?(:ignore_control_ids)
|
7651
|
+
@media_config = args[:media_config] if args.key?(:media_config)
|
7652
|
+
@model_id = args[:model_id] if args.key?(:model_id)
|
7653
|
+
@name = args[:name] if args.key?(:name)
|
7654
|
+
@oneway_synonyms_control_ids = args[:oneway_synonyms_control_ids] if args.key?(:oneway_synonyms_control_ids)
|
7655
|
+
@ranking_expression = args[:ranking_expression] if args.key?(:ranking_expression)
|
7656
|
+
@redirect_control_ids = args[:redirect_control_ids] if args.key?(:redirect_control_ids)
|
7657
|
+
@replacement_control_ids = args[:replacement_control_ids] if args.key?(:replacement_control_ids)
|
7658
|
+
@solution_type = args[:solution_type] if args.key?(:solution_type)
|
7659
|
+
@synonyms_control_ids = args[:synonyms_control_ids] if args.key?(:synonyms_control_ids)
|
7660
|
+
@update_time = args[:update_time] if args.key?(:update_time)
|
7661
|
+
end
|
7662
|
+
end
|
7663
|
+
|
7664
|
+
# Specifies the configurations needed for Generic Discovery.Currently we support:
|
7665
|
+
# * `content_search_spec`: configuration for generic content search.
|
7666
|
+
class GoogleCloudDiscoveryengineV1betaServingConfigGenericConfig
|
7667
|
+
include Google::Apis::Core::Hashable
|
7668
|
+
|
7669
|
+
# A specification for configuring the behavior of content search.
|
7670
|
+
# Corresponds to the JSON property `contentSearchSpec`
|
7671
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec]
|
7672
|
+
attr_accessor :content_search_spec
|
7673
|
+
|
7674
|
+
def initialize(**args)
|
7675
|
+
update!(**args)
|
7676
|
+
end
|
7677
|
+
|
7678
|
+
# Update properties of this object
|
7679
|
+
def update!(**args)
|
7680
|
+
@content_search_spec = args[:content_search_spec] if args.key?(:content_search_spec)
|
7681
|
+
end
|
7682
|
+
end
|
7683
|
+
|
7684
|
+
# Specifies the configurations needed for Media Discovery. Currently we support:
|
7685
|
+
# * `demote_content_watched`: Threshold for watched content demotion. Customers
|
7686
|
+
# can specify if using watched content demotion or use viewed detail page. Using
|
7687
|
+
# the content watched demotion, customers need to specify the watched minutes or
|
7688
|
+
# percentage exceeds the threshold, the content will be demoted in the
|
7689
|
+
# recommendation result. * `promote_fresh_content`: cutoff days for fresh
|
7690
|
+
# content promotion. Customers can specify if using content freshness promotion.
|
7691
|
+
# If the content was published within the cutoff days, the content will be
|
7692
|
+
# promoted in the recommendation result. Can only be set if SolutionType is
|
7693
|
+
# SOLUTION_TYPE_RECOMMENDATION.
|
7694
|
+
class GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig
|
7695
|
+
include Google::Apis::Core::Hashable
|
7696
|
+
|
7697
|
+
# Specifies the content freshness used for recommendation result. Contents will
|
7698
|
+
# be demoted if contents were published for more than content freshness cutoff
|
7699
|
+
# days.
|
7700
|
+
# Corresponds to the JSON property `contentFreshnessCutoffDays`
|
7701
|
+
# @return [Fixnum]
|
7702
|
+
attr_accessor :content_freshness_cutoff_days
|
7703
|
+
|
7704
|
+
# Specifies the content watched minutes threshold for demotion.
|
7705
|
+
# Corresponds to the JSON property `contentWatchedMinutesThreshold`
|
7706
|
+
# @return [Float]
|
7707
|
+
attr_accessor :content_watched_minutes_threshold
|
7708
|
+
|
7709
|
+
# Specifies the content watched percentage threshold for demotion. Threshold
|
7710
|
+
# value must be between [0, 1.0] inclusive.
|
7711
|
+
# Corresponds to the JSON property `contentWatchedPercentageThreshold`
|
7712
|
+
# @return [Float]
|
7713
|
+
attr_accessor :content_watched_percentage_threshold
|
7714
|
+
|
7715
|
+
# Specifies the content watched minutes threshold for demotion.
|
7716
|
+
# Corresponds to the JSON property `contentWatchedSecondsThreshold`
|
7717
|
+
# @return [Float]
|
7718
|
+
attr_accessor :content_watched_seconds_threshold
|
7719
|
+
|
7720
|
+
# Specifies the event type used for demoting recommendation result. Currently
|
7721
|
+
# supported values: * `view-item`: Item viewed. * `media-play`: Start/resume
|
7722
|
+
# watching a video, playing a song, etc. * `media-complete`: Finished or stopped
|
7723
|
+
# midway through a video, song, etc. If unset, watch history demotion will not
|
7724
|
+
# be applied. Content freshness demotion will still be applied.
|
7725
|
+
# Corresponds to the JSON property `demotionEventType`
|
7726
|
+
# @return [String]
|
7727
|
+
attr_accessor :demotion_event_type
|
7728
|
+
|
7729
|
+
def initialize(**args)
|
7730
|
+
update!(**args)
|
7731
|
+
end
|
7732
|
+
|
7733
|
+
# Update properties of this object
|
7734
|
+
def update!(**args)
|
7735
|
+
@content_freshness_cutoff_days = args[:content_freshness_cutoff_days] if args.key?(:content_freshness_cutoff_days)
|
7736
|
+
@content_watched_minutes_threshold = args[:content_watched_minutes_threshold] if args.key?(:content_watched_minutes_threshold)
|
7737
|
+
@content_watched_percentage_threshold = args[:content_watched_percentage_threshold] if args.key?(:content_watched_percentage_threshold)
|
7738
|
+
@content_watched_seconds_threshold = args[:content_watched_seconds_threshold] if args.key?(:content_watched_seconds_threshold)
|
7739
|
+
@demotion_event_type = args[:demotion_event_type] if args.key?(:demotion_event_type)
|
7740
|
+
end
|
7741
|
+
end
|
7742
|
+
|
7437
7743
|
# SiteSearchEngine captures DataStore level site search persisting
|
7438
7744
|
# configurations. It is a singleton value per data store.
|
7439
7745
|
class GoogleCloudDiscoveryengineV1betaSiteSearchEngine
|
@@ -7605,7 +7911,7 @@ module Google
|
|
7605
7911
|
end
|
7606
7912
|
end
|
7607
7913
|
|
7608
|
-
#
|
7914
|
+
# Failed due to insufficient quota.
|
7609
7915
|
class GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure
|
7610
7916
|
include Google::Apis::Core::Hashable
|
7611
7917
|
|
@@ -16,13 +16,13 @@ module Google
|
|
16
16
|
module Apis
|
17
17
|
module DiscoveryengineV1beta
|
18
18
|
# Version of the google-apis-discoveryengine_v1beta gem
|
19
|
-
GEM_VERSION = "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 = "
|
25
|
+
REVISION = "20240213"
|
26
26
|
end
|
27
27
|
end
|
28
28
|
end
|
@@ -856,6 +856,12 @@ module Google
|
|
856
856
|
include Google::Apis::Core::JsonObjectSupport
|
857
857
|
end
|
858
858
|
|
859
|
+
class GoogleCloudDiscoveryengineV1betaEmbeddingConfig
|
860
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
861
|
+
|
862
|
+
include Google::Apis::Core::JsonObjectSupport
|
863
|
+
end
|
864
|
+
|
859
865
|
class GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata
|
860
866
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
861
867
|
|
@@ -1036,6 +1042,12 @@ module Google
|
|
1036
1042
|
include Google::Apis::Core::JsonObjectSupport
|
1037
1043
|
end
|
1038
1044
|
|
1045
|
+
class GoogleCloudDiscoveryengineV1betaListServingConfigsResponse
|
1046
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
1047
|
+
|
1048
|
+
include Google::Apis::Core::JsonObjectSupport
|
1049
|
+
end
|
1050
|
+
|
1039
1051
|
class GoogleCloudDiscoveryengineV1betaListTargetSitesResponse
|
1040
1052
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
1041
1053
|
|
@@ -1330,6 +1342,24 @@ module Google
|
|
1330
1342
|
include Google::Apis::Core::JsonObjectSupport
|
1331
1343
|
end
|
1332
1344
|
|
1345
|
+
class GoogleCloudDiscoveryengineV1betaServingConfig
|
1346
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
1347
|
+
|
1348
|
+
include Google::Apis::Core::JsonObjectSupport
|
1349
|
+
end
|
1350
|
+
|
1351
|
+
class GoogleCloudDiscoveryengineV1betaServingConfigGenericConfig
|
1352
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
1353
|
+
|
1354
|
+
include Google::Apis::Core::JsonObjectSupport
|
1355
|
+
end
|
1356
|
+
|
1357
|
+
class GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig
|
1358
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
1359
|
+
|
1360
|
+
include Google::Apis::Core::JsonObjectSupport
|
1361
|
+
end
|
1362
|
+
|
1333
1363
|
class GoogleCloudDiscoveryengineV1betaSiteSearchEngine
|
1334
1364
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
1335
1365
|
|
@@ -2700,6 +2730,13 @@ module Google
|
|
2700
2730
|
end
|
2701
2731
|
end
|
2702
2732
|
|
2733
|
+
class GoogleCloudDiscoveryengineV1betaEmbeddingConfig
|
2734
|
+
# @private
|
2735
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
2736
|
+
property :field_path, as: 'fieldPath'
|
2737
|
+
end
|
2738
|
+
end
|
2739
|
+
|
2703
2740
|
class GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata
|
2704
2741
|
# @private
|
2705
2742
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -2987,6 +3024,15 @@ module Google
|
|
2987
3024
|
end
|
2988
3025
|
end
|
2989
3026
|
|
3027
|
+
class GoogleCloudDiscoveryengineV1betaListServingConfigsResponse
|
3028
|
+
# @private
|
3029
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
3030
|
+
property :next_page_token, as: 'nextPageToken'
|
3031
|
+
collection :serving_configs, as: 'servingConfigs', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaServingConfig, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaServingConfig::Representation
|
3032
|
+
|
3033
|
+
end
|
3034
|
+
end
|
3035
|
+
|
2990
3036
|
class GoogleCloudDiscoveryengineV1betaListTargetSitesResponse
|
2991
3037
|
# @private
|
2992
3038
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -3481,6 +3527,53 @@ module Google
|
|
3481
3527
|
end
|
3482
3528
|
end
|
3483
3529
|
|
3530
|
+
class GoogleCloudDiscoveryengineV1betaServingConfig
|
3531
|
+
# @private
|
3532
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
3533
|
+
collection :boost_control_ids, as: 'boostControlIds'
|
3534
|
+
property :create_time, as: 'createTime'
|
3535
|
+
property :display_name, as: 'displayName'
|
3536
|
+
collection :dissociate_control_ids, as: 'dissociateControlIds'
|
3537
|
+
property :diversity_level, as: 'diversityLevel'
|
3538
|
+
property :embedding_config, as: 'embeddingConfig', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEmbeddingConfig, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEmbeddingConfig::Representation
|
3539
|
+
|
3540
|
+
collection :filter_control_ids, as: 'filterControlIds'
|
3541
|
+
property :generic_config, as: 'genericConfig', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaServingConfigGenericConfig, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaServingConfigGenericConfig::Representation
|
3542
|
+
|
3543
|
+
collection :ignore_control_ids, as: 'ignoreControlIds'
|
3544
|
+
property :media_config, as: 'mediaConfig', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig::Representation
|
3545
|
+
|
3546
|
+
property :model_id, as: 'modelId'
|
3547
|
+
property :name, as: 'name'
|
3548
|
+
collection :oneway_synonyms_control_ids, as: 'onewaySynonymsControlIds'
|
3549
|
+
property :ranking_expression, as: 'rankingExpression'
|
3550
|
+
collection :redirect_control_ids, as: 'redirectControlIds'
|
3551
|
+
collection :replacement_control_ids, as: 'replacementControlIds'
|
3552
|
+
property :solution_type, as: 'solutionType'
|
3553
|
+
collection :synonyms_control_ids, as: 'synonymsControlIds'
|
3554
|
+
property :update_time, as: 'updateTime'
|
3555
|
+
end
|
3556
|
+
end
|
3557
|
+
|
3558
|
+
class GoogleCloudDiscoveryengineV1betaServingConfigGenericConfig
|
3559
|
+
# @private
|
3560
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
3561
|
+
property :content_search_spec, as: 'contentSearchSpec', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec::Representation
|
3562
|
+
|
3563
|
+
end
|
3564
|
+
end
|
3565
|
+
|
3566
|
+
class GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig
|
3567
|
+
# @private
|
3568
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
3569
|
+
property :content_freshness_cutoff_days, as: 'contentFreshnessCutoffDays'
|
3570
|
+
property :content_watched_minutes_threshold, as: 'contentWatchedMinutesThreshold'
|
3571
|
+
property :content_watched_percentage_threshold, as: 'contentWatchedPercentageThreshold'
|
3572
|
+
property :content_watched_seconds_threshold, as: 'contentWatchedSecondsThreshold'
|
3573
|
+
property :demotion_event_type, as: 'demotionEventType'
|
3574
|
+
end
|
3575
|
+
end
|
3576
|
+
|
3484
3577
|
class GoogleCloudDiscoveryengineV1betaSiteSearchEngine
|
3485
3578
|
# @private
|
3486
3579
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1399,6 +1399,119 @@ module Google
|
|
1399
1399
|
execute_or_queue_command(command, &block)
|
1400
1400
|
end
|
1401
1401
|
|
1402
|
+
# Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not
|
1403
|
+
# exist.
|
1404
|
+
# @param [String] name
|
1405
|
+
# Required. The resource name of the ServingConfig to get. Format: `projects/`
|
1406
|
+
# project_number`/locations/`location`/collections/`collection`/dataStores/`
|
1407
|
+
# data_store`/servingConfigs/`serving_config_id``
|
1408
|
+
# @param [String] fields
|
1409
|
+
# Selector specifying which fields to include in a partial response.
|
1410
|
+
# @param [String] quota_user
|
1411
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1412
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1413
|
+
# @param [Google::Apis::RequestOptions] options
|
1414
|
+
# Request-specific options
|
1415
|
+
#
|
1416
|
+
# @yield [result, err] Result & error if block supplied
|
1417
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaServingConfig] parsed result object
|
1418
|
+
# @yieldparam err [StandardError] error object if request failed
|
1419
|
+
#
|
1420
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaServingConfig]
|
1421
|
+
#
|
1422
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1423
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1424
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1425
|
+
def get_project_location_collection_data_store_serving_config(name, fields: nil, quota_user: nil, options: nil, &block)
|
1426
|
+
command = make_simple_command(:get, 'v1beta/{+name}', options)
|
1427
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaServingConfig::Representation
|
1428
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaServingConfig
|
1429
|
+
command.params['name'] = name unless name.nil?
|
1430
|
+
command.query['fields'] = fields unless fields.nil?
|
1431
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1432
|
+
execute_or_queue_command(command, &block)
|
1433
|
+
end
|
1434
|
+
|
1435
|
+
# Lists all ServingConfigs linked to this dataStore.
|
1436
|
+
# @param [String] parent
|
1437
|
+
# Required. The dataStore resource name. Format: `projects/`project_number`/
|
1438
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store``
|
1439
|
+
# @param [Fixnum] page_size
|
1440
|
+
# Optional. Maximum number of results to return. If unspecified, defaults to 100.
|
1441
|
+
# If a value greater than 100 is provided, at most 100 results are returned.
|
1442
|
+
# @param [String] page_token
|
1443
|
+
# Optional. A page token, received from a previous `ListServingConfigs` call.
|
1444
|
+
# Provide this to retrieve the subsequent page.
|
1445
|
+
# @param [String] fields
|
1446
|
+
# Selector specifying which fields to include in a partial response.
|
1447
|
+
# @param [String] quota_user
|
1448
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1449
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1450
|
+
# @param [Google::Apis::RequestOptions] options
|
1451
|
+
# Request-specific options
|
1452
|
+
#
|
1453
|
+
# @yield [result, err] Result & error if block supplied
|
1454
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListServingConfigsResponse] parsed result object
|
1455
|
+
# @yieldparam err [StandardError] error object if request failed
|
1456
|
+
#
|
1457
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListServingConfigsResponse]
|
1458
|
+
#
|
1459
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1460
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1461
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1462
|
+
def list_project_location_collection_data_store_serving_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1463
|
+
command = make_simple_command(:get, 'v1beta/{+parent}/servingConfigs', options)
|
1464
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListServingConfigsResponse::Representation
|
1465
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListServingConfigsResponse
|
1466
|
+
command.params['parent'] = parent unless parent.nil?
|
1467
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
1468
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
1469
|
+
command.query['fields'] = fields unless fields.nil?
|
1470
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1471
|
+
execute_or_queue_command(command, &block)
|
1472
|
+
end
|
1473
|
+
|
1474
|
+
# Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does
|
1475
|
+
# not exist.
|
1476
|
+
# @param [String] name
|
1477
|
+
# Immutable. Fully qualified name `projects/`project`/locations/`location`/
|
1478
|
+
# collections/`collection_id`/dataStores/`data_store_id`/servingConfigs/`
|
1479
|
+
# serving_config_id``
|
1480
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaServingConfig] google_cloud_discoveryengine_v1beta_serving_config_object
|
1481
|
+
# @param [String] update_mask
|
1482
|
+
# Indicates which fields in the provided ServingConfig to update. The following
|
1483
|
+
# are NOT supported: * ServingConfig.name If not set, all supported fields are
|
1484
|
+
# updated.
|
1485
|
+
# @param [String] fields
|
1486
|
+
# Selector specifying which fields to include in a partial response.
|
1487
|
+
# @param [String] quota_user
|
1488
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1489
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1490
|
+
# @param [Google::Apis::RequestOptions] options
|
1491
|
+
# Request-specific options
|
1492
|
+
#
|
1493
|
+
# @yield [result, err] Result & error if block supplied
|
1494
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaServingConfig] parsed result object
|
1495
|
+
# @yieldparam err [StandardError] error object if request failed
|
1496
|
+
#
|
1497
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaServingConfig]
|
1498
|
+
#
|
1499
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1500
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1501
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1502
|
+
def patch_project_location_collection_data_store_serving_config(name, google_cloud_discoveryengine_v1beta_serving_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1503
|
+
command = make_simple_command(:patch, 'v1beta/{+name}', options)
|
1504
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaServingConfig::Representation
|
1505
|
+
command.request_object = google_cloud_discoveryengine_v1beta_serving_config_object
|
1506
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaServingConfig::Representation
|
1507
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaServingConfig
|
1508
|
+
command.params['name'] = name unless name.nil?
|
1509
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
1510
|
+
command.query['fields'] = fields unless fields.nil?
|
1511
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1512
|
+
execute_or_queue_command(command, &block)
|
1513
|
+
end
|
1514
|
+
|
1402
1515
|
# Makes a recommendation, which requires a contextual user event.
|
1403
1516
|
# @param [String] serving_config
|
1404
1517
|
# Required. Full resource name of a ServingConfig: `projects/*/locations/global/
|
@@ -2698,6 +2811,119 @@ module Google
|
|
2698
2811
|
execute_or_queue_command(command, &block)
|
2699
2812
|
end
|
2700
2813
|
|
2814
|
+
# Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not
|
2815
|
+
# exist.
|
2816
|
+
# @param [String] name
|
2817
|
+
# Required. The resource name of the ServingConfig to get. Format: `projects/`
|
2818
|
+
# project_number`/locations/`location`/collections/`collection`/dataStores/`
|
2819
|
+
# data_store`/servingConfigs/`serving_config_id``
|
2820
|
+
# @param [String] fields
|
2821
|
+
# Selector specifying which fields to include in a partial response.
|
2822
|
+
# @param [String] quota_user
|
2823
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2824
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2825
|
+
# @param [Google::Apis::RequestOptions] options
|
2826
|
+
# Request-specific options
|
2827
|
+
#
|
2828
|
+
# @yield [result, err] Result & error if block supplied
|
2829
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaServingConfig] parsed result object
|
2830
|
+
# @yieldparam err [StandardError] error object if request failed
|
2831
|
+
#
|
2832
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaServingConfig]
|
2833
|
+
#
|
2834
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2835
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2836
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2837
|
+
def get_project_location_collection_engine_serving_config(name, fields: nil, quota_user: nil, options: nil, &block)
|
2838
|
+
command = make_simple_command(:get, 'v1beta/{+name}', options)
|
2839
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaServingConfig::Representation
|
2840
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaServingConfig
|
2841
|
+
command.params['name'] = name unless name.nil?
|
2842
|
+
command.query['fields'] = fields unless fields.nil?
|
2843
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2844
|
+
execute_or_queue_command(command, &block)
|
2845
|
+
end
|
2846
|
+
|
2847
|
+
# Lists all ServingConfigs linked to this dataStore.
|
2848
|
+
# @param [String] parent
|
2849
|
+
# Required. The dataStore resource name. Format: `projects/`project_number`/
|
2850
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store``
|
2851
|
+
# @param [Fixnum] page_size
|
2852
|
+
# Optional. Maximum number of results to return. If unspecified, defaults to 100.
|
2853
|
+
# If a value greater than 100 is provided, at most 100 results are returned.
|
2854
|
+
# @param [String] page_token
|
2855
|
+
# Optional. A page token, received from a previous `ListServingConfigs` call.
|
2856
|
+
# Provide this to retrieve the subsequent page.
|
2857
|
+
# @param [String] fields
|
2858
|
+
# Selector specifying which fields to include in a partial response.
|
2859
|
+
# @param [String] quota_user
|
2860
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2861
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2862
|
+
# @param [Google::Apis::RequestOptions] options
|
2863
|
+
# Request-specific options
|
2864
|
+
#
|
2865
|
+
# @yield [result, err] Result & error if block supplied
|
2866
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListServingConfigsResponse] parsed result object
|
2867
|
+
# @yieldparam err [StandardError] error object if request failed
|
2868
|
+
#
|
2869
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListServingConfigsResponse]
|
2870
|
+
#
|
2871
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2872
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2873
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2874
|
+
def list_project_location_collection_engine_serving_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2875
|
+
command = make_simple_command(:get, 'v1beta/{+parent}/servingConfigs', options)
|
2876
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListServingConfigsResponse::Representation
|
2877
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListServingConfigsResponse
|
2878
|
+
command.params['parent'] = parent unless parent.nil?
|
2879
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
2880
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
2881
|
+
command.query['fields'] = fields unless fields.nil?
|
2882
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2883
|
+
execute_or_queue_command(command, &block)
|
2884
|
+
end
|
2885
|
+
|
2886
|
+
# Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does
|
2887
|
+
# not exist.
|
2888
|
+
# @param [String] name
|
2889
|
+
# Immutable. Fully qualified name `projects/`project`/locations/`location`/
|
2890
|
+
# collections/`collection_id`/dataStores/`data_store_id`/servingConfigs/`
|
2891
|
+
# serving_config_id``
|
2892
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaServingConfig] google_cloud_discoveryengine_v1beta_serving_config_object
|
2893
|
+
# @param [String] update_mask
|
2894
|
+
# Indicates which fields in the provided ServingConfig to update. The following
|
2895
|
+
# are NOT supported: * ServingConfig.name If not set, all supported fields are
|
2896
|
+
# updated.
|
2897
|
+
# @param [String] fields
|
2898
|
+
# Selector specifying which fields to include in a partial response.
|
2899
|
+
# @param [String] quota_user
|
2900
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2901
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2902
|
+
# @param [Google::Apis::RequestOptions] options
|
2903
|
+
# Request-specific options
|
2904
|
+
#
|
2905
|
+
# @yield [result, err] Result & error if block supplied
|
2906
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaServingConfig] parsed result object
|
2907
|
+
# @yieldparam err [StandardError] error object if request failed
|
2908
|
+
#
|
2909
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaServingConfig]
|
2910
|
+
#
|
2911
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2912
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2913
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2914
|
+
def patch_project_location_collection_engine_serving_config(name, google_cloud_discoveryengine_v1beta_serving_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2915
|
+
command = make_simple_command(:patch, 'v1beta/{+name}', options)
|
2916
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaServingConfig::Representation
|
2917
|
+
command.request_object = google_cloud_discoveryengine_v1beta_serving_config_object
|
2918
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaServingConfig::Representation
|
2919
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaServingConfig
|
2920
|
+
command.params['name'] = name unless name.nil?
|
2921
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
2922
|
+
command.query['fields'] = fields unless fields.nil?
|
2923
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2924
|
+
execute_or_queue_command(command, &block)
|
2925
|
+
end
|
2926
|
+
|
2701
2927
|
# Makes a recommendation, which requires a contextual user event.
|
2702
2928
|
# @param [String] serving_config
|
2703
2929
|
# Required. Full resource name of a ServingConfig: `projects/*/locations/global/
|
@@ -4053,6 +4279,119 @@ module Google
|
|
4053
4279
|
execute_or_queue_command(command, &block)
|
4054
4280
|
end
|
4055
4281
|
|
4282
|
+
# Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not
|
4283
|
+
# exist.
|
4284
|
+
# @param [String] name
|
4285
|
+
# Required. The resource name of the ServingConfig to get. Format: `projects/`
|
4286
|
+
# project_number`/locations/`location`/collections/`collection`/dataStores/`
|
4287
|
+
# data_store`/servingConfigs/`serving_config_id``
|
4288
|
+
# @param [String] fields
|
4289
|
+
# Selector specifying which fields to include in a partial response.
|
4290
|
+
# @param [String] quota_user
|
4291
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
4292
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
4293
|
+
# @param [Google::Apis::RequestOptions] options
|
4294
|
+
# Request-specific options
|
4295
|
+
#
|
4296
|
+
# @yield [result, err] Result & error if block supplied
|
4297
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaServingConfig] parsed result object
|
4298
|
+
# @yieldparam err [StandardError] error object if request failed
|
4299
|
+
#
|
4300
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaServingConfig]
|
4301
|
+
#
|
4302
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
4303
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
4304
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
4305
|
+
def get_project_location_data_store_serving_config(name, fields: nil, quota_user: nil, options: nil, &block)
|
4306
|
+
command = make_simple_command(:get, 'v1beta/{+name}', options)
|
4307
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaServingConfig::Representation
|
4308
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaServingConfig
|
4309
|
+
command.params['name'] = name unless name.nil?
|
4310
|
+
command.query['fields'] = fields unless fields.nil?
|
4311
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
4312
|
+
execute_or_queue_command(command, &block)
|
4313
|
+
end
|
4314
|
+
|
4315
|
+
# Lists all ServingConfigs linked to this dataStore.
|
4316
|
+
# @param [String] parent
|
4317
|
+
# Required. The dataStore resource name. Format: `projects/`project_number`/
|
4318
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store``
|
4319
|
+
# @param [Fixnum] page_size
|
4320
|
+
# Optional. Maximum number of results to return. If unspecified, defaults to 100.
|
4321
|
+
# If a value greater than 100 is provided, at most 100 results are returned.
|
4322
|
+
# @param [String] page_token
|
4323
|
+
# Optional. A page token, received from a previous `ListServingConfigs` call.
|
4324
|
+
# Provide this to retrieve the subsequent page.
|
4325
|
+
# @param [String] fields
|
4326
|
+
# Selector specifying which fields to include in a partial response.
|
4327
|
+
# @param [String] quota_user
|
4328
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
4329
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
4330
|
+
# @param [Google::Apis::RequestOptions] options
|
4331
|
+
# Request-specific options
|
4332
|
+
#
|
4333
|
+
# @yield [result, err] Result & error if block supplied
|
4334
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListServingConfigsResponse] parsed result object
|
4335
|
+
# @yieldparam err [StandardError] error object if request failed
|
4336
|
+
#
|
4337
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListServingConfigsResponse]
|
4338
|
+
#
|
4339
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
4340
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
4341
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
4342
|
+
def list_project_location_data_store_serving_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
4343
|
+
command = make_simple_command(:get, 'v1beta/{+parent}/servingConfigs', options)
|
4344
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListServingConfigsResponse::Representation
|
4345
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListServingConfigsResponse
|
4346
|
+
command.params['parent'] = parent unless parent.nil?
|
4347
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
4348
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
4349
|
+
command.query['fields'] = fields unless fields.nil?
|
4350
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
4351
|
+
execute_or_queue_command(command, &block)
|
4352
|
+
end
|
4353
|
+
|
4354
|
+
# Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does
|
4355
|
+
# not exist.
|
4356
|
+
# @param [String] name
|
4357
|
+
# Immutable. Fully qualified name `projects/`project`/locations/`location`/
|
4358
|
+
# collections/`collection_id`/dataStores/`data_store_id`/servingConfigs/`
|
4359
|
+
# serving_config_id``
|
4360
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaServingConfig] google_cloud_discoveryengine_v1beta_serving_config_object
|
4361
|
+
# @param [String] update_mask
|
4362
|
+
# Indicates which fields in the provided ServingConfig to update. The following
|
4363
|
+
# are NOT supported: * ServingConfig.name If not set, all supported fields are
|
4364
|
+
# updated.
|
4365
|
+
# @param [String] fields
|
4366
|
+
# Selector specifying which fields to include in a partial response.
|
4367
|
+
# @param [String] quota_user
|
4368
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
4369
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
4370
|
+
# @param [Google::Apis::RequestOptions] options
|
4371
|
+
# Request-specific options
|
4372
|
+
#
|
4373
|
+
# @yield [result, err] Result & error if block supplied
|
4374
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaServingConfig] parsed result object
|
4375
|
+
# @yieldparam err [StandardError] error object if request failed
|
4376
|
+
#
|
4377
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaServingConfig]
|
4378
|
+
#
|
4379
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
4380
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
4381
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
4382
|
+
def patch_project_location_data_store_serving_config(name, google_cloud_discoveryengine_v1beta_serving_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
4383
|
+
command = make_simple_command(:patch, 'v1beta/{+name}', options)
|
4384
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaServingConfig::Representation
|
4385
|
+
command.request_object = google_cloud_discoveryengine_v1beta_serving_config_object
|
4386
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaServingConfig::Representation
|
4387
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaServingConfig
|
4388
|
+
command.params['name'] = name unless name.nil?
|
4389
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
4390
|
+
command.query['fields'] = fields unless fields.nil?
|
4391
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
4392
|
+
execute_or_queue_command(command, &block)
|
4393
|
+
end
|
4394
|
+
|
4056
4395
|
# Makes a recommendation, which requires a contextual user event.
|
4057
4396
|
# @param [String] serving_config
|
4058
4397
|
# 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_v1beta
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 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-
|
11
|
+
date: 2024-02-18 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_v1beta/CHANGELOG.md
|
61
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1beta/v0.
|
61
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1beta/v0.35.0
|
62
62
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1beta
|
63
63
|
post_install_message:
|
64
64
|
rdoc_options: []
|