gpt 0.0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63a792b425c4cbce7e97eea48da74efc7d1fab57bb88f8623c683b19d567a55c
-  data.tar.gz: d359d30ae5e9d184330a7922d39416ab80de88a03871a5f6009d2e9d9c65b562
+  metadata.gz: 840186b5978b9ff54b0aa11256b238bfe03dba6d50020e70ace54dc9ad69e95c
+  data.tar.gz: 63ea299d5a2d5f0c119e99605cde359294bc60de72fe84eadfd704288c03eb06
 SHA512:
-  metadata.gz: 87a5832356464d22b9e0b10a346e8e441593ca6a54ba81a76f135b48cb94fe01951fe89954bcff891eba3d2bfae5a0755c99a974900b90fb4615dfe0459ae410
-  data.tar.gz: 4ad05661b2149c090d5e2546d3952b9410cd9d6c0332cca32cfed5499b21972a0953a153768ebff59ddc66458b1122cadf2312ce45fff6a292c0d7b5a43a6da6
+  metadata.gz: 7aa46b3f49131432ee7e33303d9581a391d7eea15e75b9ff7e5e1ef78ed33a5c720f337cdafb9641d62a8a11bac427b222fcaa8e9d473f4040559cd7c6e8769c
+  data.tar.gz: f8a4865378bd4981362d751e9c4140618bb2451b90c408a92a3ba95ee391138168c3fe26dcbe73211b867d7547b3ac6803f57b5a989d19e4021488e4c5365e74

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 0.1.0
+- Suporte e exemplos para GPT-5 (reasoning minimal, text verbosity, custom tools e allowed_tools)
+- Validação de `OPENAI_API_KEY` e ajuste de User-Agent
+- README atualizado para GPT-5
+
+## 0.1.1
+- Adiciona `GPT.ask` para uso simplificado, com suporte a streaming
+- Adiciona `GPT::ResponseExtender` com helpers (`content`, `usage`, `total_tokens`, `to_h`)
+- `Responses#create/get` passam a estender a resposta com os helpers
+
 ## 0.0.1
 - Primeira versão com cliente para API Responses (create/get/delete/cancel/input_items) e streaming SSE.
 

data/README.md

@@ -1,39 +1,93 @@
 # gpt
 
-Cliente Ruby simples para a API Responses.
+Cliente Ruby simples para a Responses API, com foco no GPT-5, com uma API de alto nível inspirada no OpenAIExt.
 
-Instalação
+## Instalação
 ```
-gem build gpt.gemspec && gem install ./gpt-0.0.1.gem
+bash build_and_install.sh
 ```
 
-Uso básico
+## Configuração
+- Defina `OPENAI_API_KEY` ou `OPENAI_ACCESS_TOKEN` no ambiente.
+- Opcional: `OPENAI_ORG_ID` ou `OPENAI_ORGANIZATION_ID`, `OPENAI_PROJECT_ID`.
+- Opcional: `OPENAI_REQUEST_TIMEOUT` (segundos, padrão 120).
+
+## Uso básico (GPT-5)
 ```ruby
 require 'gpt'
 
-client = GPT.client
+res = GPT.ask('Diga olá em uma frase.', model: 'gpt-5')
+puts res.content
+```
+
+## Reasoning mínimo (minimal)
+```ruby
+res = GPT.responses.create({
+  'model' => 'gpt-5',
+  'input' => 'Quanto ouro seria necessário para cobrir a Estátua da Liberdade com 1mm?',
+  'reasoning' => { 'effort' => 'minimal' }
+})
+```
+
+## Verbosidade baixa
+```ruby
+res = GPT.responses.create({
+  'model' => 'gpt-5',
+  'input' => 'Qual é a resposta para a vida, o universo e tudo mais?',
+  'text' => { 'verbosity' => 'low' }
+})
+```
+
+## Ferramentas personalizadas (custom tools)
+```ruby
+res = GPT.responses.create({
+  'model' => 'gpt-5',
+  'input' => 'Use a ferramenta code_exec para calcular a área de um círculo com raio igual ao número de letras r em blueberry',
+  'tools' => [
+    { 'type' => 'custom', 'name' => 'code_exec', 'description' => 'Executa código Python arbitrário' }
+  ]
+})
+```
+
+## Restringindo ferramentas (allowed_tools)
+```ruby
+res = GPT.responses.create({
+  'model' => 'gpt-5',
+  'input' => 'Como está o tempo em São Paulo?',
+  'tools' => [ { 'type' => 'function', 'name' => 'get_weather' } ],
+  'tool_choice' => {
+    'type' => 'allowed_tools',
+    'mode' => 'auto',
+    'tools' => [ { 'type' => 'function', 'name' => 'get_weather' } ]
+  }
+})
+```
 
