v8.1.0

Added

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

v8.0.0

[8.0.0] - 2025-03-14

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

[7.3.1] - 2024-10-15

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!

v7.0.1

Fixed

• Update to v2 of Assistants in Messages, Runs, RunSteps and Threads - thanks to @willywg and others for pointing this out.

v7.0.0

Added

• Add support for Batches, thanks to @simonx1 for the PR!
• Allow use of local LLMs like Ollama! Thanks to @ThomasSevestre
• Update to v2 of the Assistants beta & add documentation on streaming from an Assistant.
• Add Assistants endpoint to create and run a thread in one go, thank you @quocphien90
• Add missing parameters (order, limit, etc) to Runs, RunSteps and Messages - thanks to @shalecraig and @coezbek
• Add missing Messages#list spec - thanks @adammeghji
• Add Messages#modify to README - thanks to @nas887
• Don't add the api_version (/v1/) to base_uris that already include it - thanks to @kaiwren for raising this issue
• Allow passing a StringIO to Files#upload - thanks again to @simonx1
• Add Ruby 3.3 to CI

Security

• [BREAKING] ruby-openai will no longer log out API errors by default - you can reenable by passing log_errors: true to your client. This will help to prevent leaking secrets to logs. Thanks to @lalunamel for this PR.

Removed

• [BREAKING] Remove deprecated edits endpoint.

Fixed

• Fix README DALL·E 3 error - thanks to @clayton
• Fix README tool_calls error and add missing tool_choice info - thanks to @Jbrito6492

v6.5.0

Added

• Add back the deprecated Completions endpoint that I removed a bit prematurely. Thanks, [@mishranant](https://github.com/
  mishranant) and everyone who requested this.