public final class ServingConfig extends com.google.protobuf.GeneratedMessageV3 implements ServingConfigOrBuilder
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.Protobuf type
google.cloud.discoveryengine.v1alpha.ServingConfig| Modifier and Type | Class and Description |
|---|---|
static class |
ServingConfig.Builder
Configures metadata that is used to generate serving time results (e.g.
|
static class |
ServingConfig.GenericConfig
Specifies the configurations needed for Generic Discovery.Currently we
support:
* `content_search_spec`: configuration for generic content search.
|
static interface |
ServingConfig.GenericConfigOrBuilder |
static class |
ServingConfig.MediaConfig
Specifies the configurations needed for Media Discovery.
|
static interface |
ServingConfig.MediaConfigOrBuilder |
static class |
ServingConfig.VerticalConfigCase |
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
BOOST_CONTROL_IDS_FIELD_NUMBER |
static int |
CREATE_TIME_FIELD_NUMBER |
static int |
CUSTOM_FINE_TUNING_SPEC_FIELD_NUMBER |
static int |
DISPLAY_NAME_FIELD_NUMBER |
static int |
DISSOCIATE_CONTROL_IDS_FIELD_NUMBER |
static int |
DIVERSITY_LEVEL_FIELD_NUMBER |
static int |
EMBEDDING_CONFIG_FIELD_NUMBER |
static int |
FILTER_CONTROL_IDS_FIELD_NUMBER |
static int |
GENERIC_CONFIG_FIELD_NUMBER |
static int |
GUIDED_SEARCH_SPEC_FIELD_NUMBER |
static int |
IGNORE_CONTROL_IDS_FIELD_NUMBER |
static int |
MEDIA_CONFIG_FIELD_NUMBER |
static int |
MODEL_ID_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
ONEWAY_SYNONYMS_CONTROL_IDS_FIELD_NUMBER |
static int |
RANKING_EXPRESSION_FIELD_NUMBER |
static int |
REDIRECT_CONTROL_IDS_FIELD_NUMBER |
static int |
REPLACEMENT_CONTROL_IDS_FIELD_NUMBER |
static int |
SOLUTION_TYPE_FIELD_NUMBER |
static int |
SYNONYMS_CONTROL_IDS_FIELD_NUMBER |
static int |
UPDATE_TIME_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
String |
getBoostControlIds(int index)
Boost controls to use in serving path.
|
com.google.protobuf.ByteString |
getBoostControlIdsBytes(int index)
Boost controls to use in serving path.
|
int |
getBoostControlIdsCount()
Boost controls to use in serving path.
|
com.google.protobuf.ProtocolStringList |
getBoostControlIdsList()
Boost controls to use in serving path.
|
com.google.protobuf.Timestamp |
getCreateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getCreateTimeOrBuilder()
Output only.
|
CustomFineTuningSpec |
getCustomFineTuningSpec()
Custom fine tuning configs.
|
CustomFineTuningSpecOrBuilder |
getCustomFineTuningSpecOrBuilder()
Custom fine tuning configs.
|
static ServingConfig |
getDefaultInstance() |
ServingConfig |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
String |
getDisplayName()
Required.
|
com.google.protobuf.ByteString |
getDisplayNameBytes()
Required.
|
String |
getDissociateControlIds(int index)
Condition do not associate specifications.
|
com.google.protobuf.ByteString |
getDissociateControlIdsBytes(int index)
Condition do not associate specifications.
|
int |
getDissociateControlIdsCount()
Condition do not associate specifications.
|
com.google.protobuf.ProtocolStringList |
getDissociateControlIdsList()
Condition do not associate specifications.
|
String |
getDiversityLevel()
How much diversity to use in recommendation model results e.g.
|
com.google.protobuf.ByteString |
getDiversityLevelBytes()
How much diversity to use in recommendation model results e.g.
|
EmbeddingConfig |
getEmbeddingConfig()
Bring your own embedding config.
|
EmbeddingConfigOrBuilder |
getEmbeddingConfigOrBuilder()
Bring your own embedding config.
|
String |
getFilterControlIds(int index)
Filter controls to use in serving path.
|
com.google.protobuf.ByteString |
getFilterControlIdsBytes(int index)
Filter controls to use in serving path.
|
int |
getFilterControlIdsCount()
Filter controls to use in serving path.
|
com.google.protobuf.ProtocolStringList |
getFilterControlIdsList()
Filter controls to use in serving path.
|
ServingConfig.GenericConfig |
getGenericConfig()
The GenericConfig of the serving configuration.
|
ServingConfig.GenericConfigOrBuilder |
getGenericConfigOrBuilder()
The GenericConfig of the serving configuration.
|
GuidedSearchSpec |
getGuidedSearchSpec()
Guided search configs.
|
GuidedSearchSpecOrBuilder |
getGuidedSearchSpecOrBuilder()
Guided search configs.
|
String |
getIgnoreControlIds(int index)
Condition ignore specifications.
|
com.google.protobuf.ByteString |
getIgnoreControlIdsBytes(int index)
Condition ignore specifications.
|
int |
getIgnoreControlIdsCount()
Condition ignore specifications.
|
com.google.protobuf.ProtocolStringList |
getIgnoreControlIdsList()
Condition ignore specifications.
|
ServingConfig.MediaConfig |
getMediaConfig()
The MediaConfig of the serving configuration.
|
ServingConfig.MediaConfigOrBuilder |
getMediaConfigOrBuilder()
The MediaConfig of the serving configuration.
|
String |
getModelId()
The id of the model to use at serving time.
|
com.google.protobuf.ByteString |
getModelIdBytes()
The id of the model to use at serving time.
|
String |
getName()
Immutable.
|
com.google.protobuf.ByteString |
getNameBytes()
Immutable.
|
String |
getOnewaySynonymsControlIds(int index)
Condition oneway synonyms specifications.
|
com.google.protobuf.ByteString |
getOnewaySynonymsControlIdsBytes(int index)
Condition oneway synonyms specifications.
|
int |
getOnewaySynonymsControlIdsCount()
Condition oneway synonyms specifications.
|
com.google.protobuf.ProtocolStringList |
getOnewaySynonymsControlIdsList()
Condition oneway synonyms specifications.
|
com.google.protobuf.Parser<ServingConfig> |
getParserForType() |
String |
getRankingExpression()
The ranking expression controls the customized ranking on retrieval
documents.
|
com.google.protobuf.ByteString |
getRankingExpressionBytes()
The ranking expression controls the customized ranking on retrieval
documents.
|
String |
getRedirectControlIds(int index)
IDs of the redirect controls.
|
com.google.protobuf.ByteString |
getRedirectControlIdsBytes(int index)
IDs of the redirect controls.
|
int |
getRedirectControlIdsCount()
IDs of the redirect controls.
|
com.google.protobuf.ProtocolStringList |
getRedirectControlIdsList()
IDs of the redirect controls.
|
String |
getReplacementControlIds(int index)
Condition replacement specifications.
|
com.google.protobuf.ByteString |
getReplacementControlIdsBytes(int index)
Condition replacement specifications.
|
int |
getReplacementControlIdsCount()
Condition replacement specifications.
|
com.google.protobuf.ProtocolStringList |
getReplacementControlIdsList()
Condition replacement specifications.
|
int |
getSerializedSize() |
SolutionType |
getSolutionType()
Required.
|
int |
getSolutionTypeValue()
Required.
|
String |
getSynonymsControlIds(int index)
Condition synonyms specifications.
|
com.google.protobuf.ByteString |
getSynonymsControlIdsBytes(int index)
Condition synonyms specifications.
|
int |
getSynonymsControlIdsCount()
Condition synonyms specifications.
|
com.google.protobuf.ProtocolStringList |
getSynonymsControlIdsList()
Condition synonyms specifications.
|
com.google.protobuf.Timestamp |
getUpdateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getUpdateTimeOrBuilder()
Output only.
|
ServingConfig.VerticalConfigCase |
getVerticalConfigCase() |
boolean |
hasCreateTime()
Output only.
|
boolean |
hasCustomFineTuningSpec()
Custom fine tuning configs.
|
boolean |
hasEmbeddingConfig()
Bring your own embedding config.
|
boolean |
hasGenericConfig()
The GenericConfig of the serving configuration.
|
boolean |
hasGuidedSearchSpec()
Guided search configs.
|
int |
hashCode() |
boolean |
hasMediaConfig()
The MediaConfig of the serving configuration.
|
boolean |
hasUpdateTime()
Output only.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static ServingConfig.Builder |
newBuilder() |
static ServingConfig.Builder |
newBuilder(ServingConfig prototype) |
ServingConfig.Builder |
newBuilderForType() |
protected ServingConfig.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static ServingConfig |
parseDelimitedFrom(InputStream input) |
static ServingConfig |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ServingConfig |
parseFrom(byte[] data) |
static ServingConfig |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ServingConfig |
parseFrom(ByteBuffer data) |
static ServingConfig |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ServingConfig |
parseFrom(com.google.protobuf.ByteString data) |
static ServingConfig |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ServingConfig |
parseFrom(com.google.protobuf.CodedInputStream input) |
static ServingConfig |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ServingConfig |
parseFrom(InputStream input) |
static ServingConfig |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<ServingConfig> |
parser() |
ServingConfig.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int MEDIA_CONFIG_FIELD_NUMBER
public static final int GENERIC_CONFIG_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
public static final int SOLUTION_TYPE_FIELD_NUMBER
public static final int MODEL_ID_FIELD_NUMBER
public static final int DIVERSITY_LEVEL_FIELD_NUMBER
public static final int EMBEDDING_CONFIG_FIELD_NUMBER
public static final int RANKING_EXPRESSION_FIELD_NUMBER
public static final int GUIDED_SEARCH_SPEC_FIELD_NUMBER
public static final int CUSTOM_FINE_TUNING_SPEC_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
public static final int FILTER_CONTROL_IDS_FIELD_NUMBER
public static final int BOOST_CONTROL_IDS_FIELD_NUMBER
public static final int REDIRECT_CONTROL_IDS_FIELD_NUMBER
public static final int SYNONYMS_CONTROL_IDS_FIELD_NUMBER
public static final int ONEWAY_SYNONYMS_CONTROL_IDS_FIELD_NUMBER
public static final int DISSOCIATE_CONTROL_IDS_FIELD_NUMBER
public static final int REPLACEMENT_CONTROL_IDS_FIELD_NUMBER
public static final int IGNORE_CONTROL_IDS_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public ServingConfig.VerticalConfigCase getVerticalConfigCase()
getVerticalConfigCase in interface ServingConfigOrBuilderpublic boolean hasMediaConfig()
The MediaConfig of the serving configuration.
.google.cloud.discoveryengine.v1alpha.ServingConfig.MediaConfig media_config = 7;hasMediaConfig in interface ServingConfigOrBuilderpublic ServingConfig.MediaConfig getMediaConfig()
The MediaConfig of the serving configuration.
.google.cloud.discoveryengine.v1alpha.ServingConfig.MediaConfig media_config = 7;getMediaConfig in interface ServingConfigOrBuilderpublic ServingConfig.MediaConfigOrBuilder getMediaConfigOrBuilder()
The MediaConfig of the serving configuration.
.google.cloud.discoveryengine.v1alpha.ServingConfig.MediaConfig media_config = 7;getMediaConfigOrBuilder in interface ServingConfigOrBuilderpublic boolean hasGenericConfig()
The GenericConfig of the serving configuration.
.google.cloud.discoveryengine.v1alpha.ServingConfig.GenericConfig generic_config = 10;
hasGenericConfig in interface ServingConfigOrBuilderpublic ServingConfig.GenericConfig getGenericConfig()
The GenericConfig of the serving configuration.
.google.cloud.discoveryengine.v1alpha.ServingConfig.GenericConfig generic_config = 10;
getGenericConfig in interface ServingConfigOrBuilderpublic ServingConfig.GenericConfigOrBuilder getGenericConfigOrBuilder()
The GenericConfig of the serving configuration.
.google.cloud.discoveryengine.v1alpha.ServingConfig.GenericConfig generic_config = 10;
getGenericConfigOrBuilder in interface ServingConfigOrBuilderpublic String getName()
Immutable. Fully qualified name
`projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];getName in interface ServingConfigOrBuilderpublic com.google.protobuf.ByteString getNameBytes()
Immutable. Fully qualified name
`projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];getNameBytes in interface ServingConfigOrBuilderpublic 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.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];getDisplayName in interface ServingConfigOrBuilderpublic com.google.protobuf.ByteString getDisplayNameBytes()
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.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];getDisplayNameBytes in interface ServingConfigOrBuilderpublic int getSolutionTypeValue()
Required. Immutable. Specifies the solution type that a serving config can be associated with.
.google.cloud.discoveryengine.v1alpha.SolutionType solution_type = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
getSolutionTypeValue in interface ServingConfigOrBuilderpublic SolutionType getSolutionType()
Required. Immutable. Specifies the solution type that a serving config can be associated with.
.google.cloud.discoveryengine.v1alpha.SolutionType solution_type = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
getSolutionType in interface ServingConfigOrBuilderpublic 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][google.cloud.discoveryengine.v1alpha.SolutionType] is [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
string model_id = 4;getModelId in interface ServingConfigOrBuilderpublic com.google.protobuf.ByteString getModelIdBytes()
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][google.cloud.discoveryengine.v1alpha.SolutionType] is [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
string model_id = 4;getModelIdBytes in interface ServingConfigOrBuilderpublic 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][google.cloud.discoveryengine.v1alpha.SolutionType] is [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
string diversity_level = 5;getDiversityLevel in interface ServingConfigOrBuilderpublic com.google.protobuf.ByteString getDiversityLevelBytes()
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][google.cloud.discoveryengine.v1alpha.SolutionType] is [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
string diversity_level = 5;getDiversityLevelBytes in interface ServingConfigOrBuilderpublic boolean hasEmbeddingConfig()
Bring your own embedding config. The config is used for search semantic retrieval. The retrieval is based on the dot product of [SearchRequest.EmbeddingSpec.EmbeddingVector.vector][google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.vector] and the document embeddings that are provided by this EmbeddingConfig. If [SearchRequest.EmbeddingSpec.EmbeddingVector.vector][google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.vector] is provided, it overrides this [ServingConfig.embedding_config][google.cloud.discoveryengine.v1alpha.ServingConfig.embedding_config].
.google.cloud.discoveryengine.v1alpha.EmbeddingConfig embedding_config = 20;hasEmbeddingConfig in interface ServingConfigOrBuilderpublic EmbeddingConfig getEmbeddingConfig()
Bring your own embedding config. The config is used for search semantic retrieval. The retrieval is based on the dot product of [SearchRequest.EmbeddingSpec.EmbeddingVector.vector][google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.vector] and the document embeddings that are provided by this EmbeddingConfig. If [SearchRequest.EmbeddingSpec.EmbeddingVector.vector][google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.vector] is provided, it overrides this [ServingConfig.embedding_config][google.cloud.discoveryengine.v1alpha.ServingConfig.embedding_config].
.google.cloud.discoveryengine.v1alpha.EmbeddingConfig embedding_config = 20;getEmbeddingConfig in interface ServingConfigOrBuilderpublic EmbeddingConfigOrBuilder getEmbeddingConfigOrBuilder()
Bring your own embedding config. The config is used for search semantic retrieval. The retrieval is based on the dot product of [SearchRequest.EmbeddingSpec.EmbeddingVector.vector][google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.vector] and the document embeddings that are provided by this EmbeddingConfig. If [SearchRequest.EmbeddingSpec.EmbeddingVector.vector][google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.vector] is provided, it overrides this [ServingConfig.embedding_config][google.cloud.discoveryengine.v1alpha.ServingConfig.embedding_config].
.google.cloud.discoveryengine.v1alpha.EmbeddingConfig embedding_config = 20;getEmbeddingConfigOrBuilder in interface ServingConfigOrBuilderpublic 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][google.cloud.discoveryengine.v1alpha.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)`.
string ranking_expression = 21;getRankingExpression in interface ServingConfigOrBuilderpublic com.google.protobuf.ByteString getRankingExpressionBytes()
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][google.cloud.discoveryengine.v1alpha.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)`.
string ranking_expression = 21;getRankingExpressionBytes in interface ServingConfigOrBuilderpublic boolean hasGuidedSearchSpec()
Guided search configs.
.google.cloud.discoveryengine.v1alpha.GuidedSearchSpec guided_search_spec = 22;hasGuidedSearchSpec in interface ServingConfigOrBuilderpublic GuidedSearchSpec getGuidedSearchSpec()
Guided search configs.
.google.cloud.discoveryengine.v1alpha.GuidedSearchSpec guided_search_spec = 22;getGuidedSearchSpec in interface ServingConfigOrBuilderpublic GuidedSearchSpecOrBuilder getGuidedSearchSpecOrBuilder()
Guided search configs.
.google.cloud.discoveryengine.v1alpha.GuidedSearchSpec guided_search_spec = 22;getGuidedSearchSpecOrBuilder in interface ServingConfigOrBuilderpublic boolean hasCustomFineTuningSpec()
Custom fine tuning configs. If [SearchRequest.custom_fine_tuning_spec][google.cloud.discoveryengine.v1alpha.SearchRequest.custom_fine_tuning_spec] is set, it has higher priority than the configs set here.
.google.cloud.discoveryengine.v1alpha.CustomFineTuningSpec custom_fine_tuning_spec = 24;
hasCustomFineTuningSpec in interface ServingConfigOrBuilderpublic CustomFineTuningSpec getCustomFineTuningSpec()
Custom fine tuning configs. If [SearchRequest.custom_fine_tuning_spec][google.cloud.discoveryengine.v1alpha.SearchRequest.custom_fine_tuning_spec] is set, it has higher priority than the configs set here.
.google.cloud.discoveryengine.v1alpha.CustomFineTuningSpec custom_fine_tuning_spec = 24;
getCustomFineTuningSpec in interface ServingConfigOrBuilderpublic CustomFineTuningSpecOrBuilder getCustomFineTuningSpecOrBuilder()
Custom fine tuning configs. If [SearchRequest.custom_fine_tuning_spec][google.cloud.discoveryengine.v1alpha.SearchRequest.custom_fine_tuning_spec] is set, it has higher priority than the configs set here.
.google.cloud.discoveryengine.v1alpha.CustomFineTuningSpec custom_fine_tuning_spec = 24;
getCustomFineTuningSpecOrBuilder in interface ServingConfigOrBuilderpublic boolean hasCreateTime()
Output only. ServingConfig created timestamp.
.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime in interface ServingConfigOrBuilderpublic com.google.protobuf.Timestamp getCreateTime()
Output only. ServingConfig created timestamp.
.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTime in interface ServingConfigOrBuilderpublic com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
Output only. ServingConfig created timestamp.
.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTimeOrBuilder in interface ServingConfigOrBuilderpublic boolean hasUpdateTime()
Output only. ServingConfig updated timestamp.
.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasUpdateTime in interface ServingConfigOrBuilderpublic com.google.protobuf.Timestamp getUpdateTime()
Output only. ServingConfig updated timestamp.
.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTime in interface ServingConfigOrBuilderpublic com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. ServingConfig updated timestamp.
.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTimeOrBuilder in interface ServingConfigOrBuilderpublic com.google.protobuf.ProtocolStringList getFilterControlIdsList()
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.
repeated string filter_control_ids = 11;getFilterControlIdsList in interface ServingConfigOrBuilderpublic int getFilterControlIdsCount()
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.
repeated string filter_control_ids = 11;getFilterControlIdsCount in interface ServingConfigOrBuilderpublic String getFilterControlIds(int index)
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.
repeated string filter_control_ids = 11;getFilterControlIds in interface ServingConfigOrBuilderindex - The index of the element to return.public com.google.protobuf.ByteString getFilterControlIdsBytes(int index)
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.
repeated string filter_control_ids = 11;getFilterControlIdsBytes in interface ServingConfigOrBuilderindex - The index of the value to return.public com.google.protobuf.ProtocolStringList getBoostControlIdsList()
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.
repeated string boost_control_ids = 12;getBoostControlIdsList in interface ServingConfigOrBuilderpublic int getBoostControlIdsCount()
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.
repeated string boost_control_ids = 12;getBoostControlIdsCount in interface ServingConfigOrBuilderpublic String getBoostControlIds(int index)
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.
repeated string boost_control_ids = 12;getBoostControlIds in interface ServingConfigOrBuilderindex - The index of the element to return.public com.google.protobuf.ByteString getBoostControlIdsBytes(int index)
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.
repeated string boost_control_ids = 12;getBoostControlIdsBytes in interface ServingConfigOrBuilderindex - The index of the value to return.public com.google.protobuf.ProtocolStringList getRedirectControlIdsList()
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][google.cloud.discoveryengine.v1alpha.SolutionType] is [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string redirect_control_ids = 14;getRedirectControlIdsList in interface ServingConfigOrBuilderpublic int getRedirectControlIdsCount()
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][google.cloud.discoveryengine.v1alpha.SolutionType] is [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string redirect_control_ids = 14;getRedirectControlIdsCount in interface ServingConfigOrBuilderpublic String getRedirectControlIds(int index)
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][google.cloud.discoveryengine.v1alpha.SolutionType] is [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string redirect_control_ids = 14;getRedirectControlIds in interface ServingConfigOrBuilderindex - The index of the element to return.public com.google.protobuf.ByteString getRedirectControlIdsBytes(int index)
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][google.cloud.discoveryengine.v1alpha.SolutionType] is [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string redirect_control_ids = 14;getRedirectControlIdsBytes in interface ServingConfigOrBuilderindex - The index of the value to return.public com.google.protobuf.ProtocolStringList getSynonymsControlIdsList()
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][google.cloud.discoveryengine.v1alpha.SolutionType] is [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string synonyms_control_ids = 15;getSynonymsControlIdsList in interface ServingConfigOrBuilderpublic int getSynonymsControlIdsCount()
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][google.cloud.discoveryengine.v1alpha.SolutionType] is [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string synonyms_control_ids = 15;getSynonymsControlIdsCount in interface ServingConfigOrBuilderpublic String getSynonymsControlIds(int index)
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][google.cloud.discoveryengine.v1alpha.SolutionType] is [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string synonyms_control_ids = 15;getSynonymsControlIds in interface ServingConfigOrBuilderindex - The index of the element to return.public com.google.protobuf.ByteString getSynonymsControlIdsBytes(int index)
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][google.cloud.discoveryengine.v1alpha.SolutionType] is [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string synonyms_control_ids = 15;getSynonymsControlIdsBytes in interface ServingConfigOrBuilderindex - The index of the value to return.public com.google.protobuf.ProtocolStringList getOnewaySynonymsControlIdsList()
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][google.cloud.discoveryengine.v1alpha.SolutionType] is [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string oneway_synonyms_control_ids = 16;getOnewaySynonymsControlIdsList in interface ServingConfigOrBuilderpublic int getOnewaySynonymsControlIdsCount()
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][google.cloud.discoveryengine.v1alpha.SolutionType] is [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string oneway_synonyms_control_ids = 16;getOnewaySynonymsControlIdsCount in interface ServingConfigOrBuilderpublic String getOnewaySynonymsControlIds(int index)
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][google.cloud.discoveryengine.v1alpha.SolutionType] is [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string oneway_synonyms_control_ids = 16;getOnewaySynonymsControlIds in interface ServingConfigOrBuilderindex - The index of the element to return.public com.google.protobuf.ByteString getOnewaySynonymsControlIdsBytes(int index)
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][google.cloud.discoveryengine.v1alpha.SolutionType] is [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string oneway_synonyms_control_ids = 16;getOnewaySynonymsControlIdsBytes in interface ServingConfigOrBuilderindex - The index of the value to return.public com.google.protobuf.ProtocolStringList getDissociateControlIdsList()
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][google.cloud.discoveryengine.v1alpha.SolutionType] is [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string dissociate_control_ids = 17;getDissociateControlIdsList in interface ServingConfigOrBuilderpublic int getDissociateControlIdsCount()
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][google.cloud.discoveryengine.v1alpha.SolutionType] is [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string dissociate_control_ids = 17;getDissociateControlIdsCount in interface ServingConfigOrBuilderpublic String getDissociateControlIds(int index)
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][google.cloud.discoveryengine.v1alpha.SolutionType] is [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string dissociate_control_ids = 17;getDissociateControlIds in interface ServingConfigOrBuilderindex - The index of the element to return.public com.google.protobuf.ByteString getDissociateControlIdsBytes(int index)
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][google.cloud.discoveryengine.v1alpha.SolutionType] is [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string dissociate_control_ids = 17;getDissociateControlIdsBytes in interface ServingConfigOrBuilderindex - The index of the value to return.public com.google.protobuf.ProtocolStringList getReplacementControlIdsList()
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][google.cloud.discoveryengine.v1alpha.SolutionType] is [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string replacement_control_ids = 18;getReplacementControlIdsList in interface ServingConfigOrBuilderpublic int getReplacementControlIdsCount()
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][google.cloud.discoveryengine.v1alpha.SolutionType] is [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string replacement_control_ids = 18;getReplacementControlIdsCount in interface ServingConfigOrBuilderpublic String getReplacementControlIds(int index)
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][google.cloud.discoveryengine.v1alpha.SolutionType] is [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string replacement_control_ids = 18;getReplacementControlIds in interface ServingConfigOrBuilderindex - The index of the element to return.public com.google.protobuf.ByteString getReplacementControlIdsBytes(int index)
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][google.cloud.discoveryengine.v1alpha.SolutionType] is [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH].
repeated string replacement_control_ids = 18;getReplacementControlIdsBytes in interface ServingConfigOrBuilderindex - The index of the value to return.public com.google.protobuf.ProtocolStringList getIgnoreControlIdsList()
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.
repeated string ignore_control_ids = 19;getIgnoreControlIdsList in interface ServingConfigOrBuilderpublic int getIgnoreControlIdsCount()
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.
repeated string ignore_control_ids = 19;getIgnoreControlIdsCount in interface ServingConfigOrBuilderpublic String getIgnoreControlIds(int index)
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.
repeated string ignore_control_ids = 19;getIgnoreControlIds in interface ServingConfigOrBuilderindex - The index of the element to return.public com.google.protobuf.ByteString getIgnoreControlIdsBytes(int index)
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.
repeated string ignore_control_ids = 19;getIgnoreControlIdsBytes in interface ServingConfigOrBuilderindex - The index of the value to return.public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static ServingConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ServingConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ServingConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ServingConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ServingConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ServingConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ServingConfig parseFrom(InputStream input) throws IOException
IOExceptionpublic static ServingConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ServingConfig parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static ServingConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ServingConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static ServingConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic ServingConfig.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static ServingConfig.Builder newBuilder()
public static ServingConfig.Builder newBuilder(ServingConfig prototype)
public ServingConfig.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected ServingConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static ServingConfig getDefaultInstance()
public static com.google.protobuf.Parser<ServingConfig> parser()
public com.google.protobuf.Parser<ServingConfig> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public ServingConfig getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2024 Google LLC. All rights reserved.