ruby-openai 7.0.1 → 7.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4067ee94a830c3637d339dff7445d0176610bcb1d381754915a9279bedac59fa
-  data.tar.gz: b2f6e4e7331e1f60f32aa3c1fb5628124c3b09539b5d4e2a99ebf9e539420cd2
+  metadata.gz: 7108bf76aa6f30cd7c38b41967b0162d6a4014698c1c8364b8116e5c665c044f
+  data.tar.gz: 736587458668b4608e49fa8ec50e460da14eeda0dfb8a739c68806e3bd5d0a2c
 SHA512:
-  metadata.gz: 6f81268cc24c111b011aa87e1a0a877a72caf7a8b9d52cea367c35edf222909f5b8648d6925e30755a71692bd00974fc6d630c055a1639d5bbb8e9a33da11ef9
-  data.tar.gz: 2393f1d34582d37c2ee23f07d81d792fb60b0d5f3e9e5e2b900aa056d4ec49b23244d1d7766a3256a521e7621d17fa349f53134f9bdd64499a1fb760b2818038
+  metadata.gz: 76cac4818b5941d5732becebc91675c1ebeaba4f27c1710888afbb1893f3f8ff4d18e24a3c90f4d4332eb89730b0f6195507cf99519e764876a614ca3927a0cb
+  data.tar.gz: 4757d8e11b494a75d0ea839ae073610adfa77317ba0e13ddabdd21bf10fd34127a5747138644dba4d9073aa509341bfeaed69a3d00150d1ae90a42ddeadd53e4

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,28 @@ 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.2.0] - 2024-10-10
+
+### Added
+
+- Add ability to pass parameters to Files#list endpoint - thanks to [@parterburn](https://github.com/parterburn)!
+- Add Velvet observability platform to README - thanks to [@philipithomas](https://github.com/philipithomas)
+- Add Assistants::Messages#delete endpoint - thanks to [@mochetts](https://github.com/mochetts)!
+
+## [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

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.1)
+    ruby-openai (7.2.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.3.6)
+      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

@@ -6,9 +6,9 @@
 
 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)
+[📚 Rails AI (FREE Book)](https://railsai.com) | [🎮 Ruby AI Builders Discord](https://discord.gg/k4Uc224xVD) | [🐦 X](https://x.com/alexrudall) | [🧠 Anthropic Gem](https://github.com/alexrudall/anthropic) | [🚂 Midjourney Gem](https://github.com/alexrudall/midjourney)
 
 ## Contents
 
@@ -35,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)
@@ -54,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)
@@ -103,7 +109,7 @@ 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",
-  log_errors: true # Highly recommended in development, so you can see what errors OpenAI is returning. Not recommended in production.
+  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.
 )
 ```
 
@@ -114,8 +120,8 @@ 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.log_errors = true # Highly recommended in development, so you can see what errors OpenAI is returning. Not recommended in production.
+  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
 ```
 
@@ -133,7 +139,9 @@ client = OpenAI::Client.new(access_token: "access_token_goes_here")
 
 #### Custom timeout or base URI
 
