ToolConfig Class

Definition

Namespace:

Azure.AI.Projects.Agents

Assembly:

Azure.AI.Projects.Agents.dll

Package:

Azure.AI.Projects.Agents v2.1.0-beta.3

Source:

ToolConfig.cs

Per-tool configuration that controls tool visibility and search behavior.

public class ToolConfig : System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.Agents.ToolConfig>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Projects.Agents.ToolConfig>

type ToolConfig = class
    interface IJsonModel<ToolConfig>
    interface IPersistableModel<ToolConfig>

Public Class ToolConfig
Implements IJsonModel(Of ToolConfig), IPersistableModel(Of ToolConfig)

Inheritance

Object

ToolConfig

Implements

IJsonModel<ToolConfig> IPersistableModel<ToolConfig> IPersistableModel<T>

Constructors

Name	Description
ToolConfig()	Initializes a new instance of ToolConfig.

Properties

Name	Description
AdditionalSearchText	Additional text indexed for tool_search. Supplements the native tool description to improve discoverability. Does not alter tools/list output.
Pin	When true, the tool is always included in agent context and visible in tools/list. When false (default), the tool is hidden from tools/list and only discoverable via tool_search.

Methods

Name	Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name	Description
IJsonModel<ToolConfig>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<ToolConfig>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<ToolConfig>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<ToolConfig>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<ToolConfig>.Write(ModelReaderWriterOptions)