Add Experimental attribute to all public APIs in the OpenAI.Assistants namespace

.dotnet/CHANGELOG.md

@@ -15,6 +15,7 @@
 ### Other Changes
 
 - Reverted the removal of the version path parameter "v1" from the default endpoint URL. (commit_hash)
+- Added `Experimental` attribute to all public APIs in the `OpenAI.Assistants` namespace. (commit_hash)
 
 ## 2.0.0-beta.10 (2024-08-26)
 

.dotnet/examples/Assistants/Example01_RetrievalAugmentedGeneration.cs

@@ -15,7 +15,6 @@ public partial class AssistantExamples
     public void Example01_RetrievalAugmentedGeneration()
     {
         // Assistants is a beta API and subject to change; acknowledge its experimental status by suppressing the matching warning.
-#pragma warning disable OPENAI001
         OpenAIClient openAIClient = new(Environment.GetEnvironmentVariable("OPENAI_API_KEY"));
         FileClient fileClient = openAIClient.GetFileClient();
         AssistantClient assistantClient = openAIClient.GetAssistantClient();

.dotnet/examples/Assistants/Example01_RetrievalAugmentedGenerationAsync.cs

@@ -16,7 +16,6 @@ public partial class AssistantExamples
     public async Task Example01_RetrievalAugmentedGenerationAsync()
     {
         // Assistants is a beta API and subject to change; acknowledge its experimental status by suppressing the matching warning.
-#pragma warning disable OPENAI001
         OpenAIClient openAIClient = new(Environment.GetEnvironmentVariable("OPENAI_API_KEY"));
         FileClient fileClient = openAIClient.GetFileClient();
         AssistantClient assistantClient = openAIClient.GetAssistantClient();

.dotnet/examples/Assistants/Example02_FunctionCalling.cs

@@ -61,7 +61,6 @@ string GetCurrentWeather(string location, string unit = "celsius")
         #endregion
 
         // Assistants is a beta API and subject to change; acknowledge its experimental status by suppressing the matching warning.
-#pragma warning disable OPENAI001
         AssistantClient client = new(Environment.GetEnvironmentVariable("OPENAI_API_KEY"));
 
         #region

.dotnet/examples/Assistants/Example02_FunctionCallingAsync.cs

@@ -61,7 +61,6 @@ string GetCurrentWeather(string location, string unit = "celsius")
         #endregion
 
         // Assistants is a beta API and subject to change; acknowledge its experimental status by suppressing the matching warning.
-#pragma warning disable OPENAI001
         AssistantClient client = new(Environment.GetEnvironmentVariable("OPENAI_API_KEY"));
 
         #region

.dotnet/examples/Assistants/Example02b_FunctionCallingStreaming.cs

@@ -63,7 +63,6 @@ public async Task Example02b_FunctionCallingStreaming()
         #endregion
 
         // Assistants is a beta API and subject to change; acknowledge its experimental status by suppressing the matching warning.
-#pragma warning disable OPENAI001
         AssistantClient client = new(Environment.GetEnvironmentVariable("OPENAI_API_KEY"));
 
         #region Create a new assistant with function tools

.dotnet/examples/Assistants/Example03_ListAssistantsWithPagination.cs

@@ -12,7 +12,6 @@ public partial class AssistantExamples
     public void Example03_ListAssistantsWithPagination()
     {
         // Assistants is a beta API and subject to change; acknowledge its experimental status by suppressing the matching warning.
-#pragma warning disable OPENAI001
         AssistantClient client = new(Environment.GetEnvironmentVariable("OPENAI_API_KEY"));
 
         int count = 0;

.dotnet/examples/Assistants/Example03_ListAssistantsWithPaginationAsync.cs

@@ -13,7 +13,6 @@ public partial class AssistantExamples
     public async Task Example03_ListAssistantsWithPaginationAsync()
     {
         // Assistants is a beta API and subject to change; acknowledge its experimental status by suppressing the matching warning.
-#pragma warning disable OPENAI001
         AssistantClient client = new(Environment.GetEnvironmentVariable("OPENAI_API_KEY"));
 
         int count = 0;

.dotnet/examples/Assistants/Example04_AllTheTools.cs

@@ -14,8 +14,6 @@ public partial class AssistantExamples
     [Test]
     public void Example04_AllTheTools()
     {
-#pragma warning disable OPENAI001
-
         #region Define a function tool
         static string GetNameOfFamilyMember(string relation)
             => relation switch

.dotnet/examples/Assistants/Example05_AssistantsWithVision.cs

@@ -12,7 +12,6 @@ public partial class AssistantExamples
     public void Example05_AssistantsWithVision()
     {
         // Assistants is a beta API and subject to change; acknowledge its experimental status by suppressing the matching warning.
-#pragma warning disable OPENAI001
         OpenAIClient openAIClient = new(Environment.GetEnvironmentVariable("OPENAI_API_KEY"));
         FileClient fileClient = openAIClient.GetFileClient();
         AssistantClient assistantClient = openAIClient.GetAssistantClient();

.dotnet/examples/Assistants/Example05_AssistantsWithVisionAsync.cs

@@ -13,7 +13,6 @@ public partial class AssistantExamples
     public async Task Example05_AssistantsWithVisionAsync()
     {
         // Assistants is a beta API and subject to change; acknowledge its experimental status by suppressing the matching warning.
-#pragma warning disable OPENAI001
         OpenAIClient openAIClient = new(Environment.GetEnvironmentVariable("OPENAI_API_KEY"));
         FileClient fileClient = openAIClient.GetFileClient();
         AssistantClient assistantClient = openAIClient.GetAssistantClient();

.dotnet/examples/ClientExamples.cs

@@ -42,8 +42,6 @@ public void CreateAssistantAndFileClients()
     {
         OpenAIClient openAIClient = new(Environment.GetEnvironmentVariable("OPENAI_API_KEY"));
         FileClient fileClient = openAIClient.GetFileClient();
-#pragma warning disable OPENAI001
         AssistantClient assistantClient = openAIClient.GetAssistantClient();
-#pragma warning restore OPENAI001
     }
 }

.dotnet/examples/OpenAI.Examples.csproj

@@ -1,8 +1,13 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <TargetFramework>net8.0</TargetFramework>
-    <!--Ignore XML doc comments on test types and members-->
-    <NoWarn>$(NoWarn);CS1591</NoWarn>
+
+    <!-- CS1591 - Ignore XML doc comments on test types and members-->
+    <NoWarn>$(NoWarn);CS1591;</NoWarn>
+
+    <!-- OPENAI001 - Ignore experimental warnings-->
+    <NoWarn>$(NoWarn);OPENAI001;</NoWarn>
+
     <LangVersion>latest</LangVersion>
   </PropertyGroup>
   <ItemGroup>

.dotnet/src/Custom/Assistants/Assistant.cs

@@ -1,5 +1,8 @@
+using System.Diagnostics.CodeAnalysis;
+
 namespace OpenAI.Assistants;
 
+[Experimental("OPENAI001")]
 [CodeGenModel("AssistantObject")]
 public partial class Assistant
 {

.dotnet/src/Custom/Assistants/AssistantCollectionOptions.cs

@@ -1,8 +1,11 @@
+using System.Diagnostics.CodeAnalysis;
+
 namespace OpenAI.Assistants;
 
 /// <summary>
 /// Represents addition options available when requesting a collection of <see cref="Assistant"/> instances.
 /// </summary>
+[Experimental("OPENAI001")]
 public class AssistantCollectionOptions
 {
     /// <summary>

.dotnet/src/Custom/Assistants/AssistantCreationOptions.cs

@@ -1,10 +1,12 @@
 using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
 
 namespace OpenAI.Assistants;
 
 /// <summary>
 /// Represents additional options available when creating a new <see cref="Assistant"/>.
 /// </summary>
+[Experimental("OPENAI001")]
 [CodeGenModel("CreateAssistantRequest")]
 [CodeGenSuppress(nameof(AssistantCreationOptions), typeof(string))]
 public partial class AssistantCreationOptions
@@ -51,4 +53,4 @@ public AssistantCreationOptions()
         Metadata = new ChangeTrackingDictionary<string, string>();
         Tools = new ChangeTrackingList<ToolDefinition>();
     }
-}
+}

.dotnet/src/Custom/Assistants/AssistantModificationOptions.cs

@@ -1,10 +1,12 @@
 using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
 
 namespace OpenAI.Assistants;
 
 /// <summary>
 /// Represents additional options available when modifying an existing <see cref="Assistant"/>.
 /// </summary>
+[Experimental("OPENAI001")]
 [CodeGenModel("ModifyAssistantRequest")]
 public partial class AssistantModificationOptions
 {
@@ -40,4 +42,4 @@ public partial class AssistantModificationOptions
     /// </summary>
     [CodeGenMember("TopP")]
     public float? NucleusSamplingFactor { get; set; }
-}
+}

.dotnet/src/Custom/Assistants/AssistantResponseFormat.cs

@@ -2,9 +2,11 @@
 using System;
 using System.ClientModel.Primitives;
 using System.ComponentModel;
+using System.Diagnostics.CodeAnalysis;
 
 namespace OpenAI.Assistants;
 
+[Experimental("OPENAI001")]
 [CodeGenModel("AssistantResponseFormat")]
 public partial class AssistantResponseFormat : IEquatable<AssistantResponseFormat>, IEquatable<string>
 {
@@ -106,4 +108,4 @@ public override string ToString()
             return ModelReaderWriter.Write(this).ToString();
         }
     }
-}
+}

.dotnet/src/Custom/Assistants/AssistantThread.cs

@@ -1,5 +1,8 @@
+using System.Diagnostics.CodeAnalysis;
+
 namespace OpenAI.Assistants;
 
+[Experimental("OPENAI001")]
 [CodeGenModel("ThreadObject")]
 public partial class AssistantThread
 {

.dotnet/src/Custom/Assistants/CodeInterpreterToolDefinition.Serialization.cs

@@ -1,7 +1,4 @@
-using System;
-using System.ClientModel;
 using System.ClientModel.Primitives;
-using System.Collections.Generic;
 using System.Text.Json;
 
 namespace OpenAI.Assistants;
@@ -23,4 +20,4 @@ protected override void WriteCore(Utf8JsonWriter writer, ModelReaderWriterOption
         writer.WriteSerializedAdditionalRawData(SerializedAdditionalRawData, options);
         writer.WriteEndObject();
     }
-}
+}

