# Ollixir v0.1.1 - Table of Contents

## Pages

- [Overview](overview.md)
- [Examples](examples.md)

- Guides
  - [Getting Started](getting-started.md)
  - [Ollama Server Setup](ollama-setup.md)
  - [Streaming](streaming.md)
  - [Tools](tools.md)
  - [Structured Outputs](structured-outputs.md)
  - [Thinking Mode](thinking.md)
  - [Embeddings](embeddings.md)
  - [Multimodal](multimodal.md)
  - [HuggingFace Integration](huggingface.md)
  - [Cloud API](cloud-api.md)
  - [Cheatsheet](cheatsheet.md)

- Project
  - [Changelog](changelog.md)
  - [License](license.md)

## Modules

- Client
  - [Ollixir](Ollixir.md): Elixir client for the Ollama API.

- Errors
  - [Ollixir.ConnectionError](Ollixir.ConnectionError.md): Exception raised when unable to connect to the Ollama server.
  - [Ollixir.Errors](Ollixir.Errors.md): Error handling utilities for Ollixir.
  - [Ollixir.RequestError](Ollixir.RequestError.md): Exception raised for pre-request validation errors.
  - [Ollixir.ResponseError](Ollixir.ResponseError.md): Exception raised for API response errors.
  - [Ollixir.Retry](Ollixir.Retry.md): Retry utilities for transient errors.

- Helpers
  - [Ollixir.Image](Ollixir.Image.md): Image handling utilities for multimodal models.
  - [Ollixir.Options](Ollixir.Options.md): Model inference options.
  - [Ollixir.Options.Presets](Ollixir.Options.Presets.md): Pre-configured option sets for common use cases.

  - [Ollixir.Tool](Ollixir.Tool.md): Tool definition helpers for function calling.

- HuggingFace
  - [Ollixir.HuggingFace](Ollixir.HuggingFace.md):   HuggingFace Hub integration for Ollixir.

- Web
  - [Ollixir.Web](Ollixir.Web.md): Web search and fetch functionality for Ollama cloud API.
  - [Ollixir.Web.FetchResponse](Ollixir.Web.FetchResponse.md): Response from web_fetch.

  - [Ollixir.Web.SearchResponse](Ollixir.Web.SearchResponse.md): Response from web_search.

  - [Ollixir.Web.SearchResult](Ollixir.Web.SearchResult.md): Single web search result.

  - [Ollixir.Web.Tools](Ollixir.Web.Tools.md): Tool definitions for web search and fetch.

- Types
  - [Ollixir.Types](Ollixir.Types.md): Typed response structs for Ollama API.
  - [Ollixir.Types.ChatResponse](Ollixir.Types.ChatResponse.md): Response from the chat endpoint.

  - [Ollixir.Types.EmbedResponse](Ollixir.Types.EmbedResponse.md): Response from embed endpoint.

  - [Ollixir.Types.EmbeddingsResponse](Ollixir.Types.EmbeddingsResponse.md): Response from embeddings endpoint.

  - [Ollixir.Types.GenerateResponse](Ollixir.Types.GenerateResponse.md): Response from the generate/completion endpoint.

  - [Ollixir.Types.ListResponse](Ollixir.Types.ListResponse.md): Response from list_models.

  - [Ollixir.Types.Logprob](Ollixir.Types.Logprob.md): Log probability for a token.

  - [Ollixir.Types.Message](Ollixir.Types.Message.md): Chat message structure.

  - [Ollixir.Types.ModelDetails](Ollixir.Types.ModelDetails.md): Model details structure.

  - [Ollixir.Types.ModelInfo](Ollixir.Types.ModelInfo.md): Model information.

  - [Ollixir.Types.ProcessResponse](Ollixir.Types.ProcessResponse.md): Response from list_running (ps).

  - [Ollixir.Types.ProgressResponse](Ollixir.Types.ProgressResponse.md): Progress response for pull/push/create operations.

  - [Ollixir.Types.ShowResponse](Ollixir.Types.ShowResponse.md): Response from show_model.

  - [Ollixir.Types.StatusResponse](Ollixir.Types.StatusResponse.md): Simple status response.

  - [Ollixir.Types.ToolCall](Ollixir.Types.ToolCall.md): Tool call definition.

- Internals
  - [Ollixir.Blob](Ollixir.Blob.md): Module for working for blobs in Ollama.