mirror of
https://github.com/MindWorkAI/AI-Studio.git
synced 2025-02-12 05:49:06 +00:00
20 lines
1.1 KiB
C#
20 lines
1.1 KiB
C#
|
namespace AIStudio.Tools.ERIClient.DataModel;
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Represents information about the used embedding for this data source. The purpose of this information is to give the
|
||
|
|
/// interested user an idea of what kind of embedding is used and what it does.
|
||
|
|
/// </summary>
|
||
|
|
/// <param name="EmbeddingType">What kind of embedding is used. For example, "Transformer Embedding," "Contextual Word
|
||
|
|
/// Embedding," "Graph Embedding," etc.</param>
|
||
|
|
/// <param name="EmbeddingName">Name the embedding used. This can be a library, a framework, or the name of the used
|
||
|
|
/// algorithm.</param>
|
||
|
|
/// <param name="Description">A short description of the embedding. Describe what the embedding is doing.</param>
|
||
|
|
/// <param name="UsedWhen">Describe when the embedding is used. For example, when the user prompt contains certain
|
||
|
|
/// keywords, or anytime?</param>
|
||
|
|
/// <param name="Link">A link to the embedding's documentation or the source code. Might be null.</param>
|
||
|
|
public readonly record struct EmbeddingInfo(
|
||
|
|
string EmbeddingType,
|
||
|
|
string EmbeddingName,
|
||
|
|
string Description,
|
||
|
|
string UsedWhen,
|
||
|
|
string? Link);
|