Streaming Client Result investigation - assistants

.dotnet/scripts/Add-Customizations.ps1

@@ -28,9 +28,13 @@ function Set-LangVersionToLatest {
     $root = Split-Path $PSScriptRoot -Parent
     $filePath = Join-Path -Path $root -ChildPath "tests\OpenAI.Tests.csproj"
     $xml = [xml](Get-Content -Path $filePath)
+
+    $xml.Project.PropertyGroup.TargetFramework = "net8.0"
+
     $element = $xml.CreateElement("LangVersion")
     $element.InnerText = "latest"
     $xml.Project.PropertyGroup.AppendChild($element) | Out-Null
+
     $xml.Save($filePath)
 }
 

.dotnet/scripts/Update-ClientModel.ps1

@@ -6,13 +6,13 @@ function Update-SystemClientModelPackage {
     $directory = Join-Path -Path $root -ChildPath "src"
     Set-Location -Path $directory
     dotnet remove "OpenAI.csproj" package "System.ClientModel"
-    dotnet add "OpenAI.csproj" package "System.ClientModel" --version "1.1.0-alpha.20240305.1" --source "https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-net/nuget/v3/index.json"
+    dotnet add "OpenAI.csproj" package "System.ClientModel" --version "1.1.0-alpha.20240319.1" --source "https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-net/nuget/v3/index.json"
 
     # Update System.ClientModel package in OpenAI.Tests.csproj
     $directory = Join-Path -Path $root -ChildPath "tests"
     Set-Location -Path $directory
     dotnet remove "OpenAI.Tests.csproj" package "System.ClientModel"
-    dotnet add "OpenAI.Tests.csproj" package "System.ClientModel" --version "1.1.0-alpha.20240305.1" --source "https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-net/nuget/v3/index.json"
+    dotnet add "OpenAI.Tests.csproj" package "System.ClientModel" --version "1.1.0-alpha.20240319.1" --source "https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-net/nuget/v3/index.json"
 
     Set-Location -Path $current
 }

.dotnet/src/Custom/Assistants/AssistantClient.Protocol.cs