.dotnet/src/Custom/Assistants/CodeInterpreterToolResources.cs

@@ -1,8 +1,10 @@
 using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
 
 namespace OpenAI.Assistants;
 
 /// <summary> The AssistantObjectToolResourcesCodeInterpreter. </summary>
+[Experimental("OPENAI001")]
 [CodeGenModel("AssistantObjectToolResourcesCodeInterpreter")]
 public partial class CodeInterpreterToolResources
 {

.dotnet/src/Custom/Assistants/FileSearchToolDefinition.Serialization.cs

@@ -1,7 +1,4 @@
-using System;
-using System.ClientModel;
 using System.ClientModel.Primitives;
-using System.Collections.Generic;
 using System.Text.Json;
 
 namespace OpenAI.Assistants;

.dotnet/src/Custom/Assistants/FileSearchToolDefinition.cs

@@ -1,9 +1,8 @@
-using System;
-using System.Collections.Generic;
 using System.Diagnostics.CodeAnalysis;
 
 namespace OpenAI.Assistants;
 
+[Experimental("OPENAI001")]
 [CodeGenModel("AssistantToolsFileSearch")]
 [CodeGenSuppress(nameof(FileSearchToolDefinition))]
 public partial class FileSearchToolDefinition : ToolDefinition

.dotnet/src/Custom/Assistants/FileSearchToolResources.cs

@@ -1,9 +1,11 @@
 using System.ClientModel.Primitives;
 using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
 using System.Text.Json;
 
 namespace OpenAI.Assistants;
 
+[Experimental("OPENAI001")]
 [CodeGenModel("ToolResourcesFileSearch")]
 [CodeGenSerialization(nameof(NewVectorStores), "vector_stores", SerializationValueHook = nameof(SerializeNewVectorStores))]
 public partial class FileSearchToolResources

.dotnet/src/Custom/Assistants/FunctionToolDefinition.Serialization.cs

@@ -1,7 +1,4 @@
-using System;
-using System.ClientModel;
 using System.ClientModel.Primitives;
-using System.Collections.Generic;
 using System.Text.Json;
 
 namespace OpenAI.Assistants;
@@ -25,4 +22,4 @@ protected override void WriteCore(Utf8JsonWriter writer, ModelReaderWriterOption
         writer.WriteSerializedAdditionalRawData(SerializedAdditionalRawData, options);
         writer.WriteEndObject();
     }
-}
+}

