using System.Diagnostics.CodeAnalysis;
using System.Globalization;
using System.Text.Json;
namespace AIStudio.Tools.ToolCallingSystem;
///
/// Reads the arguments a model passes to a tool, and refuses wrong ones.
///
///
/// A wrong argument is refused rather than guessed at: a placeholder such as 0 is not a page, and
/// quietly reading it as "no page" would do something the model did not ask for. The model reads
/// the refusal and tries again, so every refusal says what arrived, what would have been right,
/// and, for an optional argument, that leaving it out is always an option. A model which believes
/// the argument has to be there otherwise keeps trying placeholders, and every attempt costs one of
/// the tool calls an answer may make.
/// A null counts the same as leaving an argument out: with a strict schema, a model has to pass
/// every argument and passes null for one it does not want to set.
///
internal static class ToolArgumentReader
{
///
/// How much of a wrongly passed argument a refusal repeats back to the model.
///
///
/// Enough for a GUID in quotes. The model sent the value itself, so repeating all of it back
/// only costs tokens.
///
private const int MAX_ARGUMENT_ECHO_LENGTH = 40;
private static readonly string[] DATE_TIME_FORMATS_WITH_OFFSET = ["yyyy-MM-dd'T'HH:mmzzz", "yyyy-MM-dd'T'HH:mm:sszzz", "yyyy-MM-dd'T'HH:mm:ss.FFFFFFFzzz"];
private static readonly string[] DATE_TIME_FORMATS_IN_UTC = ["yyyy-MM-dd'T'HH:mm'Z'", "yyyy-MM-dd'T'HH:mm:ss'Z'", "yyyy-MM-dd'T'HH:mm:ss.FFFFFFF'Z'"];
private static readonly string[] DATE_TIME_FORMATS_WITHOUT_OFFSET = ["yyyy-MM-dd", "yyyy-MM-dd'T'HH:mm", "yyyy-MM-dd'T'HH:mm:ss", "yyyy-MM-dd'T'HH:mm:ss.FFFFFFF"];
///
/// Reads a string argument the model always has to pass.
///
/// The arguments the model passed.
/// The argument.
/// The value, trimmed and never empty.
/// The argument is missing, no string, or empty.
public static string ReadRequiredString(JsonElement arguments, string propertyName)
{
if (!TryGetArgument(arguments, propertyName, out var value))
throw new ArgumentException($"Missing required argument '{propertyName}'.");
var text = ReadString(propertyName, value, whenLeftOut: null);
if (string.IsNullOrWhiteSpace(text))
throw InvalidArgument(propertyName, value, "a non-empty string", whenLeftOut: null);
return text;
}
///
/// Reads an optional string argument.
///
/// The arguments the model passed.
/// The argument.
/// What happens without the argument, completing "Leave it out ...".
/// The value, trimmed, or null when the model left the argument out.
/// The argument is no string.
public static string? ReadOptionalString(JsonElement arguments, string propertyName, string whenLeftOut)
{
if (!TryGetArgument(arguments, propertyName, out var value))
return null;
return ReadString(propertyName, value, whenLeftOut);
}
///
/// Reads an optional string argument which has to be a single line of limited length.
///
///
/// For what ends up in a search, such as a part of an address. An empty string is refused
/// rather than read as leaving the argument out: it asks for nothing, and in a search it would
/// match everything.
///
/// The arguments the model passed.
/// The argument.
/// How long the line may be.
/// What happens without the argument, completing "Leave it out ...".
/// The line, trimmed and never empty, or null when the model left the argument out.
/// The argument is no string, empty, too long, or holds a line break or another control character.
public static string? ReadOptionalLine(JsonElement arguments, string propertyName, int maxCharacters, string whenLeftOut)
{
var text = ReadOptionalString(arguments, propertyName, whenLeftOut);
if (text is null)
return null;
if (text.Length == 0)
throw Refusal($"Argument '{propertyName}' must not be empty.", whenLeftOut);
if (text.Length > maxCharacters)
throw Refusal($"Argument '{propertyName}' must be at most {maxCharacters} characters long, but had {text.Length}.", whenLeftOut);
if (text.Any(char.IsControl))
throw Refusal($"Argument '{propertyName}' must not contain control characters such as line breaks. Write it as a single line.", whenLeftOut);
return text;
}
///
/// Reads an optional argument which has to be a positive integer.
///
/// The arguments the model passed.
/// The argument.
/// What happens without the argument, completing "Leave it out ...".
/// The value, or null when the model left the argument out.
/// The argument is no positive integer.
public static int? ReadOptionalPositiveInt(JsonElement arguments, string propertyName, string whenLeftOut)
{
if (!TryGetArgument(arguments, propertyName, out var value))
return null;
if (value.ValueKind is not JsonValueKind.Number || !value.TryGetInt32(out var intValue) || intValue <= 0)
throw InvalidArgument(propertyName, value, "a positive integer", whenLeftOut);
return intValue;
}
///
/// Reads an optional argument which has to be true or false.
///
///
/// Only a JSON boolean counts. A string such as "true" is refused, since a model which writes
/// one may just as well write "yes", and guessing what it meant is what this reader avoids.
///
/// The arguments the model passed.
/// The argument.
/// What happens without the argument, completing "Leave it out ...".
/// The value, or null when the model left the argument out.
/// The argument is no boolean.
public static bool? ReadOptionalBoolean(JsonElement arguments, string propertyName, string whenLeftOut)
{
if (!TryGetArgument(arguments, propertyName, out var value))
return null;
return value.ValueKind switch
{
JsonValueKind.True => true,
JsonValueKind.False => false,
_ => throw InvalidArgument(propertyName, value, "true or false", whenLeftOut),
};
}
///
/// Reads an optional argument which has to be a date, or a date with a time of day.
///
///
/// The model writes the dates the user speaks of, and the user speaks of their own time zone.
/// So a date stands for its beginning there, and a time of day without an offset is a time
/// there as well. Only a time with an offset or a Z keeps the offset it states. Everything else,
/// such as "yesterday" or a date in another order, is refused.
///
/// The arguments the model passed.
/// The argument.
/// The time zone of the user.
/// What happens without the argument, completing "Leave it out ...".
/// The point in time, or null when the model left the argument out.
/// The argument is no date in one of the accepted forms.
public static DateTimeOffset? ReadOptionalDateTime(JsonElement arguments, string propertyName, TimeZoneInfo timeZone, string whenLeftOut)
{
if (!TryGetArgument(arguments, propertyName, out var value))
return null;
var text = value.ValueKind is JsonValueKind.String ? value.GetString()?.Trim() : null;
if (text is null || !TryParseDateTime(text, timeZone, out var pointInTime))
throw InvalidArgument(propertyName, value, "a date such as 2026-09-01, or a date with a time of day such as 2026-09-01T14:30", whenLeftOut);
return pointInTime;
}
private static bool TryParseDateTime(string text, TimeZoneInfo timeZone, out DateTimeOffset pointInTime)
{
if (DateTimeOffset.TryParseExact(text, DATE_TIME_FORMATS_WITH_OFFSET, CultureInfo.InvariantCulture, DateTimeStyles.None, out pointInTime))
return true;
// Without AssumeUniversal, a Z would get the offset of this computer:
if (DateTimeOffset.TryParseExact(text, DATE_TIME_FORMATS_IN_UTC, CultureInfo.InvariantCulture, DateTimeStyles.AssumeUniversal, out pointInTime))
return true;
if (DateTime.TryParseExact(text, DATE_TIME_FORMATS_WITHOUT_OFFSET, CultureInfo.InvariantCulture, DateTimeStyles.None, out var localTime))
{
pointInTime = new DateTimeOffset(localTime, timeZone.GetUtcOffset(localTime));
return true;
}
pointInTime = default;
return false;
}
///
/// Reads an optional argument which has to be one of the values the tool offers.
///
///
/// The values are compared exactly, because the schema offers them exactly so.
///
/// The arguments the model passed.
/// The argument.
/// The values the tool offers.
/// What happens without the argument, completing "Leave it out ...".
/// The value, or null when the model left the argument out.
/// The argument is none of the offered values.
public static string? ReadOptionalChoice(JsonElement arguments, string propertyName, IReadOnlyCollection allowedValues, string whenLeftOut)
{
if (!TryGetArgument(arguments, propertyName, out var value))
return null;
if (!TryReadChoice(value, allowedValues, out var choice))
throw InvalidArgument(propertyName, value, $"one of {string.Join(", ", allowedValues)}", whenLeftOut);
return choice;
}
///
/// Reads an optional argument which has to be a list of values the tool offers.
///
///
/// The values are compared exactly, because the schema offers them exactly so. An empty list is
/// refused rather than read as leaving the argument out: it asks for none of the values, and
/// what leaving it out does instead is for the refusal to say. A value the model names twice
/// counts once.
///
/// The arguments the model passed.
/// The argument.
/// The values the tool offers.
/// What happens without the argument, completing "Leave it out ...".
/// The values in the order the model named them, or null when it left the argument out.
/// The argument is no list, an empty one, or holds a value the tool does not offer.
public static IReadOnlyList? ReadOptionalChoices(JsonElement arguments, string propertyName, IReadOnlyCollection allowedValues, string whenLeftOut)
{
if (!TryGetArgument(arguments, propertyName, out var value))
return null;
var offeredValues = string.Join(", ", allowedValues);
if (value.ValueKind is not JsonValueKind.Array || value.GetArrayLength() == 0)
throw InvalidArgument(propertyName, value, $"a list of one or more of {offeredValues}", whenLeftOut);
var choices = new List(value.GetArrayLength());
foreach (var item in value.EnumerateArray())
{
if (!TryReadChoice(item, allowedValues, out var choice))
throw InvalidListValue(propertyName, item, $"one of {offeredValues}", whenLeftOut);
if (!choices.Contains(choice, StringComparer.Ordinal))
choices.Add(choice);
}
return choices;
}
///
/// Looks up an argument, treating null the same as leaving it out.
///
private static bool TryGetArgument(JsonElement arguments, string propertyName, out JsonElement value) =>
arguments.TryGetProperty(propertyName, out value) && value.ValueKind is not JsonValueKind.Null;
private static string ReadString(string propertyName, JsonElement value, string? whenLeftOut)
{
if (value.ValueKind is not JsonValueKind.String)
throw InvalidArgument(propertyName, value, "a string", whenLeftOut);
return value.GetString()?.Trim() ?? string.Empty;
}
private static bool TryReadChoice(JsonElement value, IReadOnlyCollection allowedValues, [NotNullWhen(true)] out string? choice)
{
choice = value.ValueKind is JsonValueKind.String ? value.GetString()?.Trim() : null;
return choice is not null && allowedValues.Contains(choice, StringComparer.Ordinal);
}
///
/// Builds the refusal of an argument the model passed wrongly.
///
/// The argument.
/// What the model passed, as it arrived.
/// What the argument must be, completing "must be ...".
/// What happens without the argument, completing "Leave it out ...", or null for a required one.
private static ArgumentException InvalidArgument(string propertyName, JsonElement value, string expectation, string? whenLeftOut) =>
Refusal($"Argument '{propertyName}' must be {expectation}, but was {Echo(value)}.", whenLeftOut);
///
/// Builds the refusal of a list the model passed with a wrong value in it.
///
///
/// Only the wrong value is repeated back, not the whole list: the model has to find out which
/// of its values the tool means.
///
private static ArgumentException InvalidListValue(string propertyName, JsonElement item, string expectation, string whenLeftOut) =>
Refusal($"Every value of argument '{propertyName}' must be {expectation}, but one was {Echo(item)}.", whenLeftOut);
private static ArgumentException Refusal(string message, string? whenLeftOut) => new(whenLeftOut is null ? message : $"{message} Leave it out {whenLeftOut}.");
private static string Echo(JsonElement value)
{
var receivedValue = value.GetRawText();
return receivedValue.Length > MAX_ARGUMENT_ECHO_LENGTH ? $"{receivedValue[..MAX_ARGUMENT_ECHO_LENGTH]}..." : receivedValue;
}
}