Add convenience layer to FineTuning with tests

.dotnet.azure/sdk/openai/Azure.AI.OpenAI/src/Custom/AzureOpenAIClient.cs

@@ -15,6 +15,10 @@
 global using OpenAI.VectorStores;
 #if !AZURE_OPENAI_GA
 global using OpenAI.RealtimeConversation;
+using Azure.AI.OpenAI.Assistants;
+using Azure.AI.OpenAI.FineTuning;
+using Azure.AI.OpenAI.RealtimeConversation;
+using Azure.AI.OpenAI.VectorStores;
 #endif
 
 using System.ClientModel;
@@ -29,13 +33,6 @@
 using Azure.AI.OpenAI.Images;
 using Azure.Core;
 
-#if !AZURE_OPENAI_GA
-using Azure.AI.OpenAI.Assistants;
-using Azure.AI.OpenAI.FineTuning;
-using Azure.AI.OpenAI.RealtimeConversation;
-using Azure.AI.OpenAI.VectorStores;
-#endif
-
 #pragma warning disable AZC0007
 
 namespace Azure.AI.OpenAI;

.dotnet.azure/sdk/openai/Azure.AI.OpenAI/src/Custom/FineTuning/AzureFineTuningClient.Protocol.cs

@@ -6,72 +6,67 @@
 using System.ClientModel;
 using System.ClientModel.Primitives;
 using System.Text.Json;
