agent-framework-core 0.3.0

Core abstractions for agent-framework-rs: messages, chat clients, agents, tools, threads, middleware, memory, and workflows
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

//! # agent-framework-core
//!
//! Core abstractions for `agent-framework-rs`, a Rust implementation of the
//! Microsoft Agent Framework. This crate provides the building blocks:
//!
//! - [`types`] — the data model: messages, content, responses, options.
//! - [`client`] — the [`ChatClient`](client::ChatClient) trait and the
//!   automatic function-invocation loop.
//! - [`agent`] — the [`SupportsAgentRun`](agent::SupportsAgentRun) trait and
//!   [`Agent`](agent::Agent).
//! - [`compaction`] — conversation-history compaction strategies and the
//!   [`Tokenizer`](compaction::Tokenizer) abstraction.
//! - [`tools`] — executable tools and hosted-tool markers.
//! - [`session`] — [`AgentSession`](session::AgentSession), a lightweight
//!   conversation identity + state container.
//! - [`history`] — [`HistoryProvider`](history::HistoryProvider)s: conversation
//!   history as a [`ContextProvider`](memory::ContextProvider).
//! - [`memory`] — context / memory providers.
//! - [`middleware`] — agent, chat, and function middleware pipelines.
//! - [`observability`] — OpenTelemetry GenAI-style `tracing` instrumentation.
//! - [`skills`] — [`Skill`](skills::Skill) capability packages, surfaced via
//!   [`SkillsProvider`](skills::SkillsProvider), a
//!   [`ContextProvider`](memory::ContextProvider) that progressively
//!   discloses skill instructions and resources through
//!   framework-generated tools.
//! - [`settings`] — secret-masking [`SecretString`](settings::SecretString)
//!   and precedence-based setting resolution.
//! - [`workflow`] — graph-based multi-agent workflow orchestration.
//!
//! ## Example
//!
//! ```no_run
//! use agent_framework_core::prelude::*;
//! # async fn demo(client: impl ChatClient + 'static) -> Result<()> {
//! let agent = Agent::builder(client)
//!     .name("assistant")
//!     .instructions("You are a helpful assistant.")
//!     .build();
//!
//! let response = agent.run_once("Hello!").await?;
//! println!("{}", response.text());
//! # Ok(())
//! # }
//! ```

pub mod agent;
pub mod client;
pub mod compaction;
pub mod error;
pub mod history;
pub mod memory;
pub mod middleware;
pub mod observability;
pub mod session;
pub mod settings;
pub mod skills;
pub mod streaming;
pub mod tools;
pub mod types;
pub mod workflow;

pub use error::{Error, Result};

/// Commonly used imports.
pub mod prelude {
    pub use crate::agent::{
        Agent, AgentBuilder, AgentRunOptions, AgentRunStream, AgentToolStreamCallback,
        AsToolOptions, SupportsAgentRun,
    };
    pub use crate::client::{
        ChatClient, ChatStream, EmbeddingClient, FunctionInvokingChatClient, RetryOn, RetryPolicy,
        RetryingChatClient,
    };
    pub use crate::compaction::{
        compact, ApproxTokenizer, CompactionProvider, CompactionStrategy, SelectiveToolResult,
        SlidingWindow, TokenBudget, Tokenizer, Truncation,
    };
    pub use crate::error::{Error, Result};
    pub use crate::history::{FileHistoryProvider, HistoryProvider, InMemoryHistoryProvider};
    pub use crate::memory::{ContextProvider, SessionContext};
    pub use crate::middleware::{
        AgentContext, ChatContext, FunctionInvocationContext, LiveToolList, Middleware,
        MiddlewarePipeline, Next,
    };
    pub use crate::observability::{ObservabilityConfig, ObservableChatClient};
    pub use crate::session::{AgentSession, SessionState};
    pub use crate::settings::{load_setting, SecretString};
    pub use crate::skills::{Skill, SkillsProvider};
    pub use crate::tools::{
        hosted_code_interpreter, hosted_file_search, hosted_image_generation, hosted_mcp,
        hosted_web_search, ApprovalMode, FunctionInvocationConfig, FunctionTool, McpApprovalMode,
        Tool, ToolDefinition, ToolKind, ToolSource,
    };
    pub use crate::types::{
        AgentResponse, AgentResponseUpdate, ChatOptions, ChatResponse, ChatResponseUpdate, Content,
        Embedding, EmbeddingGenerationOptions, FinishReason, FunctionApprovalRequestContent,
        FunctionApprovalResponseContent, FunctionCallContent, FunctionResultContent,
        GeneratedEmbeddings, Message, ResponseFormat, Role, TextContent, ToolMode, UsageDetails,
    };
    pub use crate::workflow::{
        CheckpointStorage, ConcurrentBuilder, Executor, FileCheckpointStorage, GroupChatBuilder,
        GroupChatDirective, GroupChatManager, GroupChatState, HandoffBuilder,
        HandoffInteractionMode, InMemoryCheckpointStorage, MagenticBuilder, MagenticContext,
        MagenticManager, MagenticPlanReviewDecision, MagenticPlanReviewRequest,
        MagenticStallInterventionDecision, MagenticStallInterventionRequest, RequestInfoExecutor,
        SequentialBuilder, SharedState, StandardMagenticManager, Workflow, WorkflowAgent,
        WorkflowAgentExt, WorkflowBuilder, WorkflowContext, WorkflowEvent, WorkflowExecutor,
        WorkflowRun, WorkflowRunState,
    };
}