cognis 0.2.1

LLM application framework built on cognis-core
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119

//! Chain abstractions for composing prompts, models, and sequential pipelines.
//!
//! # Deprecation Notice
//!
//! **Standalone chain types are soft-deprecated** in favor of composable
//! [`Runnable`](cognis_core::runnables::Runnable) pipelines using the `|`
//! operator via [`RunnableRef`](cognis_core::runnables::RunnableRef).
//!
//! Instead of:
//! ```ignore
//! let chain = LLMChain::new(prompt, model);
//! let result = chain.run("input").await?;
//! ```
//!
//! Prefer:
//! ```ignore
//! use cognis_core::runnables::pipe::RunnableRef;
//! let chain = RunnableRef::new(prompt) | RunnableRef::new(model) | RunnableRef::new(parser);
//! let result = chain.runnable().invoke(json!("input"), None).await?;
//! ```
//!
//! Existing chain types remain available for backward compatibility but will
//! not receive new features. New workflows should use Runnable composition.
//!
//! ---
//!
//! This module provides a variety of chain types for building LLM workflows:
//!
//! - [`llm`] -- Basic LLM chain (prompt -> model -> output).
//! - [`sequential`] -- Sequential chain that pipes output from one chain to the next.
//! - [`conversation`] -- Conversation chain with memory integration.
//! - [`conversation_retrieval`] -- Conversational retrieval chain combining memory and document lookup.
//! - [`retrieval`] -- Retrieval QA chain for question answering over documents.
//! - [`map_reduce`] -- Map-reduce chain for processing document collections.
//! - [`refine`] -- Refine chain that iteratively improves answers over documents.
//! - [`router`] -- Router chain with semantic routing for dynamic dispatch.
//! - [`structured_output`] -- Structured output chain for schema-validated responses.
//! - [`summarize`] -- Summarization chains (stuff, map-reduce, refine strategies).
//! - [`sql`] -- Text-to-SQL chain with schema validation.
//! - [`api`] -- API chain for calling external HTTP endpoints.
//! - [`streaming`] -- Streaming chain execution with callback-driven token delivery.
//! - [`extraction`] -- Extraction chain for pulling structured data from text.
//! - [`transform`] -- Transform chains with sync/async transforms and pipeline composition.
//! - [`conditional`] -- Conditional, branch, and switch chains for routing based on predicates.
//! - [`documents`] -- Stuff documents chain for combining documents with formatting strategies.
//! - [`qa`] -- QA chain with retrieval integration and citation tracking.

pub mod conversation;
pub mod llm;
pub mod map_reduce;
pub mod refine;
pub mod retrieval;
pub mod sequential;

pub use conversation::ConversationChain;
pub use llm::LLMChain;
pub use map_reduce::MapReduceChain;
pub use refine::RefineChain;
pub use retrieval::{RetrievalQAChain, RetrievalResult};
pub use sequential::SequentialChain;
pub mod conversation_retrieval;
pub use conversation_retrieval::{ConversationalRetrievalChain, ConversationalRetrievalResult};
pub mod router;
pub use router::{Route, RouterChain, RouterResult, SemanticRouter};
pub mod structured_output;
pub use structured_output::StructuredOutputChain;
pub mod summarize;
pub use summarize::{
    MapReduceSummarizationChain, RefineSummarizationChain, StuffSummarizationChain,
};
pub mod sql;
pub use sql::{
    ColumnSchema, ColumnSchemaBuilder, DatabaseSchema, DatabaseSchemaBuilder, SQLQueryValidator,
    TableSchema, TableSchemaBuilder, TextToSQLChain, TextToSQLChainBuilder,
};
pub mod api;
pub use api::{
    APIChain, APIChainBuilder, APISpec, APISpecBuilder, EndpointSpec, EndpointSpecBuilder,
    ParameterSpec, ParameterSpecBuilder, RequestValidator,
};
pub mod transform;
pub use transform::{
    json_extract_transform, lowercase_transform, map_transform, regex_replace_transform,
    trim_transform, uppercase_transform, AsyncTransformChain, AsyncTransformFn, TransformChain,
    TransformChainBuilder, TransformFn, TransformPipeline,
};
pub mod streaming;
pub use streaming::{
    stream_chain, ConsoleStreamingCallback, StreamingCallback, StreamingCallbackAdapter,
    StreamingChainExecutor, StreamingChainResult, TokenCollector,
};
pub mod conditional;
pub use conditional::{
    BranchChain, BranchChainBuilder, ClosureCondition, Condition, ConditionalChain,
    ConditionalChainBuilder, KeyContainsCondition, KeyEqualsCondition, KeyExistsCondition,
    SwitchChain, SwitchChainBuilder,
};
pub mod extraction;
pub use extraction::{
    ExtractionChain, ExtractionChainBuilder, ExtractionExample, ExtractionResult, ExtractionSchema,
    ExtractionSchemaBuilder, FieldType, OutputFormat, SchemaField, SchemaFieldBuilder,
};
pub mod documents;
pub use documents::{
    create_stuff_documents_chain, CollapseStrategy, DocumentCombineStrategy, DocumentFormatter,
    StuffDocumentsChain, StuffDocumentsChainBuilder, StuffStrategy,
};
pub mod qa;
pub use qa::{
    create_qa_chain, Citation, CitedAnswer, QAChain, QAChainType, QAConfig, QAConfigBuilder,
    QAResult,
};
pub mod callbacks;
pub mod composition;
pub use composition::{
    execute_with_metrics, ChainMetrics, ChainPipeline, ChainStep, ChainStepBuilder,
    CompositionConditionalChain, CompositionSequentialChain, CompositionTransformChain, MapChain,
    ParallelChain, StepMetric,
};