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,
},
}Expand description
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
§
capabilities: ProviderCapabilitiesThe capability snapshot a runtime prepares requests against.
Tool
A tool.
Fields
§
embedding: Option<ToolEmbeddingDescriptor>Present when the tool is retrievable by embedding.
Embed
An embedding model.
Fields
§
modality: EmbedModalityWhether the model embeds text or images.
Rerank
A reranking model.
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: StringThe EffectKind::Custom kind label this handler answers.
Implementations§
Source§impl FamilyDescriptor
impl FamilyDescriptor
Sourcepub const fn family(&self) -> EffectFamily
pub const fn family(&self) -> EffectFamily
The family this descriptor belongs to.
Trait Implementations§
Source§impl Clone for FamilyDescriptor
impl Clone for FamilyDescriptor
Source§fn clone(&self) -> FamilyDescriptor
fn clone(&self) -> FamilyDescriptor
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for FamilyDescriptor
impl Debug for FamilyDescriptor
Source§impl<'de> Deserialize<'de> for FamilyDescriptor
impl<'de> Deserialize<'de> for FamilyDescriptor
Source§fn deserialize<__D>(
__deserializer: __D,
) -> Result<FamilyDescriptor, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D,
) -> Result<FamilyDescriptor, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Source§impl PartialEq for FamilyDescriptor
impl PartialEq for FamilyDescriptor
Source§impl Serialize for FamilyDescriptor
impl Serialize for FamilyDescriptor
Source§fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
Serialize this value into the given Serde serializer. Read more
impl StructuralPartialEq for FamilyDescriptor
Auto Trait Implementations§
impl Freeze for FamilyDescriptor
impl RefUnwindSafe for FamilyDescriptor
impl Send for FamilyDescriptor
impl Sync for FamilyDescriptor
impl Unpin for FamilyDescriptor
impl UnsafeUnpin for FamilyDescriptor
impl UnwindSafe for FamilyDescriptor
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> DeserializeOwned for Twhere
T: for<'de> Deserialize<'de>,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoToolOutput for Twhere
T: Serialize + 'static,
impl<T> IntoToolOutput for Twhere
T: Serialize + 'static,
Source§fn into_tool_output(self) -> Result<ToolOutput, ToolExecutionError>
fn into_tool_output(self) -> Result<ToolOutput, ToolExecutionError>
Convert this value without routing structured data through a string.