merge

Author: christothes

api/OpenAI.net8.0.cs

@@ -1056,6 +1056,7 @@ public class AudioClient {
         public AudioClient(string model, ApiKeyCredential credential, OpenAIClientOptions options);
         public AudioClient(string model, ApiKeyCredential credential);
         public AudioClient(string model, string apiKey);
+        [Experimental("OPENAI001")]
         public string Model { get; }
         public ClientPipeline Pipeline { get; }
         public virtual ClientResult GenerateSpeech(BinaryContent content, RequestOptions options = null);
@@ -1403,7 +1404,12 @@ public class ChatClient {
         protected internal ChatClient(ClientPipeline pipeline, string model, OpenAIClientOptions options);
         public ChatClient(string model, ApiKeyCredential credential, OpenAIClientOptions options);
         public ChatClient(string model, ApiKeyCredential credential);
+        [Experimental("OPENAI001")]
+        public ChatClient(string model, AuthenticationPolicy authenticationPolicy, OpenAIClientOptions options);
+        [Experimental("OPENAI001")]
+        public ChatClient(string model, AuthenticationPolicy authenticationPolicy);
         public ChatClient(string model, string apiKey);
+        [Experimental("OPENAI001")]
         public string Model { get; }
         public ClientPipeline Pipeline { get; }
         public virtual ClientResult<ChatCompletion> CompleteChat(params ChatMessage[] messages);
@@ -2310,6 +2316,7 @@ public class EmbeddingClient {
         public EmbeddingClient(string model, ApiKeyCredential credential, OpenAIClientOptions options);
         public EmbeddingClient(string model, ApiKeyCredential credential);
         public EmbeddingClient(string model, string apiKey);
+        [Experimental("OPENAI001")]
         public string Model { get; }
         public ClientPipeline Pipeline { get; }
         public virtual ClientResult<OpenAIEmbedding> GenerateEmbedding(string input, EmbeddingGenerationOptions options = null, CancellationToken cancellationToken = default);
@@ -3273,6 +3280,7 @@ public class ImageClient {
         public ImageClient(string model, ApiKeyCredential credential, OpenAIClientOptions options);
         public ImageClient(string model, ApiKeyCredential credential);
         public ImageClient(string model, string apiKey);
+        [Experimental("OPENAI001")]
         public string Model { get; }
         public ClientPipeline Pipeline { get; }
         public virtual ClientResult<GeneratedImage> GenerateImage(string prompt, ImageGenerationOptions options = null, CancellationToken cancellationToken = default);
@@ -3460,6 +3468,7 @@ public class ModerationClient {
         public ModerationClient(string model, ApiKeyCredential credential, OpenAIClientOptions options);
         public ModerationClient(string model, ApiKeyCredential credential);
         public ModerationClient(string model, string apiKey);
+        [Experimental("OPENAI001")]
         public string Model { get; }
         public ClientPipeline Pipeline { get; }
         public virtual ClientResult ClassifyText(BinaryContent content, RequestOptions options = null);
@@ -4642,6 +4651,14 @@ public class OpenAIResponseClient {
         public virtual AsyncCollectionResult<StreamingResponseUpdate> GetResponseStreamingAsync(string responseId, int? startingAfter = null, CancellationToken cancellationToken = default);
     }
     [Experimental("OPENAI001")]
+    public static class OpenAIResponsesModelFactory {
+        public static MessageResponseItem MessageResponseItem(string id = null, MessageRole role = MessageRole.Assistant, MessageStatus? status = null);
+        public static OpenAIResponse OpenAIResponse(string id = null, DateTimeOffset createdAt = default, ResponseStatus? status = null, ResponseError error = null, ResponseTokenUsage usage = null, string endUserId = null, ResponseReasoningOptions reasoningOptions = null, int? maxOutputTokenCount = null, ResponseTextOptions textOptions = null, ResponseTruncationMode? truncationMode = null, ResponseIncompleteStatusDetails incompleteStatusDetails = null, IEnumerable<ResponseItem> outputItems = null, bool parallelToolCallsEnabled = false, ResponseToolChoice toolChoice = null, string model = null, IDictionary<string, string> metadata = null, float? temperature = null, float? topP = null, string previousResponseId = null, bool? background = null, string instructions = null, IEnumerable<ResponseTool> tools = null);
+        public static ReasoningResponseItem ReasoningResponseItem(string id = null, string encryptedContent = null, ReasoningStatus? status = null, IEnumerable<ReasoningSummaryPart> summaryParts = null);
+        public static ReasoningResponseItem ReasoningResponseItem(string id = null, string encryptedContent = null, ReasoningStatus? status = null, string summaryText = null);
+        public static ReferenceResponseItem ReferenceResponseItem(string id = null);
+    }
+    [Experimental("OPENAI001")]
     public class ReasoningResponseItem : ResponseItem, IJsonModel<ReasoningResponseItem>, IPersistableModel<ReasoningResponseItem> {
         public ReasoningResponseItem(IEnumerable<ReasoningSummaryPart> summaryParts);
         public ReasoningResponseItem(string summaryText);

api/OpenAI.netstandard2.0.cs

@@ -1266,6 +1266,8 @@ public class ChatClient {
         protected internal ChatClient(ClientPipeline pipeline, string model, OpenAIClientOptions options);
         public ChatClient(string model, ApiKeyCredential credential, OpenAIClientOptions options);
         public ChatClient(string model, ApiKeyCredential credential);
+        public ChatClient(string model, AuthenticationPolicy authenticationPolicy, OpenAIClientOptions options);
+        public ChatClient(string model, AuthenticationPolicy authenticationPolicy);
         public ChatClient(string model, string apiKey);
         public string Model { get; }
         public ClientPipeline Pipeline { get; }
@@ -4111,6 +4113,13 @@ public class OpenAIResponseClient {
         public virtual CollectionResult<StreamingResponseUpdate> GetResponseStreaming(string responseId, int? startingAfter = null, CancellationToken cancellationToken = default);
         public virtual AsyncCollectionResult<StreamingResponseUpdate> GetResponseStreamingAsync(string responseId, int? startingAfter = null, CancellationToken cancellationToken = default);
     }
+    public static class OpenAIResponsesModelFactory {
+        public static MessageResponseItem MessageResponseItem(string id = null, MessageRole role = MessageRole.Assistant, MessageStatus? status = null);
+        public static OpenAIResponse OpenAIResponse(string id = null, DateTimeOffset createdAt = default, ResponseStatus? status = null, ResponseError error = null, ResponseTokenUsage usage = null, string endUserId = null, ResponseReasoningOptions reasoningOptions = null, int? maxOutputTokenCount = null, ResponseTextOptions textOptions = null, ResponseTruncationMode? truncationMode = null, ResponseIncompleteStatusDetails incompleteStatusDetails = null, IEnumerable<ResponseItem> outputItems = null, bool parallelToolCallsEnabled = false, ResponseToolChoice toolChoice = null, string model = null, IDictionary<string, string> metadata = null, float? temperature = null, float? topP = null, string previousResponseId = null, bool? background = null, string instructions = null, IEnumerable<ResponseTool> tools = null);
+        public static ReasoningResponseItem ReasoningResponseItem(string id = null, string encryptedContent = null, ReasoningStatus? status = null, IEnumerable<ReasoningSummaryPart> summaryParts = null);
+        public static ReasoningResponseItem ReasoningResponseItem(string id = null, string encryptedContent = null, ReasoningStatus? status = null, string summaryText = null);
+        public static ReferenceResponseItem ReferenceResponseItem(string id = null);
+    }
     public class ReasoningResponseItem : ResponseItem, IJsonModel<ReasoningResponseItem>, IPersistableModel<ReasoningResponseItem> {
         public ReasoningResponseItem(IEnumerable<ReasoningSummaryPart> summaryParts);
         public ReasoningResponseItem(string summaryText);

codegen/generator/src/OpenAILibraryVisitor.cs

@@ -43,6 +43,7 @@ public class OpenAILibraryVisitor : ScmLibraryVisitor
         ["FunctionCallResponseItem"] = [_readonlyStatusReplacementInfo],
         ["FunctionCallOutputResponseItem"] = [_readonlyStatusReplacementInfo],
         ["MessageResponseItem"] = [_readonlyStatusReplacementInfo],
+        ["ReasoningResponseItem"] = [_readonlyStatusReplacementInfo],
         ["WebSearchCallResponseItem"] = [_readonlyStatusReplacementInfo],
     };
 

codegen/nuget.config

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="utf-8"?>
+<configuration>
+  <packageSources>
+    <add key="generator" value="https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-net/nuget/v3/index.json" />
+  </packageSources>
+</configuration>

examples/Chat/Example08_ChatSerialization.cs

@@ -39,7 +39,7 @@ public static BinaryData SerializeMessages(IEnumerable<ChatMessage> messages)
         writer.WriteEndArray();
         writer.Flush();
 
-        return BinaryData.FromBytes(stream.ToArray());
+        return BinaryData.FromBytes(stream.GetBuffer().AsMemory(0, (int)stream.Length));
     }
     #endregion
 

src/Custom/Audio/AudioClient.cs

@@ -91,6 +91,7 @@ protected internal AudioClient(ClientPipeline pipeline, string model, OpenAIClie
     /// <summary>
     /// Gets the name of the model used in requests sent to the service.
     /// </summary>
+    [Experimental("OPENAI001")]
     public string Model => _model;
 
     #region GenerateSpeech

src/Custom/Chat/ChatClient.cs

@@ -62,14 +62,37 @@ public partial class ChatClient
     /// <param name="options"> The options to configure the client. </param>
     /// <exception cref="ArgumentNullException"> <paramref name="model"/> or <paramref name="credential"/> is null. </exception>
     /// <exception cref="ArgumentException"> <paramref name="model"/> is an empty string, and was expected to be non-empty. </exception>
-    public ChatClient(string model, ApiKeyCredential credential, OpenAIClientOptions options)
+    public ChatClient(string model, ApiKeyCredential credential, OpenAIClientOptions options) : this(model, OpenAIClient.CreateApiKeyAuthenticationPolicy(credential), options)
+    {
+    }
+
+    // CUSTOM: Added as a convenience.
+    /// <summary> Initializes a new instance of <see cref="ChatClient"/>. </summary>
+    /// <param name="model"> The name of the model to use in requests sent to the service. To learn more about the available models, see <see href="https://platform.openai.com/docs/models"/>. </param>
+    /// <param name="authenticationPolicy"> The authentication policy used to authenticate with the service. </param>
+    /// <exception cref="ArgumentNullException"> <paramref name="model"/> or <paramref name="authenticationPolicy"/> is null. </exception>
+    /// <exception cref="ArgumentException"> <paramref name="model"/> is an empty string, and was expected to be non-empty. </exception>
+    [Experimental("OPENAI001")]
+    public ChatClient(string model, AuthenticationPolicy authenticationPolicy) : this(model, authenticationPolicy, new OpenAIClientOptions())
+    {
+    }
+
+    // CUSTOM: Added as a convenience.
+    /// <summary> Initializes a new instance of <see cref="ChatClient"/>. </summary>
+    /// <param name="model"> The name of the model to use in requests sent to the service. To learn more about the available models, see <see href="https://platform.openai.com/docs/models"/>. </param>
+    /// <param name="authenticationPolicy"> The authentication policy used to authenticate with the service. </param>
+    /// <param name="options"> The options to configure the client. </param>
+    /// <exception cref="ArgumentNullException"> <paramref name="model"/> or <paramref name="authenticationPolicy"/> is null. </exception>
+    /// <exception cref="ArgumentException"> <paramref name="model"/> is an empty string, and was expected to be non-empty. </exception>
+    [Experimental("OPENAI001")]
+    public ChatClient(string model, AuthenticationPolicy authenticationPolicy, OpenAIClientOptions options)
     {
         Argument.AssertNotNullOrEmpty(model, nameof(model));
-        Argument.AssertNotNull(credential, nameof(credential));
+        Argument.AssertNotNull(authenticationPolicy, nameof(authenticationPolicy));
         options ??= new OpenAIClientOptions();
 
         _model = model;
-        Pipeline = OpenAIClient.CreatePipeline(credential, options);
+        Pipeline = OpenAIClient.CreatePipeline(authenticationPolicy, options);
         _endpoint = OpenAIClient.GetEndpoint(options);
         _telemetry = new OpenTelemetrySource(model, _endpoint);
     }
@@ -101,6 +124,7 @@ protected internal ChatClient(ClientPipeline pipeline, string model, OpenAIClien
     /// <summary>
     /// Gets the name of the model used in requests sent to the service.
     /// </summary>
+    [Experimental("OPENAI001")]
     public string Model => _model;
 
     /// <summary> Generates a completion for the given chat. </summary>

src/Custom/Embeddings/EmbeddingClient.cs

@@ -2,6 +2,7 @@
 using System.ClientModel;
 using System.ClientModel.Primitives;
 using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
 using System.IO;
 using System.Linq;
 using System.Text.Json;
@@ -92,6 +93,7 @@ protected internal EmbeddingClient(ClientPipeline pipeline, string model, OpenAI
     /// <summary>
     /// Gets the name of the model used in requests sent to the service.
     /// </summary>
+    [Experimental("OPENAI001")]
     public string Model => _model;
 
     // CUSTOM: Added to simplify generating a single embedding from a string input.
@@ -217,7 +219,7 @@ private void CreateEmbeddingGenerationOptions(string input, ref EmbeddingGenerat
         writer.WriteStringValue(input);
         writer.Flush();
 
-        options.Input = BinaryData.FromBytes(stream.ToArray());
+        options.Input = BinaryData.FromBytes(stream.GetBuffer().AsMemory(0, (int)stream.Length));
         options.Model = _model;
         options.EncodingFormat = InternalCreateEmbeddingRequestEncodingFormat.Base64;
     }
@@ -237,7 +239,7 @@ private void CreateEmbeddingGenerationOptions(IEnumerable<string> inputs, ref Em
         writer.WriteEndArray();
         writer.Flush();
 
-        options.Input = BinaryData.FromBytes(stream.ToArray());
+        options.Input = BinaryData.FromBytes(stream.GetBuffer().AsMemory(0, (int)stream.Length));
         options.Model = _model;
         options.EncodingFormat = InternalCreateEmbeddingRequestEncodingFormat.Base64;
     }
@@ -264,7 +266,7 @@ private void CreateEmbeddingGenerationOptions(IEnumerable<ReadOnlyMemory<int>> i
         writer.WriteEndArray();
         writer.Flush();
 
-        options.Input = BinaryData.FromBytes(stream.ToArray());
+        options.Input = BinaryData.FromBytes(stream.GetBuffer().AsMemory(0, (int)stream.Length));
         options.Model = _model;
         options.EncodingFormat = InternalCreateEmbeddingRequestEncodingFormat.Base64;
     }

src/Custom/Embeddings/OpenAIEmbedding.cs

@@ -4,6 +4,7 @@
 using System.Buffers.Text;
 using System.Collections.Generic;
 using System.Runtime.InteropServices;
+using System.Text.Json;
 
 namespace OpenAI.Embeddings;
 
@@ -107,13 +108,18 @@ internal OpenAIEmbedding(int index, ReadOnlyMemory<float> vector)
     // CUSTOM: Implemented custom logic to transform from BinaryData to ReadOnlyMemory<float>.
     private static ReadOnlyMemory<float> ConvertToVectorOfFloats(BinaryData binaryData)
     {
-        ReadOnlySpan<byte> base64 = binaryData.ToMemory().Span;
+        ReadOnlySpan<byte> bytes = binaryData.ToMemory().Span;
 
         // Remove quotes around base64 string.
-        if (base64.Length < 2 || base64[0] != (byte)'"' || base64[base64.Length - 1] != (byte)'"')
+        if (bytes.Length > 2 && bytes[0] == (byte)'"' && bytes[bytes.Length - 1] == (byte)'"')
         {
-            ThrowInvalidData();
+            return ConvertFromBase64(bytes);
         }
+        return ConvertFromJsonArray(binaryData);
+    }
+
+    private static ReadOnlyMemory<float> ConvertFromBase64(ReadOnlySpan<byte> base64)
+    {
         base64 = base64.Slice(1, base64.Length - 2);
 
         // Decode base64 string to bytes.
@@ -153,7 +159,33 @@ private static ReadOnlyMemory<float> ConvertToVectorOfFloats(BinaryData binaryDa
             }
         }
 
-        static void ThrowInvalidData() =>
-            throw new FormatException("The input is not a valid Base64 string of encoded floats.");
+        static void ThrowInvalidData()
+            => throw new FormatException("The input is not a valid Base64 string of encoded floats.");
+    }
+
+    private static ReadOnlyMemory<float> ConvertFromJsonArray(BinaryData jsonArray)
+    {
+        using JsonDocument document = JsonDocument.Parse(jsonArray);
+        JsonElement array = document.RootElement;
+        if (array.ValueKind != JsonValueKind.Array)
+        {
+            throw new FormatException("The input is not a valid JSON array");
+        }
+
+        int arrayLength = array.GetArrayLength();
+        float[] vector = new float[arrayLength];
+        int index = 0;
+        try
+        {
+            foreach (JsonElement value in array.EnumerateArray())
+            {
+                vector[index++] = value.GetSingle();
+            }
+            return vector.AsMemory();
+        }
+        catch
+        {
+            throw new FormatException("The input is not a valid JSON array of float values");
+        }
     }
 }

src/Custom/Images/ImageClient.cs

@@ -1,6 +1,7 @@
 using System;
 using System.ClientModel;
 using System.ClientModel.Primitives;
+using System.Diagnostics.CodeAnalysis;
 using System.IO;
 using System.Linq;
 using System.Threading;
@@ -86,10 +87,11 @@ protected internal ImageClient(ClientPipeline pipeline, string model, OpenAIClie
         Pipeline = pipeline;
         _endpoint = OpenAIClient.GetEndpoint(options);
     }
-    
+
     /// <summary>
     /// Gets the name of the model used in requests sent to the service.
     /// </summary>
+    [Experimental("OPENAI001")]
     public string Model => _model;
 
     #region GenerateImages