Skip to content

Latest commit

 

History

History
126 lines (75 loc) · 9.52 KB

CHANGELOG.md

File metadata and controls

126 lines (75 loc) · 9.52 KB

Release History

2.0.0-beta.9 (Unreleased)

Features Added

  • Added the following model factories (static classes that can be used to instantiate OpenAI models for mocking in non-live test scenarios):
    • OpenAIAudioModelFactory in the OpenAI.Audio namespace
    • OpenAIEmbeddingsModelFactory in the OpenAI.Embeddings namespace
    • OpenAIFilesModelFactory in the OpenAI.Files namespace
    • OpenAIImagesModelFactory in the OpenAI.Images namespace
    • OpenAIModelsModelFactory in the OpenAI.Models namespace
    • OpenAIModerationsModelFactory in the OpenAI.Moderations namespace

Breaking Changes

Bugs Fixed

Other Changes

2.0.0-beta.8 (2024-07-31)

Breaking Changes

  • 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

  • (#49) Fixed a bug with extensible enums implementing case-insensitive equality but case-sensitive hash codes. (0c12500)
  • (#57) Fixed a bug with requests URIs with query string parameter potentially containing a malformed double question mark (??) on .NET Framework (net481). (0c12500)
  • Added optional CancellationToken parameters to methods for AssistantClient and VectorStore client, consistent with past changes in 19a65a0. (d77539c)
  • Fixed Assistants FileSearchToolDefinition's MaxResults parameter to appropriately serialize and deserialize the value (d77539c)
  • Added missing [EditorBrowsable(EditorBrowsableState.Never)] attributes to AssistantClient protocol methods, which should improve discoverability of the strongly typed methods. (d77539c)

Other Changes

  • Removed the usage of init and updated properties to use set. (58f93c8)

2.0.0-beta.7 (2024-06-24)

Bugs Fixed

  • (#84) Fixed a NullReferenceException thrown when adding the custom headers policy while OpenAIClientOptions is null (0b97311)

2.0.0-beta.6 (2024-06-21)

Features Added

  • OrganizationId and ProjectId are now present on OpenAIClientOptions. When instantiating a client, providing an instance of OpenAIClientOptions with these properties set will cause the client to add the appropriate request headers for org/project, eliminating the need to manually configure the headers. (9ee7dff)

Bugs Fixed

  • (#72) Fixed filename request encoding in operations using multipart/form-data, including files and audio (2ba8e69)
  • (#79) Fixed hard-coded user role for caller-created Assistants API messages on threads (d665b61)
  • Fixed non-streaming Assistants API run step details not reporting code interpreter logs when present (d665b61)

Breaking Changes

Assistants (beta):

  • AssistantClient.CreateMessage() and the explicit constructor for ThreadInitializationMessage now require a MessageRole parameter. This properly enables the ability to create an Assistant message representing conversation history on a new thread. (d665b61)

2.0.0-beta.5 (2024-06-14)

Features Added

  • API updates, current to openai/openai-openapi@dd73070b (1af6569)
    • This includes MaxResults for Assistants FileSearchToolDefinition, ParallelToolCallsEnabled for function tools in Assistants and Chat, and FileChunkingStrategy for Assistants VectorStores
  • Optional CancellationToken parameters are now directly present on most methods, eliminating the need to use protocol methods (19a65a0)

Bugs Fixed

  • (#30) Mitigated a .NET runtime issue that prevented chat message content and several other types from serializing correct on targets including mono and wasm (896b9e0)
  • Assistants: Fixed an issue that threw an exception when receiving code interpreter run step logs when streaming a run (207d597)
  • Fixed a concurrency condition that could cause multipart/form-data requests to no longer generate random content part boundaries (no direct scenario impact) (7cacdee)

Breaking Changes

Assistants (beta):

Other Changes

  • Added an environment-variable-based test project to the repository with baseline scenario coverage (db6328a)
  • Build/analyzer warnings cleaned up throughout the project (45fc4d7, b1fa082, 22ab606)
  • Proactively aligned library's implementation of server-sent event (SSE) handling with the source of the incoming System.Net.ServerSentEvents namespace (674e0f7)

2.0.0-beta.4 (2024-06-10)

Features Added

  • Added new, built-in helpers to simplify the use of text-only message content (1c40de6)

Bugs Fixed

  • Optimized embedding deserialization and addressed correctness on big endian systems (e28b5a7)
  • Optimized b64_json message parsing via regex (efd76b5)

2.0.0-beta.3 (2024-06-07)

Bugs Fixed

  • Removed a vestigial package reference (5874f53)

2.0.0-beta.2 (2024-06-06)

Bugs Fixed

  • Addressed an assembly properties issue (bf21eb5)
  • Added migration guide to package (f150666)

2.0.0-beta.1 (2024-06-06)

Features Added

This is the official OpenAI client library for C# / .NET. It provides convenient access to the OpenAI REST API from .NET applications and supports all the latest features. It is generated from our OpenAPI specification in collaboration with Microsoft.

Breaking Changes

If you are a user migrating from version 1.11.0 or earlier, we will soon share a migration guide to help you get started.