.NET SDK
Mon
Wed
Fri
AugSepOctNovDecJanFebMarAprMayJunJulAug
LessMore
Releases4Avg1/mo
Last Checked
4h ago
X-Stainless-Lang, X-Stainless-Package-Version, X-Stainless-Runtime, X-Stainless-Runtime-Version, X-Stainless-OS, and X-Stainless-Arch), bringing the .NET library to parity with the other official OpenAI SDKs. These restate information already present in the User-Agent header in a machine-parseable form, plus the process CPU architecture, so consumers no longer need to parse the user agent string. Any value you set yourself is preserved. The User-Agent header itself is unchanged.OpenAI.DisableTelemetry AppContext switch or the OPENAI_DISABLE_TELEMETRY environment variable. When enabled, the library sends neither the X-Stainless-* headers nor the User-Agent header that it would otherwise add. See Telemetry and privacy for details.UserAgentApplicationId from 24 characters to 512. Application identifiers up to that length are now accepted and passed through to the User-Agent header verbatim; longer values throw ArgumentOutOfRangeException when a client is created, so that the header cannot be inflated without bound. The identifier is ignored, and the limit not applied, when telemetry is disabled and no User-Agent will be sent.OPENAI001. These types were previously marked with a dedicated OPENAICUA001 code, which has been removed. Consumers who explicitly suppressed OPENAICUA001 should suppress OPENAI001 instead (the same code already used by the other experimental Responses APIs).Thank you to our developer community members who helped to make the OpenAI client library better with their contributions to this release:
ContainerNetworkPolicy type with the following derived types:
ContainerAllowlistNetworkPolicyContainerDisabledNetworkPolicyContainerNetworkPolicyKind extensible enum.ContainerNetworkPolicyDomainSecret type.NetworkPolicy property to ContainerCreationOptions.ContainerMemoryLimit extensible enum.MemoryLimit property to ContainerCreationOptions.Name property to ContainerCollectionOptions.ConversationClient:
ConversationCreationOptions type.ConversationUpdateOptions type.ConversationDeletionResult type.ConversationResource type.ConversationClient:
CreateConversation and CreateConversationAsyncDeleteConversation and DeleteConversationAsyncGetConversation and GetConversationAsyncUpdateConversation and UpdateConversationAsyncResponsePromptCacheRetentionPolicy extensible enum.PromptCacheKey and PromptCacheRetentionPolicy properties to CreateResponseOptions.PromptCacheKey and PromptCacheRetentionPolicy properties to ResponseResult.ChatMessageContentPart.CreateImagePart(Uri) incorrectly serializing image_url.url via Uri.ToString(), which would unescape percent-encoded characters (e.g., %20 → space) and break downstream image fetches. The serialized URL now uses Uri.AbsoluteUri to preserve percent-encoding.System.ClientModel dependency to version 1.14.0. For more information, see the System.ClientModel changelog.DeleteContainerResponse to ContainerDeletionResult.DeleteContainerFileResponse to ContainerFileDeletionResult.ContainerResourceExpiresAfter to ContainerExpirationPolicy.CreateContainerBody to ContainerCreationOptions.Minutes property of ContainerExpirationPolicy to Duration.Id property of ContainerDeletionResult to ContainerId.Id property of ContainerFileDeletionResult to ContainerFileId.ExpiresAfter property of ContainerResource to ExpirationPolicy.Anchor property of ContainerExpirationPolicy from string to ContainerExpirationPolicyAnchor?.Duration property of ContainerExpirationPolicy from int to TimeSpan?.ExpiresAfter property of ContainerResource from ContainerResourceExpiresAfter to ContainerExpirationPolicy.ContainerResourceExpiresAfter class.options parameter of type RequestOptions required for several methods in the ConversationClient in order to disambiguate the new overloads.Thank you to our developer community members who helped to make the OpenAI client library better with their contributions to this release:
ChatWebSearchContextSize extensible enum.SearchContextSize property to ChatWebSearchOptions.SkillClient with the following methods:
UploadSkill and UploadSkillAsyncUpdateSkill and UpdateSkillAsyncGetSkill and GetSkillAsyncGetSkills and GetSkillsAsyncDownloadSkill and DownloadSkillAsyncDeleteSkill and DeleteSkillAsyncUploadSkillVersion and UploadSkillVersionAsyncGetSkillVersion and GetSkillVersionAsyncGetSkillVersions and GetSkillVersionsAsyncDownloadSkillVersion and DownloadSkillVersionAsyncDeleteSkillVersion and DeleteSkillVersionAsyncResponseTokenLogProbabilityDetails type.ResponseTokenTopLogProbabilityDetails type.OutputTextTokenLogProbabilities property to ResponseContentPart.TokenLogProbabilities property to StreamingResponseOutputTextDeltaUpdate.TokenLogProbabilities property to StreamingResponseOutputTextDoneUpdate.FunctionName property to StreamingResponseFunctionCallArgumentsDoneUpdate.ResponseItem class hierarchy.
ResponseItemKind extensible enum.Kind property to ResponseItem.ResponseItem that takes a ResponseItemKind parameter.ResponseTool class hierarchy.
ResponseToolKind extensible Enum.Kind property to ResponseTool.ResponseTool that takes a ResponseToolKind parameter.StreamingResponseUpdate class hierarchy.
StreamingResponseUpdateKind extensible enum.Kind property to StreamingResponseUpdate.StreamingResponseUpdate that takes a StreamingResponseUpdateKind parameter.NullReferenceException when a streaming response delivered an unmodeled error event. The SSE error frame is now surfaced as a ClientResultException so the failure is observable, while the unknown-event path stays covered.UploadFile and UploadFileAsync method overloads in OpenAIFileClient that take a filePath were incorrectly using the entire path as the filename.AudioEndTime property of RealtimeClientCommandConversationItemTruncate was incorrectly serialized as a float instead of an integer.KnownSpeakerReferenceUris property of AudioTranscriptionOptions from IList<Uri> to IList<string>.CreateContainerFile and CreateContainerFileAsync methods of ContainerClient to UploadContainerFile and UploadContainerFileAsync.Order property of ContainerFileCollectionOptions from ContainerCollectionOrder? to ContainerFileCollectionOrder?.Options property of RealtimeClientSettings from OpenAIClientOptions to RealtimeClientOptions.AddResponsesClient and AddKeyedResponsesClient IHostApplicationBuilder extension methods under the OpenAI.Responses namespace.action and background parameters from the constructor of ImageGenerationCallResponseItem.ImageGenToolCallBackground type in favor of ImageGenerationToolBackground.ImageGenToolCallOutputFormat type in favor of ImageGenerationToolOutputFileFormat.ImageGenToolCallQuality type in favor of ImageGenerationToolQuality.ImageGenToolCallSize type in favor of ImageGenerationToolSize.Action property of ImageGenerationCallResponseItem from ImageGenerationToolAction to ImageGenerationToolAction?.Background property of ImageGenerationCallResponseItem from ImageGenToolCallBackground to ImageGenerationToolBackground?.OutputFormat property of ImageGenerationCallResponseItem from ImageGenToolCallOutputFormat to ImageGenerationToolOutputFileFormat?.Quality property of ImageGenerationCallResponseItem from ImageGenToolCallQuality to ImageGenerationToolQuality?.Size property of ImageGenerationCallResponseItem from ImageGenToolCallSize to ImageGenerationToolSize?.OutputFormat property of ImageGenerationCallResponseItem to OutputFileFormat.Options property of ResponsesClientSettings from OpenAIClientOptions to ResponsesClientOptions.options parameters in the constructors of ResponsesClient from OpenAIClientOptions to ResponsesClientOptions.ResponsesClient for consistency:
CompactResponse and CompactResponseAsyncGetInputTokenCount and GetInputTokenCountAsyncStreamingResponseTextAnnotationAddedUpdate to StreamingResponseOutputTextAnnotationAddedUpdate.Diarized value to the AudioTranscriptionFormat extensible enum.KnownSpeakerNames and KnownSpeakerReferenceUris properties to AudioTranscriptionOptions.TranscribeAudioDiarized and TranscribeAudioDiarizedAsync methods to the AudioClient.StreamingAudioTranscriptionUpdate:
StreamingAudioTranscriptionTextSegmentUpdateGenerateSpeechStreaming and GenerateSpeechStreamingAsync methods to the AudioClient.StreamingSpeechUpdate type with the following derived types:
StreamingSpeechAudioDeltaUpdateStreamingSpeechAudioDoneUpdateAudioClient:
CreateVoice and CreateVoiceAsyncCreateVoiceConsent and CreateVoiceConsentAsyncDeleteVoiceConsent and DeleteVoiceConsentAsyncGetVoiceConsent and GetVoiceConsentAsyncGetVoiceConsents and GetVoiceConsentsAsyncUpdateVoiceConsent and UpdateVoiceConsentAsyncChunkingStrategy property to AudioTranscriptionOptions.Usage property to AudioTranscription.AudioTranscriptionUsage type with the following derived types:
AudioTranscriptionTokenUsageAudioTranscriptionDurationUsageSpeechTokenUsage type.ResponseTool:
ApplyPatchToolResponseItem:
ApplyPatchCallItemApplyPatchCallOutputItemApplyPatchOperation type with the following derived types:
ApplyPatchCreateFileOperationApplyPatchDeleteFileOperationApplyPatchUpdateFileOperationAction property to WebSearchCallResponseItem.WebSearchAction type with the following derived types:
WebSearchFindInPageActionWebSearchOpenPageActionWebSearchSearchActionWebSearchCallActionSources value to the IncludedResponseProperty extensible enum.WebSearchActionSource type with the following derived types:
WebSearchActionUriSourceAction property to ImageGenerationTool.ImageGenerationToolAction extensible enum with values Generate, Edit, and Auto.Description property to VectorStoreCreationOptions.\/ or \u002F for /) failed to decode, causing a FormatException. Per RFC 8259 §7, these are valid JSON representations that the OpenAI API may produce.ConfigurationSchema.json to the NuGet package via the MSBuild JsonSchemaSegment feature, enabling automatic JSON IntelliSense and validation for appsettings.json when configuring OpenAI clients. Provides per-client model suggestions and OpenAI-specific options, composing with System.ClientModel's base credential and pipeline definitions.Bytes property of ContainerFileResource to SizeInBytes and changed its type from int to long?.MessageOutputTextLogprobs value of the IncludedConversationItemProperty extensible enum to MessageOutputTextLogProbabilities.limit parameter in the GetConversationItems and GetConversationItemsAsync protocol methods from long? to int?.limit parameter in the GetFiles and GetFilesAsync protocol methods from long? to int?.InputImageUri property of ResponseContentPart from Uri to string.ImageUri property of ImageGenerationToolInputImageMask from Uri to string.Size property of VectorStoreFile to UsageInBytes and changes its type from int to long?.limit parameter in the GetVideo and GetVideosAsync protocol methods from long? to int?.InputFileUri property and CreateInputFilePart(Uri) factory method to ResponseContentPart to support file URL inputs.Microsoft.SourceLink.GitHub was inadvertently included as a runtime dependency of the package, causing downstream build failures with "Source control information is not available" errors. The package is now correctly treated as a build-only dependency.JsonPatch customizations applied to ChatCompletionOptions were lost when the options were cloned internally before an API call.Thank you to our developer community members who helped to make the OpenAI client library better with their contributions to this release:
AudioClient configuration and dependency injection via the new AudioClientSettings class.BatchClient configuration and dependency injection via the new BatchClientSettings class.ChatClient configuration and dependency injection via the new ChatClientSettings class.None to ChatReasoningEffortLevel enum to allow opting out of reasoning.ContainerClient configuration and dependency injection via the new ContainerClientSettings class.ConversationClient configuration and dependency injection via the new ConversationClientSettings class.EmbeddingClient configuration and dependency injection via the new EmbeddingClientSettings class.EvaluationClient configuration and dependency injection via the new EvaluationClientSettings class.OpenAIFileClient configuration and dependency injection via the new OpenAIFileClientSettings class.GetFiles and GetFilesAsync methods in the OpenAIFileClient.FineTuningClient configuration and dependency injection via the new FineTuningClientSettings class.GraderClient configuration and dependency injection via the new GraderClientSettings class.ImageClient configuration and dependency injection via the new ImageClientSettings class.HighQuality to GeneratedImageQuality enum to allow generating higher quality images.InputFidelity property to ImageEditOptions to control how closely distinctive features from the input are preserved.OutputCompressionFactor property to ImageEditOptions to set the compression level (0-100%) for jpeg or webp outputs.OutputFileFormat property to ImageEditOptions to set the file format in which the generated images are returned.Background property to GeneratedImageCollection.OutputFileFormat property to GeneratedImageCollection.Quality property to GeneratedImageCollection.Size property to GeneratedImageCollection.OpenAIModelClient configuration and dependency injection via the new OpenAIModelClientSettings class.ModerationClient configuration and dependency injection via the new ModerationClientSettings class.ClassifyInputs and ClassifyInputsAsync methods in the ModerationClient.
ModerationInputPart class to create text or image inputs for classification.ApplicableInputKinds property of the ModerationCategory class to understand to which parts of the input the moderation results apply.RealtimeClient configuration and dependency injection via the new RealtimeClientSettings class.RealtimeMcpTool to the Tools property of their RealtimeConversationSessionOptions and configure it.
AllowedTools property to limit which of the server tools can be called by the model.ToolCallApprovalPolicy property to specify which tools require an explicit approval before being called by the model.AuthorizationToken property to specify the access token to used when authenticating with the remote MCP server.ConnectorId property to use the OpenAI-maintained MCP wrappers for popular services like Microsoft Outlook or Dropbox.RealtimeClientCommand class that represents client events to be used with the new SendCommand and SendCommandAsync overloads in the RealtimeSessionClient and exposed all supported client events as derived types:
RealtimeClientCommandConversationItemCreateRealtimeClientCommandConversationItemDeleteRealtimeClientCommandConversationItemRetrieveRealtimeClientCommandConversationItemTruncateRealtimeClientCommandInputAudioBufferAppendRealtimeClientCommandInputAudioBufferClearRealtimeClientCommandInputAudioBufferCommitRealtimeClientCommandOutputAudioBufferClearRealtimeClientCommandResponseCancelRealtimeClientCommandResponseCreateRealtimeClientCommandSessionUpdateJsonPatch, which enables users to get and set additional JSON properties in response and request payloads.ResponsesClient configuration and dependency injection via the new ResponsesClientSettings class.CompactResponse and CompactResponseAsync protocol methods in the ResponsesClient.GetInputTokenCount and GetInputTokenCountAsync protocol methods in the ResponsesClient.None to ResponseReasoningEffortLevel enum to allow opting out of reasoning.InputImageUri property to ResponseContentPart to manage image inputs as URIs.McpToolCallApprovalPolicy to facilitate its assignment.VectorStoreClient configuration and dependency injection via the new VectorStoreClientSettings class.VideoClient configuration and dependency injection via the new VideoClientSettings class.ChatCompletionOptions argument when the same instance was passed into concurrent calls of CompleteChat/CompleteChatAsync and/or CompleteChatStreaming/CompleteChatStreamingAsync.RealtimeSessionClient.RealtimeSessionClient always requiring an API key.CreateResponseOptions argument when the same instance was passed into concurrent calls of CreateResponse/CreateResponseAsync and/or CreateResponseStreaming/CreateResponseStreamingAsync.System.ClientModel dependency to version 1.9.0. For more information, see the System.ClientModel changelog.InputTokenCount, OutputTokenCount, and TotalTokenCount properties of ImageTokenUsage from int to long.RealtimeSession to RealtimeSessionClient.ConversationTool to RealtimeTool and exposed all supported tools as derived types:
RealtimeFunctionToolRealtimeMcpToolRealtimeItem into a class hierarchy and exposed all supported item types as derived types:
RealtimeMessageItemRealtimeFunctionCallItemRealtimeFunctionCallOutputItemRealtimeMcpToolCallItemRealtimeMcpToolDefinitionListItemRealtimeMcpToolCallApprovalRequestItemRealtimeMcpToolCallApprovalResponseItemRealtimeUpdate to RealtimeServerUpdate and exposed all supported server events as derived types:
RealtimeServerUpdateConversationCreatedRealtimeServerUpdateConversationItemAddedRealtimeServerUpdateConversationItemCreatedRealtimeServerUpdateConversationItemDeletedRealtimeServerUpdateConversationItemDoneRealtimeServerUpdateConversationItemInputAudioTranscriptionCompletedRealtimeServerUpdateConversationItemInputAudioTranscriptionDeltaRealtimeServerUpdateConversationItemInputAudioTranscriptionFailedRealtimeServerUpdateConversationItemInputAudioTranscriptionSegmentRealtimeServerUpdateConversationItemRetrievedRealtimeServerUpdateConversationItemTruncatedRealtimeServerUpdateErrorRealtimeServerUpdateInputAudioBufferClearedRealtimeServerUpdateInputAudioBufferCommittedRealtimeServerUpdateInputAudioBufferDtmfEventReceivedRealtimeServerUpdateInputAudioBufferSpeechStartedRealtimeServerUpdateInputAudioBufferSpeechStoppedRealtimeServerUpdateInputAudioBufferTimeoutTriggeredRealtimeServerUpdateMcpListToolsCompletedRealtimeServerUpdateMcpListToolsFailedRealtimeServerUpdateMcpListToolsInProgressRealtimeServerUpdateOutputAudioBufferClearedRealtimeServerUpdateOutputAudioBufferStartedRealtimeServerUpdateOutputAudioBufferStoppedRealtimeServerUpdateRateLimitsUpdatedRealtimeServerUpdateResponseContentPartAddedRealtimeServerUpdateResponseContentPartDoneRealtimeServerUpdateResponseCreatedRealtimeServerUpdateResponseDoneRealtimeServerUpdateResponseFunctionCallArgumentsDeltaRealtimeServerUpdateResponseFunctionCallArgumentsDoneRealtimeServerUpdateResponseMcpCallArgumentsDeltaRealtimeServerUpdateResponseMcpCallArgumentsDoneRealtimeServerUpdateResponseMcpCallCompletedRealtimeServerUpdateResponseMcpCallFailedRealtimeServerUpdateResponseMcpCallInProgressRealtimeServerUpdateResponseOutputAudioDeltaRealtimeServerUpdateResponseOutputAudioDoneRealtimeServerUpdateResponseOutputAudioTranscriptDeltaRealtimeServerUpdateResponseOutputAudioTranscriptDoneRealtimeServerUpdateResponseOutputItemAddedRealtimeServerUpdateResponseOutputItemDoneRealtimeServerUpdateResponseOutputTextDeltaRealtimeServerUpdateResponseOutputTextDoneRealtimeServerUpdateSessionCreatedRealtimeServerUpdateSessionUpdatedModel property of the ResponsesClient in favor of specifying the model on a per-call basis when calling CreateResponse/CreateResponseAsync or CreateResponseStreaming/CreateResponseStreamingAsync. To do this, set the Model property of the CreateResponseOptions parameter. With this change, users no longer have to provide a model unless it is actually needed.Instructions property of ResponseResult from string to IList<ResponseItem> to handle multi-item instructions.SafetyIdentifier property to ChatCompletionOptions, which enables users to specify a stable identifier that can be used to help detect end-users of their application that may be violating OpenAI's usage policies.SafetyIdentifier property to CreateResponseOptions and ResponseResult, which enables users to specify a stable identifier that can be used to help detect end-users of their application that may be violating OpenAI's usage policies.ConversationOptions property to CreateResponseOptions and ResponseResult, which enables users to automatically manage the state of a conversation in a multi-turn interaction by persisting state and sharing context across subsequent responses, rather than having to chain multiple response items together.MaxToolCallCount property to CreateResponseOptions and ResponseResult, which enables users to set the maximum number of total calls to built-in tools that can be processed in a response. This maximum number applies across all built-in tool calls, not per individual tool. Any further attempts to call a tool by the model will be ignored.TopLogProbabilityCount property to CreateResponseOptions and ResponseResult, which enables users to specify the number of most likely tokens to return at each token position, each with an associated log probability.IncludedProperties property to CreateResponseOptions, which enables users to specify additional output data to be included in the model response.Id property of ResponseItem.Status property of the types derived from ResponseItem.[Experimental] attribute. As we prepare to stabilize it and remove its experimental designation, we are cleaning up the APIs to better align them with the service REST APIs, as well as to offer more flexibility and improve usability. See our examples for helpful references on how to use the updated APIs.
OpenAIResponseClient class has been renamed to ResponsesClient.ResponseCreationOptions class has been renamed to CreateResponseOptions.OpenAIResponse class has been renamed to ResponseResult.CreateResponse, CreateResponseAsync, CreateResponseStreaming and CreateResponseStreamingAsync methods of the ResponsesClient with a CreateResponseOptions argument, the input items must now be specified via the new InputItems property of CreateResponseOptions.CreateResponseStreaming and CreateResponseStreamingAsync methods of the ResponsesClient with a CreateResponseOptions argument, the StreamingEnabled property of CreateResponseOptions must be set to true.OpenAIResponsesModelFactory class used for mocking output models (e.g., ResponseResult, ResponseTokenUsage, etc.) has been removed in favor of adding setters to the properties of these models.Thank you to our developer community members who helped to make the OpenAI client library better with their contributions to this release:
WebSearchTool class, with a separate WebSearchPreviewTool class for preview web search features.Filename property to FileCitationMessageAnnotation to provide the name of the cited file.StreamingResponseReasoningTextDeltaUpdate and StreamingResponseReasoningTextDoneUpdate for reasoning text events.StreamingResponseReasoningSummaryPartAddedUpdate and StreamingResponseReasoningSummaryPartDoneUpdate for reasoning summary part events.StreamingResponseReasoningSummaryTextDeltaUpdate and StreamingResponseReasoningSummaryTextDoneUpdate for reasoning summary text events.MessageCreationAttachment that prevented proper handling of file attachments in message creation. (A community contribution, courtesy of BenjaminDavidPinter)partial_image_b64 in StreamingResponseImageGenerationCallPartialImageUpdate to ensure correct serialization of partial image data in streaming responses.Patch properties by adding the JsonIgnore attribute, preventing System.InvalidOperationException when using JsonSerializer without the custom converter.System.ClientModel dependency to version 1.8.1 to adopt bug fixes for JSON Patch. For more context, see the System.ClientModel ChangeLogThank you to our developer community members who helped to make the OpenAI client library better with their contributions to this release:
Minimal property to ChatReasoningEffortLevel. (A community contribution, courtesy of kurnakovv)JsonPatch, which enables users to get and set additional JSON properties in response and request payloads.
ConversationClient to support the Conversations API with protocol methods for the following operations:
CreateConversation and CreateConversationAsyncGetConversation and GetConversationAsyncUpdateConversation and UpdateConversationAsyncDeleteConversation and DeleteConversationAsyncCreateConversationItems and CreateConversationItemsAsyncGetConversationItems and GetConversationItemsAsyncDeleteConversationItem and DeleteConversationItemAsyncJsonPatch, which enables users to get and set additional JSON properties in response and request payloads.
Minimal property to ResponseReasoningEffortLevel. (A community contribution, courtesy of kurnakovv)ContainerFileCitationMessageAnnotation class which is derived from ResponseMessageAnnotation and is used to cite files in the container of the Code Interpreter tool.gpt-image-1.
ImageGenerationTool to the Tools property of their ResponseCreationOptions and configure it using properties such as Background, Quality, Size, and more.JsonPatch, which enables users to get and set additional JSON properties in response and request payloads.
VideoClient to support the Videos API with protocol methods for the following operations:
CreateVideo and CreateVideoAsyncGetVideo and GetVideoAsyncDeleteVideo and DeleteVideoAsyncDownloadVideo and DownloadVideoAsyncGetVideos and GetVideosAsyncCreateVideoRemix and GetVideoRemixAsync