pub enum EffectKind {
Completion {
request: CompletionRequest,
stream: bool,
},
ToolCall {
name: String,
args: String,
},
Embed {
inputs: EmbedInputs,
},
Rerank {
request: RerankRequest,
},
Memory {
op: MemoryOp,
},
Retrieve {
query: RetrieveQuery,
},
Custom {
kind: Arc<str>,
payload: Value,
},
}Expand description
One effect: what a handler is asked to do.
Variants§
Completion
A completion request.
Fields
§
request: CompletionRequestThe prepared request.
ToolCall
A tool call. The context the tool runs with is not on the wire:
see ToolCallRequest.
Embed
An embedding request.
Fields
§
inputs: EmbedInputsThe inputs to embed.
Rerank
A reranking request.
Fields
§
request: RerankRequestThe query and the documents.
Memory
A conversation-memory operation.
Retrieve
A retrieval.
Fields
§
query: RetrieveQueryThe query.
Custom
An out-of-tree effect.
Implementations§
Source§impl EffectKind
impl EffectKind
Trait Implementations§
Source§impl Clone for EffectKind
impl Clone for EffectKind
Source§fn clone(&self) -> EffectKind
fn clone(&self) -> EffectKind
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 EffectKind
impl Debug for EffectKind
Source§impl<'de> Deserialize<'de> for EffectKind
impl<'de> Deserialize<'de> for EffectKind
Source§fn deserialize<__D>(
__deserializer: __D,
) -> Result<EffectKind, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D,
) -> Result<EffectKind, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Source§impl Serialize for EffectKind
impl Serialize for EffectKind
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
Auto Trait Implementations§
impl Freeze for EffectKind
impl RefUnwindSafe for EffectKind
impl Send for EffectKind
impl Sync for EffectKind
impl Unpin for EffectKind
impl UnsafeUnpin for EffectKind
impl UnwindSafe for EffectKind
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.