# openai_ex v0.9.22 - Table of Contents

> Community maintained Elixir library for OpenAI API

## Livebooks

- [OpenaiEx User Guide](userguide.md)
- [OpenaiEx Beta API User Guide](beta_guide.md)
- [Streaming Orderbot](streaming_orderbot.md)
- [Deeplearning.AI Order Bot](dlai_orderbot.md)
- [Image Generation Kino App](images.md)
- [Completions Bot (Deprecated API)](completions.md)

## Modules

- [OpenaiEx](OpenaiEx.md): `OpenaiEx` is an Elixir library that provides a community-maintained client for
the OpenAI API.
- [OpenaiEx.Audio.Speech](OpenaiEx.Audio.Speech.md): This module provides an implementation of the OpenAI audio speech API. The API reference can be found at https://platform.openai.com/docs/api-reference/audio/createSpeech.

- [OpenaiEx.Audio.Transcription](OpenaiEx.Audio.Transcription.md): This module provides an implementation of the OpenAI audio transcription API. The API reference can be found at https://platform.openai.com/docs/api-reference/audio/createTranscription.

- [OpenaiEx.Audio.Translation](OpenaiEx.Audio.Translation.md): This module provides an implementation of the OpenAI audio translation API. The API reference can be found at https://platform.openai.com/docs/api-reference/audio/createTranslation.

- [OpenaiEx.Batches](OpenaiEx.Batches.md): This module provides an implementation of the OpenAI Batch API. The API reference can be found at https://platform.openai.com/docs/api-reference/batch.

- [OpenaiEx.Beta.Assistants](OpenaiEx.Beta.Assistants.md): This module provides an implementation of the OpenAI assistants API. The API reference can be found at https://platform.openai.com/docs/api-reference/assistants.

- [OpenaiEx.Beta.Threads](OpenaiEx.Beta.Threads.md): This module provides an implementation of the OpenAI threads API. The API reference can be found at https://platform.openai.com/docs/api-reference/threads.

- [OpenaiEx.Beta.Threads.Messages](OpenaiEx.Beta.Threads.Messages.md): This module provides an implementation of the OpenAI messages API. The API
reference can be found at https://platform.openai.com/docs/api-reference/messages.

- [OpenaiEx.Beta.Threads.Runs](OpenaiEx.Beta.Threads.Runs.md): This module provides an implementation of the OpenAI run API. The API
reference can be found at https://platform.openai.com/docs/api-reference/runs.

- [OpenaiEx.Beta.Threads.Runs.Steps](OpenaiEx.Beta.Threads.Runs.Steps.md): This module provides an implementation of the OpenAI run steps API. The API reference can be found at https://platform.openai.com/docs/api-reference/run-steps.

- [OpenaiEx.Beta.VectorStores](OpenaiEx.Beta.VectorStores.md): This module provides an implementation of the OpenAI vector_stores API. The API reference can be found at https://platform.openai.com/docs/api-reference/vector-stores.

- [OpenaiEx.Beta.VectorStores.File.Batches](OpenaiEx.Beta.VectorStores.File.Batches.md): This module provides an implementation of the OpenAI vector_store file batches API. The API reference can be found at https://platform.openai.com/docs/api-reference/vector-stores-file-batches.

- [OpenaiEx.Beta.VectorStores.Files](OpenaiEx.Beta.VectorStores.Files.md): This module provides an implementation of the OpenAI vector_store files API. The API reference can be found at https://platform.openai.com/docs/api-reference/vector-stores-files.

- [OpenaiEx.Chat.Completions](OpenaiEx.Chat.Completions.md): This module provides an implementation of the OpenAI chat completions API. The API reference can be found at https://platform.openai.com/docs/api-reference/chat/completions.

- [OpenaiEx.ChatMessage](OpenaiEx.ChatMessage.md): This module provides an elixir map wrapper around the OpenAI message JSON
object which is used in the chat completions and assistants APIs.

- [OpenaiEx.Completion](OpenaiEx.Completion.md): This module provides an implementation of the OpenAI completions API. The API reference can be found at https://platform.openai.com/docs/api-reference/completions.

