ruby-openai 8.2.1 → 8.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edad531342b6296e28117d60bd553335744abf4aec719af050fbc08894afbe29
-  data.tar.gz: 9118084194b776895d59495ee1b4040e06ba6922414d7231df7b0d3b7ecbcee1
+  metadata.gz: 8f5bfc460a4cb2984e54d01cf39ebd6bd20a73fb0ddb6ffd271d14e6100fe568
+  data.tar.gz: 7a01a225d40f4265762a1e14a31dae19dff5535f8626336cfba0b5780a96cc57
 SHA512:
-  metadata.gz: 782e4a2dfdcfcdea758114fadae57d38a3cb452b9e14a42af35e62cb4cef88793f9d4ec3d676706c700ea0533dc621a79c928a884b998e18ed09f68ba954c676
-  data.tar.gz: b51f699d07b20dcd665cc9ac42d02fe296844f929a75dd89f9b324c8ce1532e559dd6975593a9aabb8410fc0229b276ee60abfd5a8bd14e050785c6dbb02261c
+  metadata.gz: 108a88a9ae16ed2aed8fee72dac815f4e045dbdca622437281c9f085b17b2f5bebc5ed85ced951a794993a8629dff5e55c15061fe13882c35fdbf0fde233b2ac
+  data.tar.gz: d5a189f8b196c691dce838a225dbfa6ba5e00e306c8b9bd29740f62ab3c281973509b5caab521c84262326f09f1f55932dd017df94cfd6b8f1741a69984cbba7

data/CHANGELOG.md

