# Omni v2.0.0 - Table of Contents ## Pages - [Changelog](changelog.md) - [Upgrading to v2](upgrading-to-v2.md) - Guides - [Getting started](getting-started.md) - [Text generation](text-generation.md) - [Decisions](decisions.md) - [Providers and models](providers-and-models.md) - [Built-in providers](built-in-providers.md) ## Modules - [Omni](Omni.md): Universal Elixir client for LLM APIs. Text generation, tool use, structured output and decisions across many providers. - [Omni.Codec](Omni.Codec.md): Lossless serialisation of Omni structs to and from JSON-safe maps. - [Omni.Model](Omni.Model.md): A data struct describing a specific LLM. - [Omni.Usage](Omni.Usage.md): Token counts and computed costs for a request. - Text generation - [Omni.Context](Omni.Context.md): The context for a conversation with an LLM. - [Omni.Message](Omni.Message.md): A message in a conversation. - [Omni.Response](Omni.Response.md): The result of a text generation request. - [Omni.Schema](Omni.Schema.md): Builders and validation for JSON Schema maps. - [Omni.Schema.Adapter](Omni.Schema.Adapter.md): A behaviour for validating schemas with a library of your choice. - [Omni.StreamingResponse](Omni.StreamingResponse.md): A streaming text response, yielding events as the model writes. - [Omni.Tool](Omni.Tool.md): A tool the model can use during a conversation. - [Omni.Tool.Runner](Omni.Tool.Runner.md): Runs tool uses in parallel and returns their tool results. - Content - [Omni.Content.Attachment](Omni.Content.Attachment.md): An attachment content block: an image, a PDF or other binary content. - [Omni.Content.Data](Omni.Content.Data.md): A data content block: structured data sent to the model as JSON. - [Omni.Content.Text](Omni.Content.Text.md): A text content block. - [Omni.Content.Thinking](Omni.Content.Thinking.md): A thinking content block: the model's reasoning before it answers. - [Omni.Content.ToolResult](Omni.Content.ToolResult.md): A tool result content block: the output of one tool use. - [Omni.Content.ToolUse](Omni.Content.ToolUse.md): A tool use content block: the model asking for a tool to be run. - Decisions - [Omni.Answer](Omni.Answer.md): Answers to the questions of a decision. - [Omni.Answer.Choice](Omni.Answer.Choice.md): The answer to an `Omni.Question.Choice`. - [Omni.Answer.Predicate](Omni.Answer.Predicate.md): The answer to an `Omni.Question.Predicate`. - [Omni.Answer.Refusal](Omni.Answer.Refusal.md): The model declined to answer a question. - [Omni.Answer.Score](Omni.Answer.Score.md): The answer to an `Omni.Question.Score`. - [Omni.Decision](Omni.Decision.md): A decision: typed questions about a shared state, and their answers. - [Omni.Question](Omni.Question.md): Typed questions for `Omni.decide/3`. - [Omni.Question.Choice](Omni.Question.Choice.md): A question with one answer from a fixed set of choices. - [Omni.Question.Predicate](Omni.Question.Predicate.md): A yes/no question: how likely is a statement about the state to be true. - [Omni.Question.Score](Omni.Question.Score.md): A question rating the state on an ordered scale of levels. - Providers - [Omni.Provider](Omni.Provider.md): The provider struct, the provider module behaviour, and provider loading. - [Omni.Provider.Endpoint](Omni.Provider.Endpoint.md): Where a provider serves one dialect, and how it deviates from it. - Dialects - [Omni.Dialect](Omni.Dialect.md): Behaviour for wire format translation between Omni types and provider APIs. - [Omni.Dialect.Decision](Omni.Dialect.Decision.md): Behaviour for decision dialects. - [Omni.Dialect.Text](Omni.Dialect.Text.md): Behaviour for text generation dialects. - [Omni.Dialects.AnthropicMessages](Omni.Dialects.AnthropicMessages.md): Dialect implementation for the Anthropic Messages wire format. - [Omni.Dialects.GoogleGenerateContent](Omni.Dialects.GoogleGenerateContent.md): Dialect implementation for the Gemini API's `generateContent` wire format. - [Omni.Dialects.OllamaChat](Omni.Dialects.OllamaChat.md): Dialect implementation for the Ollama native chat API wire format. - [Omni.Dialects.OpenAICompletions](Omni.Dialects.OpenAICompletions.md): Dialect implementation for the OpenAI Chat Completions wire format. - [Omni.Dialects.OpenAIDecisions](Omni.Dialects.OpenAIDecisions.md): Dialect implementation for the OpenAI Decisions format. - [Omni.Dialects.OpenAIResponses](Omni.Dialects.OpenAIResponses.md): Dialect implementation for the OpenAI Responses wire format. - [Omni.Dialects.TypeSafeSystemOne](Omni.Dialects.TypeSafeSystemOne.md): Dialect implementation for the System One decision format. - Sources - [Omni.Source](Omni.Source.md): Behaviour for pluggable model data sources. - [Omni.Sources.LLMDB](Omni.Sources.LLMDB.md): A model source reading the optional `llm_db` package. - [Omni.Sources.ModelsDev](Omni.Sources.ModelsDev.md): The default model source, reading a bundled models.dev snapshot. ## Mix Tasks - [mix omni.verify](Mix.Tasks.Omni.Verify.md): Runs a set of live scenarios against one model and reports which pass.