openai-kotlin

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)

Fixed

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

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)

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)

Added

• Audio: add timestampGranularities (thanks @mxwell)

Fixed

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

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

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)
  )

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)

Fixed

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

This release represents a significant update to the library. Following OpenAI DevDay 2023, it introduces a range of new features and improvements, including new APIs and multimodal capabilities.

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)

Fix

• Models: permission field nullable (#251)

Experimental

• Chat: add mergeToChatMessage extension (#250)

Added

• Fine-tuning: API implementation (#242)

Deprecated

• Fine-tunes is deprecated

Added

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

Fix

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

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.

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

Fix

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

Added

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

Added

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

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