OpenApiToolboxTool Class

Definition

Namespace:

Azure.AI.Projects.Agents

Assembly:

Azure.AI.Projects.Agents.dll

Package:

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

Source:

OpenApiToolboxTool.cs

An OpenAPI tool stored in a toolbox.

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

type OpenApiToolboxTool = class
    inherit ToolboxTool
    interface IJsonModel<OpenApiToolboxTool>
    interface IPersistableModel<OpenApiToolboxTool>

Public Class OpenApiToolboxTool
Inherits ToolboxTool
Implements IJsonModel(Of OpenApiToolboxTool), IPersistableModel(Of OpenApiToolboxTool)

Inheritance

Object

ToolboxTool

OpenApiToolboxTool

Implements

IJsonModel<OpenApiToolboxTool> IPersistableModel<OpenApiToolboxTool> IPersistableModel<T>

Constructors

Name	Description
OpenApiToolboxTool(OpenApiFunctionDefinition)	Initializes a new instance of OpenApiToolboxTool.

Properties

Name	Description
Description	Optional user-defined description for this tool or configuration. (Inherited from ToolboxTool)
FunctionDefinition	The openapi function definition.
Name	Optional user-defined name for this tool or configuration. (Inherited from ToolboxTool)
ToolConfigs	Per-tool configuration map. Keys are tool names or * (catch-all default). Resolution order: exact tool name match takes priority over *. Unknown tool names are silently ignored at runtime. (Inherited from ToolboxTool)

Methods

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

Explicit Interface Implementations

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