.dotnet/src/Custom/Assistants/FunctionToolDefinition.cs

@@ -4,6 +4,7 @@
 
 namespace OpenAI.Assistants;
 
+[Experimental("OPENAI001")]
 [CodeGenModel("AssistantToolsFunction")]
 [CodeGenSuppress(nameof(FunctionToolDefinition), typeof(InternalFunctionDefinition))]
 public partial class FunctionToolDefinition : ToolDefinition

.dotnet/src/Custom/Assistants/GeneratorStubs.cs

@@ -1,51 +1,67 @@
+using System.Diagnostics.CodeAnalysis;
+
 namespace OpenAI.Assistants;
 
 /*
  * This file stubs and performs minimal customization to generated public types for the OpenAI.Assistants namespace
  * that are not otherwise attributed elsewhere.
  */
-
+[Experimental("OPENAI001")]
 [CodeGenModel("AssistantToolsCode")]
 public partial class CodeInterpreterToolDefinition : ToolDefinition { }
 
+[Experimental("OPENAI001")]
 [CodeGenModel("MessageObjectStatus")]
 public readonly partial struct MessageStatus { }
 
+[Experimental("OPENAI001")]
 [CodeGenModel("MessageObjectIncompleteDetails")]
 public partial class MessageFailureDetails { }
 
