Add an example

Author: ShivangiReja

api/OpenAI.net8.0.cs

@@ -38,7 +38,7 @@ public class OpenAIClient {
         [Experimental("OPENAI001")]
         public virtual VectorStoreClient GetVectorStoreClient();
         [Experimental("OPENAI001")]
-        public virtual Videos.VideosClient GetVideosClient();
+        public virtual Videos.VideoClient GetVideoClient();
     }
     public class OpenAIClientOptions : ClientPipelineOptions {
         public Uri Endpoint { get; set; }
@@ -6820,14 +6820,14 @@ public enum VectorStoreStatus {
 }
 namespace OpenAI.Videos {
     [Experimental("OPENAI001")]
-    public class VideosClient {
-        protected VideosClient();
-        public VideosClient(ApiKeyCredential credential, OpenAIClientOptions options);
-        public VideosClient(ApiKeyCredential credential);
-        public VideosClient(AuthenticationPolicy authenticationPolicy, OpenAIClientOptions options);
-        public VideosClient(AuthenticationPolicy authenticationPolicy);
-        protected internal VideosClient(ClientPipeline pipeline, OpenAIClientOptions options);
-        public VideosClient(string apiKey);
+    public class VideoClient {
+        protected VideoClient();
+        public VideoClient(ApiKeyCredential credential, OpenAIClientOptions options);
+        public VideoClient(ApiKeyCredential credential);
+        public VideoClient(AuthenticationPolicy authenticationPolicy, OpenAIClientOptions options);
+        public VideoClient(AuthenticationPolicy authenticationPolicy);
+        protected internal VideoClient(ClientPipeline pipeline, OpenAIClientOptions options);
+        public VideoClient(string apiKey);
         [Experimental("OPENAI001")]
         public Uri Endpoint { get; }
         public ClientPipeline Pipeline { get; }

api/OpenAI.netstandard2.0.cs

@@ -25,7 +25,7 @@ public class OpenAIClient {
         public virtual OpenAIResponseClient GetOpenAIResponseClient(string model);
         public virtual RealtimeClient GetRealtimeClient();
         public virtual VectorStoreClient GetVectorStoreClient();
-        public virtual Videos.VideosClient GetVideosClient();
+        public virtual Videos.VideoClient GetVideoClient();
     }
     public class OpenAIClientOptions : ClientPipelineOptions {
         public Uri Endpoint { get; set; }
@@ -6010,14 +6010,14 @@ public enum VectorStoreStatus {
     }
 }
 namespace OpenAI.Videos {
-    public class VideosClient {
-        protected VideosClient();
-        public VideosClient(ApiKeyCredential credential, OpenAIClientOptions options);
-        public VideosClient(ApiKeyCredential credential);
-        public VideosClient(AuthenticationPolicy authenticationPolicy, OpenAIClientOptions options);
-        public VideosClient(AuthenticationPolicy authenticationPolicy);
-        protected internal VideosClient(ClientPipeline pipeline, OpenAIClientOptions options);
-        public VideosClient(string apiKey);
+    public class VideoClient {
+        protected VideoClient();
+        public VideoClient(ApiKeyCredential credential, OpenAIClientOptions options);
+        public VideoClient(ApiKeyCredential credential);
+        public VideoClient(AuthenticationPolicy authenticationPolicy, OpenAIClientOptions options);
+        public VideoClient(AuthenticationPolicy authenticationPolicy);
+        protected internal VideoClient(ClientPipeline pipeline, OpenAIClientOptions options);
+        public VideoClient(string apiKey);
         public Uri Endpoint { get; }
         public ClientPipeline Pipeline { get; }
         public virtual ClientResult CreateVideo(BinaryContent content, string contentType, RequestOptions options = null);

examples/OpenAI.Examples.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <TargetFramework>net9.0</TargetFramework>
 

examples/VectorStore/Example01_VectorStoreCreationAsync.cs

@@ -5,7 +5,6 @@
 using System;
 using System.ClientModel;
 using System.Collections.Generic;
-using System.Threading;
 using System.Threading.Tasks;
 
 namespace OpenAI.Examples;

examples/Videos/Example01_VideoCreation.cs

@@ -0,0 +1,52 @@
+using NUnit.Framework;
+using NUnit.Framework.Internal;
+using OpenAI.Videos;
+using System;
+using System.ClientModel;
+using System.Collections.Generic;
+using System.Diagnostics.Contracts;
+using System.IO;
+using System.Net.Http;
+using System.Text;
+using System.Text.Json;
+using System.Threading.Tasks;
+
+namespace OpenAI.Examples;
+
+// This example uses experimental APIs which are subject to change. To use experimental APIs,
+// please acknowledge their experimental status by suppressing the corresponding warning.
+#pragma warning disable OPENAI001
+
+public partial class VectorStoreExamples
+{
+    [Test]
+    public void Example01_SimpleVideoCreation()
+    {
+        // 1) Create the client
+        VideoClient client = new(new ApiKeyCredential(Environment.GetEnvironmentVariable("OPENAI_API_KEY")));
+
+        // 2) Build the multipart/form-data payload with an explicit boundary
+        var boundary = Guid.NewGuid().ToString();
+        var contentType = $"multipart/form-data; boundary=\"{boundary}\"";
+        using var multipart = new MultipartFormDataContent(boundary);
+
+        multipart.Add(new StringContent("sora-2", Encoding.UTF8, "text/plain"), "model");
+        multipart.Add(new StringContent("A calico cat playing a piano on stage", Encoding.UTF8, "text/plain"), "prompt");
+
+        // 3) Get a stream for the multipart body
+        using var bodyStream = multipart.ReadAsStream();
+
+        // 4) Send the request
+        var createResult = client.CreateVideo(BinaryContent.Create(bodyStream), contentType);
+        var createRaw = createResult.GetRawResponse().Content;
+
+        // 5) Parse the JSON response
+        using var createdDoc = JsonDocument.Parse(createRaw);
+        var id = createdDoc.RootElement.GetProperty("id").GetString();
+        var status = createdDoc.RootElement.GetProperty("status").GetString();
+
+        Console.WriteLine($"CreateVideo => id: {id}, status: {status}");
+    }
+}
+
+#pragma warning restore OPENAI001

examples/Videos/Example01_VideoCreationAsync.cs

@@ -0,0 +1,49 @@
+using NUnit.Framework;
+using NUnit.Framework.Internal;
+using OpenAI.Videos;
+using System;
+using System.ClientModel;
+using System.Net.Http;
+using System.Text;
+using System.Text.Json;
+using System.Threading.Tasks;
+
+namespace OpenAI.Examples;
+
+// This example uses experimental APIs which are subject to change. To use experimental APIs,
+// please acknowledge their experimental status by suppressing the corresponding warning.
+#pragma warning disable OPENAI001
+
+public partial class VectorStoreExamples
+{
+    [Test]
+    public async Task Example01_SimpleVideoCreationAsync()
+    {
+        // 1) Create the client
+        VideoClient client = new(new ApiKeyCredential(Environment.GetEnvironmentVariable("OPENAI_API_KEY")));
+
+        // 2) Build the multipart/form-data payload with an explicit boundary
+        var boundary = Guid.NewGuid().ToString();
+        var contentType = $"multipart/form-data; boundary=\"{boundary}\"";
+        using var multipart = new MultipartFormDataContent(boundary);
+
+        multipart.Add(new StringContent("sora-2", Encoding.UTF8, "text/plain"), "model");
+        multipart.Add(new StringContent("A calico cat playing a piano on stage", Encoding.UTF8, "text/plain"), "prompt");
+
+        // 3) Get a stream for the multipart body
+        using var bodyStream = await multipart.ReadAsStreamAsync();
+
+        // 4) Send the request
+        var createResult = await client.CreateVideoAsync(BinaryContent.Create(bodyStream), contentType);
+        var createRaw = createResult.GetRawResponse().Content;
+
+        // 5) Parse the JSON response
+        using var createdDoc = JsonDocument.Parse(createRaw);
+        var id = createdDoc.RootElement.GetProperty("id").GetString();
+        var status = createdDoc.RootElement.GetProperty("status").GetString();
+
+        Console.WriteLine($"CreateVideo => id: {id}, status: {status}");
+    }
+}
+
+#pragma warning restore OPENAI001

src/Custom/OpenAIClient.cs

@@ -50,7 +50,7 @@ namespace OpenAI;
 [CodeGenSuppress("_cachedRealtimeClient")]
 [CodeGenSuppress("_cachedOpenAIResponseClient")]
 [CodeGenSuppress("_cachedVectorStoreClient")]
-[CodeGenSuppress("_cachedVideosClient")]
+[CodeGenSuppress("_cachedVideoClient")]
 [CodeGenSuppress("_cachedInternalAssistantMessageClient")]
 [CodeGenSuppress("_cachedInternalAssistantRunClient")]
 [CodeGenSuppress("_cachedInternalAssistantThreadClient")]
@@ -72,7 +72,7 @@ namespace OpenAI;
 [CodeGenSuppress("GetRealtimeClient")]
 [CodeGenSuppress("GetOpenAIResponseClient")]
 [CodeGenSuppress("GetVectorStoreClient")]
-[CodeGenSuppress("GetVideosClient")]
+[CodeGenSuppress("GetVideoClient")]
 [CodeGenSuppress("GetInternalAssistantMessageClient")]
 [CodeGenSuppress("GetInternalAssistantRunClient")]
 [CodeGenSuppress("GetInternalAssistantThreadClient")]
@@ -344,19 +344,19 @@ protected internal OpenAIClient(ClientPipeline pipeline, OpenAIClientOptions opt
     [Experimental("OPENAI001")]
     public virtual ContainerClient GetContainerClient() => new(Pipeline, _options);
 
-    internal static AuthenticationPolicy CreateApiKeyAuthenticationPolicy(ApiKeyCredential credential)
-    {
-        Argument.AssertNotNull(credential, nameof(credential));
-        return ApiKeyAuthenticationPolicy.CreateHeaderApiKeyPolicy(credential, AuthorizationHeader, AuthorizationApiKeyPrefix);
-    }
-
     /// <summary>
-    /// Gets a new instance of <see cref="VideosClient"/> that reuses the client configuration details provided to
+    /// Gets a new instance of <see cref="VideoClient"/> that reuses the client configuration details provided to
     /// the <see cref="OpenAIClient"/> instance.
     /// </summary>
     /// <returns></returns>
     [Experimental("OPENAI001")]
-    public virtual VideosClient GetVideosClient() => new(Pipeline, _options);
+    public virtual VideoClient GetVideoClient() => new(Pipeline, _options);
+
+    internal static AuthenticationPolicy CreateApiKeyAuthenticationPolicy(ApiKeyCredential credential)
+    {
+        Argument.AssertNotNull(credential, nameof(credential));
+        return ApiKeyAuthenticationPolicy.CreateHeaderApiKeyPolicy(credential, AuthorizationHeader, AuthorizationApiKeyPrefix);
+    }
 
     internal static ClientPipeline CreatePipeline(AuthenticationPolicy authenticationPolicy, OpenAIClientOptions options)
     {

src/Custom/Videos/VideosClient.cs renamed to src/Custom/Videos/VideoClient.cs

@@ -11,43 +11,43 @@ namespace OpenAI.Videos;
 // - Suppressed methods that only take the options parameter.
 /// <summary> The service client for OpenAI video operations. </summary>
 [CodeGenType("Videos")]
-[CodeGenSuppress("VideosClient", typeof(ClientPipeline), typeof(Uri))]
-public partial class VideosClient
+[CodeGenSuppress("VideoClient", typeof(ClientPipeline), typeof(Uri))]
+public partial class VideoClient
 {
     // CUSTOM: Added as a convenience.
-    /// <summary> Initializes a new instance of <see cref="VideosClient"/>. </summary>
+    /// <summary> Initializes a new instance of <see cref="VideoClient"/>. </summary>
     /// <param name="apiKey"> The API key to authenticate with the service. </param>
     /// <exception cref="ArgumentNullException"> <paramref name="apiKey"/> is null. </exception>
-    public VideosClient(string apiKey) : this(new ApiKeyCredential(apiKey), new OpenAIClientOptions())
+    public VideoClient(string apiKey) : this(new ApiKeyCredential(apiKey), new OpenAIClientOptions())
     {
     }
 
     // CUSTOM:
     // - Used a custom pipeline.
     // - Demoted the endpoint parameter to be a property in the options class.
-    /// <summary> Initializes a new instance of <see cref="VideosClient"/>. </summary>
+    /// <summary> Initializes a new instance of <see cref="VideoClient"/>. </summary>
     /// <param name="credential"> The <see cref="ApiKeyCredential"/> to authenticate with the service. </param>
     /// <exception cref="ArgumentNullException"> <paramref name="credential"/> is null. </exception>
-    public VideosClient(ApiKeyCredential credential) : this(credential, new OpenAIClientOptions())
+    public VideoClient(ApiKeyCredential credential) : this(credential, new OpenAIClientOptions())
     {
     }
 
     // CUSTOM:
     // - Used a custom pipeline.
     // - Demoted the endpoint parameter to be a property in the options class.
-    /// <summary> Initializes a new instance of <see cref="VideosClient"/>. </summary>
+    /// <summary> Initializes a new instance of <see cref="VideoClient"/>. </summary>
     /// <param name="credential"> The <see cref="ApiKeyCredential"/> to authenticate with the service. </param>
     /// <param name="options"> The options to configure the client. </param>
     /// <exception cref="ArgumentNullException"> <paramref name="credential"/> is null. </exception>
-    public VideosClient(ApiKeyCredential credential, OpenAIClientOptions options) : this(OpenAIClient.CreateApiKeyAuthenticationPolicy(credential), options)
+    public VideoClient(ApiKeyCredential credential, OpenAIClientOptions options) : this(OpenAIClient.CreateApiKeyAuthenticationPolicy(credential), options)
     {
     }
 
     // CUSTOM: Added as a convenience.
     /// <summary> Initializes a new instance of <see cref="GraderClient"/>. </summary>
     /// <param name="authenticationPolicy"> The authentication policy used to authenticate with the service. </param>
     /// <exception cref="ArgumentNullException"> <paramref name="authenticationPolicy"/> is null. </exception>
-    public VideosClient(AuthenticationPolicy authenticationPolicy) : this(authenticationPolicy, new OpenAIClientOptions())
+    public VideoClient(AuthenticationPolicy authenticationPolicy) : this(authenticationPolicy, new OpenAIClientOptions())
     {
     }
 
@@ -56,7 +56,7 @@ public VideosClient(ApiKeyCredential credential, OpenAIClientOptions options) :
     /// <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="authenticationPolicy"/> is null. </exception>
-    public VideosClient(AuthenticationPolicy authenticationPolicy, OpenAIClientOptions options)
+    public VideoClient(AuthenticationPolicy authenticationPolicy, OpenAIClientOptions options)
     {
         Argument.AssertNotNull(authenticationPolicy, nameof(authenticationPolicy));
         options ??= new OpenAIClientOptions();
@@ -73,7 +73,7 @@ public VideosClient(AuthenticationPolicy authenticationPolicy, OpenAIClientOptio
     /// <param name="pipeline"> The HTTP pipeline to send and receive REST requests and responses. </param>
     /// <param name="options"> The options to configure the client. </param>
     /// <exception cref="ArgumentNullException"> <paramref name="pipeline"/> is null. </exception>
-    protected internal VideosClient(ClientPipeline pipeline, OpenAIClientOptions options)
+    protected internal VideoClient(ClientPipeline pipeline, OpenAIClientOptions options)
     {
         Argument.AssertNotNull(pipeline, nameof(pipeline));
         options ??= new OpenAIClientOptions();

src/Generated/VideosClient.RestClient.cs renamed to src/Generated/VideoClient.RestClient.cs

@@ -8,7 +8,7 @@
 
 namespace OpenAI.Videos
 {
-    public partial class VideosClient
+    public partial class VideoClient
     {
         private static PipelineMessageClassifier _pipelineMessageClassifier200;
 

src/Generated/VideosClient.cs renamed to src/Generated/VideoClient.cs

@@ -12,11 +12,11 @@
 namespace OpenAI.Videos
 {
     [Experimental("OPENAI001")]
-    public partial class VideosClient
+    public partial class VideoClient
     {
         private readonly Uri _endpoint;
 
-        protected VideosClient()
+        protected VideoClient()
         {
         }