ruby-openai 8.0.0 → 8.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db56b0b2e16d752cb827fcc80f47d6880187d4f3140c29d3519f9527539dcc29
-  data.tar.gz: dff6c57719e2cf0ae912b9815d58c9cb08c46ff3b1e7e71bf1c4952de605bbad
+  metadata.gz: 25124958f17722e0cc4168772bf02daf283b0d43dd2a2c143575ad23fc5539ac
+  data.tar.gz: cfaa4cb81ee668a4296774d7bce0591a2c23a3f0944794acde1db3e89586d199
 SHA512:
-  metadata.gz: 6a2035500d97c58f4637ccfdc40cd09edb9545a77242ee4b02a6f53fb83b4c2dd616e2e8069265439067ab8f52d54c5316e42cf067b9096820ff67672914ce17
-  data.tar.gz: 1ba769f55b5ca75b48aadf906e4b75618e090681d4410f0e60da6d470d432901197106538912e17b24762587f956c8b5770c7e338083878d672596736bc5b891
+  metadata.gz: d2ded6da66a157a190c24b0f7748a833d13ae9a4da67b52879eae8510e74cd90d80ffa6faaf573375c3a26d74b091165af6b30ca51c4cf860b1ba6f5c633cbdf
+  data.tar.gz: d31a28fafe6cac7caa99537f97a0fa1b0b918ebea09371d730e6d425b9bf228c726d9207c7a2bd08070103d49c9aa71e34ecf4f7ea888c2321f5fa128abf4fdc

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).
 
+## [8.1.0] - 2025-03-30
+
+### Added
+
+- Add Vector#search endpoint - thank you [@jaebrownn](https://github.com/jaebrownn) for this PR!
+
 ## [8.0.0] - 2025-03-14
 
 ### Added

data/Gemfile.lock

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

data/README.md

@@ -1,11 +1,12 @@
 # Ruby OpenAI
