Azure.AI.Projects tests and recordings (Azure#52235)

* initial tests

* tests following guide

* tests with recording and sanitation enabled

* telemetry recording

* update name changes

* final test updates

* update assets.json tag

* update api

* address comments, consolidate test framework

* run scripts

Author: sophia-ramsey

sdk/ai/Azure.AI.Projects/api/Azure.AI.Projects.net8.0.cs

@@ -114,7 +114,7 @@ public AIProjectClient(System.Uri endpoint, System.ClientModel.AuthenticationTok
         public virtual Azure.AI.Projects.DeploymentsOperations GetDeploymentsOperationsClient() { throw null; }
         public virtual Azure.AI.Projects.Evaluations GetEvaluationsClient() { throw null; }
         public virtual Azure.AI.Projects.IndexesOperations GetIndexesOperationsClient() { throw null; }
-        public OpenAI.OpenAIClient GetOpenAIClient(string? connectionName = null, string? apiVersion = null) { throw null; }
+        public virtual OpenAI.OpenAIClient GetOpenAIClient(string? connectionName = null, string? apiVersion = null) { throw null; }
         public virtual Azure.AI.Projects.RedTeams GetRedTeamsClient() { throw null; }
     }
     public partial class AIProjectClientOptions : System.ClientModel.Primitives.ClientPipelineOptions
@@ -370,14 +370,14 @@ public partial class ConnectionsOperations
     {
         protected ConnectionsOperations() { }
         public System.ClientModel.Primitives.ClientPipeline Pipeline { get { throw null; } }
-        public Azure.AI.Projects.ConnectionProperties GetConnection(string connectionName, bool includeCredentials = false, string clientRequestId = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
-        public System.Threading.Tasks.Task<System.ClientModel.ClientResult<Azure.AI.Projects.ConnectionProperties>> GetConnectionAsync(string connectionName, bool includeCredentials = false, string clientRequestId = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+        public virtual Azure.AI.Projects.ConnectionProperties GetConnection(string connectionName, bool includeCredentials = false, string clientRequestId = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+        public virtual System.Threading.Tasks.Task<System.ClientModel.ClientResult<Azure.AI.Projects.ConnectionProperties>> GetConnectionAsync(string connectionName, bool includeCredentials = false, string clientRequestId = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
         public virtual System.ClientModel.CollectionResult<Azure.AI.Projects.ConnectionProperties> GetConnections(Azure.AI.Projects.ConnectionType? connectionType = default(Azure.AI.Projects.ConnectionType?), bool? defaultConnection = default(bool?), string clientRequestId = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
         public virtual System.ClientModel.Primitives.CollectionResult GetConnections(string connectionType, bool? defaultConnection, string clientRequestId, System.ClientModel.Primitives.RequestOptions options) { throw null; }
         public virtual System.ClientModel.AsyncCollectionResult<Azure.AI.Projects.ConnectionProperties> GetConnectionsAsync(Azure.AI.Projects.ConnectionType? connectionType = default(Azure.AI.Projects.ConnectionType?), bool? defaultConnection = default(bool?), string clientRequestId = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
         public virtual System.ClientModel.Primitives.AsyncCollectionResult GetConnectionsAsync(string connectionType, bool? defaultConnection, string clientRequestId, System.ClientModel.Primitives.RequestOptions options) { throw null; }
-        public Azure.AI.Projects.ConnectionProperties GetDefaultConnection(Azure.AI.Projects.ConnectionType? connectionType = default(Azure.AI.Projects.ConnectionType?), bool includeCredentials = false) { throw null; }
-        public System.Threading.Tasks.Task<Azure.AI.Projects.ConnectionProperties> GetDefaultConnectionAsync(Azure.AI.Projects.ConnectionType? connectionType = default(Azure.AI.Projects.ConnectionType?), bool includeCredentials = false) { throw null; }
+        public virtual Azure.AI.Projects.ConnectionProperties GetDefaultConnection(Azure.AI.Projects.ConnectionType? connectionType = default(Azure.AI.Projects.ConnectionType?), bool includeCredentials = false) { throw null; }
+        public virtual System.Threading.Tasks.Task<Azure.AI.Projects.ConnectionProperties> GetDefaultConnectionAsync(Azure.AI.Projects.ConnectionType? connectionType = default(Azure.AI.Projects.ConnectionType?), bool includeCredentials = false) { throw null; }
     }
     [System.Runtime.InteropServices.StructLayoutAttribute(System.Runtime.InteropServices.LayoutKind.Sequential)]
     public readonly partial struct ConnectionType : System.IEquatable<Azure.AI.Projects.ConnectionType>

sdk/ai/Azure.AI.Projects/api/Azure.AI.Projects.netstandard2.0.cs

@@ -114,7 +114,7 @@ public AIProjectClient(System.Uri endpoint, System.ClientModel.AuthenticationTok
         public virtual Azure.AI.Projects.DeploymentsOperations GetDeploymentsOperationsClient() { throw null; }
         public virtual Azure.AI.Projects.Evaluations GetEvaluationsClient() { throw null; }
         public virtual Azure.AI.Projects.IndexesOperations GetIndexesOperationsClient() { throw null; }
-        public OpenAI.OpenAIClient GetOpenAIClient(string? connectionName = null, string? apiVersion = null) { throw null; }
+        public virtual OpenAI.OpenAIClient GetOpenAIClient(string? connectionName = null, string? apiVersion = null) { throw null; }
         public virtual Azure.AI.Projects.RedTeams GetRedTeamsClient() { throw null; }
     }
     public partial class AIProjectClientOptions : System.ClientModel.Primitives.ClientPipelineOptions
@@ -370,14 +370,14 @@ public partial class ConnectionsOperations
     {
         protected ConnectionsOperations() { }
         public System.ClientModel.Primitives.ClientPipeline Pipeline { get { throw null; } }
-        public Azure.AI.Projects.ConnectionProperties GetConnection(string connectionName, bool includeCredentials = false, string clientRequestId = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
-        public System.Threading.Tasks.Task<System.ClientModel.ClientResult<Azure.AI.Projects.ConnectionProperties>> GetConnectionAsync(string connectionName, bool includeCredentials = false, string clientRequestId = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+        public virtual Azure.AI.Projects.ConnectionProperties GetConnection(string connectionName, bool includeCredentials = false, string clientRequestId = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+        public virtual System.Threading.Tasks.Task<System.ClientModel.ClientResult<Azure.AI.Projects.ConnectionProperties>> GetConnectionAsync(string connectionName, bool includeCredentials = false, string clientRequestId = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
         public virtual System.ClientModel.CollectionResult<Azure.AI.Projects.ConnectionProperties> GetConnections(Azure.AI.Projects.ConnectionType? connectionType = default(Azure.AI.Projects.ConnectionType?), bool? defaultConnection = default(bool?), string clientRequestId = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
         public virtual System.ClientModel.Primitives.CollectionResult GetConnections(string connectionType, bool? defaultConnection, string clientRequestId, System.ClientModel.Primitives.RequestOptions options) { throw null; }
         public virtual System.ClientModel.AsyncCollectionResult<Azure.AI.Projects.ConnectionProperties> GetConnectionsAsync(Azure.AI.Projects.ConnectionType? connectionType = default(Azure.AI.Projects.ConnectionType?), bool? defaultConnection = default(bool?), string clientRequestId = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
         public virtual System.ClientModel.Primitives.AsyncCollectionResult GetConnectionsAsync(string connectionType, bool? defaultConnection, string clientRequestId, System.ClientModel.Primitives.RequestOptions options) { throw null; }
-        public Azure.AI.Projects.ConnectionProperties GetDefaultConnection(Azure.AI.Projects.ConnectionType? connectionType = default(Azure.AI.Projects.ConnectionType?), bool includeCredentials = false) { throw null; }
-        public System.Threading.Tasks.Task<Azure.AI.Projects.ConnectionProperties> GetDefaultConnectionAsync(Azure.AI.Projects.ConnectionType? connectionType = default(Azure.AI.Projects.ConnectionType?), bool includeCredentials = false) { throw null; }
+        public virtual Azure.AI.Projects.ConnectionProperties GetDefaultConnection(Azure.AI.Projects.ConnectionType? connectionType = default(Azure.AI.Projects.ConnectionType?), bool includeCredentials = false) { throw null; }
+        public virtual System.Threading.Tasks.Task<Azure.AI.Projects.ConnectionProperties> GetDefaultConnectionAsync(Azure.AI.Projects.ConnectionType? connectionType = default(Azure.AI.Projects.ConnectionType?), bool includeCredentials = false) { throw null; }
     }
     [System.Runtime.InteropServices.StructLayoutAttribute(System.Runtime.InteropServices.LayoutKind.Sequential)]
     public readonly partial struct ConnectionType : System.IEquatable<Azure.AI.Projects.ConnectionType>

sdk/ai/Azure.AI.Projects/assets.json

@@ -2,5 +2,5 @@
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "net",
   "TagPrefix": "net/ai/Azure.AI.Projects",
-  "Tag": "net/ai/Azure.AI.Projects_2d64ec531c"
+  "Tag": "net/ai/Azure.AI.Projects_7e48fa872a"
 }

sdk/ai/Azure.AI.Projects/src/Custom/Connections/ConnectionsOperations.cs

@@ -19,7 +19,7 @@ public partial class ConnectionsOperations
         /// <param name="cancellationToken"> The cancellation token that can be used to cancel the operation. </param>
         /// <returns>A <see cref="ConnectionProperties"/> object.</returns>
         /// <exception cref="RequestFailedException">Thrown when the request fails.</exception>
-        public ConnectionProperties GetConnection(string connectionName, bool includeCredentials = false, string clientRequestId = default, CancellationToken cancellationToken = default)
+        public virtual ConnectionProperties GetConnection(string connectionName, bool includeCredentials = false, string clientRequestId = default, CancellationToken cancellationToken = default)
         {
             if (string.IsNullOrWhiteSpace(connectionName))
             {
@@ -44,7 +44,7 @@ public ConnectionProperties GetConnection(string connectionName, bool includeCre
         /// <param name="cancellationToken"> The cancellation token that can be used to cancel the operation. </param>
         /// <returns>A <see cref="ConnectionProperties"/> object.</returns>
         /// <exception cref="RequestFailedException">Thrown when the request fails.</exception>
-        public async Task<ClientResult<ConnectionProperties>> GetConnectionAsync(string connectionName, bool includeCredentials = false, string clientRequestId = default, CancellationToken cancellationToken = default)
+        public virtual async Task<ClientResult<ConnectionProperties>> GetConnectionAsync(string connectionName, bool includeCredentials = false, string clientRequestId = default, CancellationToken cancellationToken = default)
         {
             if (string.IsNullOrWhiteSpace(connectionName))
             {
@@ -67,7 +67,7 @@ public async Task<ClientResult<ConnectionProperties>> GetConnectionAsync(string
         /// <param name="includeCredentials">Whether to include credentials in the response. Default is false.</param>
         /// <returns>A <see cref="ConnectionProperties"/> object.</returns>
         /// <exception cref="RequestFailedException">Thrown when the request fails.</exception>
-        public ConnectionProperties GetDefaultConnection(ConnectionType? connectionType = null, bool includeCredentials = false)
+        public virtual ConnectionProperties GetDefaultConnection(ConnectionType? connectionType = null, bool includeCredentials = false)
         {
             foreach (var connection in GetConnections(connectionType))
             {
@@ -86,7 +86,7 @@ public ConnectionProperties GetDefaultConnection(ConnectionType? connectionType
         /// <param name="includeCredentials">Whether to include credentials in the response. Default is false.</param>
         /// <returns>A <see cref="ConnectionProperties"/> object.</returns>
         /// <exception cref="RequestFailedException">Thrown when the request fails.</exception>
-        public async Task<ConnectionProperties> GetDefaultConnectionAsync(ConnectionType? connectionType = null, bool includeCredentials = false)
+        public virtual async Task<ConnectionProperties> GetDefaultConnectionAsync(ConnectionType? connectionType = null, bool includeCredentials = false)
         {
             await foreach (var connection in GetConnectionsAsync(connectionType).ConfigureAwait(false))
             {

sdk/ai/Azure.AI.Projects/src/Custom/Inference/Inference.cs

@@ -27,7 +27,7 @@ public partial class AIProjectClient : ClientConnectionProvider
         /// <param name="connectionName"></param>
         /// <param name="apiVersion"></param>
         /// <returns></returns>
-        public OpenAIClient GetOpenAIClient(string? connectionName = null, string? apiVersion = null)
+        public virtual OpenAIClient GetOpenAIClient(string? connectionName = null, string? apiVersion = null)
         {
             AzureOpenAIClientKey openAIClientKey = new();
 

sdk/ai/Azure.AI.Projects/tests/AIAgentsTest.cs

@@ -0,0 +1,48 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+#nullable disable
+
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading;
+using System.Threading.Tasks;
+using Azure.AI.Agents.Persistent;
+using Azure.Identity;
+using Azure.Core.TestFramework;
+using NUnit.Framework;
+using Azure.AI.Projects.Tests.Utils;
+
+namespace Azure.AI.Projects.Tests;
+
+public class AIAgentsTest : ProjectsClientTestBase
+{
+    public AIAgentsTest(bool isAsync) : base(isAsync) //, RecordedTestMode.Record)
+    {
+    }
+
+    [TestCase]
+    [RecordedTest]
+    [Ignore("Agents API calls are not recorded")]
+    public async Task AgentsTest()
+    {
+        var modelDeploymentName = TestEnvironment.MODELDEPLOYMENTNAME;
+
+        AIProjectClient projectClient = GetTestClient();
+        PersistentAgentsClient agentsClient = projectClient.GetPersistentAgentsClient();
+
+        Console.WriteLine("Create an agent with a model deployment");
+        PersistentAgent agent = await agentsClient.Administration.CreateAgentAsync(
+            model: modelDeploymentName,
+            name: "Math Tutor",
+            instructions: "You are a personal math tutor. Write and run code to answer math questions."
+        );
+        Assert.NotNull(agent.Id);
+        Assert.AreEqual(agent.Model, modelDeploymentName);
+        Assert.AreEqual(agent.Name, "Math Tutor");
+        Assert.AreEqual(agent.Instructions, "You are a personal math tutor. Write and run code to answer math questions.");
+
+        await agentsClient.Administration.DeleteAgentAsync(agentId: agent.Id);
+    }
+}

sdk/ai/Azure.AI.Projects/tests/AIProjectsTestEnvironment.cs

@@ -7,7 +7,7 @@ namespace Azure.AI.Projects.Tests
 {
     public class AIProjectsTestEnvironment : TestEnvironment
     {
-        public string PROJECTENDPOINT => GetRecordedVariable("PROJECT_ENDPOINT");
+        public string PROJECTENDPOINT => GetRecordedVariable("PROJECT_ENDPOINT", options => options.IsSecret("https://sanitized-host.services.ai.azure.com/api/projects/sanitized-project"));
         public string DATASETNAME => GetRecordedVariable("DATASET_NAME");
         public string DATASETVERSION1 => GetRecordedVariable("DATASET_VERSION_1");
         public string DATASETVERSION2 => GetRecordedVariable("DATASET_VERSION_2");
@@ -19,6 +19,7 @@ public class AIProjectsTestEnvironment : TestEnvironment
         public string AISEARCHCONNECTIONNAME => GetRecordedVariable("AI_SEARCH_CONNECTION_NAME");
         public string AISEARCHINDEXNAME => GetRecordedVariable("AI_SEARCH_INDEX_NAME");
         public string CONNECTIONNAME => GetRecordedVariable("CONNECTION_NAME");
+        public string CONNECTIONTYPE => GetRecordedVariable("CONNECTION_TYPE");
         public string AOAICONNECTIONNAME => GetRecordedVariable("AOAI_CONNECTION_NAME");
         public string TESTIMAGEPNGINPUTPATH => GetRecordedVariable("TEST_IMAGE_PNG_INPUT_PATH");
         public string SAMPLEFILEPATH => GetRecordedVariable("SAMPLE_FILE_PATH");

sdk/ai/Azure.AI.Projects/tests/AzureOpenAI_InferenceTest.cs

@@ -0,0 +1,62 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+#nullable disable
+
+using System;
+using System.Linq;
+using System.Threading.Tasks;
+using Azure.AI.OpenAI;
+using Azure.Core.TestFramework;
+using NUnit.Framework;
+using OpenAI.Chat;
+using Azure.Identity;
+using Azure.AI.Projects.Tests.Utils;
+
+namespace Azure.AI.Projects.Tests;
+
+public class AzureOpenAI_ChatTest : ProjectsClientTestBase
+{
+    public AzureOpenAI_ChatTest(bool isAsync) : base(isAsync)//, RecordedTestMode.Record)
+    {
+    }
+
+    [TestCase]
+    [RecordedTest]
+    [Ignore("Calls to AzureOpenAIClient are not recorded yet")]
+    public async Task AzureOpenAI_ChatTestAsync()
+    {
+        var modelDeploymentName = TestEnvironment.MODELDEPLOYMENTNAME;
+        var connectionName = TestEnvironment.AOAICONNECTIONNAME;
+
+        Console.WriteLine("Create the Azure OpenAI chat client");
+        AIProjectClient projectClient = GetTestClient();
+        AzureOpenAIClient azureOpenAIClient = (AzureOpenAIClient)projectClient.GetOpenAIClient(connectionName: connectionName, apiVersion: null);
+        ChatClient chatClient = azureOpenAIClient.GetChatClient(deploymentName: modelDeploymentName);
+
+        Console.WriteLine("Complete a chat");
+        ChatCompletion result = await chatClient.CompleteChatAsync("How many feet are in a mile?");
+        Console.WriteLine(result.Content[0].Text);
+        var contains = new[] { "5280", "5,280", "five thousand two hundred eighty", "five thousand two hundred and eighty" };
+        Assert.That(contains.Any(item => result.Content[0].Text.Contains(item)), "The response should contain the number of feet in a mile.");
+    }
+
+    [TestCase]
+    [RecordedTest]
+    [Ignore("Calls to AzureOpenAIClient are not recorded yet")]
+    public async Task AzureOpenAI_ChatTest_NoConnection()
+    {
+        var modelDeploymentName = TestEnvironment.MODELDEPLOYMENTNAME;
+
+        Console.WriteLine("Create the Azure OpenAI chat client");
+        AIProjectClient projectClient = GetTestClient();
+        AzureOpenAIClient azureOpenAIClient = (AzureOpenAIClient)projectClient.GetOpenAIClient(connectionName: null, apiVersion: null);
+        ChatClient chatClient = azureOpenAIClient.GetChatClient(deploymentName: modelDeploymentName);
+
+        Console.WriteLine("Complete a chat");
+        ChatCompletion result = await chatClient.CompleteChatAsync("How many feet are in a mile?");
+        Console.WriteLine(result.Content[0].Text);
+        var contains = new[] { "5280", "5,280", "five thousand two hundred eighty", "five thousand two hundred and eighty" };
+        Assert.That(contains.Any(item => result.Content[0].Text.Contains(item)), "The response should contain the number of feet in a mile.");
+    }
+}