Class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaServingConfig

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1beta/classes.rb,
lib/google/apis/discoveryengine_v1beta/representations.rb,
lib/google/apis/discoveryengine_v1beta/representations.rb

Overview

Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions). The ServingConfig is passed in the search and predict request and generates results.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1betaServingConfig

Returns a new instance of GoogleCloudDiscoveryengineV1betaServingConfig.



8072
8073
8074
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 8072

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#boost_control_ids ⇒ Array<String>

Boost controls to use in serving path. All triggered boost controls will be applied. Boost controls must be in the same data store as the serving config. Maximum of 20 boost controls. Corresponds to the JSON property boostControlIds

Returns:

  • (Array<String>) 


7928
7929
7930
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 7928

def boost_control_ids
  @boost_control_ids
end

#create_time ⇒ String

Output only. ServingConfig created timestamp. Corresponds to the JSON property createTime

Returns:

  • (String) 


7933
7934
7935
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 7933

def create_time
  @create_time
end

#display_name ⇒ String

Required. The human readable serving config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponds to the JSON property displayName

Returns:

  • (String) 


7940
7941
7942
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 7940

def display_name
  @display_name
end

#dissociate_control_ids ⇒ Array<String>

Condition do not associate specifications. If multiple do not associate conditions match, all matching do not associate controls in the list will execute. Order does not matter. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. Corresponds to the JSON property dissociateControlIds

Returns:

  • (Array<String>) 


7948
7949
7950
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 7948

def dissociate_control_ids
  @dissociate_control_ids
end

#diversity_level ⇒ String

How much diversity to use in recommendation model results e.g. medium- diversity or high-diversity. Currently supported values: * no-diversity * low-diversity * medium-diversity * high-diversity * auto-diversity If not specified, we choose default based on recommendation model type. Default value: no-diversity. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION. Corresponds to the JSON property diversityLevel

Returns:

  • (String) 


7958
7959
7960
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 7958

def diversity_level
  @diversity_level
end

#embedding_config ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEmbeddingConfig

Defines embedding config, used for bring your own embeddings feature. Corresponds to the JSON property embeddingConfig

Returns:



7963
7964
7965
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 7963

def embedding_config
  @embedding_config
end

#filter_control_ids ⇒ Array<String>

Filter controls to use in serving path. All triggered filter controls will be applied. Filter controls must be in the same data store as the serving config. Maximum of 20 filter controls. Corresponds to the JSON property filterControlIds

Returns:

  • (Array<String>) 


7970
7971
7972
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 7970

def filter_control_ids
  @filter_control_ids
end

#generic_config ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaServingConfigGenericConfig

Specifies the configurations needed for Generic Discovery.Currently we support:

  • content_search_spec: configuration for generic content search. Corresponds to the JSON property genericConfig

Returns:



7976
7977
7978
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 7976

def generic_config
  @generic_config
end

#ignore_control_ids ⇒ Array<String>

Condition ignore specifications. If multiple ignore conditions match, all matching ignore controls in the list will execute. Order does not matter. Maximum number of specifications is 100. Corresponds to the JSON property ignoreControlIds

Returns:

  • (Array<String>) 


7983
7984
7985
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 7983

def ignore_control_ids
  @ignore_control_ids
end

#media_config ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig

Specifies the configurations needed for Media Discovery. Currently we support:

  • demote_content_watched: Threshold for watched content demotion. Customers can specify if using watched content demotion or use viewed detail page. Using the content watched demotion, customers need to specify the watched minutes or percentage exceeds the threshold, the content will be demoted in the recommendation result. * promote_fresh_content: cutoff days for fresh content promotion. Customers can specify if using content freshness promotion. If the content was published within the cutoff days, the content will be promoted in the recommendation result. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION. Corresponds to the JSON property mediaConfig

Returns:



7997
7998
7999
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 7997

def media_config
  @media_config
end

#model_id ⇒ String

The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION. Corresponds to the JSON property modelId

Returns:

  • (String) 


8005
8006
8007
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 8005

def model_id
  @model_id
end

