https://github.com/noizu-labs-ml/elixir-openai
Elixir OpenAi Client
https://github.com/noizu-labs-ml/elixir-openai
Last synced: 5 months ago
JSON representation
Elixir OpenAi Client
- Host: GitHub
- URL: https://github.com/noizu-labs-ml/elixir-openai
- Owner: noizu-labs-ml
- License: mit
- Created: 2023-04-07T07:05:43.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-26T11:43:12.000Z (over 1 year ago)
- Last Synced: 2024-09-04T05:01:25.885Z (7 months ago)
- Language: Elixir
- Size: 128 KB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-elixir - Noizu-OpenAi - An Elixir Api for the OpenAI Library. ([Docs](https://hexdocs.pm/noizu_labs_open_ai/api-reference.html)). (Artificial Intelligence)
README
# Noizu.OpenAI
Noizu.OpenAI is an Elixir wrapper for the OpenAI API. It provides a simple and convenient way to interact with OpenAI's powerful AI models for tasks like text generation, completion, translation, image generation, and more.
## Installation
To install Noizu.OpenAI, add the following to your `mix.exs` file:
```elixir
defp deps do
[
{:noizu_labs_open_ai, "~> 0.1.0"}
]
end
```
Then, run `mix deps.get` to fetch the dependencies.
## Configuration
To configure the Noizu.OpenAI, add the following to your `config.exs` or the appropriate environment-specific config file:
```elixir
config :noizu_openai,
openai_api_key: "your_openai_api_key",
openai_org: "your_openai_organization_id" # Optional
```
Replace `"your_openai_api_key"` with your actual OpenAI API key, and `"your_openai_organization_id"` with your OpenAI organization ID if applicable.
## Usage
Noizu.OpenAI provides modules for different OpenAI API endpoints:
- [Noizu.OpenAI.Api.Audio](lib/api/audio/README.md)
- [Noizu.OpenAI.Api.Chat](lib/api/chat/README.md)
- [Noizu.OpenAI.Api.Completion](lib/api/completion/README.md)
- [Noizu.OpenAI.Api.Edit](lib/api/edit/README.md)
- [Noizu.OpenAI.Api.Embedding](lib/api/embedding/README.md)
- [Noizu.OpenAI.Api.Engine](lib/api/engine/README.md)
- [Noizu.OpenAI.Api.File](lib/api/file/README.md)
- [Noizu.OpenAI.Api.FineTune](api/fine_tune/README.md) *deprecated
- [Noizu.OpenAI.Api.Image](api/image/README.md)
- [Noizu.OpenAI.Api.Model](api/model/README.md)
- [Noizu.OpenAI.Api.Thread](api/thread/README.md)
- [Noizu.OpenAI.Api.Assistant](api/assistant/README.md)
- [Noizu.OpenAI.Api.FineTuning](api/fine_tuning/README.md)
Each module corresponds to a specific functionality provided by the OpenAI API. You can use the functions in these modules to interact with the respective API endpoints.
Here's an example of using the `Noizu.OpenAI.Api.Chat` module to generate a chatbot response:
```elixir
alias Noizu.OpenAI.Api.Chat
messages = [
%{"role" => "system", "content" => "You are a helpful assistant."},
%{"role" => "user", "content" => "Who won the world series in 2020?"},
]
{:ok, response} = Chat.chat(messages)
```
Refer to the documentation for each module to learn about the available functions and their usage.
## Documentation
You can generate the documentation for this project using ExDoc. Run `mix docs` and open the `doc/index.html` file in your browser.
## Tests
To run the tests for this project, use the command `mix test`.
## Contributing
If you'd like to contribute to the development of Noizu.OpenAI, please submit a pull request with your changes or open an issue to discuss your proposed changes.
## License
Noizu.OpenAI is released under the [MIT License](https://opensource.org/licenses/MIT).