OpenApiTool Class

Definition

Namespace:

Azure.AI.Extensions.OpenAI

Assembly:

Azure.AI.Extensions.OpenAI.dll

Package:

Azure.AI.Extensions.OpenAI v3.0.0-beta.3

Source:

OpenApiTool.cs

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

public class OpenApiTool : OpenAI.Responses.ResponseTool, System.ClientModel.Primitives.IJsonModel<Azure.AI.Extensions.OpenAI.OpenApiTool>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Extensions.OpenAI.OpenApiTool>

type OpenApiTool = class
    inherit ResponseTool
    interface IJsonModel<OpenApiTool>
    interface IPersistableModel<OpenApiTool>

Public Class OpenApiTool
Inherits ResponseTool
Implements IJsonModel(Of OpenApiTool), IPersistableModel(Of OpenApiTool)

Inheritance

OpenAI.Responses.ResponseTool

OpenApiTool

Implements

IJsonModel<OpenApiTool> IPersistableModel<OpenApiTool> IPersistableModel<T>

Constructors

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

Properties

Name	Description
FunctionDefinition	The openapi function definition.
ToolConfigs	Deprecated. This property is deprecated and will be removed in a future version.

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)
IPersistableModel<OpenApiTool>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<OpenApiTool>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<OpenApiTool>.Write(ModelReaderWriterOptions)