+
 [![Gem Version](https://img.shields.io/gem/v/ruby-openai.svg)](https://rubygems.org/gems/ruby-openai)
 [![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! 🤖❤️
 
-Stream text with GPT-4, transcribe and translate audio with Whisper, or create images with DALL·E...
+Stream chats with the Responses API, transcribe and translate audio with Whisper, create images with DALL·E, and much more...
 
 💥 Click [subscribe now](https://mailchi.mp/8c7b574726a9/ruby-openai) to hear first about new releases in the Rails AI newsletter!
 
@@ -16,7 +17,7 @@ Stream text with GPT-4, transcribe and translate audio with Whisper, or create i
 ## Contents
 
 - [Ruby OpenAI](#ruby-openai)
-- [Table of Contents](#table-of-contents)
+  - [Contents](#contents)
   - [Installation](#installation)
     - [Bundler](#bundler)
     - [Gem install](#gem-install)
@@ -39,6 +40,13 @@ Stream text with GPT-4, transcribe and translate audio with Whisper, or create i
       - [Vision](#vision)
       - [JSON Mode](#json-mode)
     - [Responses API](#responses-api)
+      - [Create a Response](#create-a-response)
+      - [Follow-up Messages](#follow-up-messages)
+      - [Tool Calls](#tool-calls)
+      - [Streaming](#streaming)
+      - [Retrieve a Response](#retrieve-a-response)
+      - [Delete a Response](#delete-a-response)
+      - [List Input Items](#list-input-items)
     - [Functions](#functions)
     - [Completions](#completions)
     - [Embeddings](#embeddings)
@@ -70,6 +78,7 @@ Stream text with GPT-4, transcribe and translate audio with Whisper, or create i
     - [Usage](#usage)
     - [Errors](#errors-1)
   - [Development](#development)
+    - [To check for deprecations](#to-check-for-deprecations)
   - [Release](#release)
   - [Contributing](#contributing)
   - [License](#license)
@@ -88,7 +97,7 @@ gem "ruby-openai"
 And then execute:
 
 ```bash
-$ bundle install
+bundle install
 ```
 
 ### Gem install
@@ -96,7 +105,7 @@ $ bundle install
 Or install with:
 
 ```bash
-$ gem install ruby-openai
+gem install ruby-openai
 ```
 
 and require with:
@@ -472,9 +481,11 @@ You can stream it as well!
 ```
 
 ### Responses API
+
 [OpenAI's most advanced interface for generating model responses](https://platform.openai.com/docs/api-reference/responses). Supports text and image inputs, and text outputs. Create stateful interactions with the model, using the output of previous responses as input. Extend the model's capabilities with built-in tools for file search, web search, computer use, and more. Allow the model access to external systems and data using function calling.
 
 #### Create a Response
+
 ```ruby
 response = client.responses.create(parameters: {
   model: "gpt-4o",
@@ -485,6 +496,7 @@ puts response.dig("output", 0, "content", 0, "text")
 ```
 
 #### Follow-up Messages
+
 ```ruby
 followup = client.responses.create(parameters: {
   model: "gpt-4o",
@@ -496,6 +508,7 @@ puts followup.dig("output", 0, "content", 0, "text")
 ```
 
 #### Tool Calls
+
 ```ruby
 response = client.responses.create(parameters: {
   model: "gpt-4o",
@@ -523,6 +536,7 @@ puts response.dig("output", 0, "name")
 ```
 
 #### Streaming
+
 ```ruby
 client.responses.create(
   parameters: {
@@ -540,6 +554,7 @@ client.responses.create(
 ```
 
 #### Retrieve a Response
+
 ```ruby
 retrieved_response = client.responses.retrieve(response_id: response["id"])
 puts retrieved_response["object"]
@@ -547,6 +562,7 @@ puts retrieved_response["object"]
 ```
 
 #### Delete a Response
+
 ```ruby
 deletion = client.responses.delete(response_id: response["id"])
 puts deletion["deleted"]
@@ -554,6 +570,7 @@ puts deletion["deleted"]
 ```
 
 #### List Input Items
+
 ```ruby
 input_items = client.responses.input_items(response_id: response["id"])
 puts input_items["object"] # => "list"
@@ -910,6 +927,27 @@ response = client.vector_stores.modify(
 )
 ```
 
+You can search a vector store for relevant chunks based on a query:
+
+```ruby
+response = client.vector_stores.search(
+  id: vector_store_id,
+  parameters: {
+    query: "What is the return policy?",
+    max_num_results: 20,
+    ranking_options: {
+      # Add any ranking options here in line with the API documentation
+    },
+    rewrite_query: true,
+    filters: {
+      type: "eq",
+      property: "region",
+      value: "us"
+    }
+  }
+)
+```
+
 You can delete vector stores:
 
 ```ruby
@@ -1588,6 +1626,7 @@ File.binwrite('demo.mp3', response)
 ```
 
 ### Usage
+
 The Usage API provides information about the cost of various OpenAI services within your organization.
 To use Admin APIs like Usage, you need to set an OPENAI_ADMIN_TOKEN, which can be generated [here](https://platform.openai.com/settings/organization/admin-keys).
 

data/lib/openai/vector_stores.rb

@@ -23,5 +23,9 @@ module OpenAI
     def delete(id:)
       @client.delete(path: "/vector_stores/#{id}")
     end
+
+    def search(id:, parameters: {})
+      @client.json_post(path: "/vector_stores/#{id}/search", parameters: parameters)
+    end
   end
 end

data/lib/openai/version.rb

@@ -1,3 +1,3 @@
 module OpenAI
-  VERSION = "8.0.0".freeze
+  VERSION = "8.1.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-openai
 version: !ruby/object:Gem::Version
-  version: 8.0.0
+  version: 8.1.0
 platform: ruby
 authors:
 - Alex
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-14 00:00:00.000000000 Z
+date: 2025-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: event_stream_parser