ruby-openai 7.0.0 → 7.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8334c2f0658ff33f39e96e8316b5c7122ca8810f5bfaca945c8d5f1add38b85a
-  data.tar.gz: b761ed842f7c27ba7f3e6e3137f6d60f2d51cb1a32f585989fd2b1992d256b46
+  metadata.gz: a86dc627f27eeea7cf3eb1bf2eec2b0209d0bb8c11fef0eb6fd6518f7f10cfe9
+  data.tar.gz: 712ab627670853d680c8858a9d27aef5a82be09de8d53e5f7156ee608ba8d939
 SHA512:
-  metadata.gz: 7c53448def0a2a9849744a09c10f91fb4c16eb23fbf0d52be748574a9a96b05cb5641821c7728b9d95764cf50399f23c48bfdf3444d86ab80e65602e2264f6ba
-  data.tar.gz: 8806bbe03d2cde1b1fdfb691bcc2c4d803837faed6f001027135bdf9ed54a4bdf4eb01128c36d9d84b35622876ec087c494980e67b01a72a8ecb01040180cc72
+  metadata.gz: 72e14dc39495046b71ca147953582a24f8c9261955f2ca2a8d898ca7f8e136b459c31583620c16db3fa80c39da61c1f3a4cc932c5b3f2e71741fed42719eaeaf
+  data.tar.gz: 82db19d40f9b44fedb73d8f310771af71096d3d7e8e56f96d000a70f4c61abb1f21cbe98187d70fec1c3d639921eabe8cd8e456cac92dbcfa6e2efcb655f865b

data/.gitignore

@@ -10,11 +10,6 @@
 /test/tmp/
 /test/version_tmp/
 /tmp/
-/.bundle/
-/.yardoc
-/_yardoc/
-/doc/
-
 
 # Used by dotenv library to load environment variables.
 .env

data/CHANGELOG.md

