genai-rb 0.0.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1aec54cd52a2625f22438e6d5baa1418f71e923ace70ffca6d29e67f3aedc99b
-  data.tar.gz: c5dcdba349bc3930b2d353e43e07e88f2a384db499bafa133722e8d77e376d73
+  metadata.gz: 8418d629d5c593b1900b31e44637a6b3fa494411d77e52a4c1dbd7004d36b2ff
+  data.tar.gz: 1a1913a35895c991249dd5c4e5048ca376a7605c46f8f650ef15f11b92b9e54f
 SHA512:
-  metadata.gz: 8df382a222223835262b53fa5175b569610b10042c113c2b0e40184aef851db017b51afb450911cb461d9d4b47ec5c01346ffceb4d751f36d83e9b55c6f123b1
-  data.tar.gz: d3d6a35dbbf0896c424e4a29aa9d8bbd25bb11632fb388c71449efcf0cde702a653149b2b38509f54d4d5442d920a184401f5ebf07cb58a9e607b72f4bee545c
+  metadata.gz: ac01403695c45ebced2ec88afaa18ddbd2ad2e22d2a022a3d688907491650dd3d43793fcfb9e517ecc9471cb928d9bd54a3ee4e96bc1fe3c27e9513a2f2c4b8c
+  data.tar.gz: 7fc52345aea27e0d0350b38fe4f71a294eedcef76096b9d558c832ef6cd5f5a2d476748bd30eded89ae68a3fad44fd0be3a761fb64401a5f7332edd668ef86e6

data/CHANGELOG.md

@@ -1,10 +1,11 @@
-## [Release]
-
-## [0.0.2] - 2025-08-16 (Me gustas tu)
-
-- Fix typos
-- Add support for Korean Unicode decoding
-
-## [0.0.1] - 2025-08-15 (Glass Bead)
-
-- Initial release
+## [Release]
+
+## [0.1.0] - 2025-08-16 (Glass Bead)
+
+- Initial release
+
+## [0.2.0] - 2026-07-31 (Me gustas tu)
+
+- Switch from Gemini-only requests to OpenAI-compatible chat completions.
+- Use `OPENAI_API_KEY` and optional `OPENAI_BASE_URL`.
+- Update examples and documentation for OpenAI-compatible providers.

data/LICENSE.txt

@@ -1,21 +1,21 @@
-The MIT License (MIT)
-
-Copyright (c) 2025 Siruu580
-
-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.
+The MIT License (MIT)
+
+Copyright (c) 2025-2026 qweruby
+
+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

@@ -1,107 +1,156 @@
-
 # Genai
 
-An unofficial Ruby package for Google Gemini. Easily generate text and images, analyze web content, and integrate Google Search—all with a simple Ruby API.
+OpenAI-compatible chat completions for Ruby.
 
 ## Installation
 
-Add to your Gemfile:
+Add the gem to your Gemfile:
 
 ```ruby
-gem 'genai-rb'
+gem "genai-rb"
 ```
 
-Then run:
+Install dependencies:
 
 ```bash
 bundle install
 ```
 
-Or install directly:
+Or install it directly:
 
 ```bash
 gem install genai-rb
 ```
 
-## Usage
+## Setup
 
-### Setup
+Set your API key:
 
-Get your Gemini API key from [Google AI Studio](https://makersuite.google.com/app/apikey).
+```bash
+export OPENAI_API_KEY="api_key"
+```
 
-Set your API key:
+By default, requests go to:
+
+```text
+https://api.openai.com/v1
+```
+
+For another OpenAI-compatible provider, set `OPENAI_BASE_URL` with `/v1` included:
 
 ```bash
-export GEMINI_API_KEY="api_key"
+export OPENAI_BASE_URL="https://api.example.com/v1"
 ```
 
-Or pass it directly:
+For Gemini's OpenAI-compatible endpoint:
+
+```bash
+export OPENAI_API_KEY="gemini_api_key"
+export OPENAI_BASE_URL="https://generativelanguage.googleapis.com/v1beta/openai"
+```
+
+You can also pass values in Ruby:
 
 ```ruby
-require 'genai'
-client = Genai.new(api_key: "api_key")
+require "genai"
+
+client = Genai.new(
+  api_key: "api_key",
+  base_url: "https://api.openai.com/v1"
+)
 ```
 
-### Text Generation
+## Quick Start
 
 ```ruby
+require "genai"
+
+client = Genai.new
+
 response = client.generate_content(contents: "Hello, how are you?")
 puts response
 ```
 
-### Use a Specific Model
+The default model is `gpt-5.5`.
 
-```ruby
-response = client.generate_content(model_id: "gemini-2.5-flash", contents: "Explain quantum computing.")
+Run the included example:
+
+```bash
+ruby example.rb
 ```
 
-### URL Context
+Edit the variables at the top of `example.rb` to change providers:
 
 ```ruby
-response = client.generate_content(contents: "Summarize: https://example.com/article", tools: [:url_context])
+api_key = "your_api_key"
+base_url = "https://api.openai.com/v1"
+model = "gpt-5.5"
 ```
 
-### Google Search Integration
+For Gemini's OpenAI-compatible endpoint:
 
 ```ruby
-response = client.generate_content(contents: "Latest AI news?", tools: [:google_search, :url_context])
+api_key = "your_gemini_api_key"
+base_url = "https://generativelanguage.googleapis.com/v1beta/openai"
+model = "gemini-2.5-flash"
 ```
 
-### Advanced Configuration
+## Choosing A Model
 
 ```ruby
-client = Genai.new(api_key: "api_key", timeout: 120, max_retries: 5)
-response = client.model("gemini-2.0-flash").generate_content(
-  contents: "Write a creative story about a robot learning to paint",
-  config: { temperature: 0.8, max_output_tokens: 1000 }
+response = client.generate_content(
+  model: "gpt-5.5",
+  contents: "Explain quantum computing."
 )
+
+puts response
 ```
 
-### Model Instances
+## Configuration
+
+Pass OpenAI chat completion options with `config`:
 
 ```ruby
-model = client.model("gemini-2.5-flash")
-response = model.generate_content(contents: "Explain the benefits of renewable energy")
+response = client.generate_content(
+  contents: "Write a short story about a robot learning to paint.",
+  config: {
+    temperature: 0.8,
+    max_tokens: 1000
+  }
+)
 ```
 
-## Supported Models
+`max_output_tokens` is accepted as an alias for `max_tokens`.
+
+## Messages
+
+Use OpenAI-style messages when you need system or multi-turn context:
 
-- All Gemini models
+```ruby
+response = client.generate_content(
+  contents: [
+    { role: "system", content: "Answer briefly." },
+    { role: "user", content: "0.1 + 0.2 == 0.3? Explain." }
+  ]
+)
+
+puts response
+```
+
+## Chat Sessions
 
-## Features
+```ruby
+chat = client.chats.create(model: "gpt-5.5")
 
-- Text and image generation
-- URL context analysis
-- Google Search integration
-- Multiple model support
-- Customizable generation config
-- Robust error handling and retry logic
-- Simple, intuitive Ruby API
+puts chat.send_message("a = 231018")
+puts chat.send_message("What is a?")
+```
 
-## Contributing
+## Supported APIs
 
-Pull requests are always welcome.
+- OpenAI Chat Completions API
+- OpenAI-compatible `/v1/chat/completions` providers
 
 ## License
 
-Open source under the [MIT License](https://opensource.org/licenses/MIT).
+Open source under the [MIT License](https://opensource.org/licenses/MIT).