v8.3.0

Added

• Add Conversations API - thanks to @parterburn for the great PR!

v8.2.1

Fixed

• Fix bug introduce in v8.2 which broke streaming with Faraday 2.1.0 - thanks to @daikimiura for the excellent PR!

v8.2.0

Added

• Add Security.md and activate private vulnerability reporting
• Add RealTime endpoint to create WebRTC token - thank you to @ngelx for the PR and others for input!
• Add multi-image upload - thank you to @ryankon and others for requesting.
• Refactor streaming so that Chat, Responses, Assistant Runs and any others where events are streamed now send the event to the Proc, replacing unused _bytesize. Search the README for _event to see how to use this. Important change implemented by @ingemar!
• Handle OpenAI::Files request parameters - thank you to @okorepanov for the PR.
• Add Gemini docs - thanks to @francis.
• Add web proxy debugging docs - thanks to @cpb.
• Add Rails / ActiveStorage transcription docs - thanks to @AndreyAzimov.

v8.1.0

Added

• Add Vector#search endpoint - thank you @jaebrownn for this PR!

v8.0.0

Added

• Add Responses endpoints - thanks to my excellent colleague @simonx1 for your work on this!
• Add docs for the Deepseek chat API.
• Add Models#delete - thanks to bennysghost.

Fixed

• [BREAKING] Try to JSON parse everything. If it fails, fall back gracefully to returning the raw response. Thank you to @gregszero and the many others who raised this issue.
• [BREAKING] An unknown file type will no longer prevent file upload, but instead raise a warning.
• [BREAKING] ruby-openai longer requires "faraday/multipart" for Faraday 1 users (Faraday 1 already includes it and it was causing a warning). Thanks to ajGingrich for raising this!
• Add user_data and evals as options for known File types - thank you to jontec for this fix!
• Fix a syntax ambiguity in Client.rb - thank you to viralpraxis.

Removed

• [BREAKING] Backwards compatibility for require "ruby/openai" is removed - from v8 on you MUST use require "openai". This fixes a deprecation warning with Ruby 3.4. Thanks to @ndemianc for this PR.
• [BREAKING] Removed support for Ruby 2.6. ruby-openai may still work with this version but it's no longer supported.
• Removed the 'OpenAI-Beta' header from Batches API requests.

v7.4.0

Added

• Add support for OPENAI_ADMIN_TOKEN to allow for administrative endpoints to be called.
• Add support for Usage endpoints.

v7.3.1

Fixed

• Fix 404 error when using Client#embeddings with Azure - thanks to @ymtdzzz for raising this in a really clear issue.

v7.3.0

Added

• Add ability to (with the right incantations) retrieve the chunks used by an Assistant file search - thanks to @agamble for the addition!

v7.2.0

Added

• Add ability to pass parameters to Files#list endpoint - thanks to @parterburn!
• Add Velvet observability platform to README - thanks to @philipithomas
• Add Assistants::Messages#delete endpoint - thanks to @mochetts!

v7.1.0

Added

• Add new Vector Store endpoints - thanks to @willywg for this PR!
• Add parameters to batches.list endpoint so you can for example use after - thanks to @marckohlbrugge!
• Add vision as permitted purpose for files - thanks again to @willywg for the PR.
• Add improved README example of tool calling - thanks @krschacht - check out his project HostedGPT!

Fixed

• Fix broken link in README table of contents - thanks to @garrettgsb!
• Skip sending nil headers - thanks to @drnic!