Enum EmbeddingRepresentation

pub enum EmbeddingRepresentation {
    Symmetric,
    Document,
    Query,
}

Type of embedding representation to embed the prompt with.

"symmetric": Symmetric embeddings assume that the text to be compared is interchangeable. Usage examples for symmetric embeddings are clustering, classification, anomaly detection or visualisation tasks. “symmetric” embeddings should be compared with other “symmetric” embeddings.

"document" and "query": Asymmetric embeddings assume that there is a difference between queries and documents. They are used together in use cases such as search where you want to compare shorter queries against larger documents.

"query"-embeddings are optimized for shorter texts, such as questions or keywords.

"document"-embeddings are optimized for larger pieces of text to compare queries against.

Variants

Symmetric

Document

Query

Trait Implementations

impl Debug for EmbeddingRepresentation

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

Formats the value using the given formatter.

impl Default for EmbeddingRepresentation

fn default() -> Self

Returns the “default value” for a type.

impl Serialize for EmbeddingRepresentation

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.