CustomToolParam Class

Definition

Custom tool.

public class CustomToolParam : Azure.AI.AgentServer.Responses.Models.Tool, System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Responses.Models.CustomToolParam>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Responses.Models.CustomToolParam>
type CustomToolParam = class
    inherit Tool
    interface IJsonModel<CustomToolParam>
    interface IPersistableModel<CustomToolParam>
Public Class CustomToolParam
Inherits Tool
Implements IJsonModel(Of CustomToolParam), IPersistableModel(Of CustomToolParam)
Inheritance
CustomToolParam
Implements

Constructors

Name Description
CustomToolParam(String)

Initializes a new instance of CustomToolParam.

Properties

Name Description
DeferLoading

Whether this tool should be deferred and discovered via tool search.

Description

Optional description of the custom tool, used to provide more context.

Format

The input format for the custom tool. Default is unconstrained text.

Name

The name of the custom tool, used to identify it in tool calls.

Methods

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

Explicit Interface Implementations

Name Description
IJsonModel<CustomToolParam>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<CustomToolParam>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IJsonModel<Tool>.Create(Utf8JsonReader, ModelReaderWriterOptions) (Inherited from Tool)
IJsonModel<Tool>.Write(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from Tool)
IPersistableModel<CustomToolParam>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<CustomToolParam>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<CustomToolParam>.Write(ModelReaderWriterOptions)
IPersistableModel<Tool>.Create(BinaryData, ModelReaderWriterOptions) (Inherited from Tool)
IPersistableModel<Tool>.GetFormatFromOptions(ModelReaderWriterOptions) (Inherited from Tool)
IPersistableModel<Tool>.Write(ModelReaderWriterOptions) (Inherited from Tool)

Applies to