Merge pull request #164 from Joy-less/replace-JsonSchema

Remove JsonSchema, use System.Text.Json.Schema instead

src/Chat.cs

@@ -163,7 +163,7 @@ public IAsyncEnumerable<string> SendAsync(string message, IEnumerable<string>? i
 	/// <param name="message">The message to send</param>
 	/// <param name="tools">Tools that the model can make use of, see https://ollama.com/blog/tool-support. By using tools, response streaming is automatically turned off</param>
 	/// <param name="imagesAsBase64">Base64 encoded images to send to the model</param>
-	/// <param name="format">Currently accepts "json" or JsonSchema or null.</param>
+	/// <param name="format">Accepts <c>"json"</c> or an object created with <c>JsonSerializerOptions.Default.GetJsonSchemaAsNode</c></param>
 	/// <param name="cancellationToken">The token to cancel the operation with</param>
 	public IAsyncEnumerable<string> SendAsync(string message, IEnumerable<Tool>? tools, IEnumerable<string>? imagesAsBase64 = null, object? format = null, CancellationToken cancellationToken = default)
 		=> SendAsAsync(ChatRole.User, message, tools: tools, imagesAsBase64: imagesAsBase64, format: format, cancellationToken: cancellationToken);
@@ -204,7 +204,7 @@ public IAsyncEnumerable<string> SendAsAsync(ChatRole role, string message, IEnum
 	/// <param name="message">The message to send</param>
 	/// <param name="tools">Tools that the model can make use of, see https://ollama.com/blog/tool-support. By using tools, response streaming is automatically turned off</param>
 	/// <param name="imagesAsBase64">Base64 encoded images to send to the model</param>
-	/// <param name="format">Currently accepts "json" or JsonSchema or null.</param>
+	/// <param name="format">Accepts <c>"json"</c> or an object created with <c>JsonSerializerOptions.Default.GetJsonSchemaAsNode</c></param>
 	/// <param name="cancellationToken">The token to cancel the operation with</param>
 	public async IAsyncEnumerable<string> SendAsAsync(ChatRole role, string message, IEnumerable<Tool>? tools, IEnumerable<string>? imagesAsBase64 = null, object? format = null, [EnumeratorCancellation] CancellationToken cancellationToken = default)
 	{

test/FunctionalTests/JsonSchemaTests.cs

@@ -0,0 +1,66 @@
+using System.Text.Json;
+using System.Text.Json.Schema;
+using NUnit.Framework;
+using FluentAssertions;
+using OllamaSharp;
+
+namespace Tests.FunctionalTests;
+
+public class JsonSchemaTests
+{
+	private readonly Uri _baseUri = new("http://localhost:11434");
+	private readonly string _model = "llama3.2:1b";
+
+	private OllamaApiClient _client = null!;
+	private Chat _chat = null!;
+
+	[SetUp]
+	public async Task Setup()
+	{
+		_client = new OllamaApiClient(_baseUri);
+		_chat = new Chat(_client);
+
+		var modelExists = (await _client.ListLocalModelsAsync()).Any(m => m.Name == _model);
+		if (!modelExists)
+			await _client.PullModelAsync(_model).ToListAsync();
+	}
+
+	[TearDown]
+	public Task Teardown()
+	{
+		_client?.Dispose();
+		return Task.CompletedTask;
+	}
+
+	[Test]
+	public async Task GenerateSword_ShouldSucceed()
+	{
+		var responseSchema = JsonSerializerOptions.Default.GetJsonSchemaAsNode(typeof(Sword));
+
+		_client.SelectedModel = _model;
+
+		var response = await _chat
+			.SendAsync("""
+				Generate a sword with the name 'Excalibur'.
+
+				Return a valid JSON object like:
+				{
+					"Name": "",
+					"Damage": 0
+				}
+				""", tools: null, format: responseSchema)
+			.StreamToEndAsync();
+		response.Should().NotBeNullOrEmpty();
+
+		var responseSword = JsonSerializer.Deserialize<Sword>(response);
+		responseSword.Should().NotBeNull();
+		responseSword.Name.ToLowerInvariant().Should().Contain("excalibur");
+		responseSword.Damage.Should().BeOfType(typeof(int));
+	}
+
+	private class Sword
+	{
+		public required string Name { get; set; }
+		public required int Damage { get; set; }
+	}
+}