ruby-openai 7.0.0 → 7.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8334c2f0658ff33f39e96e8316b5c7122ca8810f5bfaca945c8d5f1add38b85a
-  data.tar.gz: b761ed842f7c27ba7f3e6e3137f6d60f2d51cb1a32f585989fd2b1992d256b46
+  metadata.gz: 4067ee94a830c3637d339dff7445d0176610bcb1d381754915a9279bedac59fa
+  data.tar.gz: b2f6e4e7331e1f60f32aa3c1fb5628124c3b09539b5d4e2a99ebf9e539420cd2
 SHA512:
-  metadata.gz: 7c53448def0a2a9849744a09c10f91fb4c16eb23fbf0d52be748574a9a96b05cb5641821c7728b9d95764cf50399f23c48bfdf3444d86ab80e65602e2264f6ba
-  data.tar.gz: 8806bbe03d2cde1b1fdfb691bcc2c4d803837faed6f001027135bdf9ed54a4bdf4eb01128c36d9d84b35622876ec087c494980e67b01a72a8ecb01040180cc72
+  metadata.gz: 6f81268cc24c111b011aa87e1a0a877a72caf7a8b9d52cea367c35edf222909f5b8648d6925e30755a71692bd00974fc6d630c055a1639d5bbb8e9a33da11ef9
+  data.tar.gz: 2393f1d34582d37c2ee23f07d81d792fb60b0d5f3e9e5e2b900aa056d4ec49b23244d1d7766a3256a521e7621d17fa349f53134f9bdd64499a1fb760b2818038

