mirror of
https://github.com/microsoft/agent-framework.git
synced 2026-06-16 21:04:09 +08:00
14d2ab3262
Rename authored identifiers, XML docs, log messages, and comments from 'folder' to 'directory' across the file skills codebase for consistency with the agentskills.io specification and .NET conventions. Public API changes (experimental): - ScriptFolders → ScriptDirectories - ResourceFolders → ResourceDirectories .NET BCL API calls (Directory.Exists, Path.GetDirectoryName, etc.) were already using 'directory' and are unchanged. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
60 lines
2.8 KiB
C#
60 lines
2.8 KiB
C#
// Copyright (c) Microsoft. All rights reserved.
|
|
|
|
using System.Collections.Generic;
|
|
using System.Diagnostics.CodeAnalysis;
|
|
using Microsoft.Shared.DiagnosticIds;
|
|
|
|
namespace Microsoft.Agents.AI;
|
|
|
|
/// <summary>
|
|
/// Configuration options for file-based skill sources.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Use this class to configure file-based skill discovery without relying on
|
|
/// positional constructor or method parameters. New options can be added here
|
|
/// without breaking existing callers.
|
|
/// </remarks>
|
|
[Experimental(DiagnosticIds.Experiments.AgentsAIExperiments)]
|
|
public sealed class AgentFileSkillsSourceOptions
|
|
{
|
|
/// <summary>
|
|
/// Gets or sets the allowed file extensions for skill resources.
|
|
/// When <see langword="null"/>, defaults to <c>.md</c>, <c>.json</c>, <c>.yaml</c>,
|
|
/// <c>.yml</c>, <c>.csv</c>, <c>.xml</c>, <c>.txt</c>.
|
|
/// </summary>
|
|
public IEnumerable<string>? AllowedResourceExtensions { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the allowed file extensions for skill scripts.
|
|
/// When <see langword="null"/>, defaults to <c>.py</c>, <c>.js</c>, <c>.sh</c>,
|
|
/// <c>.ps1</c>, <c>.cs</c>, <c>.csx</c>.
|
|
/// </summary>
|
|
public IEnumerable<string>? AllowedScriptExtensions { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets relative directory paths to scan for script files within each skill directory.
|
|
/// Values may be single-segment names (e.g., <c>"scripts"</c>) or multi-segment relative
|
|
/// paths (e.g., <c>"sub/scripts"</c>). Use <c>"."</c> to include files directly at the
|
|
/// skill root. Leading <c>"./"</c> prefixes, trailing separators, and backslashes are
|
|
/// normalized automatically; paths containing <c>".."</c> segments or absolute paths are
|
|
/// rejected.
|
|
/// When <see langword="null"/>, defaults to <c>scripts</c> (per the
|
|
/// <see href="https://agentskills.io/specification">Agent Skills specification</see>).
|
|
/// When set, replaces the defaults entirely.
|
|
/// </summary>
|
|
public IEnumerable<string>? ScriptDirectories { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets relative directory paths to scan for resource files within each skill directory.
|
|
/// Values may be single-segment names (e.g., <c>"references"</c>) or multi-segment relative
|
|
/// paths (e.g., <c>"sub/resources"</c>). Use <c>"."</c> to include files directly at the
|
|
/// skill root. Leading <c>"./"</c> prefixes, trailing separators, and backslashes are
|
|
/// normalized automatically; paths containing <c>".."</c> segments or absolute paths are
|
|
/// rejected.
|
|
/// When <see langword="null"/>, defaults to <c>references</c> and <c>assets</c> (per the
|
|
/// <see href="https://agentskills.io/specification">Agent Skills specification</see>).
|
|
/// When set, replaces the defaults entirely.
|
|
/// </summary>
|
|
public IEnumerable<string>? ResourceDirectories { get; set; }
|
|
}
|