+[Experimental("OPENAI001")]
 [CodeGenModel("MessageObjectIncompleteDetailsReason")]
 public readonly partial struct MessageFailureReason { }
 
+[Experimental("OPENAI001")]
 [CodeGenModel("RunCompletionUsage")]
 public partial class RunTokenUsage { }
 
+[Experimental("OPENAI001")]
 [CodeGenModel("RunObjectLastError")]
 public partial class RunError { }
 
+[Experimental("OPENAI001")]
 [CodeGenModel("RunObjectLastErrorCode")]
 public readonly partial struct RunErrorCode { }
 
+[Experimental("OPENAI001")]
 [CodeGenModel("RunObjectIncompleteDetails")]
 public partial class RunIncompleteDetails { }
 
+[Experimental("OPENAI001")]
 [CodeGenModel("RunObjectIncompleteDetailsReason")]
 public readonly partial struct RunIncompleteReason { }
 
+[Experimental("OPENAI001")]
 [CodeGenModel("RunStepObjectType")]
 public readonly partial struct RunStepType { }
 
+[Experimental("OPENAI001")]
 [CodeGenModel("RunStepObjectStatus")]
 public readonly partial struct RunStepStatus { }
 
+[Experimental("OPENAI001")]
 [CodeGenModel("RunStepObjectLastError")]
 public partial class RunStepError { }
 
+[Experimental("OPENAI001")]
 [CodeGenModel("RunStepObjectLastErrorCode")]
 public readonly partial struct RunStepErrorCode { }
 
+[Experimental("OPENAI001")]
 [CodeGenModel("RunStepCompletionUsage")]
 public partial class RunStepTokenUsage { }
 
+[Experimental("OPENAI001")]
 [CodeGenModel("RunStepDetailsToolCallsCodeObjectCodeInterpreterOutputsObject")]
 public partial class RunStepCodeInterpreterOutput { }

.dotnet/src/Custom/Assistants/Internal/InternalMessageImageFileContent.Serialization.cs

@@ -1,7 +1,4 @@
-using System;
-using System.ClientModel;
 using System.ClientModel.Primitives;
-using System.Collections.Generic;
 using System.Text.Json;
 
 namespace OpenAI.Assistants;

.dotnet/src/Custom/Assistants/Internal/InternalMessageImageUrlContent.Serialization.cs

@@ -1,7 +1,4 @@
-using System;
-using System.ClientModel;
 using System.ClientModel.Primitives;
-using System.Collections.Generic;
 using System.Text.Json;
 
 namespace OpenAI.Assistants;

.dotnet/src/Custom/Assistants/Internal/InternalMessageRefusalContent.Serialization.cs

@@ -1,7 +1,4 @@
-using System;
-using System.ClientModel;
 using System.ClientModel.Primitives;
-using System.Collections.Generic;
 using System.Text.Json;
 
 namespace OpenAI.Assistants;

.dotnet/src/Custom/Assistants/Internal/InternalRequestMessageTextContent.Serialization.cs

@@ -1,7 +1,4 @@
-using System;
-using System.ClientModel;
 using System.ClientModel.Primitives;
-using System.Collections.Generic;
 using System.Text.Json;
 
 namespace OpenAI.Assistants;

.dotnet/src/Custom/Assistants/Internal/InternalResponseMessageTextContent.Serialization.cs

@@ -1,7 +1,4 @@
-using System;
-using System.ClientModel;
 using System.ClientModel.Primitives;
-using System.Collections.Generic;
 using System.Text.Json;
 
 namespace OpenAI.Assistants;

.dotnet/src/Custom/Assistants/Internal/UnknownAssistantToolDefinition.Serialization.cs

@@ -1,7 +1,4 @@
-using System;
-using System.ClientModel;
 using System.ClientModel.Primitives;
-using System.Collections.Generic;
 using System.Text.Json;
 
 namespace OpenAI.Assistants;