Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
wip tests
  • Loading branch information
christothes committed May 1, 2025
commit d8da69ae5b1f30f7e4c3177aa7fa1dcb1a9551a6
2 changes: 1 addition & 1 deletion src/Utility/ChatTools.cs
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,7 @@ internal string CallLocal(ChatToolCall call)
arguments.Add(argument.Value.ValueKind switch
{
JsonValueKind.String => argument.Value.GetString()!,
JsonValueKind.Number => argument.Value.GetDouble(),
JsonValueKind.Number => argument.Value.GetInt32(),
JsonValueKind.True => true,
JsonValueKind.False => false,
_ => throw new NotImplementedException()
Expand Down
2 changes: 2 additions & 0 deletions src/Utility/ToolsUtility.cs
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ internal static ReadOnlySpan<byte> ClrToJsonTypeUtf8(Type clrType) =>
clrType switch
{
Type t when t == typeof(double) => "number"u8,
Type t when t == typeof(int) => "number"u8,
Type t when t == typeof(string) => "string"u8,
Type t when t == typeof(bool) => "bool"u8,
_ => throw new NotImplementedException()
Expand All @@ -45,6 +46,7 @@ internal static string ClrToJsonTypeUtf16(Type clrType) =>
clrType switch
{
Type t when t == typeof(double) => "number",
Type t when t == typeof(int) => "number",
Type t when t == typeof(string) => "string",
Type t when t == typeof(bool) => "bool",
_ => throw new NotImplementedException()
Expand Down
131 changes: 131 additions & 0 deletions tests/Utility/ChatToolsTests.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
using Moq;
using NUnit.Framework;
using OpenAI.Chat;
using OpenAI.Embeddings;
using System;
using System.Collections.Generic;
using System.ClientModel;
using System.ClientModel.Primitives;
using System.IO;
using System.Linq;
using System.Net.Http;
using System.Threading;
using System.Threading.Tasks;

namespace OpenAI.Tests.Utility;

[TestFixture]
[Category("Utility")]
public class ChatToolsTests
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider adding a test for the following scenario: I have an ongoing chat where the model called "Function Foo" at some point, but then I remove "Function Foo" from the list of available tools and continue talking to the model. Confirm that when the model sees "Function Foo" in the chat history but not in its list of available tools, it still works correctly.

{
private class TestTools
{
public static string Echo(string message) => message;
public static int Add(int a, int b) => a + b;
}

private Mock<EmbeddingClient> mockEmbeddingClient;

[SetUp]
public void Setup()
{
mockEmbeddingClient = new Mock<EmbeddingClient>("text-embedding-ada-002", new ApiKeyCredential("test-key"));
}

[Test]
public void CanAddLocalTools()
{
var tools = new ChatTools();
tools.AddLocalTools(typeof(TestTools));

Assert.That(tools.Tools, Has.Count.EqualTo(2));
Assert.That(tools.Tools.Any(t => t.FunctionName == "Echo"));
Assert.That(tools.Tools.Any(t => t.FunctionName == "Add"));
}

[Test]
public async Task CanCallToolsAsync()
{
var tools = new ChatTools();
tools.AddLocalTools(typeof(TestTools));

var toolCalls = new[]
{
ChatToolCall.CreateFunctionToolCall("call1", "Echo", BinaryData.FromString(@"{""message"": ""Hello""}")),
ChatToolCall.CreateFunctionToolCall("call2", "Add", BinaryData.FromString(@"{""a"": 2, ""b"": 3}"))
};

var results = await tools.CallAsync(toolCalls);
var resultsList = results.ToList();

Assert.That(resultsList, Has.Count.EqualTo(2));
Assert.That(resultsList[0].ToolCallId, Is.EqualTo("call1"));
Assert.That(resultsList[0].Content[0].Text, Is.EqualTo("Hello"));
Assert.That(resultsList[1].ToolCallId, Is.EqualTo("call2"));
Assert.That(resultsList[1].Content[0].Text, Is.EqualTo("5"));
}

[Test]
public void CreatesCompletionOptionsWithTools()
{
var tools = new ChatTools();
tools.AddLocalTools(typeof(TestTools));

var options = tools.CreateCompletionOptions();

Assert.That(options.Tools, Has.Count.EqualTo(2));
Assert.That(options.Tools.Any(t => t.FunctionName == "Echo"));
Assert.That(options.Tools.Any(t => t.FunctionName == "Add"));
}

[Test]
public async Task CanFilterToolsByRelevance()
{
// Setup mock embedding client to return a mock response
var embedding = OpenAIEmbeddingsModelFactory.OpenAIEmbedding(vector: new[] { 0.5f, 0.5f });
var embeddingCollection = OpenAIEmbeddingsModelFactory.OpenAIEmbeddingCollection(
items: new[] { embedding },
model: "text-embedding-ada-002",
usage: OpenAIEmbeddingsModelFactory.EmbeddingTokenUsage(10, 10));
var mockResponse = new MockPipelineResponse(200);

mockEmbeddingClient
.Setup(c => c.GenerateEmbeddingAsync(
It.IsAny<string>(),
It.IsAny<EmbeddingGenerationOptions>(),
It.IsAny<CancellationToken>()))
.ReturnsAsync(ClientResult.FromValue(embedding, mockResponse));

var tools = new ChatTools(mockEmbeddingClient.Object);
tools.AddLocalTools(typeof(TestTools));

var options = await Task.Run(() => tools.CreateCompletionOptions("Need to add two numbers", 1, 0.5f));

Assert.That(options.Tools, Has.Count.LessThanOrEqualTo(1));
}

[Test]
public void ImplicitConversionToCompletionOptions()
{
var tools = new ChatTools();
tools.AddLocalTools(typeof(TestTools));

ChatCompletionOptions options = tools;

Assert.That(options.Tools, Has.Count.EqualTo(2));
Assert.That(options.Tools.Any(t => t.FunctionName == "Echo"));
Assert.That(options.Tools.Any(t => t.FunctionName == "Add"));
}

[Test]
public void ThrowsWhenCallingNonExistentTool()
{
var tools = new ChatTools();
var toolCalls = new[]
{
ChatToolCall.CreateFunctionToolCall("call1", "NonExistentTool", BinaryData.FromString("{}"))
};

Assert.ThrowsAsync<InvalidOperationException>(() => tools.CallAsync(toolCalls));
}
}
126 changes: 126 additions & 0 deletions tests/Utility/ResponseToolsTests.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
using Moq;
using NUnit.Framework;
using OpenAI.Embeddings;
using OpenAI.Responses;
using System;
using System.ClientModel;
using System.ClientModel.Primitives;
using System.Linq;
using System.Threading.Tasks;

namespace OpenAI.Tests.Utility;

[TestFixture]
[Category("Utility")]
public class ResponseToolsTests
{
private class TestTools
{
public static string Echo(string message) => message;
public static int Add(int a, int b) => a + b;
}

private Mock<EmbeddingClient> mockEmbeddingClient;

[SetUp]
public void Setup()
{
mockEmbeddingClient = new Mock<EmbeddingClient>("text-embedding-ada-002", new ApiKeyCredential("test-key"));
}

[Test]
public void CanAddLocalTools()
{
var tools = new ResponseTools();
tools.AddLocalTools(typeof(TestTools));

Assert.That(tools.Tools, Has.Count.EqualTo(2));
Assert.That(tools.Tools.Any(t => ((string)t.GetType().GetProperty("Name").GetValue(t)).Contains("Echo")));
Assert.That(tools.Tools.Any(t => ((string)t.GetType().GetProperty("Name").GetValue(t)).Contains("Add")));
}

[Test]
public async Task CanCallToolAsync()
{
var tools = new ResponseTools();
tools.AddLocalTools(typeof(TestTools));

var toolCall = new FunctionCallResponseItem("call1", "Echo", BinaryData.FromString(@"{""message"": ""Hello""}"));
var result = await tools.CallAsync(toolCall);

Assert.That(result.CallId, Is.EqualTo("call1"));
Assert.That(result.ToString(), Is.EqualTo("Hello"));

var addCall = new FunctionCallResponseItem("call2", "Add", BinaryData.FromString(@"{""a"": 2, ""b"": 3}"));
result = await tools.CallAsync(addCall);

Assert.That(result.CallId, Is.EqualTo("call2"));
Assert.That(result.ToString(), Is.EqualTo("5"));
}

[Test]
public void CreatesResponseOptionsWithTools()
{
var tools = new ResponseTools();
tools.AddLocalTools(typeof(TestTools));

var options = tools.CreateResponseOptions();

Assert.That(options.Tools, Has.Count.EqualTo(2));
Assert.That(options.Tools.Any(t => t.ToString().Contains("Echo")));
Assert.That(options.Tools.Any(t => t.ToString().Contains("Add")));
}

[Test]
public async Task CanFilterToolsByRelevance()
{
// Setup mock embedding client to return a mock response
var embedding = OpenAIEmbeddingsModelFactory.OpenAIEmbedding(vector: new[] { 0.5f, 0.5f });
var embeddingCollection = OpenAIEmbeddingsModelFactory.OpenAIEmbeddingCollection(
items: new[] { embedding },
model: "text-embedding-ada-002",
usage: OpenAIEmbeddingsModelFactory.EmbeddingTokenUsage(10, 10));
var mockResponse = new MockPipelineResponse(200);

mockEmbeddingClient
.Setup(c => c.GenerateEmbeddingsAsync(
It.IsAny<BinaryContent>(),
It.IsAny<RequestOptions>()))
.ReturnsAsync(ClientResult.FromValue(embeddingCollection, mockResponse));

var tools = new ResponseTools(mockEmbeddingClient.Object);
tools.AddLocalTools(typeof(TestTools));

var options = await Task.Run(() => tools.CreateResponseOptions("Need to add two numbers", 1, 0.5f));

Assert.That(options.Tools, Has.Count.LessThanOrEqualTo(1));
mockEmbeddingClient.Verify(
c => c.GenerateEmbeddingsAsync(
It.IsAny<BinaryContent>(),
It.IsAny<RequestOptions>()),
Times.Once);
}

[Test]
public void ImplicitConversionToResponseOptions()
{
var tools = new ResponseTools();
tools.AddLocalTools(typeof(TestTools));

ResponseCreationOptions options = tools;

Assert.That(options.Tools, Has.Count.EqualTo(2));
Assert.That(options.Tools.Any(t => t.ToString().Contains("Echo")));
Assert.That(options.Tools.Any(t => t.ToString().Contains("Add")));
}

[Test]
public async Task ReturnsErrorForNonExistentTool()
{
var tools = new ResponseTools();
var toolCall = new FunctionCallResponseItem("call1", "NonExistentTool", BinaryData.FromString("{}"));

var result = await tools.CallAsync(toolCall);
Assert.That(result.ToString(), Does.StartWith("I don't have a tool called"));
}
}