Class PluginMetadata

Namespace

FoundationaLLM.Common.Models.Plugins.Metadata

Assembly

FoundationaLLM.Common.dll

Provides the model for plugin metadata.

public class PluginMetadata

Inheritance

object

PluginMetadata

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ObjectExtensions.GetPropertyValues(object, List<string>)

Properties

Category

Gets or sets the category of the plugin.

[JsonPropertyName("category")]
public required string Category { get; set; }

Property Value

string

Dependencies

Gets or sets the list of PluginDependencyMetadata objects that represent the dependencies of the plugin.

[JsonPropertyName("dependencies")]
public List<PluginDependencyMetadata> Dependencies { get; set; }

Property Value

List<PluginDependencyMetadata>

Description

Gets or sets the description of the plugin.

[JsonPropertyName("description")]
public required string Description { get; set; }

Property Value

string

DisplayName

Gets or sets the display name of the plugin.

[JsonPropertyName("display_name")]
public required string DisplayName { get; set; }

Property Value

string

Name

Gets or sets the name of the plugin.

[JsonPropertyName("name")]
public required string Name { get; set; }

Property Value

string

ObjectId

Gets or sets the FoundationaLLM resoure identifier of the plugin.

[JsonPropertyName("object_id")]
public required string ObjectId { get; set; }

Property Value

string

ParameterSelectionHints

Gets or sets the metadata associated with the plugin parameter selection hints.

[JsonPropertyName("parameter_selection_hints")]
public Dictionary<string, PluginParameterSelectionHint> ParameterSelectionHints { get; set; }

Property Value

Dictionary<string, PluginParameterSelectionHint>

Remarks

The keys in the dictionary are the name of the paramters that are of type resource-object-id.

The values in the dictionary are PluginParameterSelectionHint object providing the selection hints for the parameter.

Parameters

Gets or sets the metadata associated with the plugin parameters.

[JsonPropertyName("parameters")]
public List<PluginParameterMetadata> Parameters { get; set; }

Property Value

List<PluginParameterMetadata>