Trait Runnable 

pub trait Runnable<I, O>: Send + Sync
where
    I: Send + 'static,
    O: Send + 'static,
{
    // Required method
    fn invoke<'life0, 'async_trait>(
        &'life0 self,
        input: I,
        config: RunnableConfig,
    ) -> Pin<Box<dyn Future<Output = Result<O, CognisError>> + Send + 'async_trait>>
       where 'life0: 'async_trait,
             Self: 'async_trait;

    // Provided methods
    fn batch<'life0, 'async_trait>(
        &'life0 self,
        inputs: Vec<I>,
        config: RunnableConfig,
    ) -> Pin<Box<dyn Future<Output = Result<Vec<O>, CognisError>> + Send + 'async_trait>>
       where 'life0: 'async_trait,
             I: 'static,
             O: 'static,
             Self: Sized + Sync + 'async_trait { ... }
    fn stream<'life0, 'async_trait>(
        &'life0 self,
        input: I,
        config: RunnableConfig,
    ) -> Pin<Box<dyn Future<Output = Result<RunnableStream<O>, CognisError>> + Send + 'async_trait>>
       where 'life0: 'async_trait,
             Self: Sized + Sync + 'async_trait { ... }
    fn stream_events<'life0, 'async_trait>(
        &'life0 self,
        input: I,
        config: RunnableConfig,
    ) -> Pin<Box<dyn Future<Output = Result<EventStream, CognisError>> + Send + 'async_trait>>
       where 'life0: 'async_trait,
             I: Serialize,
             O: Serialize,
             Self: Sized + Sync + 'async_trait { ... }
    fn name(&self) -> &str { ... }
    fn input_schema(&self) -> Option<Value> { ... }
    fn output_schema(&self) -> Option<Value> { ... }
}

The unified contract every cognis primitive implements.

Generic over I (input) and O (output). One required method (invoke); batch, stream, and stream_events have sensible defaults that implementations override only when they can do better.

Required Methods

