Enum RerankingMetadataSelectiveModeConfiguration 

#[non_exhaustive]
pub enum RerankingMetadataSelectiveModeConfiguration {
    FieldsToExclude(Vec<FieldForReranking>),
    FieldsToInclude(Vec<FieldForReranking>),
    #[non_exhaustive]
    Unknown,
}

Contains configurations for the metadata fields to include or exclude when considering reranking. If you include the fieldsToExclude field, the reranker ignores all the metadata fields that you specify. If you include the fieldsToInclude field, the reranker uses only the metadata fields that you specify and ignores all others. You can include only one of these fields.

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.

FieldsToExclude(Vec<FieldForReranking>)

An array of objects, each of which specifies a metadata field to exclude from consideration when reranking.

FieldsToInclude(Vec<FieldForReranking>)

An array of objects, each of which specifies a metadata field to include in consideration when reranking. The remaining metadata fields are ignored.

#[non_exhaustive]

Unknown

The Unknown variant represents cases where new union variant was received. Consider upgrading the SDK to the latest available version. An unknown enum variant

Note: If you encounter this error, consider upgrading your SDK to the latest version. The Unknown variant represents cases where the server sent a value that wasn’t recognized by the client. This can happen when the server adds new functionality, but the client has not been updated. To investigate this, consider turning on debug logging to print the raw HTTP response.

Implementations

impl RerankingMetadataSelectiveModeConfiguration

pub fn as_fields_to_exclude(&self) -> Result<&Vec<FieldForReranking>, &Self>

Tries to convert the enum instance into FieldsToExclude, extracting the inner Vec. Returns Err(&Self) if it can’t be converted.

pub fn is_fields_to_exclude(&self) -> bool

Returns true if this is a FieldsToExclude.

pub fn as_fields_to_include(&self) -> Result<&Vec<FieldForReranking>, &Self>

Tries to convert the enum instance into FieldsToInclude, extracting the inner Vec. Returns Err(&Self) if it can’t be converted.

pub fn is_fields_to_include(&self) -> bool

Returns true if this is a FieldsToInclude.

pub fn is_unknown(&self) -> bool

Returns true if the enum instance is the Unknown variant.

Trait Implementations

impl Clone for RerankingMetadataSelectiveModeConfiguration

fn clone(&self) -> RerankingMetadataSelectiveModeConfiguration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RerankingMetadataSelectiveModeConfiguration

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

Formats the value using the given formatter.

impl PartialEq for RerankingMetadataSelectiveModeConfiguration

fn eq(&self, other: &RerankingMetadataSelectiveModeConfiguration) -> 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 StructuralPartialEq for RerankingMetadataSelectiveModeConfiguration