com.google.cloud.discoveryengine.v1

Enum SearchRequest.RankingExpressionBackend

java.lang.Object

java.lang.Enum<SearchRequest.RankingExpressionBackend>

com.google.cloud.discoveryengine.v1.SearchRequest.RankingExpressionBackend

All Implemented Interfaces:

com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<SearchRequest.RankingExpressionBackend>

Enclosing class:

SearchRequest

public static enum SearchRequest.RankingExpressionBackend
extends Enum<SearchRequest.RankingExpressionBackend>
implements com.google.protobuf.ProtocolMessageEnum

 The backend to use for the ranking expression evaluation.
 

Protobuf enum google.cloud.discoveryengine.v1.SearchRequest.RankingExpressionBackend

Enum Constant Summary

Enum Constants

Enum Constant and Description
BYOE Deprecated.
CLEARBOX Deprecated.
RANK_BY_EMBEDDING Ranking by custom embedding model, the default way to evaluate the ranking expression.
RANK_BY_FORMULA Ranking by custom formula.
RANKING_EXPRESSION_BACKEND_UNSPECIFIED Default option for unspecified/unknown values.
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field and Description
static int	BYOE_VALUE Deprecated.
static int	CLEARBOX_VALUE Deprecated.
static int	RANK_BY_EMBEDDING_VALUE Ranking by custom embedding model, the default way to evaluate the ranking expression.
static int	RANK_BY_FORMULA_VALUE Ranking by custom formula.
static int	RANKING_EXPRESSION_BACKEND_UNSPECIFIED_VALUE Default option for unspecified/unknown values.

Method Summary

Modifier and Type	Method and Description
static SearchRequest.RankingExpressionBackend	forNumber(int value)
static com.google.protobuf.Descriptors.EnumDescriptor	getDescriptor()
com.google.protobuf.Descriptors.EnumDescriptor	getDescriptorForType()
int	getNumber()
com.google.protobuf.Descriptors.EnumValueDescriptor	getValueDescriptor()
static com.google.protobuf.Internal.EnumLiteMap<SearchRequest.RankingExpressionBackend>	internalGetValueMap()
static SearchRequest.RankingExpressionBackend	valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
static SearchRequest.RankingExpressionBackend	valueOf(int value) Deprecated. Use forNumber(int) instead.
static SearchRequest.RankingExpressionBackend	valueOf(String name) Returns the enum constant of this type with the specified name.
static SearchRequest.RankingExpressionBackend[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

RANKING_EXPRESSION_BACKEND_UNSPECIFIED

public static final SearchRequest.RankingExpressionBackend RANKING_EXPRESSION_BACKEND_UNSPECIFIED

 Default option for unspecified/unknown values.
 

RANKING_EXPRESSION_BACKEND_UNSPECIFIED = 0;

BYOE

@Deprecated
public static final SearchRequest.RankingExpressionBackend BYOE

Deprecated.

 Deprecated: Use `RANK_BY_EMBEDDING` instead.
 Ranking by custom embedding model, the default way to evaluate the
 ranking expression. Legacy enum option, `RANK_BY_EMBEDDING` should be
 used instead.
 

BYOE = 1 [deprecated = true];

CLEARBOX

@Deprecated
public static final SearchRequest.RankingExpressionBackend CLEARBOX

Deprecated.

 Deprecated: Use `RANK_BY_FORMULA` instead.
 Ranking by custom formula. Legacy enum option, `RANK_BY_FORMULA` should
 be used instead.
 

CLEARBOX = 2 [deprecated = true];

RANK_BY_EMBEDDING

public static final SearchRequest.RankingExpressionBackend RANK_BY_EMBEDDING

 Ranking by custom embedding model, the default way to evaluate the
 ranking expression.
 

RANK_BY_EMBEDDING = 3;

RANK_BY_FORMULA

public static final SearchRequest.RankingExpressionBackend RANK_BY_FORMULA

 Ranking by custom formula.
 

RANK_BY_FORMULA = 4;

UNRECOGNIZED

public static final SearchRequest.RankingExpressionBackend UNRECOGNIZED

Field Detail

RANKING_EXPRESSION_BACKEND_UNSPECIFIED_VALUE

public static final int RANKING_EXPRESSION_BACKEND_UNSPECIFIED_VALUE

 Default option for unspecified/unknown values.
 

RANKING_EXPRESSION_BACKEND_UNSPECIFIED = 0;

See Also:

Constant Field Values

BYOE_VALUE

@Deprecated
public static final int BYOE_VALUE

Deprecated.

 Deprecated: Use `RANK_BY_EMBEDDING` instead.
 Ranking by custom embedding model, the default way to evaluate the
 ranking expression. Legacy enum option, `RANK_BY_EMBEDDING` should be
 used instead.
 

BYOE = 1 [deprecated = true];

See Also:

Constant Field Values

CLEARBOX_VALUE

@Deprecated
public static final int CLEARBOX_VALUE

Deprecated.

 Deprecated: Use `RANK_BY_FORMULA` instead.
 Ranking by custom formula. Legacy enum option, `RANK_BY_FORMULA` should
 be used instead.
 

CLEARBOX = 2 [deprecated = true];

See Also:

Constant Field Values

RANK_BY_EMBEDDING_VALUE

public static final int RANK_BY_EMBEDDING_VALUE

 Ranking by custom embedding model, the default way to evaluate the
 ranking expression.
 

RANK_BY_EMBEDDING = 3;

See Also:

Constant Field Values

RANK_BY_FORMULA_VALUE

public static final int RANK_BY_FORMULA_VALUE

 Ranking by custom formula.
 

RANK_BY_FORMULA = 4;

See Also:

Constant Field Values

Method Detail

values

public static SearchRequest.RankingExpressionBackend[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SearchRequest.RankingExpressionBackend c : SearchRequest.RankingExpressionBackend.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SearchRequest.RankingExpressionBackend valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getNumber

public final int getNumber()

Specified by:

getNumber in interface com.google.protobuf.Internal.EnumLite

Specified by:

getNumber in interface com.google.protobuf.ProtocolMessageEnum

valueOf

@Deprecated
public static SearchRequest.RankingExpressionBackend valueOf(int value)

Deprecated. Use forNumber(int) instead.

Parameters:

value - The numeric wire value of the corresponding enum entry.

Returns:

The enum associated with the given numeric wire value.

forNumber

public static SearchRequest.RankingExpressionBackend forNumber(int value)

Parameters:

value - The numeric wire value of the corresponding enum entry.

Returns:

The enum associated with the given numeric wire value.

internalGetValueMap

public static com.google.protobuf.Internal.EnumLiteMap<SearchRequest.RankingExpressionBackend> internalGetValueMap()

getValueDescriptor

public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()

Specified by:

getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

getDescriptorForType

public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

getDescriptor

public static com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

valueOf

public static SearchRequest.RankingExpressionBackend valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)