Enum TaskType

#[repr(i32)]
pub enum TaskType {
    Unspecified = 0,
    RetrievalQuery = 1,
    RetrievalDocument = 2,
    SemanticSimilarity = 3,
    Classification = 4,
    Clustering = 5,
    QuestionAnswering = 6,
    FactVerification = 7,
}

Type of task for which the embedding will be used.

Variants

Unspecified = 0

Unset value, which will default to one of the other enum values.

RetrievalQuery = 1

Specifies the given text is a query in a search/retrieval setting.

RetrievalDocument = 2

Specifies the given text is a document from the corpus being searched.

SemanticSimilarity = 3

Specifies the given text will be used for STS.

Classification = 4

Specifies that the given text will be classified.

Clustering = 5

Specifies that the embeddings will be used for clustering.

QuestionAnswering = 6

Specifies that the given text will be used for question answering.

FactVerification = 7

Specifies that the given text will be used for fact verification.

Implementations

impl TaskType

pub fn is_valid(value: i32) -> bool

Returns true if value is a variant of TaskType.

pub fn from_i32(value: i32) -> Option<TaskType>

👎Deprecated: Use the TryFrom<i32> implementation instead

Converts an i32 to a TaskType, or None if value is not a valid variant.

impl TaskType

pub fn as_str_name(&self) -> &'static str

String value of the enum field names used in the ProtoBuf definition.

The values are not transformed in any way and thus are considered stable (if the ProtoBuf definition does not change) and safe for programmatic use.

pub fn from_str_name(value: &str) -> Option<Self>

Creates an enum from field names used in the ProtoBuf definition.

Trait Implementations

impl Clone for TaskType

fn clone(&self) -> TaskType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TaskType

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

Formats the value using the given formatter.

impl Default for TaskType

fn default() -> TaskType

Returns the “default value” for a type.

impl From<TaskType> for i32

fn from(value: TaskType) -> i32

Converts to this type from the input type.

impl Hash for TaskType

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for TaskType

fn cmp(&self, other: &TaskType) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for TaskType

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

fn partial_cmp(&self, other: &TaskType) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<i32> for TaskType

type Error = UnknownEnumValue

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<TaskType, UnknownEnumValue>

Performs the conversion.

impl Copy for TaskType

impl Eq for TaskType

impl StructuralPartialEq for TaskType