Azure/azure-sdk-for-net Azure.AI.OpenAI_2.0.0-beta.6

on GitHub

2.0.0-beta.6 (2024-09-23)

This version increments library compatibility to OpenAI 2.0.0-beta.12, including support for o1 models with reasoning tokens and a number of breaking changes to method names.

Features Added

• The library now includes support for the new OpenAI o1 model family. (2ab1a94)
  • ChatCompletionOptions will automatically apply its MaxOutputTokenCount value (renamed from MaxTokens) to the new max_completion_tokens request body property
  • Usage includes a new OutputTokenDetails property with a ReasoningTokenCount value that will reflect o1 model use of this new subcategory of output tokens.
  • Note that OutputTokenCount (completion_tokens) is the sum of displayed tokens generated by the model and (when applicable) these new reasoning tokens
• Assistants file search now includes support for RankingOptions. (2ab1a94)
  • Use of the include[] query string parameter and retrieval of run step detail result content is currently only available via protocol methods
• Added support for the Uploads API in FileClient. This Experimental feature allows uploading large files in multiple parts. (2ab1a94)
  • The feature is supported by the CreateUpload, AddUploadPart, CompleteUpload, and CancelUpload protocol methods.

Breaking Changes

• Renamed ChatMessageContentPart's CreateTextMessageContentPart factory method to CreateTextPart. (2ab1a94)
• Renamed ChatMessageContentPart's CreateImageMessageContentPart factory method to CreateImagePart. (2ab1a94)
• Renamed ChatMessageContentPart's CreateRefusalMessageContentPart factory method to CreateRefusalPart. (2ab1a94)
• Renamed ImageChatMessageContentPartDetail to ChatImageDetailLevel. (2ab1a94)
• Removed ChatMessageContentPart's ToString overload. (2ab1a94)
• Renamed the MaxTokens property in ChatCompletionOptions to MaxOutputTokenCount. (2ab1a94)
• Renamed properties in ChatTokenUsage:
  • InputTokens is renamed to InputTokenCount. (2ab1a94)
  • OutputTokens is renamed to OutputTokenCount. (2ab1a94)
  • TotalTokens is renamed to TotalTokenCount. (2ab1a94)
• Removed the common ListOrder enum from the top-level OpenAI namespace in favor of individual enums in their corresponding sub-namespace. (2ab1a94)
• Renamed the PageSize property to PageSizeLimit. (2ab1a94)
• Updated deletion methods to return a result object instead of a bool. Affected methods:
  • DeleteAssitant, DeleteMessage, and DeleteThread in AssistantClient. (2ab1a94)
  • DeleteVectorStore and RemoveFileFromStore in VectorStoreClient. (2ab1a94)
  • DeleteModel in ModelClient. (2ab1a94)
  • DeleteFile in FileClient. (2ab1a94)
• Removed setters from collection properties. (2ab1a94)
• Renamed ChatTokenLogProbabilityInfo to ChatTokenLogProbabilityDetails. (2ab1a94)
• Renamed ChatTokenTopLogProbabilityInfo to ChatTokenTopLogProbabilityDetails. (2ab1a94)
• Renamed the Utf8ByteValues properties of ChatTokenLogProbabilityDetails and ChatTokenTopLogProbabilityDetails to Utf8Bytes and changed their type from IReadOnlyList<int> to ReadOnlyMemory<byte>?. (2ab1a94)
• Renamed the Start and End properties of TranscribedSegment and TranscribedWord to StartTime and EndTime. (2ab1a94)
• Changed the type of TranscribedSegment's AverageLogProbability and NoSpeechProbability properties from double to float. (2ab1a94)
• Changed the type of TranscribedSegment's SeekOffset property from long to int. (2ab1a94)
• Changed the type of TranscribedSegment's TokenIds property from IReadOnlyList<long> to IReadOnlyList<int>. (2ab1a94)
• Updated the Embedding.Vector property to the Embedding.ToFloats() method. (2ab1a94)
• Removed the optional parameter from the constructors of VectorStoreCreationHelper, AssistantChatMessage, and ChatFunction. (2ab1a94)
• Removed the optional purpose parameter from FileClient.GetFilesAsync and FileClient.GetFiles methods, and added overloads where purpose is required. (2ab1a94)
• Renamed ModerationClient's ClassifyTextInput methods to ClassifyText. (2ab1a94)
• Removed duplicated Created property from GeneratedImageCollection. (2ab1a94)

Bugs Fixed

• Addressed an issue that caused multi-page queries of fine-tuning jobs, checkpoints, and events to fail. (2ab1a94)
• ChatCompletionOptions can now be serialized via ModelReaderWriter.Write() prior to calling CompleteChat using the options. (2ab1a94)

Other Changes

• Added support for CancellationToken to ModelClient methods. (2ab1a94)
• Applied the Obsolete attribute where appropriate to align with the existing deprecations in the REST API. (2ab1a94)