ollama-oxide 0.2.0

A Rust library for integrating with Ollama's native API, providing low-level inference and high-level conveniences.
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154

//! # ollama-oxide
//!
//! A Rust library for integrating with Ollama's native API.
//!
//! ## Quick Start
//!
//! ### Async Example
//! ```no_run
//! use ollama_oxide::{OllamaClient, OllamaApiAsync, Result};
//!
//! #[tokio::main]
//! async fn main() -> Result<()> {
//!     let client = OllamaClient::default()?;
//!     let version = client.version().await?;
//!     println!("Ollama version: {}", version.version);
//!     Ok(())
//! }
//! ```
//!
//! ### Sync Example
//! ```no_run
//! use ollama_oxide::{OllamaClient, OllamaApiSync, Result};
//!
//! fn main() -> Result<()> {
//!     let client = OllamaClient::default()?;
//!     let version = client.version_blocking()?;
//!     println!("Ollama version: {}", version.version);
//!     Ok(())
//! }
//! ```

// ============================================================================
// Error Handling
// ============================================================================

mod error;

pub use error::{Error, Result};

// ============================================================================
// Inference Module
// ============================================================================

#[cfg(feature = "inference")]
pub mod inference;

#[cfg(feature = "inference")]
pub use inference::{
    // Chat types
    ChatMessage,
    ChatRequest,
    ChatResponse,
    ChatRole,
    EmbedInput,
    EmbedRequest,
    EmbedResponse,
    FormatSetting,
    GenerateRequest,
    GenerateResponse,
    KeepAliveSetting,
    Logprob,
    ModelOptions,
    ResponseMessage,
    StopSetting,
    ThinkSetting,
    TokenLogprob,
    VersionResponse,
};

// ============================================================================
// HTTP Client Module
// ============================================================================

#[cfg(feature = "http")]
pub mod http;

#[cfg(feature = "http")]
pub use http::{
    ChatStream, ChatStreamBlocking, ClientConfig, OllamaApiAsync, OllamaApiSync, OllamaClient,
};

// ============================================================================
// Model Module
// ============================================================================

#[cfg(feature = "model")]
pub mod model;

#[cfg(feature = "model")]
pub use model::{
    CopyRequest, CreateRequest, CreateResponse, DeleteRequest, LicenseSetting, ListResponse,
    ModelDetails, ModelSummary, PsResponse, PullRequest, PullResponse, PushRequest, PushResponse,
    RunningModel, ShowModelDetails, ShowRequest, ShowResponse,
};

// ============================================================================
// Ergonomic Tools Module (requires "tools" feature)
// ============================================================================

#[cfg(feature = "tools")]
pub mod tools;

// Tool types re-exports (requires both "inference" and "tools" features)
#[cfg(feature = "tools")]
pub use tools::{ToolCall, ToolCallFunction, ToolDefinition, ToolFunction};

// ============================================================================
// Prelude
// ============================================================================

pub mod prelude {
    pub use crate::{Error, Result};

    #[cfg(feature = "http")]
    pub use crate::{
        ChatStream, ChatStreamBlocking, ClientConfig, OllamaApiAsync, OllamaApiSync, OllamaClient,
    };

    #[cfg(feature = "inference")]
    pub use crate::{
        // Chat types
        ChatMessage,
        ChatRequest,
        ChatResponse,
        ChatRole,
        // Inference types
        EmbedInput,
        EmbedRequest,
        EmbedResponse,
        FormatSetting,
        GenerateRequest,
        GenerateResponse,
        KeepAliveSetting,
        Logprob,
        ModelOptions,
        ResponseMessage,
        StopSetting,
        ThinkSetting,
        TokenLogprob,
        VersionResponse,
    };

    // Tool types (requires "tools" features)
    #[cfg(feature = "tools")]
    pub use crate::{ToolCall, ToolCallFunction, ToolDefinition, ToolFunction};

    // Model types (requires "model" feature)
    #[cfg(feature = "model")]
    pub use crate::{
        CopyRequest, CreateRequest, CreateResponse, DeleteRequest, LicenseSetting, ListResponse,
        ModelDetails, ModelSummary, PsResponse, RunningModel, ShowModelDetails, ShowRequest,
        ShowResponse,
    };
}