@@ -5,6 +5,26 @@ 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.1.0] - 2024-06-10
+
+### Added
+
+- Add new Vector Store endpoints - thanks to [@willywg](https://github.com/willywg) for this PR!
+- Add parameters to batches.list endpoint so you can for example use `after` - thanks to [@marckohlbrugge](https://github.com/marckohlbrugge)!
+- Add vision as permitted purpose for files - thanks again to [@willywg](https://github.com/willywg) for the PR.
+- Add improved README example of tool calling - thanks [@krschacht](https://github.com/krschacht) - check out his project [HostedGPT](https://github.com/AllYourBot/hostedgpt)!
+
+### Fixed
+
+- Fix broken link in README table of contents - thanks to [@garrettgsb](https://github.com/garrettgsb)!
+- Skip sending nil headers - thanks to [@drnic](https://github.com/drnic)!
+
+## [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

@@ -5,8 +5,8 @@ gemspec
 
 gem "byebug", "~> 11.1.3"
 gem "dotenv", "~> 2.8.1"
-gem "rake", "~> 13.1"
+gem "rake", "~> 13.2"
 gem "rspec", "~> 3.13"
 gem "rubocop", "~> 1.50.2"
 gem "vcr", "~> 6.1.0"
-gem "webmock", "~> 3.19.1"
+gem "webmock", "~> 3.23.1"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-openai (7.0.0)
+    ruby-openai (7.1.0)
       event_stream_parser (>= 0.3.0, < 2.0.0)
       faraday (>= 1)
       faraday-multipart (>= 1)
@@ -9,12 +9,14 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.5)
+    addressable (2.8.6)
       public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
     base64 (0.2.0)
+    bigdecimal (3.1.8)
     byebug (11.1.3)
-    crack (0.4.5)
+    crack (1.0.0)
+      bigdecimal
       rexml
     diff-lcs (1.5.1)
     dotenv (2.8.1)
@@ -26,17 +28,18 @@ GEM
     faraday-multipart (1.0.4)
       multipart-post (~> 2)
     faraday-net_http (3.0.2)
-    hashdiff (1.0.1)
+    hashdiff (1.1.0)
     json (2.6.3)
     multipart-post (2.3.0)
     parallel (1.22.1)
     parser (3.2.2.0)
       ast (~> 2.4.1)
-    public_suffix (5.0.3)
+    public_suffix (5.0.5)
     rainbow (3.1.1)
-    rake (13.1.0)
+    rake (13.2.1)
     regexp_parser (2.8.0)
-    rexml (3.2.6)
+    rexml (3.2.9)
+      strscan
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
@@ -64,9 +67,10 @@ GEM
       parser (>= 3.2.1.0)
     ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
+    strscan (3.1.0)
     unicode-display_width (2.4.2)
     vcr (6.1.0)
-    webmock (3.19.1)
+    webmock (3.23.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
@@ -77,12 +81,12 @@ PLATFORMS
 DEPENDENCIES
   byebug (~> 11.1.3)
   dotenv (~> 2.8.1)
-  rake (~> 13.1)
+  rake (~> 13.2)
   rspec (~> 3.13)
   rubocop (~> 1.50.2)
   ruby-openai!
   vcr (~> 6.1.0)
-  webmock (~> 3.19.1)
+  webmock (~> 3.23.1)
 
 BUNDLED WITH
    2.4.5

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...
+Stream text with GPT-4o, 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)
@@ -34,14 +35,20 @@ Stream text with GPT-4, transcribe and translate audio with Whisper, or create i
       - [Vision](#vision)
       - [JSON Mode](#json-mode)
     - [Functions](#functions)
-    - [Edits](#edits)
+    - [Completions](#completions)
     - [Embeddings](#embeddings)
     - [Batches](#batches)
     - [Files](#files)
+      - [For fine-tuning purposes](#for-fine-tuning-purposes)
+      - [For assistant purposes](#for-assistant-purposes)
     - [Finetunes](#finetunes)
+    - [Vector Stores](#vector-stores)
+    - [Vector Store Files](#vector-store-files)
+    - [Vector Store File Batches](#vector-store-file-batches)
     - [Assistants](#assistants)
     - [Threads and Messages](#threads-and-messages)
     - [Runs](#runs)
+      - [Create and Run](#create-and-run)
       - [Runs involving function tools](#runs-involving-function-tools)
     - [Image Generation](#image-generation)
       - [DALL·E 2](#dalle-2)
@@ -53,7 +60,7 @@ Stream text with GPT-4, transcribe and translate audio with Whisper, or create i
       - [Translate](#translate)
       - [Transcribe](#transcribe)
       - [Speech](#speech)
-    - [Errors](#errors)
+    - [Errors](#errors-1)
   - [Development](#development)
   - [Release](#release)
   - [Contributing](#contributing)
@@ -100,7 +107,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 because it could leak private data to your logs.
+)
 ```
 
 ### With Config
@@ -109,8 +119,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 because it could leak private data to your logs.
 end
 ```
 
@@ -239,6 +250,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/openai"
+  )
+
+  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.
@@ -257,7 +289,7 @@ There are different models that can be used to generate text. For a full list an
 
 ```ruby
 client.models.list
-client.models.retrieve(id: "gpt-3.5-turbo")
+client.models.retrieve(id: "gpt-4o")
 ```
 
 ### Chat
@@ -267,7 +299,7 @@ GPT is a model that can be used to generate text in a conversational style. You
 ```ruby
 response = client.chat(
     parameters: {
-        model: "gpt-3.5-turbo", # Required.
+        model: "gpt-4o", # Required.
         messages: [{ role: "user", content: "Hello!"}], # Required.
         temperature: 0.7,
     })
@@ -284,7 +316,7 @@ You can stream from the API in realtime, which can be much faster and used to cr
 ```ruby
 client.chat(
     parameters: {
-        model: "gpt-3.5-turbo", # Required.
+        model: "gpt-4o", # Required.
         messages: [{ role: "user", content: "Describe a character called Anna!"}], # Required.
         temperature: 0.7,
         stream: proc do |chunk, _bytesize|
@@ -320,12 +352,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-4o",
         response_format: { type: "json_object" },
         messages: [{ role: "user", content: "Hello! Give me some JSON please."}],
         temperature: 0.7,
@@ -345,7 +377,7 @@ You can stream it as well!
 ```ruby
   response = client.chat(
     parameters: {
-      model: "gpt-3.5-turbo-1106",
+      model: "gpt-4o",
       messages: [{ role: "user", content: "Can I have some JSON please?"}],
         response_format: { type: "json_object" },
         stream: proc do |chunk, _bytesize|
@@ -376,26 +408,29 @@ You can describe and pass in functions and the model will intelligently choose t
 ```ruby
 
 def get_current_weather(location:, unit: "fahrenheit")
-  # use a weather api to fetch weather
+  # Here you could use a weather api to fetch the weather.
+  "The weather in #{location} is nice 🌞 #{unit}"
 end
 
+messages = [
+  {
+    "role": "user",
+    "content": "What is the weather like in San Francisco?",
+  },
+]
+
 response =
   client.chat(
     parameters: {
-      model: "gpt-3.5-turbo",
-      messages: [
-        {
-          "role": "user",
-          "content": "What is the weather like in San Francisco?",
-        },
-      ],
+      model: "gpt-4o",
+      messages: messages,  # Defined above because we'll use it again
       tools: [
         {
           type: "function",
           function: {
             name: "get_current_weather",
             description: "Get the current weather in a given location",
-            parameters: {
+            parameters: {  # Format: https://json-schema.org/understanding-json-schema
               type: :object,
               properties: {
                 location: {
@@ -412,31 +447,51 @@ response =
           },
         }
       ],
-      tool_choice: {
-        type: "function",
-        function: {
-          name: "get_current_weather"
-        }
-      }
+      tool_choice: "required"  # Optional, defaults to "auto"
+                               # Can also put "none" or specific functions, see docs
     },
   )
 
 message = response.dig("choices", 0, "message")
 
 if message["role"] == "assistant" && message["tool_calls"]
-  function_name = message.dig("tool_calls", 0, "function", "name")
-  args =
-    JSON.parse(
-      message.dig("tool_calls", 0, "function", "arguments"),
+  message["tool_calls"].each do |tool_call|
+    tool_call_id = tool_call.dig("id")
+    function_name = tool_call.dig("function", "name")
+    function_args = JSON.parse(
+      tool_call.dig("function", "arguments"),
       { symbolize_names: true },
     )
+    function_response = case function_name
+      when "get_current_weather"
+        get_current_weather(**function_args)  # => "The weather is nice 🌞"
+      else
+        # decide how to handle
+    end
+
+    # For a subsequent message with the role "tool", OpenAI requires the preceding message to have a tool_calls argument.
+    messages << message
 
-  case function_name
-  when "get_current_weather"
-    get_current_weather(**args)
+    messages << {
+      tool_call_id: tool_call_id,
+      role: "tool",
+      name: function_name,
+      content: function_response
+    }  # Extend the conversation with the results of the functions
   end
+
+  second_response = client.chat(
+    parameters: {
+      model: "gpt-4o",
+      messages: messages
+  })
+
+  puts second_response.dig("choices", 0, "message", "content")
+
+  # At this point, the model has decided to call functions, you've called the functions
+  # and provided the response back, and the model has considered this and responded.
 end
-# => "The weather is nice 🌞"
+# => "It looks like the weather is nice and sunny in San Francisco! If you're planning to go out, it should be a pleasant day."
 ```
 
 ### Completions
@@ -446,7 +501,7 @@ Hit the OpenAI API for a completion using other GPT-3 models:
 ```ruby
 response = client.completions(
     parameters: {
-        model: "gpt-3.5-turbo",
+        model: "gpt-4o",
         prompt: "Once upon a time",
         max_tokens: 5
     })
@@ -471,18 +526,16 @@ puts response.dig("data", 0, "embedding")
 ```
 
 ### Batches
-
-The Batches endpoint allows you to create and manage large batches of API requests to run asynchronously. Currently, only the `/v1/chat/completions` endpoint is supported for batches.
+The Batches endpoint allows you to create and manage large batches of API requests to run asynchronously. Currently, the supported endpoints for batches are `/v1/chat/completions` (Chat Completions API) and `/v1/embeddings` (Embeddings API).
 
 To use the Batches endpoint, you need to first upload a JSONL file containing the batch requests using the Files endpoint. The file must be uploaded with the purpose set to `batch`. Each line in the JSONL file represents a single request and should have the following format:
-
 ```json
 {
   "custom_id": "request-1",
   "method": "POST",
   "url": "/v1/chat/completions",
   "body": {
-    "model": "gpt-3.5-turbo",
+    "model": "gpt-4o",
     "messages": [
       { "role": "system", "content": "You are a helpful assistant." },
       { "role": "user", "content": "What is 2+2?" }
@@ -542,7 +595,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-4o",
     "choices": [
       {
         "index": 0,
@@ -559,7 +612,7 @@ These files are in JSONL format, with each line representing the output or error
 If a request fails with a non-HTTP error, the error object will contain more information about the cause of the failure.
 
 ### Files
-
+#### For fine-tuning purposes
 Put your data in a `.jsonl` file like this:
 
 ```json
@@ -577,6 +630,24 @@ client.files.content(id: "file-123")
 client.files.delete(id: "file-123")
 ```
 
+#### For assistant purposes
+
+You can send a file path:
+
+```ruby
+client.files.upload(parameters: { file: "path/to/file.pdf", purpose: "assistants" })
+```
+
+or a File object
+
+```ruby
+my_file = File.open("path/to/file.pdf", "rb")
+client.files.upload(parameters: { file: my_file, purpose: "assistants" })
+```
+
+
+See supported file types on [API documentation](https://platform.openai.com/docs/assistants/tools/file-search/supported-files).
+
 ### Finetunes
 
 Upload your fine-tuning data in a `.jsonl` file as above and get its ID:
@@ -592,7 +663,7 @@ You can then use this file ID to create a fine tuning job:
 response = client.finetunes.create(
     parameters: {
     training_file: file_id,
-    model: "gpt-3.5-turbo"
+    model: "gpt-4o"
 })
 fine_tune_id = response["id"]
 ```
@@ -629,6 +700,135 @@ You can also capture the events for a job:
 client.finetunes.list_events(id: fine_tune_id)
 ```
 
+### Vector Stores
+Vector Store objects give the File Search tool the ability to search your files.
+
+You can create a new vector store:
+
+```ruby
+response = client.vector_stores.create(
+  parameters: {
+    name: "my vector store",
+    file_ids: ["file-abc123", "file-def456"]
+  }
+)
+
+vector_store_id = response["id"]
+```
+
+Given a `vector_store_id` you can `retrieve` the current field values:
+
+```ruby
+client.vector_stores.retrieve(id: vector_store_id)
+```
+
+You can get a `list` of all vector stores currently available under the organization:
+
+```ruby
+client.vector_stores.list
+```
+
+You can modify an existing vector store, except for the `file_ids`:
+
+```ruby
+response = client.vector_stores.modify(
+  id: vector_store_id,
+  parameters: {
+    name: "Modified Test Vector Store",
+  }
+)
+```
+
+You can delete vector stores:
+
+```ruby
+client.vector_stores.delete(id: vector_store_id)
+```
+
+### Vector Store Files
+Vector store files represent files inside a vector store.
+
+You can create a new vector store file by attaching a File to a vector store.
+
+```ruby
+response = client.vector_store_files.create(
+  vector_store_id: "vector-store-abc123",
+  parameters: {
+    file_id: "file-abc123"
+  }
+)
+
+vector_store_file_id = response["id"]
+```
+
+Given a `vector_store_file_id` you can `retrieve` the current field values:
+
+```ruby
+client.vector_store_files.retrieve(
+  vector_store_id: "vector-store-abc123",
+  id: vector_store_file_id
+)
+```
+
+You can get a `list` of all vector store files currently available under the vector store:
+
+```ruby
+client.vector_store_files.list(vector_store_id: "vector-store-abc123")
+```
+
+You can delete a vector store file:
+
+```ruby
+client.vector_store_files.delete(
+  vector_store_id: "vector-store-abc123",
+  id: vector_store_file_id
+)
+```
+Note: This will remove the file from the vector store but the file itself will not be deleted. To delete the file, use the delete file endpoint.
+
+### Vector Store File Batches
+Vector store file batches represent operations to add multiple files to a vector store.
+
+You can create a new vector store file batch by attaching multiple Files to a vector store.
+
+```ruby
+response = client.vector_store_file_batches.create(
+  vector_store_id: "vector-store-abc123",
+  parameters: {
+    file_ids: ["file-abc123", "file-def456"]
+  }
+)
+
+file_batch_id = response["id"]
+```
+
+Given a `file_batch_id` you can `retrieve` the current field values:
+
+```ruby
+client.vector_store_file_batches.retrieve(
+  vector_store_id: "vector-store-abc123",
+  id: file_batch_id
+)
+```
+
+You can get a `list` of all vector store files in a batch currently available under the vector store:
+
+```ruby
+client.vector_store_file_batches.list(
+  vector_store_id: "vector-store-abc123",
+  id: file_batch_id
+)
+```
+
+You can cancel a vector store file batch (This attempts to cancel the processing of files in this batch as soon as possible):
+
+```ruby
+client.vector_store_file_batches.cancel(
+  vector_store_id: "vector-store-abc123",
+  id: file_batch_id
+)
+```
+
 ### Assistants
 
 Assistants are stateful actors that can have many conversations and use tools to perform tasks (see [Assistant Overview](https://platform.openai.com/docs/assistants/overview)).
@@ -638,16 +838,23 @@ 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-4o",
         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" },
+            { type: "file_search" }
         ],
-        "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
+          },
+          file_search: {
+            vector_store_ids: [] # See Vector Stores section above for how to add vector stores
+          }
+        },
+        "metadata": { my_internal_version_id: "1.0.0" }
     })
 assistant_id = response["id"]
 ```
@@ -829,11 +1036,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']
 ```
@@ -970,7 +1173,7 @@ response = client.audio.transcribe(
     parameters: {
         model: "whisper-1",
         file: File.open("path_to_file", "rb"),
-        language: "en" # Optional.
+        language: "en" # Optional
     })
 puts response["text"]
 # => "Transcription of the text"
@@ -985,7 +1188,9 @@ response = client.audio.speech(
   parameters: {
     model: "tts-1",
     input: "This is a speech test!",
-    voice: "alloy"
+    voice: "alloy",
+    response_format: "mp3", # Optional
+    speed: 1.0 # Optional
   }
 )
 File.binwrite('demo.mp3', response)
@@ -998,7 +1203,7 @@ HTTP errors can be caught like this:
 
 ```
   begin
-    OpenAI::Client.new.models.retrieve(id: "gpt-3.5-turbo")
+    OpenAI::Client.new.models.retrieve(id: "gpt-4o")
   rescue Faraday::Error => e
     raise "Got a Faraday error: #{e}"
   end

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,11 +1,11 @@
 module OpenAI
   class Batches
     def initialize(client:)
-      @client = client.beta(assistants: "v1")
+      @client = client.beta(assistants: OpenAI::Assistants::BETA_VERSION)
     end
 
-    def list
-      @client.get(path: "/batches")
+    def list(parameters: {})
+      @client.get(path: "/batches", parameters: parameters)
     end
 
     def retrieve(id:)

data/lib/openai/client.rb

@@ -78,6 +78,18 @@ module OpenAI
       @run_steps ||= OpenAI::RunSteps.new(client: self)
     end
 
+    def vector_stores
+      @vector_stores ||= OpenAI::VectorStores.new(client: self)
+    end
+
+    def vector_store_files
+      @vector_store_files ||= OpenAI::VectorStoreFiles.new(client: self)
+    end
+
+    def vector_store_file_batches
+      @vector_store_file_batches ||= OpenAI::VectorStoreFileBatches.new(client: self)
+    end
+
     def batches
       @batches ||= OpenAI::Batches.new(client: self)
     end

data/lib/openai/files.rb

@@ -4,6 +4,7 @@ module OpenAI
       assistants
       batch
       fine-tune
+      vision
     ].freeze
 
     def initialize(client:)

data/lib/openai/http_headers.rb

@@ -19,7 +19,7 @@ module OpenAI
         "Content-Type" => "application/json",
         "Authorization" => "Bearer #{@access_token}",
         "OpenAI-Organization" => @organization_id
-      }
+      }.compact
     end
 
     def azure_headers

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/vector_store_file_batches.rb

@@ -0,0 +1,29 @@
+module OpenAI
+  class VectorStoreFileBatches
+    def initialize(client:)
+      @client = client.beta(assistants: OpenAI::Assistants::BETA_VERSION)
+    end
+
+    def list(vector_store_id:, id:, parameters: {})
+      @client.get(
+        path: "/vector_stores/#{vector_store_id}/file_batches/#{id}/files",
+        parameters: parameters
+      )
+    end
+
+    def retrieve(vector_store_id:, id:)
+      @client.get(path: "/vector_stores/#{vector_store_id}/file_batches/#{id}")
+    end
+
+    def create(vector_store_id:, parameters: {})
+      @client.json_post(
+        path: "/vector_stores/#{vector_store_id}/file_batches",
+        parameters: parameters
+      )
+    end
+
+    def cancel(vector_store_id:, id:)
+      @client.post(path: "/vector_stores/#{vector_store_id}/file_batches/#{id}/cancel")
+    end
+  end
+end

data/lib/openai/vector_store_files.rb

@@ -0,0 +1,23 @@
+module OpenAI
+  class VectorStoreFiles
+    def initialize(client:)
+      @client = client.beta(assistants: OpenAI::Assistants::BETA_VERSION)
+    end
+
+    def list(vector_store_id:, parameters: {})
+      @client.get(path: "/vector_stores/#{vector_store_id}/files", parameters: parameters)
+    end
+
+    def retrieve(vector_store_id:, id:)
+      @client.get(path: "/vector_stores/#{vector_store_id}/files/#{id}")
+    end
+
+    def create(vector_store_id:, parameters: {})
+      @client.json_post(path: "/vector_stores/#{vector_store_id}/files", parameters: parameters)
+    end
+
+    def delete(vector_store_id:, id:)
+      @client.delete(path: "/vector_stores/#{vector_store_id}/files/#{id}")
+    end
+  end
+end

data/lib/openai/vector_stores.rb

@@ -0,0 +1,27 @@
+module OpenAI
+  class VectorStores
+    def initialize(client:)
+      @client = client.beta(assistants: OpenAI::Assistants::BETA_VERSION)
+    end
+
+    def list(parameters: {})
+      @client.get(path: "/vector_stores", parameters: parameters)
+    end
+
+    def retrieve(id:)
+      @client.get(path: "/vector_stores/#{id}")
+    end
+
+    def create(parameters: {})
+      @client.json_post(path: "/vector_stores", parameters: parameters)
+    end
+
+    def modify(id:, parameters: {})
+      @client.json_post(path: "/vector_stores/#{id}", parameters: parameters)
+    end
+
+    def delete(id:)
+      @client.delete(path: "/vector_stores/#{id}")
+    end
+  end
+end

data/lib/openai/version.rb

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

data/lib/openai.rb

@@ -12,6 +12,9 @@ require_relative "openai/threads"
 require_relative "openai/messages"
 require_relative "openai/runs"
 require_relative "openai/run_steps"
+require_relative "openai/vector_stores"
+require_relative "openai/vector_store_files"
+require_relative "openai/vector_store_file_batches"
 require_relative "openai/audio"
 require_relative "openai/version"
 require_relative "openai/batches"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-openai
 version: !ruby/object:Gem::Version
-  version: 7.0.0
+  version: 7.1.0
 platform: ruby
 authors:
 - Alex
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-27 00:00:00.000000000 Z
+date: 2024-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: event_stream_parser
@@ -102,6 +102,9 @@ files:
 - lib/openai/run_steps.rb
 - lib/openai/runs.rb
 - lib/openai/threads.rb
+- lib/openai/vector_store_file_batches.rb
+- lib/openai/vector_store_files.rb
+- lib/openai/vector_stores.rb
 - lib/openai/version.rb
 - lib/ruby/openai.rb
 - pull_request_template.md
@@ -130,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: "OpenAI API + Ruby! \U0001F916❤️"