Azure/azure-sdk-for-net Azure.AI.OpenAI_2.1.0-beta.2

on GitHub

2.1.0-beta.2 (2024-11-04)

This update brings compatibility with the Azure OpenAI 2024-10-01-preview service API version as well as the 2.1.0-beta.2 release of the OpenAI library.

Breaking Changes

• [Experimental] ChatCitation and ChatRetrievedDocument have each replaced the Uri property of type System.Uri with a string property named Url. This aligns with the REST specification and accounts for the wire value of url not always providing a valid RFC 3986 identifier [azure-sdk-for-net #46793]

Features Added

• The included update via 2024-09-01-preview brings AOAI support for streaming token usage in chat completions; Usage is now automatically populated in StreamingChatCompletionUpdate instances.
  • Note 1: this feature is not yet compatible when using On Your Data features (after invoking the .AddDataSource() extension method on ChatCompletionOptions)
  • Note 2: this feature is not yet compatible when using image input (a ChatMessageContentPart of Kind Image)
• 2024-10-01-preview further adds support for ungrounded content detection in chat completion content filter results via the UngroundedMaterial property on ResponseContentFilterResult, as retrieved from a chat completion via the GetResponseContentFilterResult() extension method.

Via OpenAI 2.0.0-beta.2:

• Made improvements to the experimental Realtime API. Please note this features area is currently under rapid development and not all changes may be reflected here.
  • Several types have been renamed for consistency and clarity.
  • ConversationRateLimitsUpdate (previously ConversationRateLimitsUpdatedUpdate) now includes named RequestDetails and TokenDetails properties, mapping to the corresponding named items in the underlying rate_limits command payload.

Bugs Fixed

• Addressed an HTTP 401 issue that caused certain connection retry attempts, such as those triggered for HTTP 429 rate limiting errors, to sometimes generate a malformed request with multiple Authorization headers that would then be rejected. #46401
• Addressed an issue that caused ChatCitation and ChatRetrievedDocument to sometimes throw on deserialization, specifically when a returned value in the url JSON field was not populated with an RFC 3986 compliant identifier for System.Uri [azure-sdk-for-net #46793]

Via OpenAI 2.0.0-beta.2:

• Fixed serialization and deserialization of ConversationToolChoice literal values (such as "required").