Struct Ollama

pub struct Ollama { /* private fields */ }

The Ollama struct encapsulates an Ollama client and default options for embedding and prompt models. It uses the Builder pattern for flexible and customizable instantiation.

By default it will look for a OLLAMA_API_KEY environment variable. Note that either a prompt model or embedding model always need to be set, either with Ollama::with_default_prompt_model or Ollama::with_default_embed_model or via the builder. You can find available models in the Ollama documentation.

Under the hood it uses async_openai, with the Ollama openai mapping. This means some features might not work as expected. See the Ollama documentation for details.

Implementations

impl Ollama

pub fn builder() -> OllamaBuilder

Creates a new OllamaBuilder for constructing Ollama instances.

pub fn with_default_prompt_model( &mut self, model: impl Into<String>, ) -> &mut Ollama

Sets a default prompt model to use when prompting

pub fn with_default_embed_model( &mut self, model: impl Into<String>, ) -> &mut Ollama

Sets a default embedding model to use when embedding

Trait Implementations

impl Clone for Ollama

fn clone(&self) -> Ollama

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Ollama

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

Formats the value using the given formatter.

impl Default for Ollama

fn default() -> Ollama

Returns the “default value” for a type.

impl EmbeddingModel for Ollama

fn embed<'life0, 'async_trait>( &'life0 self, input: Vec<String>, ) -> Pin<Box<dyn Future<Output = Result<Vec<Vec<f32>>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, Ollama: 'async_trait,

fn name(&self) -> &'static str

impl SimplePrompt for Ollama

The SimplePrompt trait defines a method for sending a prompt to an AI model and receiving a response.

fn prompt<'life0, 'async_trait>( &'life0 self, prompt: Prompt, ) -> Pin<Box<dyn Future<Output = Result<String, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, Ollama: 'async_trait,

Sends a prompt to the Ollama API and returns the response content.

Parameters

• prompt: A string slice that holds the prompt to be sent to the Ollama API.

Returns

• Result<String>: On success, returns the content of the response as a String. On failure, returns an error wrapped in a Result.

Errors

• Returns an error if the model is not set in the default options.
• Returns an error if the request to the Ollama API fails.
• Returns an error if the response does not contain the expected content.

fn name(&self) -> &'static str