-The default timeout for any request using this library is 120 seconds. You can change that by passing a number of seconds to the `request_timeout` when initializing the client. You can also change the base URI used for all requests, eg. to use observability tools like [Helicone](https://docs.helicone.ai/quickstart/integrate-in-one-line-of-code), and add arbitrary other headers e.g. for [openai-caching-proxy-worker](https://github.com/6/openai-caching-proxy-worker):
+- The default timeout for any request using this library is 120 seconds. You can change that by passing a number of seconds to the `request_timeout` when initializing the client.
+- You can also change the base URI used for all requests, eg. to use observability tools like [Helicone](https://docs.helicone.ai/quickstart/integrate-in-one-line-of-code) or [Velvet](https://docs.usevelvet.com/docs/getting-started)
+- You can also add arbitrary other headers e.g. for [openai-caching-proxy-worker](https://github.com/6/openai-caching-proxy-worker), eg.:
 
 ```ruby
 client = OpenAI::Client.new(
@@ -251,7 +259,7 @@ client.chat(
 ```ruby
   client = OpenAI::Client.new(
     access_token: "groq_access_token_goes_here",
-    uri_base: "https://api.groq.com/"
+    uri_base: "https://api.groq.com/openai"
   )
 
   client.chat(
@@ -273,7 +281,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).
 
@@ -283,7 +291,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
@@ -293,7 +301,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,
     })
@@ -310,7 +318,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,7 +328,28 @@ client.chat(
 # => "Anna is a young woman in her mid-twenties, with wavy chestnut hair that falls to her shoulders..."
 ```
 
-Note: OpenAPI currently does not report token usage for streaming responses. To count tokens while streaming, try `OpenAI.rough_token_count` or [tiktoken_ruby](https://github.com/IAPark/tiktoken_ruby). We think that each call to the stream proc corresponds to a single token, so you can also try counting the number of calls to the proc to get the completion token count.
+Note: In order to get usage information, you can provide the [`stream_options` parameter](https://platform.openai.com/docs/api-reference/chat/create#chat-create-stream_options) and OpenAI will provide a final chunk with the usage. Here is an example:
+
+```ruby
+stream_proc = proc { |chunk, _bytesize| puts "--------------"; puts chunk.inspect; }
+client.chat(
+    parameters: {
+        model: "gpt-4o",
+        stream: stream_proc,
+        stream_options: { include_usage: true },
+        messages: [{ role: "user", content: "Hello!"}],
+    })
+# => --------------
+# => {"id"=>"chatcmpl-7bbq05PiZqlHxjV1j7OHnKKDURKaf", "object"=>"chat.completion.chunk", "created"=>1718750612, "model"=>"gpt-4o-2024-05-13", "system_fingerprint"=>"fp_9cb5d38cf7", "choices"=>[{"index"=>0, "delta"=>{"role"=>"assistant", "content"=>""}, "logprobs"=>nil, "finish_reason"=>nil}], "usage"=>nil}
+# => --------------
+# => {"id"=>"chatcmpl-7bbq05PiZqlHxjV1j7OHnKKDURKaf", "object"=>"chat.completion.chunk", "created"=>1718750612, "model"=>"gpt-4o-2024-05-13", "system_fingerprint"=>"fp_9cb5d38cf7", "choices"=>[{"index"=>0, "delta"=>{"content"=>"Hello"}, "logprobs"=>nil, "finish_reason"=>nil}], "usage"=>nil}
+# => --------------
+# => ... more content chunks
+# => --------------
+# => {"id"=>"chatcmpl-7bbq05PiZqlHxjV1j7OHnKKDURKaf", "object"=>"chat.completion.chunk", "created"=>1718750612, "model"=>"gpt-4o-2024-05-13", "system_fingerprint"=>"fp_9cb5d38cf7", "choices"=>[{"index"=>0, "delta"=>{}, "logprobs"=>nil, "finish_reason"=>"stop"}], "usage"=>nil}
+# => --------------
+# => {"id"=>"chatcmpl-7bbq05PiZqlHxjV1j7OHnKKDURKaf", "object"=>"chat.completion.chunk", "created"=>1718750612, "model"=>"gpt-4o-2024-05-13", "system_fingerprint"=>"fp_9cb5d38cf7", "choices"=>[], "usage"=>{"prompt_tokens"=>9, "completion_tokens"=>9, "total_tokens"=>18}}
+```
 
 #### Vision
 
@@ -351,7 +380,7 @@ You can set the response_format to ask for responses in JSON:
 ```ruby
   response = client.chat(
     parameters: {
-        model: "gpt-3.5-turbo",
+        model: "gpt-4o",
         response_format: { type: "json_object" },
         messages: [{ role: "user", content: "Hello! Give me some JSON please."}],
         temperature: 0.7,
@@ -371,7 +400,7 @@ You can stream it as well!
 ```ruby
   response = client.chat(
     parameters: {
-      model: "gpt-3.5-turbo",
+      model: "gpt-4o",
       messages: [{ role: "user", content: "Can I have some JSON please?"}],
         response_format: { type: "json_object" },
         stream: proc do |chunk, _bytesize|
@@ -402,26 +431,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: {
@@ -438,31 +470,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
 
-  case function_name
-  when "get_current_weather"
-    get_current_weather(**args)
+    # For a subsequent message with the role "tool", OpenAI requires the preceding message to have a tool_calls argument.
+    messages << message
+
+    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
@@ -472,7 +524,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
     })
@@ -498,7 +550,7 @@ 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:
 
@@ -508,7 +560,7 @@ To use the Batches endpoint, you need to first upload a JSONL file containing th
   "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?" }
@@ -568,7 +620,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",
+    "model": "gpt-4o",
     "choices": [
       {
         "index": 0,
@@ -586,6 +638,8 @@ If a request fails with a non-HTTP error, the error object will contain more inf
 
 ### Files
 
+#### For fine-tuning purposes
+
 Put your data in a `.jsonl` file like this:
 
 ```json
@@ -603,6 +657,23 @@ 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:
@@ -618,7 +689,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"]
 ```
@@ -655,6 +726,139 @@ 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)).
@@ -664,16 +868,20 @@ To create a new assistant:
 ```ruby
 response = client.assistants.create(
     parameters: {
-        model: "gpt-3.5-turbo",
+        model: "gpt-4o",
         name: "OpenAI-Ruby test assistant",
         description: nil,
         instructions: "You are a Ruby dev bot. When asked a question, write and run Ruby code to answer the question",
         tools: [
             { type: "code_interpreter" },
+            { type: "file_search" }
         ],
         tool_resources: {
-          "code_interpreter": {
-            "file_ids": [] # See Files section above for how to upload files
+          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" }
@@ -995,7 +1203,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"
@@ -1010,7 +1218,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)
@@ -1023,7 +1233,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/batches.rb

@@ -4,8 +4,8 @@ module OpenAI
       @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

@@ -2,6 +2,7 @@ module OpenAI
   class Client
     include OpenAI::HTTP
 
+    SENSITIVE_ATTRIBUTES = %i[@access_token @organization_id @extra_headers].freeze
     CONFIG_KEYS = %i[
       api_type
       api_version
@@ -78,6 +79,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
@@ -95,5 +108,15 @@ module OpenAI
         client.add_headers("OpenAI-Beta": apis.map { |k, v| "#{k}=#{v}" }.join(";"))
       end
     end
+
+    def inspect
+      vars = instance_variables.map do |var|
+        value = instance_variable_get(var)
+
+        SENSITIVE_ATTRIBUTES.include?(var) ? "#{var}=[REDACTED]" : "#{var}=#{value.inspect}"
+      end
+
+      "#<#{self.class}:#{object_id} #{vars.join(', ')}>"
+    end
   end
 end

data/lib/openai/files.rb

@@ -4,14 +4,15 @@ module OpenAI
       assistants
       batch
       fine-tune
+      vision
     ].freeze
 
     def initialize(client:)
       @client = client
     end
 
-    def list
-      @client.get(path: "/files")
+    def list(parameters: {})
+      @client.get(path: "/files", parameters: parameters)
     end
 
     def upload(parameters: {})

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

@@ -16,8 +16,12 @@ module OpenAI
       @client.json_post(path: "/threads/#{thread_id}/messages", parameters: parameters)
     end
 
-    def modify(id:, thread_id:, parameters: {})
+    def modify(thread_id:, id:, parameters: {})
       @client.json_post(path: "/threads/#{thread_id}/messages/#{id}", parameters: parameters)
     end
+
+    def delete(thread_id:, id:)
+      @client.delete(path: "/threads/#{thread_id}/messages/#{id}")
+    end
   end
 end

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.1".freeze
+  VERSION = "7.2.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.1
+  version: 7.2.0
 platform: ruby
 authors:
 - Alex
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-29 00:00:00.000000000 Z
+date: 2024-10-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❤️"