Azure.AI.OpenAI_2.1.0-beta.2
Pre-release
Pre-release
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]ChatCitationandChatRetrievedDocumenthave each replaced theUriproperty of typeSystem.Uriwith astringproperty namedUrl. This aligns with the REST specification and accounts for the wire value ofurlnot always providing a valid RFC 3986 identifier [azure-sdk-for-net #46793]
Features Added
- The included update via
2024-09-01-previewbrings AOAI support for streaming token usage in chat completions;Usageis now automatically populated inStreamingChatCompletionUpdateinstances.- Note 1: this feature is not yet compatible when using On Your Data features (after invoking the
.AddDataSource()extension method onChatCompletionOptions) - Note 2: this feature is not yet compatible when using image input (a
ChatMessageContentPartofKindImage)
- Note 1: this feature is not yet compatible when using On Your Data features (after invoking the
2024-10-01-previewfurther adds support for ungrounded content detection in chat completion content filter results via theUngroundedMaterialproperty onResponseContentFilterResult, as retrieved from a chat completion via theGetResponseContentFilterResult()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
Authorizationheaders that would then be rejected. #46401 - Addressed an issue that caused
ChatCitationandChatRetrievedDocumentto sometimes throw on deserialization, specifically when a returned value in theurlJSON field was not populated with an RFC 3986 compliant identifier forSystem.Uri[azure-sdk-for-net #46793]
Via OpenAI 2.0.0-beta.2:
- Fixed serialization and deserialization of ConversationToolChoice literal values (such as "required").