Enum RankingExpressionBackend 

#[non_exhaustive]
pub enum RankingExpressionBackend {
    Unspecified,
    Byoe,
    Clearbox,
    RankByEmbedding,
    RankByFormula,
    UnknownValue(UnknownValue),
}

Available on crate features assistant-service or conversational-search-service or search-service or serving-config-service only.

The backend to use for the ranking expression evaluation.

Working with unknown values

This enum is defined as #[non_exhaustive] because Google Cloud may add additional enum variants at any time. Adding new variants is not considered a breaking change. Applications should write their code in anticipation of:

• New values appearing in future releases of the client library, and
• New values received dynamically, without application changes.

Please consult the Working with enums section in the user guide for some guidelines.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Unspecified

Default option for unspecified/unknown values.

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.

Clearbox

👎Deprecated

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

RankByEmbedding

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

RankByFormula

Ranking by custom formula.

UnknownValue(UnknownValue)

If set, the enum was initialized with an unknown value.

Applications can examine the value using RankingExpressionBackend::value or RankingExpressionBackend::name.

Implementations

impl RankingExpressionBackend

pub fn value(&self) -> Option<i32>

Gets the enum value.

Returns None if the enum contains an unknown value deserialized from the string representation of enums.

pub fn name(&self) -> Option<&str>

Gets the enum value as a string.

Returns None if the enum contains an unknown value deserialized from the integer representation of enums.

Trait Implementations

impl Clone for RankingExpressionBackend

fn clone(&self) -> RankingExpressionBackend

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RankingExpressionBackend

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RankingExpressionBackend

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RankingExpressionBackend

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for RankingExpressionBackend

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl From<&str> for RankingExpressionBackend

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<i32> for RankingExpressionBackend

fn from(value: i32) -> Self

Converts to this type from the input type.

impl PartialEq for RankingExpressionBackend

fn eq(&self, other: &RankingExpressionBackend) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for RankingExpressionBackend

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RankingExpressionBackend