#name ⇒ String

Immutable. Fully qualified name projects/project/locations/location/ collections/collection_id/engines/engine_id/servingConfigs/ serving_config_id` Corresponds to the JSON propertyname`

Returns:

  • (String) 


8012
8013
8014
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 8012

def name
  @name
end

#oneway_synonyms_control_ids ⇒ Array<String>

Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. Corresponds to the JSON property onewaySynonymsControlIds

Returns:

  • (Array<String>) 


8020
8021
8022
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 8020

def oneway_synonyms_control_ids
  @oneway_synonyms_control_ids
end

#ranking_expression ⇒ String

The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if SearchRequest.ranking_expression is specified, it overrides the ServingConfig ranking expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, " + ", function; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: relevance_score: pre-defined keywords, used for measure relevance between query and document. embedding_field_path: the document embedding field used with query embedding vector. dotProduct: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be 0.5 * relevance_score + 0.3 * dotProduct(doc_embedding). Corresponds to the JSON property rankingExpression

Returns:

  • (String) 


8038
8039
8040
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 8038

def ranking_expression
  @ranking_expression
end

#redirect_control_ids ⇒ Array<String>

IDs of the redirect controls. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. Corresponds to the JSON property redirectControlIds

Returns:

  • (Array<String>) 


8045
8046
8047
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 8045

def redirect_control_ids
  @redirect_control_ids
end

#replacement_control_ids ⇒ Array<String>

Condition replacement specifications. Applied according to the order in the list. A previously replaced term can not be re-replaced. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. Corresponds to the JSON property replacementControlIds

Returns:

  • (Array<String>) 


8052
8053
8054
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 8052

def replacement_control_ids
  @replacement_control_ids
end

#solution_type ⇒ String

Required. Immutable. Specifies the solution type that a serving config can be associated with. Corresponds to the JSON property solutionType

Returns:

  • (String) 


8058
8059
8060
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 8058

def solution_type
  @solution_type
end

#synonyms_control_ids ⇒ Array<String>

Condition synonyms specifications. If multiple synonyms conditions match, all matching synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. Corresponds to the JSON property synonymsControlIds

Returns:

  • (Array<String>) 


8065
8066
8067
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 8065

def synonyms_control_ids
  @synonyms_control_ids
end

#update_time ⇒ String

Output only. ServingConfig updated timestamp. Corresponds to the JSON property updateTime

Returns:

  • (String) 


8070
8071
8072
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 8070

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 8077

def update!(**args)
  @boost_control_ids = args[:boost_control_ids] if args.key?(:boost_control_ids)
  @create_time = args[:create_time] if args.key?(:create_time)
  @display_name = args[:display_name] if args.key?(:display_name)
  @dissociate_control_ids = args[:dissociate_control_ids] if args.key?(:dissociate_control_ids)
  @diversity_level = args[:diversity_level] if args.key?(:diversity_level)
  @embedding_config = args[:embedding_config] if args.key?(:embedding_config)
  @filter_control_ids = args[:filter_control_ids] if args.key?(:filter_control_ids)
  @generic_config = args[:generic_config] if args.key?(:generic_config)
  @ignore_control_ids = args[:ignore_control_ids] if args.key?(:ignore_control_ids)
  @media_config = args[:media_config] if args.key?(:media_config)
  @model_id = args[:model_id] if args.key?(:model_id)
  @name = args[:name] if args.key?(:name)
  @oneway_synonyms_control_ids = args[:oneway_synonyms_control_ids] if args.key?(:oneway_synonyms_control_ids)
  @ranking_expression = args[:ranking_expression] if args.key?(:ranking_expression)
  @redirect_control_ids = args[:redirect_control_ids] if args.key?(:redirect_control_ids)
  @replacement_control_ids = args[:replacement_control_ids] if args.key?(:replacement_control_ids)
  @solution_type = args[:solution_type] if args.key?(:solution_type)
  @synonyms_control_ids = args[:synonyms_control_ids] if args.key?(:synonyms_control_ids)
  @update_time = args[:update_time] if args.key?(:update_time)
end