Enum FamilyDescriptor 

pub enum FamilyDescriptor {
    Completion {
        model: ModelRef,
        capabilities: ProviderCapabilities,
    },
    Tool {
        name: String,
        description: String,
        parameters: Value,
        embedding: Option<ToolEmbeddingDescriptor>,
    },
    Embed {
        model: String,
        dims: Option<usize>,
        max_documents: usize,
        modality: EmbedModality,
    },
    Rerank {
        model: String,
        max_documents: usize,
    },
    Memory {},
    Retrieve {},
    Custom {
        kind: String,
    },
}

The family-keyed description of a handler. The variant is the family: binding a typed view compares Family::FAMILY against FamilyDescriptor::family.

Variants

Completion

A completion model.

Fields

model: ModelRef

The model’s label.

capabilities: ProviderCapabilities

The capability snapshot a runtime prepares requests against.

Tool

A tool.

Fields

name: String

The tool’s name (the name the model calls it by).

description: String

The tool’s description.

parameters: Value

The JSON schema of the tool’s arguments.

embedding: Option<ToolEmbeddingDescriptor>

Present when the tool is retrievable by embedding.

Embed

An embedding model.

Fields

model: String

The model’s label.

dims: Option<usize>

The vector dimension, when the model declares one.

max_documents: usize

The largest batch the model accepts.

modality: EmbedModality

Whether the model embeds text or images.

Rerank

A reranking model.

Fields

model: String

The model’s label.

max_documents: usize

The largest batch the model accepts.

Memory

A conversation-memory backend.

Retrieve

A vector-store index.

Custom

A handler for an out-of-tree kind: the label it serves.

Fields

kind: String

The EffectKind::Custom kind label this handler answers.

Implementations

impl FamilyDescriptor

pub const fn family(&self) -> EffectFamily

The family this descriptor belongs to.

Trait Implementations

impl Clone for FamilyDescriptor

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FamilyDescriptor

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FamilyDescriptor

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for FamilyDescriptor

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for FamilyDescriptor

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 FamilyDescriptor