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

on GitHub

2.0.0-beta.3 (2024-08-23)

This change updates the library for compatibility with the latest 2.0.0-beta.9 of the OpenAI package and the 2024-07-01-preview Azure OpenAI service API version label, as published on 8/5.

Features Added

• The library now directly supports alternative authentication audiences, including Azure Government. This can be specified by providing an appropriate AzureOpenAIAudience value to the AzureOpenAIClientOptions.Audience property when creating a client. See the client configuration section of the README for more details.

Additional new features from the OpenAI package can be found in the OpenAI changelog.

Please note: Structured Outputs support is not yet available with the 2024-07-01-preview service API version. This means that attempting to use the feature with this library version will fail with an unrecognized property for either response_format or strict in request payloads; all existing functionality is unaffected. Azure OpenAI support for Structured Outputs is coming soon.

Breaking Changes

No Azure-specific breaking changes are present in this update.

The update from OpenAI 2.0.0-beta.7 to 2.0.0-beta.9 does bring a number of breaking changes, however, as described in the OpenAI changelog:

• Removed client constructors that do not explicitly take an API key parameter or an endpoint via an OpenAIClientOptions parameter, making it clearer how to appropriately instantiate a client. (13a9c68)
• Removed the endpoint parameter from all client constructors, making it clearer that an alternative endpoint must be specified via the OpenAIClientOptions parameter. (13a9c68)
• Removed OpenAIClient's Endpoint protected property. (13a9c68)
• Made OpenAIClient's constructor that takes a ClientPipeline parameter protected internal instead of just protected. (13a9c68)
• Renamed the User property in applicable Options classes to EndUserId, making its purpose clearer. (13a9c68)
• Changed name of return types from methods returning streaming collections from ResultCollection to CollectionResult. (7bdecfd)
• Changed return types from methods returning paginated collections from PageableCollection to PageCollection. (7bdecfd)
• Users must now call GetAllValues on the collection of pages to enumerate collection items directly. Corresponding protocol methods return IEnumerable<ClientResult> where each collection item represents a single service response holding a page of values. (7bdecfd)
• Updated VectorStoreFileCounts and VectorStoreFileAssociationError types from readonly struct to class. (58f93c8)

Bugs Fixed

• Removed an inappropriate null check in FileClient.GetFiles() (azure-sdk-for-net 44912)
• Addressed issues with automatic retry behavior, including for HTTP 429 rate limit errors:
  • Authorization headers are now appropriately reapplied to retried requests
  • Automatic retry behavior will now honor header-based intervals from Retry-After and related response headers
• The client will now originate an x-ms-client-request-id header to match prior library behavior and facilitate troubleshooting

Additional, non-Azure-specific bug fixes can be found in the OpenAI changelog.