fn invoke<'life0, 'async_trait>( &'life0 self, input: I, config: RunnableConfig, ) -> Pin<Box<dyn Future<Output = Result<O, CognisError>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: 'async_trait,

One-shot invocation. The hot path.

Provided Methods

fn batch<'life0, 'async_trait>( &'life0 self, inputs: Vec<I>, config: RunnableConfig, ) -> Pin<Box<dyn Future<Output = Result<Vec<O>, CognisError>> + Send + 'async_trait>>

where 'life0: 'async_trait, I: 'static, O: 'static, Self: Sized + Sync + 'async_trait,

Run multiple inputs in parallel. Defaults to buffer_unordered honouring config.max_concurrency.

fn stream<'life0, 'async_trait>( &'life0 self, input: I, config: RunnableConfig, ) -> Pin<Box<dyn Future<Output = Result<RunnableStream<O>, CognisError>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: Sized + Sync + 'async_trait,

Stream the final output (chunks of O). Default emits one item via invoke — non-streaming runnables are correct without override.

fn stream_events<'life0, 'async_trait>( &'life0 self, input: I, config: RunnableConfig, ) -> Pin<Box<dyn Future<Output = Result<EventStream, CognisError>> + Send + 'async_trait>>

where 'life0: 'async_trait, I: Serialize, O: Serialize, Self: Sized + Sync + 'async_trait,

Stream structured events. Default emits OnStart + OnEnd around an invoke call. Graph engines override to surface per-node events.

fn name(&self) -> &str

Friendly name for telemetry / introspection.

fn input_schema(&self) -> Option<Value>

JSON Schema for the input type, if known.

fn output_schema(&self) -> Option<Value>

JSON Schema for the output type, if known.

Implementations on Foreign Types

impl Runnable<String, Vec<Document>> for BM25Retriever

fn invoke<'life0, 'async_trait>( &'life0 self, query: String, __arg2: RunnableConfig, ) -> Pin<Box<dyn Future<Output = Result<Vec<Document>, CognisError>> + Send + 'async_trait>>

where 'life0: 'async_trait, BM25Retriever: 'async_trait,

fn name(&self) -> &str

impl Runnable<String, Vec<Document>> for EnsembleRetriever

fn invoke<'life0, 'async_trait>( &'life0 self, query: String, config: RunnableConfig, ) -> Pin<Box<dyn Future<Output = Result<Vec<Document>, CognisError>> + Send + 'async_trait>>

where 'life0: 'async_trait, EnsembleRetriever: 'async_trait,

fn name(&self) -> &str

impl Runnable<String, Vec<Document>> for VectorRetriever

fn invoke<'life0, 'async_trait>( &'life0 self, query: String, __arg2: RunnableConfig, ) -> Pin<Box<dyn Future<Output = Result<Vec<Document>, CognisError>> + Send + 'async_trait>>

where 'life0: 'async_trait, VectorRetriever: 'async_trait,

fn name(&self) -> &str

impl Runnable<Vec<Document>, Vec<Document>> for Dedup

fn invoke<'life0, 'async_trait>( &'life0 self, input: Vec<Document>, __arg2: RunnableConfig, ) -> Pin<Box<dyn Future<Output = Result<Vec<Document>, CognisError>> + Send + 'async_trait>>

where 'life0: 'async_trait, Dedup: 'async_trait,

fn name(&self) -> &str

impl Runnable<Vec<Document>, Vec<Document>> for Enrichment

fn invoke<'life0, 'async_trait>( &'life0 self, input: Vec<Document>, __arg2: RunnableConfig, ) -> Pin<Box<dyn Future<Output = Result<Vec<Document>, CognisError>> + Send + 'async_trait>>

where 'life0: 'async_trait, Enrichment: 'async_trait,

fn name(&self) -> &str

impl Runnable<Vec<Document>, Vec<Document>> for MetadataTransformer

fn invoke<'life0, 'async_trait>( &'life0 self, input: Vec<Document>, __arg2: RunnableConfig, ) -> Pin<Box<dyn Future<Output = Result<Vec<Document>, CognisError>> + Send + 'async_trait>>

where 'life0: 'async_trait, MetadataTransformer: 'async_trait,

fn name(&self) -> &str

impl<T> Runnable<Vec<Message>, T> for StructuredClient<T>

where T: JsonSchema + DeserializeOwned + Send + 'static,

fn invoke<'life0, 'async_trait>( &'life0 self, input: Vec<Message>, __arg2: RunnableConfig, ) -> Pin<Box<dyn Future<Output = Result<T, CognisError>> + Send + 'async_trait>>

where 'life0: 'async_trait, StructuredClient<T>: 'async_trait,

fn name(&self) -> &str

Implementors

impl Runnable<FactExtractionInput, Vec<Fact>> for FactExtractor

impl Runnable<String, bool> for BooleanParser

impl Runnable<String, WorkflowState> for Workflow

impl Runnable<String, String> for StringParser

impl Runnable<String, Vec<String>> for CommaListParser

impl Runnable<String, Vec<String>> for NumberedListParser

impl Runnable<String, Vec<Document>> for ContextualCompressionRetriever

impl Runnable<String, Vec<Document>> for MultiQueryRetriever

impl Runnable<String, Vec<Document>> for RerankingRetriever

impl Runnable<String, Vec<Document>> for SelfQueryRetriever

impl Runnable<String, Vec<Document>> for TimeWeightedRetriever

impl Runnable<String, Vec<Document>> for CachingRetriever

impl Runnable<String, Vec<Document>> for CrossEncoderReranker

impl Runnable<String, Vec<Document>> for MultiVectorRetriever

impl Runnable<String, Vec<Document>> for ParentDocumentRetriever

impl Runnable<String, Vec<Document>> for QueryTranslatorRetriever

impl Runnable<String, HashMap<String, String>> for XmlParser

impl Runnable<Vec<Message>, Message> for Client

impl Runnable<Vec<Document>, Vec<Document>> for CompressorPipeline

impl Runnable<Vec<Document>, Vec<Document>> for LongContextReorder

impl<A, B, I, M, O> Runnable<I, O> for Pipe<A, B, I, M, O>

where A: Runnable<I, M>, B: Runnable<M, O>, I: Send + 'static, M: Send + 'static, O: Send + 'static,

impl<I> Runnable<I, String> for PromptTemplate<I>

where I: Serialize + Send + Sync + 'static,

impl<I> Runnable<I, Vec<Message>> for ChatPromptTemplate<I>

where I: Serialize + Send + Sync + 'static,

impl<I> Runnable<I, I> for Passthrough

where I: Send + 'static,

impl<I, E> Runnable<I, String> for FewShotTemplate<I, E>

where I: Serialize + Send + Sync + 'static, E: Serialize + Send + Sync + Clone + 'static,

impl<I, O> Runnable<I, HashMap<String, O>> for Parallel<I, O>

where I: Send + Sync + Clone + 'static, O: Send + 'static,

impl<I, O> Runnable<I, AssignOutput<I, O>> for Assign<I, O>

where I: Send + Sync + Clone + 'static, O: Send + 'static,

impl<I, O> Runnable<I, O> for Branch<I, O>

where I: Send + 'static, O: Send + 'static,

impl<I, O> Runnable<I, O> for Lambda<I, O>

where I: Send + 'static, O: Send + 'static,

impl<I, O> Runnable<I, O> for Configurable<I, O>

where I: Send + 'static, O: Send + 'static,

impl<O> Runnable<String, O> for LlmExtractor<O>

where O: DeserializeOwned + JsonSchema + Send + 'static,

impl<P, F, I, O> Runnable<I, O> for Fallback<P, F, I, O>

where P: Runnable<I, O>, F: Runnable<I, O>, I: Clone + Send + 'static, O: Send + 'static,

impl<R> Runnable<Vec<Message>, Message> for RunnableWithMessageHistory<R>

where R: Runnable<Vec<Message>, Message>,

impl<R, I, O> Runnable<Vec<I>, Vec<O>> for Each<R, I, O>

where R: Runnable<I, O>, I: Send + 'static, O: Send + 'static,

impl<R, I, O> Runnable<I, O> for Bind<R, I, O>

where R: Runnable<I, O>, I: Send + 'static, O: Send + 'static,

impl<R, I, O> Runnable<I, O> for WithListeners<R, I, O>

where R: Runnable<I, O>, I: Clone + Send + Sync + 'static, O: Send + Sync + 'static,

impl<R, I, O> Runnable<I, O> for WithMiddleware<R, I, O>

where R: Runnable<I, O>, I: Send + 'static, O: Send + 'static,

impl<R, I, O> Runnable<I, O> for Retry<R, I, O>

where R: Runnable<I, O>, I: Clone + Send + 'static, O: Send + 'static,

impl<R, I, O> Runnable<I, O> for WithSchema<R, I, O>

where R: Runnable<I, O>, I: Send + 'static, O: Send + 'static,

impl<R, I, O> Runnable<I, O> for Timeout<R, I, O>

where R: Runnable<I, O>, I: Send + 'static, O: Send + 'static,

impl<R, I, O, K, B> Runnable<I, O> for Cache<R, I, O, K, B>

where R: Runnable<I, O>, I: Send + 'static, O: Clone + Send + Sync + 'static, K: Send + Sync + 'static, B: CacheBackend<K, O> + 'static,

impl<S> Runnable<S, S> for CompiledGraph<S>

where S: GraphState + Clone + Send + 'static, <S as GraphState>::Update: Clone,

impl<T> Runnable<String, T> for JsonParser<T>

where T: DeserializeOwned + Send + 'static,

impl<T> Runnable<String, T> for StructuredOutputParser<T>

where T: DeserializeOwned + JsonSchema + Send + 'static,

impl<T, P> Runnable<String, T> for OutputFixingParser<T, P>

where T: Send + 'static, P: OutputParser<T> + Send + Sync,

impl<T, P> Runnable<String, T> for RetryParser<T, P>

where T: Send + 'static, P: OutputParser<T> + Send + Sync,