pub struct FunctionTool<F>where
F: Fn(ToolInput, &AgentContext) -> Pin<Box<dyn Future<Output = ToolResult> + Send + '_>> + Send + Sync,{ /* private fields */ }Expand description
函数工具
从函数创建工具
§示例
ⓘ
use mofa_foundation::agent::tools::FunctionTool;
async fn my_tool_fn(input: ToolInput, ctx: &AgentContext) -> ToolResult {
let message = input.get_str("message").unwrap_or("default");
ToolResult::success_text(format!("Processed: {}", message))
}
let tool = FunctionTool::new(
"my_tool",
"A custom tool",
serde_json::json!({
"type": "object",
"properties": {
"message": { "type": "string" }
}
}),
my_tool_fn,
);Implementations§
Source§impl<F> FunctionTool<F>where
F: Fn(ToolInput, &AgentContext) -> Pin<Box<dyn Future<Output = ToolResult> + Send + '_>> + Send + Sync,
impl<F> FunctionTool<F>where
F: Fn(ToolInput, &AgentContext) -> Pin<Box<dyn Future<Output = ToolResult> + Send + '_>> + Send + Sync,
Sourcepub fn new(
name: impl Into<String>,
description: impl Into<String>,
parameters_schema: Value,
handler: F,
) -> FunctionTool<F>
pub fn new( name: impl Into<String>, description: impl Into<String>, parameters_schema: Value, handler: F, ) -> FunctionTool<F>
创建新的函数工具
Sourcepub fn with_metadata(self, metadata: ToolMetadata) -> FunctionTool<F>
pub fn with_metadata(self, metadata: ToolMetadata) -> FunctionTool<F>
设置元数据
Trait Implementations§
Source§impl<F> Tool for FunctionTool<F>where
F: Fn(ToolInput, &AgentContext) -> Pin<Box<dyn Future<Output = ToolResult> + Send + '_>> + Send + Sync,
impl<F> Tool for FunctionTool<F>where
F: Fn(ToolInput, &AgentContext) -> Pin<Box<dyn Future<Output = ToolResult> + Send + '_>> + Send + Sync,
Source§fn description(&self) -> &str
fn description(&self) -> &str
工具描述 (用于 LLM 理解)
Source§fn parameters_schema(&self) -> Value
fn parameters_schema(&self) -> Value
参数 JSON Schema
Source§fn execute<'life0, 'life1, 'async_trait>(
&'life0 self,
input: ToolInput,
ctx: &'life1 AgentContext,
) -> Pin<Box<dyn Future<Output = ToolResult> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
FunctionTool<F>: 'async_trait,
fn execute<'life0, 'life1, 'async_trait>(
&'life0 self,
input: ToolInput,
ctx: &'life1 AgentContext,
) -> Pin<Box<dyn Future<Output = ToolResult> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
FunctionTool<F>: 'async_trait,
执行工具
Source§fn metadata(&self) -> ToolMetadata
fn metadata(&self) -> ToolMetadata
工具元数据
Source§fn validate_input(&self, input: &ToolInput) -> Result<(), AgentError>
fn validate_input(&self, input: &ToolInput) -> Result<(), AgentError>
验证输入
Source§fn requires_confirmation(&self) -> bool
fn requires_confirmation(&self) -> bool
是否需要确认
Source§fn to_llm_tool(&self) -> LLMTool
fn to_llm_tool(&self) -> LLMTool
转换为 LLM Tool 格式
Auto Trait Implementations§
impl<F> Freeze for FunctionTool<F>where
F: Freeze,
impl<F> RefUnwindSafe for FunctionTool<F>where
F: RefUnwindSafe,
impl<F> Send for FunctionTool<F>
impl<F> Sync for FunctionTool<F>
impl<F> Unpin for FunctionTool<F>where
F: Unpin,
impl<F> UnsafeUnpin for FunctionTool<F>where
F: UnsafeUnpin,
impl<F> UnwindSafe for FunctionTool<F>where
F: UnwindSafe,
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> 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> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Message for T
impl<T> Message for T
Source§fn from_boxed(m: BoxedMessage) -> Result<Self, BoxedDowncastErr>
fn from_boxed(m: BoxedMessage) -> Result<Self, BoxedDowncastErr>
Convert a BoxedMessage to this concrete type
Source§fn box_message(self, pid: &ActorId) -> Result<BoxedMessage, BoxedDowncastErr>
fn box_message(self, pid: &ActorId) -> Result<BoxedMessage, BoxedDowncastErr>
Convert this message to a BoxedMessage