ResponsesOpenApiTool Class

Definition

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

public class ResponsesOpenApiTool : Azure.AI.Extensions.OpenAI.ResponsesTool, System.ClientModel.Primitives.IJsonModel<Azure.AI.Extensions.OpenAI.ResponsesOpenApiTool>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Extensions.OpenAI.ResponsesOpenApiTool>
type ResponsesOpenApiTool = class
    inherit ResponsesTool
    interface IJsonModel<ResponsesOpenApiTool>
    interface IPersistableModel<ResponsesOpenApiTool>
Public Class ResponsesOpenApiTool
Inherits ResponsesTool
Implements IJsonModel(Of ResponsesOpenApiTool), IPersistableModel(Of ResponsesOpenApiTool)
Inheritance
ResponsesOpenApiTool
Implements

Constructors

Name Description
ResponsesOpenApiTool(ResponsesOpenApiFunctionDefinition)

Initializes a new instance of ResponsesOpenApiTool.

Properties

Name Description
OpenApi

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<ResponsesOpenApiTool>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<ResponsesOpenApiTool>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IJsonModel<ResponsesTool>.Create(Utf8JsonReader, ModelReaderWriterOptions) (Inherited from ResponsesTool)
IJsonModel<ResponsesTool>.Write(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from ResponsesTool)
IPersistableModel<ResponsesOpenApiTool>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<ResponsesOpenApiTool>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<ResponsesOpenApiTool>.Write(ModelReaderWriterOptions)
IPersistableModel<ResponsesTool>.Create(BinaryData, ModelReaderWriterOptions) (Inherited from ResponsesTool)
IPersistableModel<ResponsesTool>.GetFormatFromOptions(ModelReaderWriterOptions) (Inherited from ResponsesTool)
IPersistableModel<ResponsesTool>.Write(ModelReaderWriterOptions) (Inherited from ResponsesTool)

Applies to