maritaca-ai 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d09d3d7f30a05367ba9488b60754235fb4ecd4ad204e699aa7b7035a75329d4b
+  data.tar.gz: f235d41d277a28ca87c6dca8037e8bb706145cf75e46386ac40e39ba28f945cf
+SHA512:
+  metadata.gz: 7b2ef8109622f102f41f2a14b1c21177c5ffa0af47417b5b0d17b61f334fe32e336ae25a5fb6cc9d08c31d60f6055cde42f9ac2503169abaa0bc6ee097bc4bca
+  data.tar.gz: 5da080135ef573549d4948c4b242dd4bc840be4db30b0313a5608f36613cd8e1cd00a1b5db503d65f2dad7ac195a411617ad8c43bae5ebd998d582fb8f374ad1

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+.devcontainer

data/.rubocop.yml

@@ -0,0 +1,6 @@
+AllCops:
+  TargetRubyVersion: 3.1.0
+  NewCops: enable
+
+Style/Documentation:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.1.0

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+group :test, :development do
+  gem 'pry-byebug', '~> 3.10', '>= 3.10.1'
+  gem 'rubocop', '~> 1.58'
+end

data/Gemfile.lock

@@ -0,0 +1,62 @@
+PATH
+  remote: .
+  specs:
+    maritaca-ai (1.0.0)
+      faraday (~> 2.8, >= 2.8.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    base64 (0.2.0)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    faraday (2.8.1)
+      base64
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
+    method_source (1.0.0)
+    parallel (1.24.0)
+    parser (3.2.2.4)
+      ast (~> 2.4.1)
+      racc
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.10.1)
+      byebug (~> 11.0)
+      pry (>= 0.13, < 0.15)
+    racc (1.7.3)
+    rainbow (3.1.1)
+    regexp_parser (2.8.3)
+    rexml (3.2.6)
+    rubocop (1.59.0)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.4)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    unicode-display_width (2.5.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  maritaca-ai!
+  pry-byebug (~> 3.10, >= 3.10.1)
+  rubocop (~> 1.58)
+
+BUNDLED WITH
+   2.4.22

data/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright 2023 Guilherme Baptista
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,337 @@
+# Maritaca AI
+
+A Ruby gem for interacting with [MariTalk](https://chat.maritaca.ai) from [Maritaca AI](https://www.maritaca.ai).
+
+![The image features a minimalist logo combining a red ruby and a green Brazilian maritaca bird. The left side shows a flat, smooth red ruby, while the right side transitions to a vibrant green maritaca bird, both depicted in a simple, stylized manner. The background is a subtle gradient, enhancing the logo's modern and clean design..](https://raw.githubusercontent.com/gbaptista/assets/main/maritaca-ai/maritaca-ai-canvas.png)
+
+> _This Gem is designed to provide low-level access to MariTalk, enabling people to build abstractions on top of it. If you are interested in more high-level abstractions or more user-friendly tools, you may want to consider [Nano Bots](https://github.com/icebaker/ruby-nano-bots) 💎 🤖._
+
+## TL;DR and Quick Start
+
+```ruby
+gem 'maritaca-ai', '~> 1.0.0'
+```
+
+```ruby
+require 'maritaca-ai'
+
+client = Maritaca.new(
+  credentials: { api_key: ENV['MARITACA_API_KEY'] }
+)
+
+result = client.chat_inference(
+  { model: 'maritalk',
+    chat_mode: true,
+    messages: [ { role: 'user', content: 'Oi!' } ] }
+)
+```
+
+Result:
+```ruby
+{ 'answer' => 'Oi! Como posso ajudá-lo(a) hoje?' }
+```
+
+## Index
+
+- [TL;DR and Quick Start](#tldr-and-quick-start)
+- [Index](#index)
+- [Setup](#setup)
+    - [Installing](#installing)
+    - [Credentials](#credentials)
+- [Usage](#usage)
+    - [Client](#client)
+        - [Custom Address](#custom-address)
+    - [Methods](#methods)
+        - [chat_inference](#chat_inference)
+        - [Chat](#chat)
+        - [Back-and-Forth Conversations](#back-and-forth-conversations)
+        - [Without Chat](#without-chat)
+    - [New Functionalities and APIs](#new-functionalities-and-apis)
+    - [Request Options](#request-options)
+        - [Timeout](#timeout)
+    - [Error Handling](#error-handling)
+        - [Rescuing](#rescuing)
+        - [For Short](#for-short)
+        - [Errors](#errors)
+- [Development](#development)
+    - [Purpose](#purpose)
+    - [Publish to RubyGems](#publish-to-rubygems)
+    - [Updating the README](#updating-the-readme)
+- [Resources and References](#resources-and-references)
+- [Disclaimer](#disclaimer)
+
+## Setup
+
+### Installing
+
+```sh
+gem install maritaca-ai -v 1.0.0
+```
+
+```sh
+gem 'maritaca-ai', '~> 1.0.0'
+```
+
+### Credentials
+
+You can obtain your API key at [MariTalk](https://chat.maritaca.ai).
+
+Enclose credentials in single quotes when using environment variables to prevent issues with the `$` character in the API key:
+
+```sh
+MARITACA_API_KEY='123...$a12...'
+```
+
+## Usage
+
+### Client
+
+Ensure that you have an [API Key](#credentials) for authentication.
+
+Create a new client:
+```ruby
+require 'maritaca-ai'
+
+client = Maritaca.new(
+  credentials: { api_key: ENV['MARITACA_API_KEY'] }
+)
+```
+
+#### Custom Address
+
+You can use a custom address:
+
+```ruby
+require 'maritaca-ai'
+
+client = Maritaca.new(
+  credentials: {
+    address: 'https://chat.maritaca.ai',
+    api_key: ENV['MARITACA_API_KEY']
+  }
+)
+```
+
+### Methods
+
+#### chat_inference
+
+#### Chat
+
+```ruby
+result = client.chat_inference(
+  { model: 'maritalk',
+    chat_mode: true,
+    messages: [ { role: 'user', content: 'Oi!' } ] }
+)
+```
+
+Result:
+```ruby
+{ 'answer' => 'Oi! Como posso ajudá-lo(a) hoje?' }
+```
+
+#### Back-and-Forth Conversations
+
+To maintain a back-and-forth conversation, you need to append the received responses and build a history for your requests:
+
+```rb
+result = client.chat_inference(
+  { model: 'maritalk',
+    chat_mode: true,
+    messages: [
+      { role: 'user', content: 'Oi, meu nome é Tamanduá.' },
+      { role: 'assistant', content: 'Oi Tamanduá, como posso ajudá-lo hoje?' },
+      { role: 'user', content: 'Qual é o meu nome?' }
+    ] }
+)
+```
+
+Result:
+```ruby
+{ 'answer' => 'Seu nome é Tamanduá.' }
+```
+
+#### Without Chat
+
+You can prompt the model without using chat mode:
+
+```ruby
+result = client.chat_inference(
+  { model: 'maritalk',
+    chat_mode: false,
+    messages: "Minha terra tem palmeiras,\nOnde canta o Sabiá;\n" }
+)
+```
+
+Result:
+```ruby
+{ 'answer' =>
+  "As aves, que aqui gorjeiam,\n" \
+    'Não gorjeiam como lá.' }
+```
+
+### New Functionalities and APIs
+
+Maritaca may launch a new endpoint that we haven't covered in the Gem yet. If that's the case, you may still be able to use it through the `request` method. For example, `chat_inference` is just a wrapper for `api/chat/inference`, which you can call directly like this:
+
+```ruby
+result = client.request(
+  'api/chat/inference',
+  { model: 'maritalk',
+    chat_mode: true,
+    messages: [{ role: 'user', content: 'Oi!' }] },
+  request_method: 'POST'
+)
+```
+
+### Request Options
+
+#### Timeout
+
+You can set the maximum number of seconds to wait for the request to complete with the `timeout` option:
+
+```ruby
+client = Maritaca.new(
+  credentials: { api_key: ENV['MARITACA_API_KEY'] },
+  options: { connection: { request: { timeout: 5 } } }
+)
+```
+
+You can also have more fine-grained control over [Faraday's Request Options](https://lostisland.github.io/faraday/#/customization/request-options?id=request-options) if you prefer:
+
+```ruby
+client = Maritaca.new(
+  credentials: { api_key: ENV['MARITACA_API_KEY'] },
+  options: {
+    connection: {
+      request: {
+        timeout: 5,
+        open_timeout: 5,
+        read_timeout: 5,
+        write_timeout: 5
+      }
+    }
+  }
+)
+```
+
+### Error Handling
+
+#### Rescuing
+
+```ruby
+require 'maritaca-ai'
+
+begin
+  client.chat_inference(
+    { model: 'maritalk',
+      chat_mode: true,
+      messages: [ { role: 'user', content: 'Oi!' } ] }
+  )
+rescue Maritaca::Errors::MaritacaError => error
+  puts error.class # Maritaca::Errors::RequestError
+  puts error.message # 'the server responded with status 500'
+
+  puts error.payload
+  # { model: 'maritalk',
+  #   chat_mode: true,
+  #   ...
+  # }
+
+  puts error.request
+  # #<Faraday::ServerError response={:status=>500, :headers...
+end
+```
+
+#### For Short
+
+```ruby
+require 'maritaca-ai/errors'
+
+begin
+  client.chat_inference(
+    { model: 'maritalk',
+      chat_mode: true,
+      messages: [ { role: 'user', content: 'Oi!' } ] }
+  )
+rescue MaritacaError => error
+  puts error.class # Maritaca::Errors::RequestError
+end
+```
+
+#### Errors
+
+```ruby
+MaritacaError
+
+MissingAPIKeyError
+
+RequestError
+```
+
+## Development
+
+```bash
+bundle
+rubocop -A
+```
+
+### Purpose
+
+This Gem is designed to provide low-level access to MariTalk, enabling people to build abstractions on top of it. If you are interested in more high-level abstractions or more user-friendly tools, you may want to consider [Nano Bots](https://github.com/icebaker/ruby-nano-bots) 💎 🤖.
+
+### Publish to RubyGems
+
+```bash
+gem build maritaca-ai.gemspec
+
+gem signin
+
+gem push maritaca-ai-1.0.0.gem
+```
+
+### Updating the README
+
+Install [Babashka](https://babashka.org):
+
+```sh
+curl -s https://raw.githubusercontent.com/babashka/babashka/master/install | sudo bash
+```
+
+Update the `template.md` file and then:
+
+```sh
+bb tasks/generate-readme.clj
+```
+
+Trick for automatically updating the `README.md` when `template.md` changes:
+
+```sh
+sudo pacman -S inotify-tools # Arch / Manjaro
+sudo apt-get install inotify-tools # Debian / Ubuntu / Raspberry Pi OS
+sudo dnf install inotify-tools # Fedora / CentOS / RHEL
+
+while inotifywait -e modify template.md; do bb tasks/generate-readme.clj; done
+```
+
+Trick for Markdown Live Preview:
+```sh
+pip install -U markdown_live_preview
+
+mlp README.md -p 8076
+```
+
+## Resources and References
+
+These resources and references may be useful throughout your learning process.
+
+- [Maritaca AI Official Website](https://www.maritaca.ai)
+- [MariTalk Documentation](https://maritaca-ai.github.io/maritalk-api/maritalk.html)
+- [Maritaca AI API Documentation](https://chat.maritaca.ai/docs)
+
+## Disclaimer
+
+This is not an official Maritaca AI project, nor is it affiliated with Maritaca AI in any way.
+
+This software is distributed under the [MIT License](https://github.com/gbaptista/maritaca-ai/blob/main/LICENSE). This license includes a disclaimer of warranty. Moreover, the authors assume no responsibility for any damage or costs that may result from using this project. Use the Maritaca AI Ruby Gem at your own risk.

data/components/errors.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Maritaca
+  module Errors
+    class MaritacaError < StandardError
+      def initialize(message = nil)
+        super(message)
+      end
+    end
+
+    class MissingAPIKeyError < MaritacaError; end
+    class BlockWithoutServerSentEventsError < MaritacaError; end
+
+    class RequestError < MaritacaError
+      attr_reader :request, :payload
+
+      def initialize(message = nil, request: nil, payload: nil)
+        @request = request
+        @payload = payload
+
+        super(message)
+      end
+    end
+  end
+end

data/controllers/client.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require 'event_stream_parser'
+require 'faraday'
+require 'json'
+
+require_relative '../ports/dsl/maritaca-ai/errors'
+
+module Maritaca
+  module Controllers
+    class Client
+      DEFAULT_ADDRESS = 'https://chat.maritaca.ai'
+
+      ALLOWED_REQUEST_OPTIONS = %i[timeout open_timeout read_timeout write_timeout].freeze
+
+      def initialize(config)
+        @api_key = config.dig(:credentials, :api_key)
+        @server_sent_events = config.dig(:options, :server_sent_events)
+
+        @address = if config[:credentials][:address].nil? || config[:credentials][:address].to_s.strip.empty?
+                     "#{DEFAULT_ADDRESS}/"
+                   else
+                     "#{config[:credentials][:address].to_s.sub(%r{/$}, '')}/"
+                   end
+
+        if @api_key.nil? && @address == "#{DEFAULT_ADDRESS}/"
+          raise MissingAPIKeyError, 'Missing API Key, which is required.'
+        end
+
+        @request_options = config.dig(:options, :connection, :request)
+
+        @request_options = if @request_options.is_a?(Hash)
+                             @request_options.select do |key, _|
+                               ALLOWED_REQUEST_OPTIONS.include?(key)
+                             end
+                           else
+                             {}
+                           end
+      end
+
+      def chat_inference(payload, server_sent_events: nil, &callback)
+        request('api/chat/inference', payload, server_sent_events:, &callback)
+      end
+
+      def request(path, payload = nil, server_sent_events: nil, request_method: 'POST', &callback)
+        server_sent_events_enabled = server_sent_events.nil? ? @server_sent_events : server_sent_events
+        url = "#{@address}#{path}"
+
+        if !callback.nil? && !server_sent_events_enabled
+          raise BlockWithoutServerSentEventsError,
+                'You are trying to use a block without Server Sent Events (SSE) enabled.'
+        end
+
+        results = []
+
+        method_to_call = request_method.to_s.strip.downcase.to_sym
+
+        partial_json = ''
+
+        response = Faraday.new(request: @request_options) do |faraday|
+          faraday.response :raise_error
+        end.send(method_to_call) do |request|
+          request.url url
+          request.headers['Content-Type'] = 'application/json'
+
+          request.headers['authorization'] = "Key #{@api_key}" unless @api_key.nil?
+
+          request.body = payload.to_json unless payload.nil?
+
+          if server_sent_events_enabled
+            request.options.on_data = proc do |chunk, bytes, env|
+              if env && env.status != 200
+                raise_error = Faraday::Response::RaiseError.new
+                raise_error.on_complete(env.merge(body: chunk))
+              end
+
+              partial_json += chunk
+
+              parsed_json = safe_parse_json(partial_json)
+
+              if parsed_json
+                result = { event: parsed_json, raw: { chunk:, bytes:, env: } }
+
+                callback.call(result[:event], result[:raw]) unless callback.nil?
+
+                results << result
+
+                partial_json = ''
+              end
+            end
+          end
+        end
+
+        return safe_parse_json_with_fallback_to_raw(response.body) unless server_sent_events_enabled
+
+        results.map { |result| result[:event] }
+      rescue Faraday::ServerError => e
+        raise RequestError.new(e.message, request: e, payload:)
+      end
+
+      def safe_parse_json_with_fallback_to_raw(raw)
+        raw.to_s.lstrip.start_with?('{', '[') ? JSON.parse(raw) : raw
+      rescue JSON::ParserError
+        raw
+      end
+
+      def safe_parse_json(raw)
+        raw.to_s.lstrip.start_with?('{', '[') ? JSON.parse(raw) : nil
+      rescue JSON::ParserError
+        nil
+      end
+    end
+  end
+end

data/maritaca-ai.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative 'static/gem'
+
+Gem::Specification.new do |spec|
+  spec.name    = Maritaca::GEM[:name]
+  spec.version = Maritaca::GEM[:version]
+  spec.authors = [Maritaca::GEM[:author]]
+
+  spec.summary = Maritaca::GEM[:summary]
+  spec.description = Maritaca::GEM[:description]
+
+  spec.homepage = Maritaca::GEM[:github]
+
+  spec.license = Maritaca::GEM[:license]
+
+  spec.required_ruby_version = Gem::Requirement.new(">= #{Maritaca::GEM[:ruby]}")
+
+  spec.metadata['allowed_push_host'] = Maritaca::GEM[:gem_server]
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = Maritaca::GEM[:github]
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{\A(?:test|spec|features)/})
+    end
+  end
+
+  spec.require_paths = ['ports/dsl']
+
+  spec.add_dependency 'faraday', '~> 2.8', '>= 2.8.1'
+
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

data/ports/dsl/maritaca-ai/errors.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative '../../../components/errors'
+
+include Maritaca::Errors

data/ports/dsl/maritaca-ai.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative '../../static/gem'
+require_relative '../../controllers/client'
+
+module Maritaca
+  def self.new(...)
+    Controllers::Client.new(...)
+  end
+
+  def self.version
+    Maritaca::GEM[:version]
+  end
+end

data/static/gem.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Maritaca
+  GEM = {
+    name: 'maritaca-ai',
+    version: '1.0.0',
+    author: 'gbaptista',
+    summary: 'Interact with Maritaca AI.',
+    description: "A Ruby gem for interacting with Maritaca AI's large language models.",
+    github: 'https://github.com/gbaptista/maritaca-ai',
+    gem_server: 'https://rubygems.org',
+    license: 'MIT',
+    ruby: '3.1.0'
+  }.freeze
+end

data/tasks/generate-readme.clj

@@ -0,0 +1,39 @@
+(require '[clojure.string :as str])
+
+(defn slugify [text]
+  (-> text
+      (clojure.string/lower-case)
+      (clojure.string/replace " " "-")
+      (clojure.string/replace #"[^a-z0-9\-_]" "")))
+
+(defn remove-code-blocks [content]
+  (let [code-block-regex #"(?s)```.*?```"]
+    (clojure.string/replace content code-block-regex "")))
+
+(defn process-line [line]
+  (when-let [[_ hashes title] (re-find #"^(\#{2,}) (.+)" line)]
+    (let [link (slugify title)]
+      {:level (count hashes) :title title :link link})))
+
+(defn create-index [content]
+  (let [processed-content (remove-code-blocks content)
+        processed-lines (->> processed-content
+                             clojure.string/split-lines
+                             (map process-line)
+                             (remove nil?))]
+    (->> processed-lines
+         (map (fn [{:keys [level title link]}]
+                (str (apply str (repeat (* 4 (- level 2)) " "))
+                     "- ["
+                     title
+                     "](#"
+                     link
+                     ")")))
+         (clojure.string/join "\n"))))
+
+
+(let [content         (slurp "template.md")
+      index           (create-index content)
+      updated-content (clojure.string/replace content "{index}" index)]
+  (spit "README.md" updated-content)
+  (println "README.md successfully generated."))

data/template.md

@@ -0,0 +1,312 @@
+# Maritaca AI
+
+A Ruby gem for interacting with [MariTalk](https://chat.maritaca.ai) from [Maritaca AI](https://www.maritaca.ai).
+
+![The image features a minimalist logo combining a red ruby and a green Brazilian maritaca bird. The left side shows a flat, smooth red ruby, while the right side transitions to a vibrant green maritaca bird, both depicted in a simple, stylized manner. The background is a subtle gradient, enhancing the logo's modern and clean design..](https://raw.githubusercontent.com/gbaptista/assets/main/maritaca-ai/maritaca-ai-canvas.png)
+
+> _This Gem is designed to provide low-level access to MariTalk, enabling people to build abstractions on top of it. If you are interested in more high-level abstractions or more user-friendly tools, you may want to consider [Nano Bots](https://github.com/icebaker/ruby-nano-bots) 💎 🤖._
+
+## TL;DR and Quick Start
+
+```ruby
+gem 'maritaca-ai', '~> 1.0.0'
+```
+
+```ruby
+require 'maritaca-ai'
+
+client = Maritaca.new(
+  credentials: { api_key: ENV['MARITACA_API_KEY'] }
+)
+
+result = client.chat_inference(
+  { model: 'maritalk',
+    chat_mode: true,
+    messages: [ { role: 'user', content: 'Oi!' } ] }
+)
+```
+
+Result:
+```ruby
+{ 'answer' => 'Oi! Como posso ajudá-lo(a) hoje?' }
+```
+
+## Index
+
+{index}
+
+## Setup
+
+### Installing
+
+```sh
+gem install maritaca-ai -v 1.0.0
+```
+
+```sh
+gem 'maritaca-ai', '~> 1.0.0'
+```
+
+### Credentials
+
+You can obtain your API key at [MariTalk](https://chat.maritaca.ai).
+
+Enclose credentials in single quotes when using environment variables to prevent issues with the `$` character in the API key:
+
+```sh
+MARITACA_API_KEY='123...$a12...'
+```
+
+## Usage
+
+### Client
+
+Ensure that you have an [API Key](#credentials) for authentication.
+
+Create a new client:
+```ruby
+require 'maritaca-ai'
+
+client = Maritaca.new(
+  credentials: { api_key: ENV['MARITACA_API_KEY'] }
+)
+```
+
+#### Custom Address
+
+You can use a custom address:
+
+```ruby
+require 'maritaca-ai'
+
+client = Maritaca.new(
+  credentials: {
+    address: 'https://chat.maritaca.ai',
+    api_key: ENV['MARITACA_API_KEY']
+  }
+)
+```
+
+### Methods
+
+#### chat_inference
+
+#### Chat
+
+```ruby
+result = client.chat_inference(
+  { model: 'maritalk',
+    chat_mode: true,
+    messages: [ { role: 'user', content: 'Oi!' } ] }
+)
+```
+
+Result:
+```ruby
+{ 'answer' => 'Oi! Como posso ajudá-lo(a) hoje?' }
+```
+
+#### Back-and-Forth Conversations
+
+To maintain a back-and-forth conversation, you need to append the received responses and build a history for your requests:
+
+```rb
+result = client.chat_inference(
+  { model: 'maritalk',
+    chat_mode: true,
+    messages: [
+      { role: 'user', content: 'Oi, meu nome é Tamanduá.' },
+      { role: 'assistant', content: 'Oi Tamanduá, como posso ajudá-lo hoje?' },
+      { role: 'user', content: 'Qual é o meu nome?' }
+    ] }
+)
+```
+
+Result:
+```ruby
+{ 'answer' => 'Seu nome é Tamanduá.' }
+```
+
+#### Without Chat
+
+You can prompt the model without using chat mode:
+
+```ruby
+result = client.chat_inference(
+  { model: 'maritalk',
+    chat_mode: false,
+    messages: "Minha terra tem palmeiras,\nOnde canta o Sabiá;\n" }
+)
+```
+
+Result:
+```ruby
+{ 'answer' =>
+  "As aves, que aqui gorjeiam,\n" \
+    'Não gorjeiam como lá.' }
+```
+
+### New Functionalities and APIs
+
+Maritaca may launch a new endpoint that we haven't covered in the Gem yet. If that's the case, you may still be able to use it through the `request` method. For example, `chat_inference` is just a wrapper for `api/chat/inference`, which you can call directly like this:
+
+```ruby
+result = client.request(
+  'api/chat/inference',
+  { model: 'maritalk',
+    chat_mode: true,
+    messages: [{ role: 'user', content: 'Oi!' }] },
+  request_method: 'POST'
+)
+```
+
+### Request Options
+
+#### Timeout
+
+You can set the maximum number of seconds to wait for the request to complete with the `timeout` option:
+
+```ruby
+client = Maritaca.new(
+  credentials: { api_key: ENV['MARITACA_API_KEY'] },
+  options: { connection: { request: { timeout: 5 } } }
+)
+```
+
+You can also have more fine-grained control over [Faraday's Request Options](https://lostisland.github.io/faraday/#/customization/request-options?id=request-options) if you prefer:
+
+```ruby
+client = Maritaca.new(
+  credentials: { api_key: ENV['MARITACA_API_KEY'] },
+  options: {
+    connection: {
+      request: {
+        timeout: 5,
+        open_timeout: 5,
+        read_timeout: 5,
+        write_timeout: 5
+      }
+    }
+  }
+)
+```
+
+### Error Handling
+
+#### Rescuing
+
+```ruby
+require 'maritaca-ai'
+
+begin
+  client.chat_inference(
+    { model: 'maritalk',
+      chat_mode: true,
+      messages: [ { role: 'user', content: 'Oi!' } ] }
+  )
+rescue Maritaca::Errors::MaritacaError => error
+  puts error.class # Maritaca::Errors::RequestError
+  puts error.message # 'the server responded with status 500'
+
+  puts error.payload
+  # { model: 'maritalk',
+  #   chat_mode: true,
+  #   ...
+  # }
+
+  puts error.request
+  # #<Faraday::ServerError response={:status=>500, :headers...
+end
+```
+
+#### For Short
+
+```ruby
+require 'maritaca-ai/errors'
+
+begin
+  client.chat_inference(
+    { model: 'maritalk',
+      chat_mode: true,
+      messages: [ { role: 'user', content: 'Oi!' } ] }
+  )
+rescue MaritacaError => error
+  puts error.class # Maritaca::Errors::RequestError
+end
+```
+
+#### Errors
+
+```ruby
+MaritacaError
+
+MissingAPIKeyError
+
+RequestError
+```
+
+## Development
+
+```bash
+bundle
+rubocop -A
+```
+
+### Purpose
+
+This Gem is designed to provide low-level access to MariTalk, enabling people to build abstractions on top of it. If you are interested in more high-level abstractions or more user-friendly tools, you may want to consider [Nano Bots](https://github.com/icebaker/ruby-nano-bots) 💎 🤖.
+
+### Publish to RubyGems
+
+```bash
+gem build maritaca-ai.gemspec
+
+gem signin
+
+gem push maritaca-ai-1.0.0.gem
+```
+
+### Updating the README
+
+Install [Babashka](https://babashka.org):
+
+```sh
+curl -s https://raw.githubusercontent.com/babashka/babashka/master/install | sudo bash
+```
+
+Update the `template.md` file and then:
+
+```sh
+bb tasks/generate-readme.clj
+```
+
+Trick for automatically updating the `README.md` when `template.md` changes:
+
+```sh
+sudo pacman -S inotify-tools # Arch / Manjaro
+sudo apt-get install inotify-tools # Debian / Ubuntu / Raspberry Pi OS
+sudo dnf install inotify-tools # Fedora / CentOS / RHEL
+
+while inotifywait -e modify template.md; do bb tasks/generate-readme.clj; done
+```
+
+Trick for Markdown Live Preview:
+```sh
+pip install -U markdown_live_preview
+
+mlp README.md -p 8076
+```
+
+## Resources and References
+
+These resources and references may be useful throughout your learning process.
+
+- [Maritaca AI Official Website](https://www.maritaca.ai)
+- [MariTalk Documentation](https://maritaca-ai.github.io/maritalk-api/maritalk.html)
+- [Maritaca AI API Documentation](https://chat.maritaca.ai/docs)
+
+## Disclaimer
+
+This is not an official Maritaca AI project, nor is it affiliated with Maritaca AI in any way.
+
+This software is distributed under the [MIT License](https://github.com/gbaptista/maritaca-ai/blob/main/LICENSE). This license includes a disclaimer of warranty. Moreover, the authors assume no responsibility for any damage or costs that may result from using this project. Use the Maritaca AI Ruby Gem at your own risk.

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: maritaca-ai
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- gbaptista
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-12-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.8.1
+description: A Ruby gem for interacting with Maritaca AI's large language models.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- components/errors.rb
+- controllers/client.rb
+- maritaca-ai.gemspec
+- ports/dsl/maritaca-ai.rb
+- ports/dsl/maritaca-ai/errors.rb
+- static/gem.rb
+- tasks/generate-readme.clj
+- template.md
+homepage: https://github.com/gbaptista/maritaca-ai
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/gbaptista/maritaca-ai
+  source_code_uri: https://github.com/gbaptista/maritaca-ai
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- ports/dsl
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key: 
+specification_version: 4
+summary: Interact with Maritaca AI.
+test_files: []