Skip to main content

FunctionTool

Struct FunctionTool 

Source
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,

Source

pub fn new( name: impl Into<String>, description: impl Into<String>, parameters_schema: Value, handler: F, ) -> FunctionTool<F>

创建新的函数工具

Source

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,

Source§

fn name(&self) -> &str

工具名称 (唯一标识符)
Source§

fn description(&self) -> &str

工具描述 (用于 LLM 理解)
Source§

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,

执行工具
Source§

fn metadata(&self) -> ToolMetadata

工具元数据
Source§

fn validate_input(&self, input: &ToolInput) -> Result<(), AgentError>

验证输入
Source§

fn requires_confirmation(&self) -> bool

是否需要确认
Source§

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> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

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 more
Source§

impl<T> Message for T
where T: Any + Send + 'static,

Source§

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>

Convert this message to a BoxedMessage
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> State for T
where T: Any + Send + 'static,