@@ -5,11 +5,17 @@ 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.3.0] - 2025-08-29
+
+### Added
+
+- Add Conversations API - thanks to [@parterburn](https://github.com/parterburn) for the great PR!
+
 ## [8.2.1] - 2025-08-29
 
 ### Fixed
 
-- Fix bug introduce in v8.2 which broke streaming with Faraday 2.1.0 - thanks to [@fabioxgn](https://github.com/fabioxgn) for the excellent PR!
+- Fix bug introduce in v8.2 which broke streaming with Faraday 2.1.0 - thanks to [@daikimiura](https://github.com/daikimiura) for the excellent PR!
 
 ## [8.2.0] - 2025-08-10
 

data/Gemfile.lock

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

data/README.md

@@ -77,6 +77,7 @@ Stream GPT-5 chats with the Responses API, initiate Realtime WebRTC conversation
     - [Vector Store Files](#vector-store-files)
     - [Vector Store File Batches](#vector-store-file-batches)
     - [Assistants](#assistants)
+    - [Conversations](#conversations)
     - [Threads and Messages](#threads-and-messages)
     - [Runs](#runs)
       - [Create and Run](#create-and-run)
@@ -1098,6 +1099,128 @@ client.vector_store_file_batches.cancel(
 )
 ```
 
+### Conversations
+
+The Conversations API enables you to create and manage persistent conversations with your models. This is useful for maintaining conversation state across multiple interactions.
+
+**Supported Endpoints:**
+- `POST /v1/conversations` - Create a conversation
+- `GET /v1/conversations/{id}` - Retrieve a conversation  
+- `PATCH /v1/conversations/{id}` - Modify a conversation
+- `DELETE /v1/conversations/{id}` - Delete a conversation
+- `POST /v1/conversations/{id}/items` - Create items in a conversation
+- `GET /v1/conversations/{id}/items` - List items in a conversation
+- `GET /v1/conversations/{id}/items/{item_id}` - Get a specific item
+- `DELETE /v1/conversations/{id}/items/{item_id}` - Delete an item
+
+#### Creating a Conversation
+
+To create a new conversation:
+
+```ruby
+response = client.conversations.create(
+  parameters: {
+    metadata: { purpose: "customer_support" }
+  }
+)
+conversation_id = response["id"]
+```
+
+#### Retrieving a Conversation
+
+To retrieve a specific conversation:
+
+```ruby
+conversation = client.conversations.retrieve(id: conversation_id)
+```
+
+#### Modifying a Conversation
+
+To update a conversation's metadata:
+
+```ruby
+response = client.conversations.modify(
+  id: conversation_id,
+  parameters: {
+    metadata: { status: "resolved" }
+  }
+)
+```
+
+#### Deleting a Conversation
+
+To delete a conversation:
+
+```ruby
+response = client.conversations.delete(id: conversation_id)
+```
+
+#### Managing Items in Conversations
+
+You can add, retrieve, and manage items within a conversation.
+
+##### Creating Items
+
+```ruby
+# Create multiple items at once
+response = client.conversations.create_items(
+  conversation_id: conversation_id,
+  parameters: {
+    items: [
+      {
+        type: "message",
+        role: "user",
+        content: [
+          { type: "input_text", text: "Hello!" }
+        ]
+      },
+      {
+        type: "message",
+        role: "assistant",
+        content: [
+          { type: "input_text", text: "How are you?" }
+        ]
+      }
+    ]
+  }
+)
+```
+
+##### Listing Items
+
+```ruby
+# List all items in a conversation
+response = client.conversations.list_items(conversation_id: conversation_id)
+items = response["data"]
+
+# With parameters
+response = client.conversations.list_items(
+  conversation_id: conversation_id,
+  parameters: { 
+    limit: 10,
+    order: "asc"
+  }
+)
+```
+
+##### Retrieving a Specific Item
+
+```ruby
+item = client.conversations.get_item(
+  conversation_id: conversation_id,
+  item_id: item_id
+)
+```
+
+##### Deleting an Item
+
+```ruby
+response = client.conversations.delete_item(
+  conversation_id: conversation_id,
+  item_id: item_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)).

data/lib/openai/client.rb

@@ -105,6 +105,10 @@ module OpenAI
       @usage ||= OpenAI::Usage.new(client: self)
     end
 
+    def conversations
+      @conversations ||= OpenAI::Conversations.new(client: self)
+    end
+
     def azure?
       @api_type&.to_sym == :azure
     end

data/lib/openai/conversations.rb

@@ -0,0 +1,40 @@
+module OpenAI
+  class Conversations
+    def initialize(client:)
+      @client = client
+    end
+
+    def retrieve(id:)
+      @client.get(path: "/conversations/#{id}")
+    end
+
+    def create(parameters: {})
+      @client.json_post(path: "/conversations", parameters: parameters)
+    end
+
+    def modify(id:, parameters: {})
+      @client.json_post(path: "/conversations/#{id}", parameters: parameters)
+    end
+
+    def delete(id:)
+      @client.delete(path: "/conversations/#{id}")
+    end
+
+    # Item operations within a conversation
+    def create_items(conversation_id:, parameters: {})
+      @client.json_post(path: "/conversations/#{conversation_id}/items", parameters: parameters)
+    end
+
+    def list_items(conversation_id:, parameters: {})
+      @client.get(path: "/conversations/#{conversation_id}/items", parameters: parameters)
+    end
+
+    def get_item(conversation_id:, item_id:)
+      @client.get(path: "/conversations/#{conversation_id}/items/#{item_id}")
+    end
+
+    def delete_item(conversation_id:, item_id:)
+      @client.delete(path: "/conversations/#{conversation_id}/items/#{item_id}")
+    end
+  end
+end

data/lib/openai/version.rb

@@ -1,3 +1,3 @@
 module OpenAI
-  VERSION = "8.2.1".freeze
+  VERSION = "8.3.0".freeze
 end

data/lib/openai.rb

@@ -21,6 +21,7 @@ require_relative "openai/audio"
 require_relative "openai/version"
 require_relative "openai/batches"
 require_relative "openai/usage"
+require_relative "openai/conversations"
 
 module OpenAI
   class Error < StandardError; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-openai
 version: !ruby/object:Gem::Version
-  version: 8.2.1
+  version: 8.3.0
 platform: ruby
 authors:
 - Alex
@@ -90,6 +90,7 @@ files:
 - lib/openai/audio.rb
 - lib/openai/batches.rb
 - lib/openai/client.rb
+- lib/openai/conversations.rb
 - lib/openai/files.rb
 - lib/openai/finetunes.rb
 - lib/openai/http.rb