- [OpenaiEx.ContainerFiles](OpenaiEx.ContainerFiles.md): This module provides an implementation of the OpenAI Container Files API. The API reference can be found at https://platform.openai.com/docs/api-reference/container-files.

- [OpenaiEx.Containers](OpenaiEx.Containers.md): This module provides an implementation of the OpenAI Containers API. The API reference can be found at https://platform.openai.com/docs/api-reference/containers.

- [OpenaiEx.ConversationItems](OpenaiEx.ConversationItems.md): This module provides an implementation of the OpenAI Conversation Items API. The API reference can be found at https://platform.openai.com/docs/api-reference/conversations/items.

- [OpenaiEx.Conversations](OpenaiEx.Conversations.md): This module provides an implementation of the OpenAI Conversations API. The API reference can be found at https://platform.openai.com/docs/api-reference/conversations.

- [OpenaiEx.Embeddings](OpenaiEx.Embeddings.md): This module provides an implementation of the OpenAI embeddings API. The API reference can be found at https://platform.openai.com/docs/api-reference/embeddings.

- [OpenaiEx.Evals](OpenaiEx.Evals.md): This module provides an implementation of the OpenAI evals API. The API reference can be found at https://platform.openai.com/docs/api-reference/evals.

- [OpenaiEx.Files](OpenaiEx.Files.md): This module provides an implementation of the OpenAI files API. The API reference can be found at https://platform.openai.com/docs/api-reference/files.

- [OpenaiEx.FineTuning.Jobs](OpenaiEx.FineTuning.Jobs.md): This module provides an implementation of the OpenAI fine-tuning job API. The API reference can be found at https://platform.openai.com/docs/api-reference/fine-tuning.

- [OpenaiEx.Images](OpenaiEx.Images.md): This module provides an implementation of the OpenAI images API. The API reference can be found at https://platform.openai.com/docs/api-reference/images.

- [OpenaiEx.Images.Edit](OpenaiEx.Images.Edit.md): This module provides constructors for OpenAI Image Edit API request structure. The API reference can be found at https://platform.openai.com/docs/api-reference/images/create-edit.

- [OpenaiEx.Images.Generate](OpenaiEx.Images.Generate.md): This module provides constructors for the OpenAI image generation API. The API
reference can be found at https://platform.openai.com/docs/api-reference/images/create.

- [OpenaiEx.Images.Variation](OpenaiEx.Images.Variation.md): This module provides constructors for OpenAI Image Variation API request structure. The API reference can be found at https://platform.openai.com/docs/api-reference/images/create-variation.

- [OpenaiEx.Models](OpenaiEx.Models.md): This module provides an implementation of the OpenAI Models API. Information about these models can be found at https://platform.openai.com/docs/models.

- [OpenaiEx.Moderations](OpenaiEx.Moderations.md): This module provides an implementation of the OpenAI moderation API. The API reference can be found at https://platform.openai.com/docs/api-reference/moderations.

- [OpenaiEx.Responses](OpenaiEx.Responses.md): This module provides an implementation of the OpenAI Responses API.
The API reference can be found at https://platform.openai.com/docs/api-reference/responses.

- [OpenaiEx.VectorStores](OpenaiEx.VectorStores.md): This module provides an implementation of the OpenAI vector_stores API. The API reference can be found at https://platform.openai.com/docs/api-reference/vector-stores.

- [OpenaiEx.VectorStores.File.Batches](OpenaiEx.VectorStores.File.Batches.md): This module provides an implementation of the OpenAI vector_store file batches API. The API reference can be found at https://platform.openai.com/docs/api-reference/vector-stores-file-batches.

- [OpenaiEx.VectorStores.Files](OpenaiEx.VectorStores.Files.md): This module provides an implementation of the OpenAI vector_store files API. The API reference can be found at https://platform.openai.com/docs/api-reference/vector-stores-files.

- Exceptions
  - [OpenaiEx.Error](OpenaiEx.Error.md)