Skip to main content

OllamaClient

Struct OllamaClient 

Source
pub struct OllamaClient { /* private fields */ }
Expand description

Ollama client for LLM inference

Implementations§

Source§

impl OllamaClient

Source

pub fn new(config: OllamaConfig) -> Self

Create a new Ollama client

Source

pub fn get_stats(&self) -> &OllamaUsageStats

Get usage statistics

Source

pub fn config(&self) -> &OllamaConfig

Access the underlying Ollama configuration

Source

pub async fn generate(&self, prompt: &str) -> Result<String>

Generate text completion using Ollama API

Source

pub async fn generate_with_params( &self, prompt: &str, params: OllamaGenerationParams, ) -> Result<String>

Generate text completion with custom parameters

Source

pub async fn generate_with_full_response( &self, prompt: &str, params: OllamaGenerationParams, ) -> Result<OllamaGenerateResponse>

Generate text and return the full response including KV cache context and token stats.

Use this for the two-step contextual enrichment pattern:

let client = OllamaClient::new(OllamaConfig::default());

// Step 1: Prime — load the document into Ollama's KV cache
let prime_params = OllamaGenerationParams {
    num_predict: Some(1), // generate minimal output; we just want the context
    keep_alive: Some("1h".to_string()),
    num_ctx: Some(32768),
    ..Default::default()
};
let prime = client.generate_with_full_response("<document>..full doc..</document>", prime_params).await?;
println!("Prompt tokens evaluated: {}", prime.prompt_eval_count); // ~doc_tokens

// Step 2: Per chunk — only the chunk tokens are evaluated
for chunk in chunks {
    let params = OllamaGenerationParams {
        num_predict: Some(80),
        context: Some(prime.context.clone()),  // ← KV cache reuse!
        keep_alive: Some("1h".to_string()),
        ..Default::default()
    };
    let resp = client.generate_with_full_response(&chunk, params).await?;
    println!("Chunk tokens evaluated: {}", resp.prompt_eval_count); // ~chunk_tokens, not doc_tokens!
}
Source

pub async fn generate_streaming(&self, prompt: &str) -> Result<Receiver<String>>

Generate streaming completion

Returns a channel receiver that yields tokens as they are generated. This enables real-time display of generation progress.

§Example
use graphrag_core::ollama::{OllamaClient, OllamaConfig};

let client = OllamaClient::new(OllamaConfig::default());
let mut rx = client.generate_streaming("Write a story").await?;

while let Some(token) = rx.recv().await {
    print!("{}", token);
}

Trait Implementations§

Source§

impl Clone for OllamaClient

Source§

fn clone(&self) -> OllamaClient

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for OllamaClient

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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> ErasedDestructor for T
where T: 'static,