Class AgentTool

Namespace

FoundationaLLM.Common.Models.ResourceProviders.Agent

Assembly

FoundationaLLM.Common.dll

Prvides the settings for a tool that is registered with the agent.

public class AgentTool

Inheritance

object

AgentTool

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 tool.

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

Property Value

string

ClassName

Gets or sets the underlying class name of the tool.

[JsonPropertyName("class_name")]
public string? ClassName { get; set; }

Property Value

string

Description

Gets or sets the description of the tool.

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

Property Value

string

Name

Gets or sets the name of the tool.

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

Property Value

string

PackageName

Gets or sets the package name of the tool. For internal tools, this value will be FoundationaLLM For external tools, this value will be the name of the package.

[JsonPropertyName("package_name")]
public required string PackageName { get; set; }

Property Value

string

Properties

Gets or sets a dictionary of properties that are specific to the tool.

[JsonPropertyName("properties")]
public Dictionary<string, object>? Properties { get; set; }

Property Value

Dictionary<string, object>

ResourceObjectIds

Gets or sets a dictionary of resource objects.

[JsonPropertyName("resource_object_ids")]
public Dictionary<string, ResourceObjectIdProperties> ResourceObjectIds { get; set; }

Property Value

Dictionary<string, ResourceObjectIdProperties>

Methods

GetKnowledgeSearchSettings()

Gets the knowledge search settings if they exists.

public KnowledgeSearchSettings? GetKnowledgeSearchSettings()

Returns

KnowledgeSearchSettings

An object containing the knowledge search settings.

TryGetPropertyValue<T>(string, out T?)

Tries to get the value of a property.

public bool TryGetPropertyValue<T>(string propertyName, out T? propertyValue)

Parameters

propertyName string

The name of the property being retrieved.

propertyValue T

The resultig property value.

Returns

bool

true if the property value was successfull retrieved, false otherwise.

Type Parameters

T

The type of the property being retrieved.

TryGetResourceObjectIdsWithRole(string, out List<string>?)

Tries to get the resource object identifiers with the specified role.

public bool TryGetResourceObjectIdsWithRole(string roleName, out List<string>? resourceObjectIds)

Parameters

roleName string

The name of the role being searched for. This is the value of the "object_role" property.

resourceObjectIds List<string>

The resulting list of resource object identifiers.

Returns

bool