Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dmarshaltu/openai
OpenAI library for Crystal, providing an interface to interact with various OpenAI services.
https://github.com/dmarshaltu/openai
chatgpt chatgpt-api crystal crystal-lang crystal-language openai
Last synced: 3 months ago
JSON representation
OpenAI library for Crystal, providing an interface to interact with various OpenAI services.
- Host: GitHub
- URL: https://github.com/dmarshaltu/openai
- Owner: DmarshalTU
- License: mit
- Created: 2023-08-06T20:18:23.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-17T01:36:09.000Z (about 1 year ago)
- Last Synced: 2024-10-04T21:31:58.388Z (4 months ago)
- Topics: chatgpt, chatgpt-api, crystal, crystal-lang, crystal-language, openai
- Language: Crystal
- Homepage: https://bento.me/dmarshaltu
- Size: 814 KB
- Stars: 10
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# openaiAPI
[](https://www.buymeacoffee.com/100kw)
OpenAI library for Crystal, providing an interface to interact with various OpenAI services.
## Features
- [x] Authentication
- Engine Interaction
- [x] List available engines.
- [ ] Retrieve details about a specific engine.
- [x] Completion Requests
- [x] Create completions.
- [ ] Retrieve a specific completion.
- [x] Error Handling
- [ ] Implement robust error handling for different scenarios.
- [ ] Usage Information
- [ ] Provide methods to retrieve API usage information.
- [ ] Documentation and Examples
- [ ] Include comprehensive documentation and example code for each function.
- [ ] Testing
- [ ] Write unit tests to cover the main functionality.
## Installation
1. Add the dependency to your `shard.yml`:
```yaml
dependencies:
openai:
github: dmarshaltu/openai
```
2. Run `shards install`
## Usage
```crystal
require "openai"
OPENAI_KEY = api_key().to_s
client = OpenAI::Client.new(OPENAI_KEY)
# Example usage: List available models
begin
models = client.list_models
rescue OpenAI::AuthenticationError
puts "Authentication failed: Check your API key."
end
# Define your messages array
messages = [
{"role" => "system", "content" => "You are a helpful assistant."},
{"role" => "user", "content" => "Tell me a joke."}
]
model = "gpt-3.5-turbo"
max_tokens = 150
response = client.create_chat_completion(messages, model, max_tokens)
puts response
```
response:
```bash
"OPENAI_KEY"
2024-01-11T14:13:52.075201Z DEBUG - http.client: Performing request -- method: "GET", host: "api.openai.com", port: 443, resource: "/v1/engines"
{
"object": "list",
"data": [
{
"object": "engine",
"id": "gpt-4-0613",
"ready": true,
"owner": "openai",
"permissions": null,
"created": null
},
{
"object": "engine",
"id": "curie-search-query",
"ready": true,
"owner": "openai-dev",
"permissions": null,
"created": null
},
...
...
...
2024-01-11T14:13:52.889580Z DEBUG - http.client: Performing request -- method: "POST", host: "api.openai.com", port: 443, resource: "/v1/chat/completions"
{text: "Sure, here's a classic one for you: \n\nWhy don't scientists trust atoms? \n\nBecause they make up everything!", id: "chatcmpl-8fq6bn9amQ58M942YLnTDUtvS62TV"}
```
Example project with image creation and DallE 3:
[microdallecr](https://github.com/DmarshalTU/microdallecr.git)
## Development
TODO: Write development instructions here
## Contributing
1. Fork it ()
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
## Contributors
- [dmarshaltu](https://github.com/dmarshaltu) - creator and maintainer