data/CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [7.0.1] - 2024-04-30
+
+### Fixed
+
+- Update to v2 of Assistants in Messages, Runs, RunSteps and Threads - thanks to [@willywg](https://github.com/willywg) and others for pointing this out.
+
 ## [7.0.0] - 2024-04-27
 
 ### Added

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-openai (7.0.0)
+    ruby-openai (7.0.1)
       event_stream_parser (>= 0.3.0, < 2.0.0)
       faraday (>= 1)
       faraday-multipart (>= 1)

data/README.md

@@ -4,13 +4,13 @@
 [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/alexrudall/ruby-openai/blob/main/LICENSE.txt)
 [![CircleCI Build Status](https://circleci.com/gh/alexrudall/ruby-openai.svg?style=shield)](https://circleci.com/gh/alexrudall/ruby-openai)
 
-Use the [OpenAI API](https://openai.com/blog/openai-api/) with Ruby! 🤖🩵
+Use the [OpenAI API](https://openai.com/blog/openai-api/) with Ruby! 🤖❤️
 
 Stream text with GPT-4, transcribe and translate audio with Whisper, or create images with DALL·E...
 
 [🚢 Hire me](https://peaceterms.com?utm_source=ruby-openai&utm_medium=readme&utm_id=26072023) | [🎮 Ruby AI Builders Discord](https://discord.gg/k4Uc224xVD) | [🐦 Twitter](https://twitter.com/alexrudall) | [🧠 Anthropic Gem](https://github.com/alexrudall/anthropic) | [🚂 Midjourney Gem](https://github.com/alexrudall/midjourney)
 
-# Table of Contents
+## Contents
 
 - [Ruby OpenAI](#ruby-openai)
 - [Table of Contents](#table-of-contents)
@@ -27,6 +27,7 @@ Stream text with GPT-4, transcribe and translate audio with Whisper, or create i
         - [Faraday middleware](#faraday-middleware)
       - [Azure](#azure)
       - [Ollama](#ollama)
+      - [Groq](#groq)
     - [Counting Tokens](#counting-tokens)
     - [Models](#models)
     - [Chat](#chat)
@@ -100,7 +101,10 @@ require "openai"
 For a quick test you can pass your token directly to a new client:
 
 ```ruby
-client = OpenAI::Client.new(access_token: "access_token_goes_here")
+client = OpenAI::Client.new(
+  access_token: "access_token_goes_here",
+  log_errors: true # Highly recommended in development, so you can see what errors OpenAI is returning. Not recommended in production.
+)
 ```
 
 ### With Config
@@ -109,8 +113,9 @@ For a more robust setup, you can configure the gem with your API keys, for examp
 
 ```ruby
 OpenAI.configure do |config|
-    config.access_token = ENV.fetch("OPENAI_ACCESS_TOKEN")
-    config.organization_id = ENV.fetch("OPENAI_ORGANIZATION_ID") # Optional.
+  config.access_token = ENV.fetch("OPENAI_ACCESS_TOKEN")
+  config.organization_id = ENV.fetch("OPENAI_ORGANIZATION_ID") # Optional.
+  config.log_errors = true # Highly recommended in development, so you can see what errors OpenAI is returning. Not recommended in production.
 end
 ```
 
@@ -239,6 +244,27 @@ client.chat(
 # => Hi! It's nice to meet you. Is there something I can help you with, or would you like to chat?
 ```
 
+#### Groq
+
+[Groq API Chat](https://console.groq.com/docs/quickstart) is broadly compatible with the OpenAI API, with a [few minor differences](https://console.groq.com/docs/openai). Get an access token from [here](https://console.groq.com/keys), then:
+
+```ruby
+  client = OpenAI::Client.new(
+    access_token: "groq_access_token_goes_here",
+    uri_base: "https://api.groq.com/"
+  )
+
+  client.chat(
+    parameters: {
+        model: "llama3-8b-8192", # Required.
+        messages: [{ role: "user", content: "Hello!"}], # Required.
+        temperature: 0.7,
+        stream: proc do |chunk, _bytesize|
+            print chunk.dig("choices", 0, "delta", "content")
+        end
+    })
+```
+
 ### Counting Tokens
 
 OpenAI parses prompt text into [tokens](https://help.openai.com/en/articles/4936856-what-are-tokens-and-how-to-count-them), which are words or portions of words. (These tokens are unrelated to your API access_token.) Counting tokens can help you estimate your [costs](https://openai.com/pricing). It can also help you ensure your prompt text size is within the max-token limits of your model's context window, and choose an appropriate [`max_tokens`](https://platform.openai.com/docs/api-reference/chat/create#chat/create-max_tokens) completion parameter so your response will fit as well.
@@ -247,7 +273,7 @@ To estimate the token-count of your text:
 
 ```ruby
 OpenAI.rough_token_count("Your text")
-```
+````
 
 If you need a more accurate count, try [tiktoken_ruby](https://github.com/IAPark/tiktoken_ruby).
 
@@ -320,12 +346,12 @@ puts response.dig("choices", 0, "message", "content")
 
 #### JSON Mode
 
-You can set the response_format to ask for responses in JSON (at least for `gpt-3.5-turbo-1106`):
+You can set the response_format to ask for responses in JSON:
 
 ```ruby
   response = client.chat(
     parameters: {
-        model: "gpt-3.5-turbo-1106",
+        model: "gpt-3.5-turbo",
         response_format: { type: "json_object" },
         messages: [{ role: "user", content: "Hello! Give me some JSON please."}],
         temperature: 0.7,
@@ -345,7 +371,7 @@ You can stream it as well!
 ```ruby
   response = client.chat(
     parameters: {
-      model: "gpt-3.5-turbo-1106",
+      model: "gpt-3.5-turbo",
       messages: [{ role: "user", content: "Can I have some JSON please?"}],
         response_format: { type: "json_object" },
         stream: proc do |chunk, _bytesize|
@@ -542,7 +568,7 @@ These files are in JSONL format, with each line representing the output or error
     "id": "chatcmpl-abc123",
     "object": "chat.completion",
     "created": 1677858242,
-    "model": "gpt-3.5-turbo-0301",
+    "model": "gpt-3.5-turbo",
     "choices": [
       {
         "index": 0,
@@ -638,16 +664,19 @@ To create a new assistant:
 ```ruby
 response = client.assistants.create(
     parameters: {
-        model: "gpt-3.5-turbo-1106",         # Retrieve via client.models.list. Assistants need 'gpt-3.5-turbo-1106' or later.
+        model: "gpt-3.5-turbo",
         name: "OpenAI-Ruby test assistant",
         description: nil,
-        instructions: "You are a helpful assistant for coding a OpenAI API client using the OpenAI-Ruby gem.",
+        instructions: "You are a Ruby dev bot. When asked a question, write and run Ruby code to answer the question",
         tools: [
-            { type: 'retrieval' },           # Allow access to files attached using file_ids
-            { type: 'code_interpreter' },    # Allow access to Python code interpreter
+            { type: "code_interpreter" },
         ],
-        "file_ids": ["file-123"],            # See Files section above for how to upload files
-        "metadata": { my_internal_version_id: '1.0.0' }
+        tool_resources: {
+          "code_interpreter": {
+            "file_ids": [] # See Files section above for how to upload files
+          }
+        },
+        "metadata": { my_internal_version_id: "1.0.0" }
     })
 assistant_id = response["id"]
 ```
@@ -829,11 +858,7 @@ client.runs.list(thread_id: thread_id, parameters: { order: "asc", limit: 3 })
 You can also create a thread and run in one call like this:
 
 ```ruby
-response = client.threads.create_and_run(
-    parameters: {
-        model: 'gpt-3.5-turbo',
-        messages: [{ role: 'user', content: "What's deep learning?"}]
-    })
+response = client.runs.create_thread_and_run(parameters: { assistant_id: assistant_id })
 run_id = response['id']
 thread_id = response['thread_id']
 ```

data/lib/openai/assistants.rb

@@ -1,7 +1,9 @@
 module OpenAI
   class Assistants
+    BETA_VERSION = "v2".freeze
+
     def initialize(client:)
-      @client = client.beta(assistants: "v2")
+      @client = client.beta(assistants: OpenAI::Assistants::BETA_VERSION)
     end
 
     def list

data/lib/openai/batches.rb

@@ -1,7 +1,7 @@
 module OpenAI
   class Batches
     def initialize(client:)
-      @client = client.beta(assistants: "v1")
+      @client = client.beta(assistants: OpenAI::Assistants::BETA_VERSION)
     end
 
     def list

data/lib/openai/messages.rb

@@ -1,7 +1,7 @@
 module OpenAI
   class Messages
     def initialize(client:)
-      @client = client.beta(assistants: "v1")
+      @client = client.beta(assistants: OpenAI::Assistants::BETA_VERSION)
     end
 
     def list(thread_id:, parameters: {})

data/lib/openai/run_steps.rb

@@ -1,7 +1,7 @@
 module OpenAI
   class RunSteps
     def initialize(client:)
-      @client = client.beta(assistants: "v1")
+      @client = client.beta(assistants: OpenAI::Assistants::BETA_VERSION)
     end
 
     def list(thread_id:, run_id:, parameters: {})

data/lib/openai/runs.rb

@@ -1,7 +1,7 @@
 module OpenAI
   class Runs
     def initialize(client:)
-      @client = client.beta(assistants: "v1")
+      @client = client.beta(assistants: OpenAI::Assistants::BETA_VERSION)
     end
 
     def list(thread_id:, parameters: {})

data/lib/openai/threads.rb

@@ -1,7 +1,7 @@
 module OpenAI
   class Threads
     def initialize(client:)
-      @client = client.beta(assistants: "v1")
+      @client = client.beta(assistants: OpenAI::Assistants::BETA_VERSION)
     end
 
     def retrieve(id:)

data/lib/openai/version.rb

@@ -1,3 +1,3 @@
 module OpenAI
-  VERSION = "7.0.0".freeze
+  VERSION = "7.0.1".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-openai
 version: !ruby/object:Gem::Version
-  version: 7.0.0
+  version: 7.0.1
 platform: ruby
 authors:
 - Alex
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-27 00:00:00.000000000 Z
+date: 2024-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: event_stream_parser