Stevan/anthropic-client
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: implement json schema generation for non-complex types

Browse Source
This commit is contained in:
Stevan Freeborn
2024-06-30 13:57:35 -05:00
parent 4fd8ecd96b
commit 96ed89c9ce
3 changed files with 595 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tests/AnthropicClient.Tests/Unit/Utils/JsonSchemaGeneratorTestData.cs
+453
View File
@@ -0,0 +1,453 @@
using System.Collections;
using System.Text.Json.Nodes;
namespace AnthropicClient.Tests.Unit.Utils;
public class JsonSchemaGeneratorTestData : IEnumerable<object[]>
{
private const string TestToolName = "Test tool name";
private const string TestToolDescription = "Test tool description";
public IEnumerator<object[]> GetEnumerator()
{
// string parameter type
yield return new object[]
{
Tool.CreateFromFunction(TestToolName,TestToolDescription,(string name) => name),
new JsonObject()
{
["type"] = "object",
["properties"] = new JsonObject()
{
["name"] = new JsonObject()
{
["type"] = "string",
["description"] = string.Empty
}
},
["required"] = new JsonArray()
{
"name"
},
}
};
// char parameter type
yield return new object[]
{
Tool.CreateFromFunction(TestToolName,TestToolDescription,(char name) => name),
new JsonObject()
{
["type"] = "object",
["properties"] = new JsonObject()
{
["name"] = new JsonObject()
{
["type"] = "string",
["description"] = string.Empty
}
},
["required"] = new JsonArray()
{
"name"
},
}
};
// int parameter type
yield return new object[]
{
Tool.CreateFromFunction(TestToolName,TestToolDescription,(int age) => age),
new JsonObject()
{
["type"] = "object",
["properties"] = new JsonObject()
{
["age"] = new JsonObject()
{
["type"] = "integer",
["description"] = string.Empty
}
},
["required"] = new JsonArray()
{
"age"
},
}
};
// uint parameter type
yield return new object[]
{
Tool.CreateFromFunction(TestToolName,TestToolDescription,(uint age) => age),
new JsonObject()
{
["type"] = "object",
["properties"] = new JsonObject()
{
["age"] = new JsonObject()
{
["type"] = "integer",
["description"] = string.Empty
}
},
["required"] = new JsonArray()
{
"age"
},
}
};
// long parameter type
yield return new object[]
{
Tool.CreateFromFunction(TestToolName,TestToolDescription,(long age) => age),
new JsonObject()
{
["type"] = "object",
["properties"] = new JsonObject()
{
["age"] = new JsonObject()
{
["type"] = "integer",
["description"] = string.Empty
}
},
["required"] = new JsonArray()
{
"age"
},
}
};
// ulong parameter type
yield return new object[]
{
Tool.CreateFromFunction(TestToolName,TestToolDescription,(ulong age) => age),
new JsonObject()
{
["type"] = "object",
["properties"] = new JsonObject()
{
["age"] = new JsonObject()
{
["type"] = "integer",
["description"] = string.Empty
}
},
["required"] = new JsonArray()
{
"age"
},
}
};
// short parameter type
yield return new object[]
{
Tool.CreateFromFunction(TestToolName,TestToolDescription,(short age) => age),
new JsonObject()
{
["type"] = "object",
["properties"] = new JsonObject()
{
["age"] = new JsonObject()
{
["type"] = "integer",
["description"] = string.Empty
}
},
["required"] = new JsonArray()
{
"age"
},
}
};
// ushort parameter type
yield return new object[]
{
Tool.CreateFromFunction(TestToolName,TestToolDescription,(ushort age) => age),
new JsonObject()
{
["type"] = "object",
["properties"] = new JsonObject()
{
["age"] = new JsonObject()
{
["type"] = "integer",
["description"] = string.Empty
}
},
["required"] = new JsonArray()
{
"age"
},
}
};
// byte parameter type
yield return new object[]
{
Tool.CreateFromFunction(TestToolName,TestToolDescription,(byte age) => age),
new JsonObject()
{
["type"] = "object",
["properties"] = new JsonObject()
{
["age"] = new JsonObject()
{
["type"] = "integer",
["description"] = string.Empty
}
},
["required"] = new JsonArray()
{
"age"
},
}
};
// sbyte parameter type
yield return new object[]
{
Tool.CreateFromFunction(TestToolName,TestToolDescription,(sbyte age) => age),
new JsonObject()
{
["type"] = "object",
["properties"] = new JsonObject()
{
["age"] = new JsonObject()
{
["type"] = "integer",
["description"] = string.Empty
}
},
["required"] = new JsonArray()
{
"age"
},
}
};
// bool parameter type
yield return new object[]
{
Tool.CreateFromFunction(TestToolName,TestToolDescription,(bool isAdult) => isAdult),
new JsonObject()
{
["type"] = "object",
["properties"] = new JsonObject()
{
["isAdult"] = new JsonObject()
{
["type"] = "boolean",
["description"] = string.Empty
}
},
["required"] = new JsonArray()
{
"isAdult"
},
}
};
// double parameter type
yield return new object[]
{
Tool.CreateFromFunction(TestToolName,TestToolDescription,(double age) => age),
new JsonObject()
{
["type"] = "object",
["properties"] = new JsonObject()
{
["age"] = new JsonObject()
{
["type"] = "number",
["description"] = string.Empty
}
},
["required"] = new JsonArray()
{
"age"
},
}
};
// float parameter type
yield return new object[]
{
Tool.CreateFromFunction(TestToolName,TestToolDescription,(float age) => age),
new JsonObject()
{
["type"] = "object",
["properties"] = new JsonObject()
{
["age"] = new JsonObject()
{
["type"] = "number",
["description"] = string.Empty
}
},
["required"] = new JsonArray()
{
"age"
},
}
};
// decimal parameter type
yield return new object[]
{
Tool.CreateFromFunction(TestToolName,TestToolDescription,(decimal age) => age),
new JsonObject()
{
["type"] = "object",
["properties"] = new JsonObject()
{
["age"] = new JsonObject()
{
["type"] = "number",
["description"] = string.Empty
}
},
["required"] = new JsonArray()
{
"age"
},
}
};
// datetime parameter type
yield return new object[]
{
Tool.CreateFromFunction(TestToolName,TestToolDescription,(DateTime date) => date),
new JsonObject()
{
["type"] = "object",
["properties"] = new JsonObject()
{
["date"] = new JsonObject()
{
["type"] = "string",
["format"] = "date-time",
["description"] = string.Empty
}
},
["required"] = new JsonArray()
{
"date"
},
}
};
// datetimeoffset parameter type
yield return new object[]
{
Tool.CreateFromFunction(TestToolName,TestToolDescription,(DateTimeOffset date) => date),
new JsonObject()
{
["type"] = "object",
["properties"] = new JsonObject()
{
["date"] = new JsonObject()
{
["type"] = "string",
["format"] = "date-time",
["description"] = string.Empty
}
},
["required"] = new JsonArray()
{
"date"
},
}
};
// enum parameter type
yield return new object[]
{
Tool.CreateFromFunction(TestToolName,TestToolDescription,(DayOfWeek day) => day),
new JsonObject()
{
["type"] = "object",
["properties"] = new JsonObject()
{
["day"] = new JsonObject()
{
["type"] = "string",
["description"] = string.Empty,
["enum"] = new JsonArray()
{
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
},
}
},
["required"] = new JsonArray()
{
"day"
},
}
};
// array parameter type
yield return new object[]
{
Tool.CreateFromFunction(TestToolName,TestToolDescription,(int[] numbers) => numbers),
new JsonObject()
{
["type"] = "object",
["properties"] = new JsonObject()
{
["numbers"] = new JsonObject()
{
["type"] = "array",
["items"] = new JsonObject()
{
["type"] = "integer"
},
["description"] = string.Empty
}
},
["required"] = new JsonArray()
{
"numbers"
},
}
};
// list parameter type
yield return new object[]
{
Tool.CreateFromFunction(TestToolName,TestToolDescription,(List<int> numbers) => numbers),
new JsonObject()
{
["type"] = "object",
["properties"] = new JsonObject()
{
["numbers"] = new JsonObject()
{
["type"] = "array",
["items"] = new JsonObject()
{
["type"] = "integer"
},
["description"] = string.Empty
}
},
["required"] = new JsonArray()
{
"numbers"
},
}
};
}
IEnumerator IEnumerable.GetEnumerator() => GetEnumerator();
}
tests/AnthropicClient.Tests/Unit/Utils/JsonSchemaGeneratorTests.cs
+27 -1
View File
@@ -1,6 +1,6 @@
using System.Text.Json.Nodes;
namespace AnthropicClient.Tests.Unit.Models;
namespace AnthropicClient.Tests.Unit.Utils;
public class JsonSchemaGeneratorTests
{
@@ -96,4 +96,30 @@ public class JsonSchemaGeneratorTests
JsonAssert.Equal(expectedSchema, schema);
}
[Fact]
public void GenerateInputSchema_GivenFunctionWithParametersThatIncludesCancellationToken_ItShouldReturnSchemaWithoutCancellationToken()
{
var expectedSchema = new JsonObject()
{
["type"] = "object",
["properties"] = new JsonObject(),
["required"] = new JsonArray(),
};
var testMethod = (CancellationToken token) => true;
var function = new AnthropicFunction(testMethod.Method);
var schema = JsonSchemaGenerator.GenerateInputSchema(function);
JsonAssert.Equal(expectedSchema, schema);
}
[Theory]
[ClassData(typeof(JsonSchemaGeneratorTestData))]
public void GenerateInputSchema_GivenFunction_ItShouldReturnExpectedSchema(Tool tool, JsonObject expectedSchema)
{
var schema = JsonSchemaGenerator.GenerateInputSchema(tool.Function);
JsonAssert.Equal(expectedSchema, schema);
}
}