OpenAPITool Class

Definition

The input definition information for an OpenAPI tool as used to configure an agent.

public class OpenAPITool : Azure.AI.Projects.Agents.ProjectsAgentTool, System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.Agents.OpenAPITool>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Projects.Agents.OpenAPITool>
type OpenAPITool = class
    inherit ProjectsAgentTool
    interface IJsonModel<OpenAPITool>
    interface IPersistableModel<OpenAPITool>
Public Class OpenAPITool
Inherits ProjectsAgentTool
Implements IJsonModel(Of OpenAPITool), IPersistableModel(Of OpenAPITool)
Inheritance
Implements

Constructors

Name Description
OpenAPITool(OpenApiFunctionDefinition)

Initializes a new instance of OpenAPITool.

Properties

Name Description
FunctionDefinition

The openapi function definition.

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.

Methods

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

Explicit Interface Implementations

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

Applies to