openaiAPI

OpenAI library for Crystal, providing an interface to interact with various OpenAI services.

Features

• Authentication
• Engine Interaction
  • List available engines.
  • Retrieve details about a specific engine.
• Completion Requests
  • Create completions.
  • Retrieve a specific completion.
• 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:

   dependencies:
     openai:
       github: dmarshaltu/openai

2. Run shards install

Usage

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:

"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

Development

TODO: Write development instructions here

Contributing

1. Fork it (https://github.com/dmarshaltu/openai/fork)
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 - creator and maintainer