MindWorkAI/AI-Studio
MindWorkAI/AI-Studio
1
0
Fork 0
mirror of https://github.com/MindWorkAI/AI-Studio.git synced 2025-04-28 15:19:46 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Added documentation to data source types

Browse Source
This commit is contained in:
Thorsten Sommer 2025-01-05 16:14:41 +01:00
parent 6d3f1f85fc
commit c62bcb11f4
Signed by: tsommer
GPG Key ID: 371BBA77A02C0108
2 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
app/MindWork AI Studio/Settings/DataModel/DataSourceType.cs
View File

@ -1,11 +1,27 @@
namespace AIStudio.Settings.DataModel; namespace AIStudio.Settings.DataModel;
/// <summary>
/// AI Studio data source types.
/// </summary>
public enum DataSourceType public enum DataSourceType
{ {
/// <summary>
/// No data source.
/// </summary>
NONE = 0, NONE = 0,
/// <summary>
/// One file on the local machine (or a network share).
/// </summary>
LOCAL_FILE, LOCAL_FILE,
/// <summary>
/// A directory on the local machine (or a network share).
/// </summary>
LOCAL_DIRECTORY, LOCAL_DIRECTORY,
/// <summary>
/// External data source accessed via an ERI server, cf. https://github.com/MindWorkAI/ERI.
/// </summary>
ERI, ERI,
} }

8
app/MindWork AI Studio/Settings/DataModel/DataSourceTypeExtension.cs
View File

@ -1,7 +1,15 @@
namespace AIStudio.Settings.DataModel; namespace AIStudio.Settings.DataModel;
/// <summary>
/// Extension methods for data source types.
/// </summary>
public static class DataSourceTypeExtension public static class DataSourceTypeExtension
{ {
/// <summary>
/// Get the display name of the data source type.
/// </summary>
/// <param name="type">The data source type.</param>
/// <returns>The display name of the data source type.</returns>
public static string GetDisplayName(this DataSourceType type) public static string GetDisplayName(this DataSourceType type)
{ {
return type switch return type switch