AI-Studio/app/MindWork AI Studio/Tools/ToolCallingSystem/ToolSettingsFieldDefinition.cs

47 lines
1.9 KiB
C#
Raw Normal View History

using System.Text.Json.Serialization;
namespace AIStudio.Tools.ToolCallingSystem;
public sealed class ToolSettingsFieldDefinition
{
public string Type { get; init; } = "string";
public string Title { get; init; } = string.Empty;
public string Description { get; init; } = string.Empty;
[JsonPropertyName("enum")]
public List<string> EnumValues { get; init; } = [];
/// <summary>
/// Name of a list of options the app maintains, as an alternative to spelling them out in
/// the enum field. See the tool settings option sources for the available names.
/// </summary>
/// <remarks>
/// Use this for values the app already knows, such as languages: it keeps the list in one
/// place and gives the user readable names instead of raw values. Mutually exclusive with
/// the enum field.
/// </remarks>
public string OptionSource { get; init; } = string.Empty;
public bool Secret { get; init; }
/// <summary>
/// Name of the group this field belongs to, or empty when it stands on its own.
/// </summary>
/// <remarks>
/// The fields of one group are rendered together, under a heading the implementation
/// translates and next to whatever links it offers for them. Use it when a tool
/// configures several separate things that each need a few fields, such as one search
/// backend per group. A tool with a handful of settings that all belong to it needs no
/// groups at all.
/// </remarks>
public string Group { get; init; } = string.Empty;
/// <summary>
/// The values and names to offer for this field, from whichever way it declares them.
/// </summary>
public IReadOnlyList<ToolSettingsOption> GetOptions() => string.IsNullOrWhiteSpace(this.OptionSource)
? this.EnumValues.Select(value => new ToolSettingsOption(value, value)).ToList()
: ToolSettingsOptionSources.Resolve(this.OptionSource);
}