Skip to content

CHANGELOG.md

Latest commit

 

History

History
520 lines (380 loc) · 14.2 KB

CHANGELOG.md

File metadata and controls

520 lines (380 loc) · 14.2 KB

Unreleased

4.1.0

Published 07 Feb 2026

Added

  • batch: make OpenAI interface extend Batch interface (#433).
  • responses: add Responses API support (create, retrieve, cancel, delete, and input_items listing).
  • chat: add web_search_options request support.
  • chat: expose annotations and reasoning_content in chat message payloads.
  • chat: support required tool choice mode (#429).

Fixed

  • chat: make ChatCompletionRequestBuilder.reasoningEffort, store, and maxCompletionTokens configurable.
  • chat: improve ChatResponseFormat compatibility by supporting both primitive and object variants.
  • chat: always encode JsonSchema.strict, including its default true value (#430).
  • chat: set explicit JSON class discriminator for polymorphic ContentPart serialization.
  • images: stabilize image edit uploads for live API compatibility (#459).
  • tests: remove flaky external image URL dependency from chat vision live tests.
  • tests: stabilize vector store live tests with current API behavior (#459).

Changed

  • tests: make openai-client live API tests opt-in via OPENAI_LIVE_TESTS=1.
  • ci: split billable live tests into a small JVM smoke job and a separate full-live workflow.
  • docs: fix RetrievalTool usage in Getting Started guide (#427).

4.0.1

Published 02 Feb 2025

Added

  • chat: add reasoning effort, max completion tokens, store options for reasoning model support (#415) (thanks @Taewan-P)

4.0.0

Published 01 Feb 2025

Added

  • WasmJs target (#387)
  • assistants: add structured response (#391) (thanks @ahmedmirza994)
  • chat: Add support for structured outputs (#397)
  • chat: make ChatCompletionRequest a data class (#399) (thanks @yunmanger1)
  • assistant: add streaming (#400) (thanks @Daltomon)

Fixed

  • runs: support for file search tool calls (#405) (thanks @averyaube)

Changed

  • Upgrade to Kotlin 2.0 (#387)
  • Update Ktor to 3.0 (#387)

Breaking Changes

  • Replace okio by kotlinx.io (#387)

3.8.2

Added

  • chat: add stream options (#363)
  • chat: add instanceId field to ChatCompletionRequest (#359) (thanks @harishv-collab)
  • messages: add assistant tools to attachments (#370)
  • assistants: add attachments.fileId field to MessageRequest (#367) (thanks @0chil)
  • runs: feat(runs): add new fields into assistant run (#366) (thanks @ahmedmirza994)

Fixed

  • messages: update quote to optional field for openai compatibility assistant on FileCitation (#361) (thanks @AntoDev)
  • messages: serialization exception while retrieving thread messages (#369) (thanks @meroving)

3.8.1

Published 28 Jun 2024

Fixed

  • runs: set beta header to v2 (#357) (thanks @kdman98)
  • chat: default ChatChunk.finishReason to null (#358) (thanks @Him188)

3.8.0

Published 27 Jun 2024

Added

  • assistant: added feature for assistant beta-v2, and option for version selection (thanks @kdman98)
  • vector-stores: add vector stores APIs (#324)
  • batch: add batch APIs (#334)

Fixed

  • models: make created and ownedBy nullable (#332) (thanks @thiswillbeyourgithub)
  • chat: enhance flow cancel capability (#333)
  • assistants: Assistant.name is nullable (#337) (thanks @Gama11)
  • chat: add Azure OpenAI Content Filter Support (#340) (thanks @asharab)
  • config: request options headers override previous values (#353)
  • runs: get runs order param serialization (#355)

3.7.2

Published 28 Apr 2024

Added

  • embeddings: add embedding dimensions request field (#317) (thanks @EliasJorgensen)
  • chat: add logprob and topLogprobs (#328) (thanks @jkohls-indeed)

Fix

  • chat: image_url content type (#321)
  • images: remove Quality typealias (#318) (thanks @florentine-doemges)

3.7.1

Published 01 Apr 2024

Added

  • Audio: add timestampGranularities (thanks @mxwell)

Fixed

  • Core: nullable OpenAIErrorDetails fields (#315)
  • Messages: content as image file (#313)

3.7.0

Published 11 Feb 2024

Added

  • add RequestOptions (#296)

Fixed

  • chat: add systemFingerprint to ChatCompletionChunk (#303)
  • chat: move description to FunctionTool (#304)
  • chat: make FunctionTool#Parameters nullable (#304)
  • finetuning: nullable ErrorInfo#message and ErrorInfo#code (#304)
  • image: correct Quality package name (#302) (thanks @voqaldev)
  • assistants: files endpoint (#298) (thanks @rjeeb)
  • runs: RunRequest builder

3.6.3

Published 13 Jan 2024

Added

  • Images: add quality and style fields (#292)
  • Runs: add additionalInstructions property to RunRequest (#293) (thanks @ahmedmirza994)

Fixed

  • Messages: MessageFile optional fields (#290)
  • proguard: Add EnclosingMethod proguard rule (thanks @rafsanjani)

3.6.2

Published 15 Dec 2023

Fixed

  • Completion: Choice.finishReason as nullable (#285)
  • Chat: ChatCompletion.created field change type from Int to Long (#282) (thanks @VarenytsiaMykhailo)
  • Runs: incorrect property name Run.cancelledAt (#279) (thanks @Gama11)
  • Proguard: add EnclosingMethod rule (#283) (thanks @rafsanjani)

3.6.1

Published 26 Nov 2023

Fixed

  • Runs: ToolCalls, ToolCallStep and RunSteps serialization (#266, #269, #271, #273) (thanks @voqaldev)
  • Messages: MessageContent serialization (#275)

3.6.0

Published 24 Nov 2023

Added

  • Images: Support for model selection for ImageCreation, ImageEdit and ImageVariations (#257) (thanks @FilipObornik)
  • Chat: add tool calls (#256)
  • Chat: add vision feature (#258)
  • Config: adding ktor engine config to support Kotlin Scripting (#261) (thanks @DevSrSouza)
  • Audio: add speech-to-text (#263)

Beta

  • Assistants: api implementation (#259)
  • Threads: api implementation (#262)
  • Messages: api implementation (#262)
  • Runs: api implementation (#262)

3.5.1

Published 05 Nov 2023

Fix

  • Models: permission field nullable (#251)

Experimental

  • Chat: add mergeToChatMessage extension (#250)

3.5.0

Published 04 Oct 2023

Added

  • Fine-tuning: API implementation (#242)

Deprecated

  • Fine-tunes is deprecated

3.4.2

Published 28 Sep 2023

Added

  • Config: Allow custom ktor http client configuration (#239) (Thanks @rasharab)

3.4.1

Published 31 Aug 2023

Fix

  • Chat: fix(chat): FunctionCall nullable name/arguments (#232)

3.4.0

Published 23 Aug 2023

Added

  • Introduced Parameters.Empty for functions without parameters.
  • Added File.statusDetails for retrieving file status details.
  • HyperParams new fields: computeClassificationMetrics, classificationNClasses and classificationPositiveClass.
  • Moderation: update categories and scores.

Removed

  • Removed beta status from the chat and audio features.

Deprecated

  • completions is deprecated.
  • edits as legacy.

Breaking Changes

  • Audio: Updated TranscriptionRequest's responseFormat type to AudioResponseFormat.
  • Fine Tune: set HyperParams.learningRateMultiplier to be non-nullable.
  • Edit: Choice.finishReason type to FinishReason.
  • Chat: Multiple changes have been implemented:
    • Set index, message, and finishReason fields in ChatChoice to be non-nullable.
    • Set index, delta, and finishReason fields in ChatChunk to be non-nullable.
    • Set ChatCompletionFunction.parameters to be non-nullable.
    • In FunctionCall, set name, arguments, and argumentsAsJson() to be non-nullable.
    • Modified ChatChoice.finishReason and ChatChunk.finishReason types to FinishReason.

3.3.2

Published 21 Jul 2023

Fix

  • Audio: Segment#transient property nullable (thanks @charlee-dev)

Dependencies

  • Kotlin to 1.9.0
  • Kotlin coroutines to 1.7.2
  • Kotlin serialization to 1.5.1
  • ktor to 2.3.2
  • okio to 3.4.0

3.3.1

Published 24 Jun 2023

Fix

  • Chat: function mode serializer (#203) (thanks @emeasure-github-private)

3.3.0

Published 19 Jun 2023

Added

  • Chat: Function Call (#200 #202) (thanks @JochenGuckSnk)

3.2.5

Published 03 Jun 2023

Added

  • Add OpenAIHost builder for Azure (#196)
  • Support of OpenAIHost with a base path (#196)

3.2.4

Published 21 May 2023

Added

  • Logging configuration using LoggingConfig
  • sanitize flag to sanitize authorization header in the logs
  • Enhance OpenAI() factory function parameters

Changed

  • Updated OpenAIConfig to replace logging fields with LoggingConfig
  • Authorization token is now hidden by default in the logs

3.2.3

Published 01 May 2023

Added

  • OpenAIIOException and GenericIOException (#178)

3.2.2

Published 29 Apr 2023

Feat

  • Completion: add suffix request param (#174)
  • Exceptions: Add more detailed api errors (#163)

Change

  • Replace Autocloseable until stable (#173)

3.2.1

Published 9 Apr 2023

Added

  • Proguard / R8 rules for jvm (#149)
  • OpenAI implements AutoCloseable (#151)

Dependencies

  • Kotlin to 1.8.20 (#146)
  • Kotlin serialization to 1.5.0 (#146)
  • Ktor to 2.2.4 (#146)

3.2.0

Published 23 Mar 2023

Added

  • Audio: add other formats support (#127)
  • Chat: add user param to chat request (#128)

Changed

  • Simplify and add more exceptions (#123)

3.1.1

Published 17 Mar 2023

Changed

  • Add error details to OpenAIAPIException (#120) (thanks @rosuH)

Fixed

  • Audio: switch mixed-up translation and transcription paths (#119) (thanks @matusekma)

3.1.0

Published 10 Mar 2023

Added

  • Audio: api implementation (#105)
  • Config: proxy config (#111)
  • Config: retry strategy config (#112)

3.0.0

Published 02 Mar 2023

Important changes since 2.1.3

Added

  • Requests: DSL builder functions to create requests (#80)
  • Completions and Edit: add usage to the responses (#82)
  • Files: add download and delete functions (#86)
  • OpenAIConfig: headers and organization (#96)
  • Embeddings: similarity and distance (#88) (experimental)
  • Chat implementation (#99) (beta)
  • OpenAIConfig: custom host config (#102)

Changed

  • FileSource and okio for I/O operations (e.g. files, images) (#75)
  • FineTunes: remove experimental (#90)
  • Images: mark as experimental (#91)
  • Embeddings: response changed to EmbeddingResponse to include usage. (#82)

Fixed

  • Non-blocking SSE Flow events (#95)

Dependencies

  • Update Kotlin to 1.8.10

3.0.0-beta02

Published 19 Feb 2023

Added

  • OpenAIConfig: headers and organization (#96)

Changed

  • FineTunes: remove experimental (#90)
  • Images: mark as experimental (#91)

Fixed

  • Non-blocking SSE Flow events (#95)

3.0.0-beta01

Published 06 Feb 2023

This release contains changes from 3.0.0-alpha01, plus the following:

Added

  • Embeddings: similarity and distance (#88) (Experimental)

Changed

  • Update Kotlin to 1.8.10

2.1.3

Published 29 Jan 2023

Fixed

  • Add darwin simulators and x86 targets (#85)

3.0.0-alpha01

Published 20 Jan 2023

Added

  • DSL builder functions to create requests
  • Completions and Edit: add usage to the responses
  • Files: add download and delete functions

Changed

  • FileSource and okio for I/O operations (e.g. files, images).
  • Embeddings: response changed to EmbeddingResponse to include usage.

2.1.2

Published 11 Jan 2023

Fixed

  • FineTunes: events streaming using GET (#76) (thanks @PatrickLaflamme)

2.1.1

Published 02 Jan 2023

Added

  • Targets ios, watchos and tvos (x64/arm64)

Changed

  • Update Kotlin to 1.8.0

2.1.0

Published 14 Dec 2022

Added

  • Images implementation (#68)
  • Http timeout configuration (#71)

Changed

  • Update Kotlin to 1.7.20
  • Update Kotlin serialization to 1.4.1
  • Update Ktor 2.1.3

2.0.0

Published 20 Aug 2022

Added

Changed

  • Update Kotlin to 1.7.10
  • Update Kotlin serialization to 1.4.0
  • Update Completions, Edits and Embeddings to use Models

Removed

  • Engines, Answers, Search and Classification

1.2.0

Published 11 Jun 2022

Added

  • openai-client-bom artifact for jvm projects

Changed

  • Update Kotlin to 1.7.0 (#31)
  • Update Coroutines to 1.6.2 (#26)

Deprecated

  • Answers, Classification and Search Endpoints (#29)

1.1.0

Published 08 May 2022

Added

  • Field user to CompletionRequest (#9) (thanks @Stuie)
  • Native targets: linuxX64, macosX64, macosArm64 and mingwX64 (w/ new memory manager)

Changed

  • Kotlin 1.6.21
  • Kotlin coroutines 1.6.1
  • The client throws OpenAIException on errors

1.0.0

Published 19 Jun 2021

Changed

  • Kotlin 1.5.10
  • Value classes: EngineID, FileStatus, FileId and Purpose

0.5.0

Published 03 Apr 2021

Added

Changed

  • Kotlin 1.4.32

Experimental

0.4.0

Published 20 Mar 2021

Changed

  • Deprecate stream parameter in CompletionRequest.

0.3.0

Published 13 Mar 2021

Changed

  • Remove Ktor's logging classes from public API

0.2.0

Published 11 Mar 2021

Added

  • OpenAI.completions: text completions as stream of events

Fixed

  • OpenAI.completion when stream is set

Changed

  • OpenAI.createCompletion renamed to OpenAI.completion

0.1.1

Published 10 Mar 2021

Changed

  • Ktor as an implementation dependency of openai-client

0.1.0

Published 09 Mar 2021

Added