Expand description
Common traits for common behaviour, re-exported from indexing and query
Modules§
- __
mock_ Mock Answer - __
mock_ Mock Answer_ Answer - __
mock_ Mock Answer_ Clone - __
mock_ Mock Batchable Transformer - __
mock_ Mock Batchable Transformer_ Batchable Transformer - __
mock_ Mock Batchable Transformer_ Clone - __
mock_ Mock Chunker Transformer - __
mock_ Mock Chunker Transformer_ Chunker Transformer - __
mock_ Mock Chunker Transformer_ Clone - __
mock_ Mock Embedding Model - __
mock_ Mock Embedding Model_ Clone - __
mock_ Mock Embedding Model_ Embedding Model - __
mock_ Mock Evaluate Query - __
mock_ Mock Evaluate Query_ Clone - __
mock_ Mock Evaluate Query_ Evaluate Query - __
mock_ Mock Loader - __
mock_ Mock Loader_ Clone - __
mock_ Mock Loader_ Loader - __
mock_ Mock Node Cache - __
mock_ Mock Node Cache_ Clone - __
mock_ Mock Node Cache_ Node Cache - __
mock_ Mock Persist - __
mock_ Mock Persist_ Clone - __
mock_ Mock Persist_ Persist - __
mock_ Mock Simple Prompt - __
mock_ Mock Simple Prompt_ Clone - __
mock_ Mock Simple Prompt_ Simple Prompt - __
mock_ Mock Sparse Embedding Model - __
mock_ Mock Sparse Embedding Model_ Clone - __
mock_ Mock Sparse Embedding Model_ Sparse Embedding Model - __
mock_ Mock Transform Query - __
mock_ Mock Transform Query_ Clone - __
mock_ Mock Transform Query_ Transform Query - __
mock_ Mock Transform Response - __
mock_ Mock Transform Response_ Clone - __
mock_ Mock Transform Response_ Transform Response - __
mock_ Mock Transformer - __
mock_ Mock Transformer_ Clone - __
mock_ Mock Transformer_ Transformer
Structs§
- Command
Output - Output from a
Command - Mock
Answer - Mock
Batchable Transformer - Mock
Chunker Transformer - Mock
Embedding Model - Mock
Evaluate Query - Mock
Loader - Mock
Node Cache - Mock
Persist - Mock
Simple Prompt - Mock
Sparse Embedding Model - Mock
Transform Query - Mock
Transform Response - Mock
Transformer
Enums§
- Command
- Commands that can be executed by the executor
Conceptually,
Shellallows any kind of input, and other commands enable more optimized implementations. - Command
Error - Tool
Feedback - Feedback that can be given on a tool, i.e. with a human in the loop
Traits§
- Agent
Context - Acts as the interface to the external world and manages messages for completion
- Answer
- Can answer the original query
- Batchable
Transformer - Transforms batched single nodes into streams of nodes
- Chat
Completion - Chunker
Transformer - Turns one node into many nodes
- DynClone
- This trait is implemented by any type that implements [
std::clone::Clone]. - Embedding
Model - Embeds a list of strings and returns its embeddings. Assumes the strings will be moved.
- Evaluate
Query - Evaluates a query
- Loader
- Starting point of a stream
- Message
History - A backend for the agent context. A default is provided for Arc<Mutex<Vec
>> - Node
Cache - Caches nodes, typically by their path and hash Recommended to namespace on the storage
- Persist
- Persists nodes
- Retrieve
- Can retrieve documents given a SearchStrategy
- Search
Strategy - A search strategy for the query pipeline
- Simple
Prompt - Given a string prompt, queries an LLM
- Sparse
Embedding Model - Embeds a list of strings and returns its embeddings. Assumes the strings will be moved.
- Tool
- The
Tooltrait is the main interface for chat completion and agent tools. - ToolBox
- A toolbox is a collection of tools
- Tool
Executor - A tool executor that can be used within an
AgentContext - Transform
Query - Can transform queries before retrieval
- Transform
Response - Can transform a response after retrieval
- Transformer
- Transforms single nodes into single nodes
- With
Batch Indexing Defaults - Allows for passing defaults from the pipeline to the batch transformer Required for batch transformers as at least a marker, implementation is not required
- With
Indexing Defaults - Allows for passing defaults from the pipeline to the transformer Required for batch transformers as at least a marker, implementation is not required