-res = client.responses.create({
-  'model' => 'gpt-4.1',
-  'input' => 'Diga olá em uma frase.'
+## Passando raciocínio prévio (previous_response_id)
+```ruby
+first = GPT.responses.create({
+  'model' => 'gpt-5',
+  'input' => 'Planeje passos para resolver X.'
 })
 
-puts res['id']
+followup = GPT.responses.create({
+  'model' => 'gpt-5',
+  'input' => 'Agora execute o primeiro passo.',
+  'previous_response_id' => first['id']
+})
 ```
 
-Streaming SSE
+## Streaming SSE
 ```ruby
 require 'gpt'
 
-GPT.responses.stream({
-  'model' => 'gpt-4.1',
-  'input' => 'Conte uma história curta.'
-}) do |chunk|
-  print chunk
-end
+GPT.ask('Conte uma história curta.', model: 'gpt-5', stream: true) { |chunk| print chunk }
+
+# Streaming de texto direto
+GPT.ask('Conte uma história curta.', model: 'gpt-5', text_stream: true) { |text| print text }
 ```
 
-Outras operações
+## Outras operações
 ```ruby
 id = res['id']
 GPT.responses.get(id)
@@ -41,3 +95,12 @@ GPT.responses.input_items(id)
 GPT.responses.cancel(id)
 GPT.responses.delete(id)
 ```
+
+## Helpers de resposta
+```ruby
+res = GPT.ask('Qual a capital da França?', model: 'gpt-5')
+res.content
+res.model
+res.total_tokens
+res.to_h
+```

data/lib/gpt/client.rb

@@ -5,10 +5,10 @@ module GPT
 
     attr_reader :api_key, :base_url, :timeout, :organization, :project
 
-    def initialize(api_key: ENV['OPENAI_API_KEY'], base_url: nil, timeout: nil, organization: ENV['OPENAI_ORG_ID'], project: ENV['OPENAI_PROJECT_ID'])
+    def initialize(api_key: ENV['OPENAI_API_KEY'] || ENV['OPENAI_ACCESS_TOKEN'], base_url: nil, timeout: nil, organization: ENV['OPENAI_ORG_ID'] || ENV['OPENAI_ORGANIZATION_ID'], project: ENV['OPENAI_PROJECT_ID'])
       @api_key = api_key
       @base_url = base_url || DEFAULT_BASE_URL
-      @timeout = (timeout || DEFAULT_TIMEOUT).to_i
+      @timeout = (timeout || ENV['OPENAI_REQUEST_TIMEOUT'] || DEFAULT_TIMEOUT).to_i
       @organization = organization
       @project = project
     end
@@ -86,10 +86,13 @@ module GPT
     end
 
     def apply_headers(req)
+      if !api_key || api_key.empty?
+        raise GPT::Error.new('Defina OPENAI_API_KEY ou OPENAI_ACCESS_TOKEN')
+      end
       req['Authorization'] = "Bearer #{api_key}"
       req['OpenAI-Organization'] = organization if organization && !organization.empty?
       req['OpenAI-Project'] = project if project && !project.empty?
-      req['User-Agent'] = 'gpt-ruby/0.0.1'
+      req['User-Agent'] = "gpt-ruby/#{GPT::VERSION}"
     end
 
     def parse_response(res)

data/lib/gpt/response_extender.rb

@@ -0,0 +1,74 @@
+module GPT
+  module ResponseExtender
+    def message
+      if self['choices']
+        dig('choices', 0, 'message') || {}
+      else
+        output_message = if self['output'].is_a?(Array)
+          self['output'].find { |i| i['type'] == 'message' } || self['output'].first
+        end
+        output_message || {}
+      end
+    end
+
+    def content
+      if self['choices']
+        dig('choices', 0, 'message', 'content')
+      else
+        msg = message
+        contents = msg && msg['content']
+        return nil unless contents.is_a?(Array)
+        text_item = contents.find { |c| c['type'] == 'output_text' || c['type'] == 'text' }
+        text_item && text_item['text']
+      end
+    end
+
+    def content?
+      !content.nil? && !content.empty?
+    end
+
+    def usage
+      self['usage'] || {}
+    end
+
+    def prompt_tokens
+      usage['prompt_tokens'] || 0
+    end
+
+    def completion_tokens
+      usage['completion_tokens'] || 0
+    end
+
+    def total_tokens
+      usage['total_tokens'] || 0
+    end
+
+    def model
+      self['model']
+    end
+
+    def created_at
+      if self['created']
+        Time.at(self['created'])
+      elsif self['created_at']
+        Time.at(self['created_at'])
+      end
+    end
+
+    def to_h
+      {
+        content: content,
+        role: message['role'],
+        model: model,
+        usage: usage,
+        created_at: created_at
+      }.compact
+    end
+
+    def to_s
+      content || '[No content]'
+    end
+  end
+end
+
+

data/lib/gpt/responses.rb

@@ -5,7 +5,9 @@ module GPT
     end
 
     def create(payload)
-      @client.json_post('/v1/responses', body: payload)
+      res = @client.json_post('/v1/responses', body: payload)
+      res.extend(GPT::ResponseExtender) if res.is_a?(Hash)
+      res
     end
 
     def get(response_id, include: nil, include_obfuscation: nil, starting_after: nil, stream: nil)
@@ -14,7 +16,9 @@ module GPT
       query['include_obfuscation'] = include_obfuscation unless include_obfuscation.nil?
       query['starting_after'] = starting_after if starting_after
       query['stream'] = stream unless stream.nil?
-      @client.json_get("/v1/responses/#{response_id}", query: query)
+      res = @client.json_get("/v1/responses/#{response_id}", query: query)
+      res.extend(GPT::ResponseExtender) if res.is_a?(Hash)
+      res
     end
 
     def delete(response_id)
@@ -42,6 +46,49 @@ module GPT
         yield chunk if block_given?
       end
     end
+
+    def stream_text(payload)
+      buffer = ''.dup
+      stream(payload) do |chunk|
+        buffer << chunk
+        parts = buffer.split("\n\n", -1)
+        buffer = parts.pop || ''.dup
+        parts.each do |raw_event|
+          lines = raw_event.split("\n")
+          event_name = nil
+          data_lines = []
+          lines.each do |line|
+            if line.start_with?('event:')
+              event_name = line.sub('event:', '').strip
+            elsif line.start_with?('data:')
+              data_lines << line.sub('data:', '').strip
+            end
+          end
+          next if data_lines.empty?
+          data = data_lines.join("\n")
+          next if data == '[DONE]'
+          begin
+            json = Oj.load(data)
+          rescue Oj::ParseError
+            next
+          end
+          case event_name
+          when 'response.output_text.delta'
+            delta = json['delta']
+            yield delta if delta && !delta.empty?
+          when 'response.delta'
+            delta = json.dig('delta', 'content')
+            if delta.is_a?(Array)
+              text_piece = delta.find { |c| c['type'] == 'output_text' || c['type'] == 'text' }
+              yield(text_piece['text']) if text_piece && text_piece['text'] && !text_piece['text'].empty?
+            end
+          else
+            # ignore other events
+          end
+        end
+      end
+      true
+    end
   end
 end
 

data/lib/gpt/version.rb

@@ -0,0 +1,5 @@
+module GPT
+  VERSION = '0.1.1'
+end
+
+

data/lib/gpt.rb

@@ -1,10 +1,14 @@
+module GPT; end
+
 require 'oj'
 require 'net/http'
 require 'uri'
 
+require_relative 'gpt/version'
 require_relative 'gpt/error'
 require_relative 'gpt/client'
 require_relative 'gpt/responses'
+require_relative 'gpt/response_extender'
 
 module GPT
   def self.client
@@ -14,6 +18,24 @@ module GPT
   def self.responses
     @responses ||= Responses.new(client)
   end
+
+  def self.ask(prompt, model: 'gpt-5', stream: false, text_stream: false, **opts, &block)
+    payload = { 'model' => model, 'input' => prompt }
+    opts.each { |k, v| payload[k.to_s] = v }
+    if stream
+      responses.stream(payload) do |chunk|
+        yield chunk if block_given?
+      end
+    elsif text_stream
+      responses.stream_text(payload) do |text|
+        yield text if block_given?
+      end
+    else
+      res = responses.create(payload)
+      res.extend(ResponseExtender)
+      res
+    end
+  end
 end
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gpt
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.1
 platform: ruby
 authors:
 - Gedean Dias
@@ -93,8 +93,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-description: Based on ruby-openai, adds some extra features for working with OpenAI
-  APIs
+description: Cliente Ruby simples para a Responses API com suporte aos recursos do
+  GPT-5 (reasoning, verbosity, tools).
 email: gedean.dias@gmail.com
 executables: []
 extensions: []
@@ -106,7 +106,9 @@ files:
 - lib/gpt.rb
 - lib/gpt/client.rb
 - lib/gpt/error.rb
+- lib/gpt/response_extender.rb
 - lib/gpt/responses.rb
+- lib/gpt/version.rb
 homepage: https://github.com/gedean/openaiext
 licenses:
 - MIT
@@ -127,5 +129,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.7.1
 specification_version: 4
-summary: GPT >= 5
+summary: Cliente Ruby para GPT-5 (Responses API)
 test_files: []