@@ -122,7 +122,7 @@ public virtual async Task<ClientResult> GetAssistantFileAssociationAsync(
 
     /// <inheritdoc cref="Internal.Assistants.GetAssistantFiles(string, int?, string, string, string, RequestOptions)"/>
     [EditorBrowsable(EditorBrowsableState.Never)]
-    public virtual ClientResult GetAssistantFileAssociation(
+    public virtual ClientResult GetAssistantFileAssociations(
         string assistantId,
         int? maxResults,
         string createdSortOrder,
@@ -133,7 +133,7 @@ public virtual ClientResult GetAssistantFileAssociation(
 
     /// <inheritdoc cref="Internal.Assistants.GetAssistantFilesAsync(string, int?, string, string, string, RequestOptions)"/>
     [EditorBrowsable(EditorBrowsableState.Never)]
-    public virtual async Task<ClientResult> GetAssistantFileAssociationAsync(
+    public virtual async Task<ClientResult> GetAssistantFileAssociationsAsync(
         string assistantId,
         int? maxResults,
         string createdSortOrder,
@@ -248,6 +248,24 @@ public virtual async Task<ClientResult> GetMessageAsync(
         RequestOptions options)
         => await MessageShim.GetMessageAsync(threadId, messageId, options).ConfigureAwait(false);
 
+    /// <inheritdoc cref="Internal.Messages.ModifyMessage(string, string, BinaryContent, RequestOptions)"/>
+    [EditorBrowsable(EditorBrowsableState.Never)]
+    public virtual ClientResult ModifyMessage(
+        string threadId,
+        string messageId,
+        BinaryContent content,
+        RequestOptions options)
+        => MessageShim.ModifyMessage(threadId, messageId, content, options);
+
+    /// <inheritdoc cref="Internal.Messages.ModifyMessageAsync(string, string, BinaryContent, RequestOptions)"/>
+    [EditorBrowsable(EditorBrowsableState.Never)]
+    public virtual async Task<ClientResult> ModifyMessageAsync(
+        string threadId,
+        string messageId,
+        BinaryContent content,
+        RequestOptions options)
+        => await MessageShim.ModifyMessageAsync(threadId, messageId, content, options).ConfigureAwait(false);
+
     /// <inheritdoc cref="Internal.Messages.GetMessages(string, int?, string, string, string, RequestOptions)"/>
     [EditorBrowsable(EditorBrowsableState.Never)]
     public virtual ClientResult GetMessages(

.dotnet/src/Custom/Assistants/MessageModificationOptions.cs

@@ -0,0 +1,21 @@
+using System.Collections.Generic;
+
+namespace OpenAI.Assistants;
+
+/// <summary>
+/// Represents additional options available when modifying an existing <see cref="ThreadMessage"/>.
+/// </summary>
+public partial class MessageModificationOptions
+{
+    /// <summary>
+    /// A replacement for the optional key/value mapping of additional, supplemental data items to attach to the
+    /// <see cref="ThreadMessage"/>. This information may be useful for storing custom details in a structured format.
+    /// </summary>
+    /// <remarks>
+    /// <list type="bullet">
+    ///     <item><b>Keys</b> can be a maximum of 64 characters in length.</item>
+    ///     <item><b>Values</b> can be a maximum of 512 characters in length.</item>
+    /// </list>
+    /// </remarks>
+    public IDictionary<string, string> Metadata { get; } = new ChangeTrackingDictionary<string, string>();
+}

.dotnet/src/Custom/Assistants/ThreadModificationOptions.cs

@@ -1,6 +1,3 @@
-using OpenAI.ClientShared.Internal;
-using System.ClientModel.Internal;
-
 using System.Collections.Generic;
 
 namespace OpenAI.Assistants;

.dotnet/src/Custom/Assistants/ToolOutput.cs

@@ -19,9 +19,4 @@ public ToolOutput(string toolCallId, string output = null)
         Id = toolCallId;
         Output = output;
     }
-
-    [SetsRequiredMembers]
-    public ToolOutput(RequiredToolCall toolCall, string output = null)
-        : this(toolCall.Id, output)
-    { }
 }

.dotnet/src/Custom/Audio/AudioClient.Protocol.cs

@@ -1,6 +1,8 @@
-using System.ClientModel;
+using System;
+using System.ClientModel;
 using System.ClientModel.Primitives;
 using System.ComponentModel;
+using System.IO;
 using System.Threading.Tasks;
 
 namespace OpenAI.Audio;
@@ -16,4 +18,180 @@ public virtual ClientResult GenerateSpeechFromText(BinaryContent content, Reques
     [EditorBrowsable(EditorBrowsableState.Never)]
     public virtual async Task<ClientResult> GenerateSpeechFromTextAsync(BinaryContent content, RequestOptions options = null)
         => await Shim.CreateSpeechAsync(content, options).ConfigureAwait(false);
+
+    /// <summary>
+    /// [Protocol Method] Transcribes audio into the input language.
+    /// <list type="bullet">
+    /// <item>
+    /// <description>
+    /// This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
+    /// </description>
+    /// </item>
+    /// <item>
+    /// <description>
+    /// Please try the simpler <see cref="TranscribeAudio(BinaryData, string, AudioTranscriptionOptions)"/> or <see cref="TranscribeAudio(Stream, string, AudioTranscriptionOptions)"/> convenience overload with strongly typed models first.
+    /// </description>
+    /// </item>
+    /// </list>
+    /// </summary>
+    /// <param name="content"> The content to send as the body of the request. </param>
+    /// <param name="contentType"> The content type of the request. </param>
+    /// <param name="options"> The request options, which can override default behaviors of the client pipeline on a per-call basis. </param>
+    /// <exception cref="ArgumentNullException"> <paramref name="content"/> or <paramref name="contentType"/> is null. </exception>
+    /// <exception cref="ArgumentException"> <paramref name="contentType"/> is an empty string, and was expected to be non-empty. </exception>
+    /// <exception cref="ClientResultException"> Service returned a non-success status code. </exception>
+    /// <returns> The response returned from the service. </returns>
+    [EditorBrowsable(EditorBrowsableState.Never)]
+    public virtual ClientResult TranscribeAudio(BinaryContent content, string contentType, RequestOptions options = null)
+    {
+        Argument.AssertNotNull(content, nameof(content));
+        Argument.AssertNotNullOrEmpty(contentType, nameof(contentType));
+
+        options ??= new RequestOptions();
+
+        using PipelineMessage message = CreateCreateTranscriptionRequest(content, contentType, options);
+
+        Shim.Pipeline.Send(message);
+
+        PipelineResponse response = message.Response!;
+
+        if (response.IsError && options.ErrorOptions == ClientErrorBehaviors.Default)
+        {
+            throw new ClientResultException(response);
+        }
+
+        return ClientResult.FromResponse(response);
+    }
+
+    /// <summary>
+    /// [Protocol Method] Transcribes audio into the input language.
+    /// <list type="bullet">
+    /// <item>
+    /// <description>
+    /// This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
+    /// </description>
+    /// </item>
+    /// <item>
+    /// <description>
+    /// Please try the simpler <see cref="TranscribeAudioAsync(BinaryData, string, AudioTranscriptionOptions)"/> or <see cref="TranscribeAudioAsync(Stream, string, AudioTranscriptionOptions)"/> convenience overload with strongly typed models first.
+    /// </description>
+    /// </item>
+    /// </list>
+    /// </summary>
+    /// <param name="content"> The content to send as the body of the request. </param>
+    /// <param name="contentType"> The content type of the request. </param>
+    /// <param name="options"> The request options, which can override default behaviors of the client pipeline on a per-call basis. </param>
+    /// <exception cref="ArgumentNullException"> <paramref name="content"/> or <paramref name="contentType"/> is null. </exception>
+    /// <exception cref="ArgumentException"> <paramref name="contentType"/> is an empty string, and was expected to be non-empty. </exception>
+    /// <exception cref="ClientResultException"> Service returned a non-success status code. </exception>
+    /// <returns> The response returned from the service. </returns>
+    [EditorBrowsable(EditorBrowsableState.Never)]
+    public virtual async Task<ClientResult> TranscribeAudioAsync(BinaryContent content, string contentType, RequestOptions options = null)
+    {
+        Argument.AssertNotNull(content, nameof(content));
+        Argument.AssertNotNullOrEmpty(contentType, nameof(contentType));
+
+        options ??= new RequestOptions();
+
+        using PipelineMessage message = CreateCreateTranscriptionRequest(content, contentType, options);
+
+        Shim.Pipeline.Send(message);
+
+        PipelineResponse response = message.Response!;
+
+        if (response.IsError && options.ErrorOptions == ClientErrorBehaviors.Default)
+        {
+            throw await ClientResultException.CreateAsync(response).ConfigureAwait(false);
+        }
+
+        return ClientResult.FromResponse(response);
+    }
+
+    /// <summary>
+    /// [Protocol Method] Translates audio into English.
+    /// <list type="bullet">
+    /// <item>
+    /// <description>
+    /// This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
+    /// </description>
+    /// </item>
+    /// <item>
+    /// <description>
+    /// Please try the simpler <see cref="TranslateAudio(BinaryData, string, AudioTranslationOptions)"/> or <see cref="TranslateAudio(Stream, string, AudioTranslationOptions)"/> convenience overload with strongly typed models first.
+    /// </description>
+    /// </item>
+    /// </list>
+    /// </summary>
+    /// <param name="content"> The content to send as the body of the request. </param>
+    /// <param name="contentType"> The content type of the request. </param>
+    /// <param name="options"> The request options, which can override default behaviors of the client pipeline on a per-call basis. </param>
+    /// <exception cref="ArgumentNullException"> <paramref name="content"/> is null. </exception>
+    /// <exception cref="ArgumentException"> <paramref name="contentType"/> is an empty string, and was expected to be non-empty. </exception>
+    /// <exception cref="ClientResultException"> Service returned a non-success status code. </exception>
+    /// <returns> The response returned from the service. </returns>
+    [EditorBrowsable(EditorBrowsableState.Never)]
+    public virtual ClientResult TranslateAudio(BinaryContent content, string contentType, RequestOptions options = null)
+    {
+        Argument.AssertNotNull(content, nameof(content));
+        Argument.AssertNotNullOrEmpty(contentType, nameof(contentType));
+
+        options ??= new RequestOptions();
+
+        using PipelineMessage message = CreateCreateTranslationRequest(content, contentType, options);
+
+        Shim.Pipeline.Send(message);
+
+        PipelineResponse response = message.Response!;
+
+        if (response.IsError && options.ErrorOptions == ClientErrorBehaviors.Default)
+        {
+            throw new ClientResultException(response);
+        }
+
+        return ClientResult.FromResponse(response);
+    }
+
+    /// <summary>
+    /// [Protocol Method] Translates audio into English.
+    /// <list type="bullet">
+    /// <item>
+    /// <description>
+    /// This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
+    /// </description>
+    /// </item>
+    /// <item>
+    /// <description>
+    /// Please try the simpler <see cref="TranslateAudioAsync(BinaryData, string, AudioTranslationOptions)"/> or <see cref="TranslateAudioAsync(Stream, string, AudioTranslationOptions)"/> convenience overload with strongly typed models first.
+    /// </description>
+    /// </item>
+    /// </list>
+    /// </summary>
+    /// <param name="content"> The content to send as the body of the request. </param>
+    /// <param name="contentType"> The content type of the request. </param>
+    /// <param name="options"> The request options, which can override default behaviors of the client pipeline on a per-call basis. </param>
+    /// <exception cref="ArgumentNullException"> <paramref name="content"/> is null. </exception>
+    /// <exception cref="ArgumentException"> <paramref name="contentType"/> is an empty string, and was expected to be non-empty. </exception>
+    /// <exception cref="ClientResultException"> Service returned a non-success status code. </exception>
+    /// <returns> The response returned from the service. </returns>
+    [EditorBrowsable(EditorBrowsableState.Never)]
+    public virtual async Task<ClientResult> TranslateAudioAsync(BinaryContent content, string contentType, RequestOptions options = null)
+    {
+        Argument.AssertNotNull(content, nameof(content));
+        Argument.AssertNotNullOrEmpty(contentType, nameof(contentType));
+
+        options ??= new RequestOptions();
+
+        using PipelineMessage message = CreateCreateTranslationRequest(content, contentType, options);
+
+        Shim.Pipeline.Send(message);
+
+        PipelineResponse response = message.Response!;
+
+        if (response.IsError && options.ErrorOptions == ClientErrorBehaviors.Default)
+        {
+            throw await ClientResultException.CreateAsync(response).ConfigureAwait(false);
+        }
+
+        return ClientResult.FromResponse(response);
+    }
 }