GoogleCloudDiscoveryengineV1ServingConfig (Discovery Engine API v1-rev20260427-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.discoveryengine.v1.model.GoogleCloudDiscoveryengineV1ServingConfig

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class GoogleCloudDiscoveryengineV1ServingConfig
extends com.google.api.client.json.GenericJson
```
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.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Discovery Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

GoogleCloudDiscoveryengineV1ServingConfig()

Constructors
Constructor and Description
`GoogleCloudDiscoveryengineV1ServingConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GoogleCloudDiscoveryengineV1ServingConfig`	`clone()`
`GoogleCloudDiscoveryengineV1AnswerGenerationSpec`	`getAnswerGenerationSpec()` Optional.
`List<String>`	`getBoostControlIds()` Boost controls to use in serving path.
`String`	`getCreateTime()` Output only.
`String`	`getDisplayName()` Required.
`List<String>`	`getDissociateControlIds()` Condition do not associate specifications.
`String`	`getDiversityLevel()` How much diversity to use in recommendation model results e.g.
`List<String>`	`getFilterControlIds()` Filter controls to use in serving path.
`GoogleCloudDiscoveryengineV1ServingConfigGenericConfig`	`getGenericConfig()` The GenericConfig of the serving configuration.
`List<String>`	`getIgnoreControlIds()` Condition ignore specifications.
`GoogleCloudDiscoveryengineV1ServingConfigMediaConfig`	`getMediaConfig()` The MediaConfig of the serving configuration.
`String`	`getModelId()` The id of the model to use at serving time.
`String`	`getName()` Immutable.
`List<String>`	`getOnewaySynonymsControlIds()` Condition oneway synonyms specifications.
`List<String>`	`getPromoteControlIds()` Condition promote specifications.
`String`	`getRankingExpression()` The ranking expression controls the customized ranking on retrieval documents.
`List<String>`	`getRedirectControlIds()` IDs of the redirect controls.
`List<String>`	`getReplacementControlIds()` Condition replacement specifications.
`String`	`getSolutionType()` Required.
`List<String>`	`getSynonymsControlIds()` Condition synonyms specifications.
`String`	`getUpdateTime()` Output only.
`GoogleCloudDiscoveryengineV1ServingConfig`	`set(String fieldName, Object value)`
`GoogleCloudDiscoveryengineV1ServingConfig`	`setAnswerGenerationSpec(GoogleCloudDiscoveryengineV1AnswerGenerationSpec answerGenerationSpec)` Optional.
`GoogleCloudDiscoveryengineV1ServingConfig`	`setBoostControlIds(List<String> boostControlIds)` Boost controls to use in serving path.
`GoogleCloudDiscoveryengineV1ServingConfig`	`setCreateTime(String createTime)` Output only.
`GoogleCloudDiscoveryengineV1ServingConfig`	`setDisplayName(String displayName)` Required.
`GoogleCloudDiscoveryengineV1ServingConfig`	`setDissociateControlIds(List<String> dissociateControlIds)` Condition do not associate specifications.
`GoogleCloudDiscoveryengineV1ServingConfig`	`setDiversityLevel(String diversityLevel)` How much diversity to use in recommendation model results e.g.
`GoogleCloudDiscoveryengineV1ServingConfig`	`setFilterControlIds(List<String> filterControlIds)` Filter controls to use in serving path.
`GoogleCloudDiscoveryengineV1ServingConfig`	`setGenericConfig(GoogleCloudDiscoveryengineV1ServingConfigGenericConfig genericConfig)` The GenericConfig of the serving configuration.
`GoogleCloudDiscoveryengineV1ServingConfig`	`setIgnoreControlIds(List<String> ignoreControlIds)` Condition ignore specifications.
`GoogleCloudDiscoveryengineV1ServingConfig`	`setMediaConfig(GoogleCloudDiscoveryengineV1ServingConfigMediaConfig mediaConfig)` The MediaConfig of the serving configuration.
`GoogleCloudDiscoveryengineV1ServingConfig`	`setModelId(String modelId)` The id of the model to use at serving time.
`GoogleCloudDiscoveryengineV1ServingConfig`	`setName(String name)` Immutable.
`GoogleCloudDiscoveryengineV1ServingConfig`	`setOnewaySynonymsControlIds(List<String> onewaySynonymsControlIds)` Condition oneway synonyms specifications.
`GoogleCloudDiscoveryengineV1ServingConfig`	`setPromoteControlIds(List<String> promoteControlIds)` Condition promote specifications.
`GoogleCloudDiscoveryengineV1ServingConfig`	`setRankingExpression(String rankingExpression)` The ranking expression controls the customized ranking on retrieval documents.
`GoogleCloudDiscoveryengineV1ServingConfig`	`setRedirectControlIds(List<String> redirectControlIds)` IDs of the redirect controls.
`GoogleCloudDiscoveryengineV1ServingConfig`	`setReplacementControlIds(List<String> replacementControlIds)` Condition replacement specifications.
`GoogleCloudDiscoveryengineV1ServingConfig`	`setSolutionType(String solutionType)` Required.
`GoogleCloudDiscoveryengineV1ServingConfig`	`setSynonymsControlIds(List<String> synonymsControlIds)` Condition synonyms specifications.
`GoogleCloudDiscoveryengineV1ServingConfig`	`setUpdateTime(String updateTime)` Output only.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - GoogleCloudDiscoveryengineV1ServingConfig
```
public GoogleCloudDiscoveryengineV1ServingConfig()
```
- Method Detail
  - getAnswerGenerationSpec
```
public GoogleCloudDiscoveryengineV1AnswerGenerationSpec getAnswerGenerationSpec()
```
    Optional. The specification for answer generation.
    
    Returns:
    
    value or null for none
  - setAnswerGenerationSpec
```
public GoogleCloudDiscoveryengineV1ServingConfig setAnswerGenerationSpec(GoogleCloudDiscoveryengineV1AnswerGenerationSpec answerGenerationSpec)
```
    Optional. The specification for answer generation.
    
    Parameters:
    
    answerGenerationSpec - answerGenerationSpec or null for none
  - getBoostControlIds
```
public List<String> getBoostControlIds()
```
    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.
    
    Returns:
    
    value or null for none
  - setBoostControlIds
```
public GoogleCloudDiscoveryengineV1ServingConfig setBoostControlIds(List<String> boostControlIds)
```
    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.
    
    Parameters:
    
    boostControlIds - boostControlIds or null for none
  - getCreateTime
```
public String getCreateTime()
```
    Output only. ServingConfig created timestamp.
    
    Returns:
    
    value or null for none
  - setCreateTime
```
public GoogleCloudDiscoveryengineV1ServingConfig setCreateTime(String createTime)
```
    Output only. ServingConfig created timestamp.
    
    Parameters:
    
    createTime - createTime or null for none
  - getDisplayName
```
public String getDisplayName()
```
    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.
    
    Returns:
    
    value or null for none
  - setDisplayName
```
public GoogleCloudDiscoveryengineV1ServingConfig setDisplayName(String displayName)
```
    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.
    
    Parameters:
    
    displayName - displayName or null for none
  - getDissociateControlIds
```
public List<String> getDissociateControlIds()
```
    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.
    
    Returns:
    
    value or null for none
  - setDissociateControlIds
```
public GoogleCloudDiscoveryengineV1ServingConfig setDissociateControlIds(List<String> dissociateControlIds)
```
    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.
    
    Parameters:
    
    dissociateControlIds - dissociateControlIds or null for none
  - getDiversityLevel
```
public String getDiversityLevel()
```
    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.
    
    Returns:
    
    value or null for none
  - setDiversityLevel
```
public GoogleCloudDiscoveryengineV1ServingConfig setDiversityLevel(String diversityLevel)
```
    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.
    
    Parameters:
    
    diversityLevel - diversityLevel or null for none
  - getFilterControlIds
```
public List<String> getFilterControlIds()
```
    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.
    
    Returns:
    
    value or null for none
  - setFilterControlIds
```
public GoogleCloudDiscoveryengineV1ServingConfig setFilterControlIds(List<String> filterControlIds)
```
    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.
    
    Parameters:
    
    filterControlIds - filterControlIds or null for none
  - getGenericConfig
```
public GoogleCloudDiscoveryengineV1ServingConfigGenericConfig getGenericConfig()
```
    The GenericConfig of the serving configuration.
    
    Returns:
    
    value or null for none
  - setGenericConfig
```
public GoogleCloudDiscoveryengineV1ServingConfig setGenericConfig(GoogleCloudDiscoveryengineV1ServingConfigGenericConfig genericConfig)
```
    The GenericConfig of the serving configuration.
    
    Parameters:
    
    genericConfig - genericConfig or null for none
  - getIgnoreControlIds
```
public List<String> getIgnoreControlIds()
```
    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.
    
    Returns:
    
    value or null for none
  - setIgnoreControlIds
```
public GoogleCloudDiscoveryengineV1ServingConfig setIgnoreControlIds(List<String> ignoreControlIds)
```
    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.
    
    Parameters:
    
    ignoreControlIds - ignoreControlIds or null for none
  - getMediaConfig
```
public GoogleCloudDiscoveryengineV1ServingConfigMediaConfig getMediaConfig()
```
    The MediaConfig of the serving configuration.
    
    Returns:
    
    value or null for none
  - setMediaConfig
```
public GoogleCloudDiscoveryengineV1ServingConfig setMediaConfig(GoogleCloudDiscoveryengineV1ServingConfigMediaConfig mediaConfig)
```
    The MediaConfig of the serving configuration.
    
    Parameters:
    
    mediaConfig - mediaConfig or null for none
  - getModelId
```
public String getModelId()
```
    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.
    
    Returns:
    
    value or null for none
  - setModelId
```
public GoogleCloudDiscoveryengineV1ServingConfig setModelId(String modelId)
```
    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.
    
    Parameters:
    
    modelId - modelId or null for none
  - getName
```
public String getName()
```
    Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collectio n_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`
    
    Returns:
    
    value or null for none
  - setName
```
public GoogleCloudDiscoveryengineV1ServingConfig setName(String name)
```
    Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collectio n_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`
    
    Parameters:
    
    name - name or null for none
  - getOnewaySynonymsControlIds
```
public List<String> getOnewaySynonymsControlIds()
```
    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.
    
    Returns:
    
    value or null for none
  - setOnewaySynonymsControlIds
```
public GoogleCloudDiscoveryengineV1ServingConfig setOnewaySynonymsControlIds(List<String> onewaySynonymsControlIds)
```
    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.
    
    Parameters:
    
    onewaySynonymsControlIds - onewaySynonymsControlIds or null for none
  - getPromoteControlIds
```
public List<String> getPromoteControlIds()
```
    Condition promote specifications. Maximum number of specifications is 100.
    
    Returns:
    
    value or null for none
  - setPromoteControlIds
```
public GoogleCloudDiscoveryengineV1ServingConfig setPromoteControlIds(List<String> promoteControlIds)
```
    Condition promote specifications. Maximum number of specifications is 100.
    
    Parameters:
    
    promoteControlIds - promoteControlIds or null for none
  - getRankingExpression
```
public String getRankingExpression()
```
    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)`.
    
    Returns:
    
    value or null for none
  - setRankingExpression
```
public GoogleCloudDiscoveryengineV1ServingConfig setRankingExpression(String rankingExpression)
```
    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)`.
    
    Parameters:
    
    rankingExpression - rankingExpression or null for none
  - getRedirectControlIds
```
public List<String> getRedirectControlIds()
```
    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.
    
    Returns:
    
    value or null for none
  - setRedirectControlIds
```
public GoogleCloudDiscoveryengineV1ServingConfig setRedirectControlIds(List<String> redirectControlIds)
```
    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.
    
    Parameters:
    
    redirectControlIds - redirectControlIds or null for none
  - getReplacementControlIds
```
public List<String> getReplacementControlIds()
```
    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.
    
    Returns:
    
    value or null for none
  - setReplacementControlIds
```
public GoogleCloudDiscoveryengineV1ServingConfig setReplacementControlIds(List<String> replacementControlIds)
```
    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.
    
    Parameters:
    
    replacementControlIds - replacementControlIds or null for none
  - getSolutionType
```
public String getSolutionType()
```
    Required. Immutable. Specifies the solution type that a serving config can be associated with.
    
    Returns:
    
    value or null for none
  - setSolutionType
```
public GoogleCloudDiscoveryengineV1ServingConfig setSolutionType(String solutionType)
```
    Required. Immutable. Specifies the solution type that a serving config can be associated with.
    
    Parameters:
    
    solutionType - solutionType or null for none
  - getSynonymsControlIds
```
public List<String> getSynonymsControlIds()
```
    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.
    
    Returns:
    
    value or null for none
  - setSynonymsControlIds
```
public GoogleCloudDiscoveryengineV1ServingConfig setSynonymsControlIds(List<String> synonymsControlIds)
```
    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.
    
    Parameters:
    
    synonymsControlIds - synonymsControlIds or null for none
  - getUpdateTime
```
public String getUpdateTime()
```
    Output only. ServingConfig updated timestamp.
    
    Returns:
    
    value or null for none
  - setUpdateTime
```
public GoogleCloudDiscoveryengineV1ServingConfig setUpdateTime(String updateTime)
```
    Output only. ServingConfig updated timestamp.
    
    Parameters:
    
    updateTime - updateTime or null for none
  - set
```
public GoogleCloudDiscoveryengineV1ServingConfig set(String fieldName,
                                                     Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public GoogleCloudDiscoveryengineV1ServingConfig clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class GoogleCloudDiscoveryengineV1ServingConfig

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

GoogleCloudDiscoveryengineV1ServingConfig

Method Detail

getAnswerGenerationSpec

setAnswerGenerationSpec

getBoostControlIds

setBoostControlIds

getCreateTime

setCreateTime

getDisplayName

setDisplayName

getDissociateControlIds

setDissociateControlIds

getDiversityLevel

setDiversityLevel

getFilterControlIds

setFilterControlIds

getGenericConfig

setGenericConfig

getIgnoreControlIds

setIgnoreControlIds

getMediaConfig

setMediaConfig

getModelId

setModelId

getName

setName

getOnewaySynonymsControlIds

setOnewaySynonymsControlIds

getPromoteControlIds

setPromoteControlIds

getRankingExpression

setRankingExpression

getRedirectControlIds

setRedirectControlIds

getReplacementControlIds

setReplacementControlIds

getSolutionType

setSolutionType

getSynonymsControlIds

setSynonymsControlIds

getUpdateTime

setUpdateTime

set

clone