# PhoenixAI v0.1.0 - Table of Contents

AI integration library for Elixir inspired by laravel/ai

## Pages

- Guides
  - [Getting Started](getting-started.md)
  - [Provider Setup](provider-setup.md)
  - [Agents & Tools](agents-and-tools.md)
  - [Pipelines & Teams](pipelines-and-teams.md)

- Cookbook
  - [Cookbook: RAG Pipeline](rag-pipeline.md)
  - [Cookbook: Multi-Agent Team](multi-agent-team.md)
  - [Cookbook: Streaming to LiveView](streaming-liveview.md)
  - [Cookbook: Custom Tools](custom-tools.md)

## Modules

- [PhoenixAI](PhoenixAI.md): PhoenixAI — AI integration library for Elixir.
- [PhoenixAI.Error](PhoenixAI.Error.md): Represents an error returned from an AI provider or internal operation.
- [PhoenixAI.Provider](PhoenixAI.Provider.md): Behaviour that all AI provider adapters must implement.
- [PhoenixAI.Schema.Validator](PhoenixAI.Schema.Validator.md): Pure-function JSON Schema validator.
- [PhoenixAI.ToolCall](PhoenixAI.ToolCall.md): Represents a tool/function call requested by the AI model.
- [PhoenixAI.ToolResult](PhoenixAI.ToolResult.md): Represents the result returned after executing a tool call.

- Core
  - [AI](AI.md): Thin facade for interacting with AI providers.
  - [PhoenixAI.Conversation](PhoenixAI.Conversation.md): Stub for a conversation holding an ordered list of messages. (Phase 4)
  - [PhoenixAI.Message](PhoenixAI.Message.md): Represents a single message in an AI conversation.
  - [PhoenixAI.Response](PhoenixAI.Response.md): Represents a completed response from an AI provider.

- Providers
  - [PhoenixAI.Providers.Anthropic](PhoenixAI.Providers.Anthropic.md): Anthropic provider adapter implementing the `PhoenixAI.Provider` behaviour.
  - [PhoenixAI.Providers.OpenAI](PhoenixAI.Providers.OpenAI.md): OpenAI provider adapter implementing the `PhoenixAI.Provider` behaviour.
  - [PhoenixAI.Providers.OpenRouter](PhoenixAI.Providers.OpenRouter.md): OpenRouter provider adapter implementing the `PhoenixAI.Provider` behaviour.
  - [PhoenixAI.Providers.TestProvider](PhoenixAI.Providers.TestProvider.md): Test provider for offline testing. Returns scripted responses without network calls.

- Tools & Agent
  - [PhoenixAI.Agent](PhoenixAI.Agent.md): Stateful GenServer that owns one conversation and runs the completion-tool-call loop.
  - [PhoenixAI.Tool](PhoenixAI.Tool.md): Behaviour for defining tools that AI models can call.
  - [PhoenixAI.ToolLoop](PhoenixAI.ToolLoop.md): Recursive tool execution loop.

- Orchestration
  - [PhoenixAI.Pipeline](PhoenixAI.Pipeline.md): Sequential railway pipeline.
  - [PhoenixAI.Team](PhoenixAI.Team.md): Parallel fan-out/fan-in execution.

- Streaming
  - [PhoenixAI.Stream](PhoenixAI.Stream.md): Central streaming transport — Finch SSE + per-provider chunk dispatch.
  - [PhoenixAI.StreamChunk](PhoenixAI.StreamChunk.md): Stub for a single chunk emitted during a streaming AI response. (Phase 6)

- Schema & Config
  - [PhoenixAI.Config](PhoenixAI.Config.md): Resolves configuration with cascade: call-site > config.exs > env vars > defaults.
  - [PhoenixAI.Schema](PhoenixAI.Schema.md): Behaviour for defining structured output schemas.

- Testing
  - [PhoenixAI.Test](PhoenixAI.Test.md): ExUnit helper for testing with PhoenixAI's TestProvider.