ollama-sdk 0.2.0

An idiomatic, unofficial Rust client for the Ollama API with support for streaming, tool calling, and custom transports.
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

use std::sync::Arc;

#[cfg(feature = "tracing")]
use tracing::instrument;

use async_trait::async_trait;
use serde_json::Value;
use tokio_util::sync::CancellationToken;

use crate::errors::Error;

pub mod registry;

/// Context provided to a tool during its execution.
#[derive(Clone)]
pub struct ToolContext {
    /// A token to signal cancellation of the tool's execution.
    pub cancellation_token: CancellationToken,
    // Add other context information here, e.g., access to HTTP client, logger, etc.
}

#[async_trait]
pub trait Tool: Send + Sync + 'static {
    /// Returns the name of the tool. This name must be unique and match the name
    /// the model expects to call.
    fn name(&self) -> &str;

    /// Executes the tool with the given input.
    /// The input is typically a JSON object provided by the model.
    /// The tool should return a JSON object as its result.
    #[cfg_attr(feature = "tracing", instrument(skip(self, _input, _ctx)))]
    async fn call(&self, _input: Value, _ctx: ToolContext) -> Result<Value, Error> {
        Ok(Value::Null)
    }
}

pub type DynTool = Arc<dyn Tool>;