+using System.Linq;
+using Azure.AI.OpenAI.Utility;
 
 namespace Azure.AI.OpenAI.FineTuning;
 
 internal partial class AzureFineTuningClient : FineTuningClient
 {
-    public override async Task<FineTuningJobOperation> CreateFineTuningJobAsync(
+    public override async Task<FineTuningJob> FineTuneAsync(
         BinaryContent content,
         bool waitUntilCompleted,
         RequestOptions options = null)
     {
         Argument.AssertNotNull(content, nameof(content));
 
-        using PipelineMessage message = CreateCreateFineTuningJobRequest(content, options);
+        using PipelineMessage message = PostJobPipelineMessage(content, options);
         PipelineResponse response = await Pipeline.ProcessMessageAsync(message, options).ConfigureAwait(false);
 
         using JsonDocument doc = JsonDocument.Parse(response.Content);
         string jobId = doc.RootElement.GetProperty("id"u8).GetString();
         string status = doc.RootElement.GetProperty("status"u8).GetString();
 
-        AzureFineTuningJobOperation operation = new(Pipeline, _endpoint, jobId, status, response, _apiVersion);
+        AzureFineTuningJob operation = new(Pipeline, _endpoint, response, _apiVersion);
         return await operation.WaitUntilAsync(waitUntilCompleted, options).ConfigureAwait(false);
     }
 
-    public override FineTuningJobOperation CreateFineTuningJob(
+    public override FineTuningJob FineTune(
         BinaryContent content,
         bool waitUntilCompleted,
         RequestOptions options = null)
     {
         Argument.AssertNotNull(content, nameof(content));
 
-        using PipelineMessage message = CreateCreateFineTuningJobRequest(content, options);
+        using PipelineMessage message = PostJobPipelineMessage(content, options);
         PipelineResponse response = Pipeline.ProcessMessage(message, options);
 
         using JsonDocument doc = JsonDocument.Parse(response.Content);
         string jobId = doc.RootElement.GetProperty("id"u8).GetString();
         string status = doc.RootElement.GetProperty("status"u8).GetString();
 
-        AzureFineTuningJobOperation operation = new(Pipeline, _endpoint, jobId, status, response, _apiVersion);
+        AzureFineTuningJob operation = new(Pipeline, _endpoint, response, _apiVersion);
         return operation.WaitUntil(waitUntilCompleted, options);
     }
 
-    public override AsyncCollectionResult GetJobsAsync(string after, int? limit, RequestOptions options)
+    internal override AsyncCollectionResult GetJobsAsync(string afterJobId, int? pageSize, RequestOptions options)
     {
-        return new AsyncFineTuningJobCollectionResult(this, Pipeline, options, limit, after);
+        return new AzureAsyncCollectionResult<FineTuningJob, FineTuningCollectionPageToken>(
+            Pipeline,
+            options,
+            continuation => GetJobsPipelineMessage(continuation?.After, pageSize, options),
+            page => FineTuningCollectionPageToken.FromResponse(page, pageSize),
+            page => GetJobsFromResponse(page.GetRawResponse()),
+            options?.CancellationToken ?? default
+            );
     }
 
-    public override CollectionResult GetJobs(string after, int? limit, RequestOptions options)
+    private IEnumerable<FineTuningJob> GetJobsFromResponse(PipelineResponse response)
     {
-        return new FineTuningJobCollectionResult(this, Pipeline, options, limit, after);
+        InternalListPaginatedFineTuningJobsResponse jobs = ModelReaderWriter.Read<InternalListPaginatedFineTuningJobsResponse>(response.Content)!;
+        return jobs.Data.Select(job => new AzureFineTuningJob(Pipeline, _endpoint, response, _apiVersion, job));
     }
-
-    public override async Task<ClientResult> GetJobAsync(string fineTuningJobId, RequestOptions options)
-    {
-        using PipelineMessage message = CreateRetrieveFineTuningJobRequest(fineTuningJobId, options);
-        return ClientResult.FromResponse(await Pipeline.ProcessMessageAsync(message, options).ConfigureAwait(false));
-    }
-
-    public override ClientResult GetJob(string fineTuningJobId, RequestOptions options)
-    {
-        Argument.AssertNotNullOrEmpty(fineTuningJobId, nameof(fineTuningJobId));
-
-        using PipelineMessage message = CreateRetrieveFineTuningJobRequest(fineTuningJobId, options);
-        return ClientResult.FromResponse(Pipeline.ProcessMessage(message, options));
-    }
-
-    internal override PipelineMessage CreateCreateFineTuningJobRequest(BinaryContent content, RequestOptions options)
+    internal override PipelineMessage PostJobPipelineMessage(BinaryContent content, RequestOptions options)
         => new AzureOpenAIPipelineMessageBuilder(Pipeline, _endpoint, _apiVersion)
             .WithMethod("POST")
             .WithPath("fine_tuning", "jobs")
@@ -80,7 +75,7 @@ internal override PipelineMessage CreateCreateFineTuningJobRequest(BinaryContent
             .WithOptions(options)
             .Build();
 
-    internal override PipelineMessage CreateGetPaginatedFineTuningJobsRequest(string after, int? limit, RequestOptions options)
+    internal override PipelineMessage GetJobsPipelineMessage(string after, int? limit, RequestOptions options)
         => new AzureOpenAIPipelineMessageBuilder(Pipeline, _endpoint, _apiVersion)
             .WithMethod("GET")
             .WithPath("fine_tuning", "jobs")
@@ -90,13 +85,13 @@ internal override PipelineMessage CreateGetPaginatedFineTuningJobsRequest(string
             .WithOptions(options)
             .Build();
 
-    internal override PipelineMessage CreateRetrieveFineTuningJobRequest(string fineTuningJobId, RequestOptions options)
-        => new AzureOpenAIPipelineMessageBuilder(Pipeline, _endpoint, _apiVersion)
-            .WithMethod("GET")
-            .WithPath("fine_tuning", "jobs", fineTuningJobId)
-            .WithAccept("application/json")
-            .WithOptions(options)
-            .Build();
+    //internal static new PipelineMessage GetJobPipelineMessage(ClientPipeline clientPipeline, Uri endpoint, string fineTuningJobId, RequestOptions options)
+    //    => new AzureOpenAIPipelineMessageBuilder(clientPipeline, endpoint, _apiVersion)
+    //        .WithMethod("GET")
+    //        .WithPath("fine_tuning", "jobs", fineTuningJobId)
+    //        .WithAccept("application/json")
+    //        .WithOptions(options)
+    //        .Build();
 
     private static bool TryGetLastId(ClientResult previous, out string lastId)
     {

.dotnet.azure/sdk/openai/Azure.AI.OpenAI/src/Custom/FineTuning/AzureFineTuningClient.cs

@@ -5,6 +5,8 @@
 
 using System.ClientModel;
 using System.ClientModel.Primitives;
+using System.Diagnostics.CodeAnalysis;
+using System.Net;
 
 namespace Azure.AI.OpenAI.FineTuning;
 
@@ -14,12 +16,15 @@ namespace Azure.AI.OpenAI.FineTuning;
 /// <remarks>
 /// To retrieve an instance of this type, use the matching method on <see cref="AzureOpenAIClient"/>.
 /// </remarks>
+[Experimental("OPENAI001")]
 internal partial class AzureFineTuningClient : FineTuningClient
 {
     private readonly Uri _endpoint;
     private readonly string _apiVersion;
 
+    [Experimental("OPENAI001")]
     internal AzureFineTuningClient(ClientPipeline pipeline, Uri endpoint, AzureOpenAIClientOptions options)
+//        : base(pipeline, new OpenAIClientOptions() { Endpoint = endpoint })
         : base(pipeline, new OpenAIClientOptions() { Endpoint = endpoint })
     {
         Argument.AssertNotNull(pipeline, nameof(pipeline));
@@ -30,12 +35,45 @@ internal AzureFineTuningClient(ClientPipeline pipeline, Uri endpoint, AzureOpenA
         _apiVersion = options.GetRawServiceApiValueForClient(this);
     }
 
+    [Experimental("OPENAI001")]
     protected AzureFineTuningClient()
     { }
 
-    internal override FineTuningJobOperation CreateCreateJobOperation(string jobId, string status, PipelineResponse response)
+    /// <summary>
+    /// Get FineTuningJob for a previously started fine-tuning job.
+    ///
+    /// [Learn more about fine-tuning](/docs/guides/fine-tuning)
+    /// </summary>
+    /// <param name="JobId"> The ID of the fine-tuning job. </param>
+    /// <param name="cancellationToken"> The cancellation token. </param>
+    public override FineTuningJob GetJob(string JobId, CancellationToken cancellationToken = default)
     {
-        return new AzureFineTuningJobOperation(Pipeline, _endpoint, jobId, status, response, _apiVersion);
+        return AzureFineTuningJob.Rehydrate(this, JobId, cancellationToken.ToRequestOptions());
+    }
+
+    /// <summary>
+    /// Get FineTuningJob for a previously started fine-tuning job.
+    ///
+    /// [Learn more about fine-tuning](/docs/guides/fine-tuning)
+    /// </summary>
+    /// <param name="JobId"> The ID of the fine-tuning job. </param>
+    /// <param name="cancellationToken"> The cancellation token. </param>
+    public override async Task<FineTuningJob> GetJobAsync(string JobId, CancellationToken cancellationToken = default)
+    {
+        return await AzureFineTuningJob.RehydrateAsync(this, JobId, cancellationToken.ToRequestOptions()).ConfigureAwait(false);
+    }
+
+    //public override AsyncCollectionResult<AzureFineTuningJob> GetJobsAsync(FineTuningJobCollectionOptions options = default, CancellationToken cancellationToken = default)
+    //{
+    //    options ??= new FineTuningJobCollectionOptions();
+    //    AsyncCollectionResult<AzureFineTuningJob> jobs = (AsyncCollectionResult<AzureFineTuningJob>)GetJobsAsync(options.AfterJobId, options.PageSize, cancellationToken.ToRequestOptions());
+    //    return (AsyncCollectionResult<AzureFineTuningJob>)jobs;
+    //}
+
+    [Experimental("OPENAI001")]
+    internal override FineTuningJob CreateJobFromResponse(PipelineResponse response)
+    {
+        return new AzureFineTuningJob(Pipeline, _endpoint, response, _apiVersion);
     }
 }
 

.dotnet.azure/sdk/openai/Azure.AI.OpenAI/src/Custom/FineTuning/AzureFineTuningJob.Protocol.cs

@@ -0,0 +1,165 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using System.ClientModel;
+using System.ClientModel.Primitives;
+using System.Diagnostics.CodeAnalysis;
+
+#if !AZURE_OPENAI_GA
+
+#nullable enable
+
+namespace Azure.AI.OpenAI.FineTuning;
+
+/// <summary>
+/// A long-running operation for creating a new model from a given dataset.
+/// </summary>
+[Experimental("OPENAI001")]
+internal partial class AzureFineTuningJob : FineTuningJob
+{
+    private readonly PipelineMessageClassifier _deleteJobClassifier;
+    internal new readonly ClientPipeline _pipeline;
+    private readonly Uri _endpoint;
+    private readonly string _apiVersion;
+    internal new readonly FineTuningClient _client;
+
+    internal AzureFineTuningJob(
+        ClientPipeline pipeline,
+        Uri endpoint,
+        PipelineResponse response,
+        string apiVersion)
+        : base(pipeline, endpoint, response)
+    {
+        _pipeline = pipeline;
+        _endpoint = endpoint;
+        _apiVersion = apiVersion;
+        _client = new AzureFineTuningClient(_pipeline, _endpoint, null);
+
+        _deleteJobClassifier = PipelineMessageClassifier.Create(stackalloc ushort[] { 204 });
+
+    }
+
+    internal AzureFineTuningJob(
+        ClientPipeline pipeline,
+        Uri endpoint,
+        PipelineResponse response,
+        string apiVersion,
+        InternalFineTuningJob internalJob)
+            : base(pipeline, endpoint, internalJob, response)
+    {
+        _pipeline = pipeline;
+        _endpoint = endpoint;
+        _apiVersion = apiVersion;
+        _client = new AzureFineTuningClient(_pipeline, _endpoint, null);
+
+        _deleteJobClassifier = PipelineMessageClassifier.Create(stackalloc ushort[] { 204 });
+    }
+
+    [Experimental("AOAI001")]
+    public virtual ClientResult DeleteJob(string fineTuningJobId, RequestOptions? options)
+    {
+        using PipelineMessage message = CreateDeleteJobRequestMessage(fineTuningJobId, options);
+        return ClientResult.FromResponse(_pipeline.ProcessMessage(message, options));
+    }
+
+    [Experimental("AOAI001")]
+    public virtual async Task<ClientResult> DeleteJobAsync(string fineTuningJobId, RequestOptions? options)
+    {
+        using PipelineMessage message = CreateDeleteJobRequestMessage(fineTuningJobId, options);
+        PipelineResponse response = await _pipeline.ProcessMessageAsync(message, options).ConfigureAwait(false);
+        return ClientResult.FromResponse(response);
+    }
+
+    private PipelineMessage CreateDeleteJobRequestMessage(string fineTuningJobId, RequestOptions? options)
+    => new AzureOpenAIPipelineMessageBuilder(_pipeline, _endpoint, _apiVersion)
+        .WithMethod("DELETE")
+        .WithPath("fine_tuning", "jobs", fineTuningJobId)
+        .WithAccept("application/json")
+        .WithClassifier(_deleteJobClassifier)
+        .WithOptions(options)
+        .Build();
+
+    // TODO use this
+    internal PipelineMessage CancelPipelineMessage(string fineTuningJobId, RequestOptions? options)
+    => new AzureOpenAIPipelineMessageBuilder(_pipeline, _endpoint, _apiVersion)
+        .WithMethod("POST")
+        .WithPath("fine_tuning", "jobs", fineTuningJobId, "cancel")
+        .WithAccept("application/json")
+        .WithOptions(options)
+        .Build();
+
+    /// <summary>
+    /// [Protocol Method] List the checkpoints for a fine-tuning job.
+    /// </summary>
+    /// <param name="after"> Identifier for the last checkpoint ID from the previous pagination request. </param>
+    /// <param name="limit"> Number of checkpoints to retrieve. </param>
+    /// <param name="options"> The request options, which can override default behaviors of the client pipeline on a per-call basis. </param>
+    /// <exception cref="ClientResultException"> Service returned a non-success status code. </exception>
+    /// <returns> The response returned from the service. </returns>
+    public override AsyncCollectionResult GetCheckpointsAsync(string? after, int? limit, RequestOptions? options)
+    {
+        return new AsyncFineTuningCheckpointCollectionResult(this, options, limit, after);
+    }
+
+    /// <summary>
+    /// [Protocol Method] List the checkpoints for a fine-tuning job.
+    /// </summary>
+    /// <param name="after"> Identifier for the last checkpoint ID from the previous pagination request. </param>
+    /// <param name="limit"> Number of checkpoints to retrieve. </param>
+    /// <param name="options"> The request options, which can override default behaviors of the client pipeline on a per-call basis. </param>
+    /// <exception cref="ClientResultException"> Service returned a non-success status code. </exception>
+    /// <returns> The response returned from the service. </returns>
+    internal override async Task<ClientResult> GetCheckpointsPageAsync(string? after, int? limit, RequestOptions? options)
+    {
+        using PipelineMessage message = GetCheckpointsPipelineMessage(JobId, after, limit, options);
+        return ClientResult.FromResponse(await _pipeline.ProcessMessageAsync(message, options).ConfigureAwait(false));
+    }
+
+    /// <summary>
+    /// [Protocol Method] List the checkpoints for a fine-tuning job.
+    /// </summary>
+    /// <param name="after"> Identifier for the last checkpoint ID from the previous pagination request. </param>
+    /// <param name="limit"> Number of checkpoints to retrieve. </param>
+    /// <param name="options"> The request options, which can override default behaviors of the client pipeline on a per-call basis. </param>
+    /// <exception cref="ClientResultException"> Service returned a non-success status code. </exception>
+    /// <returns> The response returned from the service. </returns>
+    internal override ClientResult GetCheckpointsPage(string? after, int? limit, RequestOptions? options)
+    {
+        using PipelineMessage message = GetCheckpointsPipelineMessage(JobId, after, limit, options);
+        return ClientResult.FromResponse(_pipeline.ProcessMessage(message, options));
+    }
+
+    internal PipelineMessage GetCheckpointsPipelineMessage(string fineTuningJobId, string? after, int? limit, RequestOptions? options)
+    => new AzureOpenAIPipelineMessageBuilder(_pipeline, _endpoint, _apiVersion)
+        .WithMethod("GET")
+        .WithPath("fine_tuning", "jobs", fineTuningJobId, "checkpoints")
+        .WithOptionalQueryParameter("after", after)
+        .WithOptionalQueryParameter("limit", limit)
+        .WithAccept("application/json")
+        .WithOptions(options)
+        .Build();
+
+    internal override async Task<ClientResult> GetEventsPageAsync(string? after, int? limit, RequestOptions? options)
+    {
+        using PipelineMessage message = GetEventsPipelineMessage(JobId, after, limit, options);
+        return ClientResult.FromResponse(await _pipeline.ProcessMessageAsync(message, options).ConfigureAwait(false));
+    }
+
+    internal override ClientResult GetEventsPage(string? after, int? limit, RequestOptions? options)
+    {
+        using PipelineMessage message = GetEventsPipelineMessage(JobId, after, limit, options);
+        return ClientResult.FromResponse(_pipeline.ProcessMessage(message, options));
+    }
+
+    internal PipelineMessage GetEventsPipelineMessage(string fineTuningJobId, string? after, int? limit, RequestOptions? options)
+    => new AzureOpenAIPipelineMessageBuilder(_pipeline, _endpoint, _apiVersion)
+        .WithMethod("GET")
+        .WithPath("fine_tuning", "jobs", fineTuningJobId, "events")
+        .WithOptionalQueryParameter("after", after)
+        .WithOptionalQueryParameter("limit", limit)
+        .WithAccept("application/json")
+        .WithOptions(options)
+        .Build();
+}
+
+#endif