Package com.azure.ai.agents.persistent.models

Class OpenApiToolDefinition

java.lang.Object

com.azure.ai.agents.persistent.models.ToolDefinition

com.azure.ai.agents.persistent.models.OpenApiToolDefinition

All Implemented Interfaces:

com.azure.json.JsonSerializable<ToolDefinition>

public final class OpenApiToolDefinition
extends ToolDefinition

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

Constructor Summary

Constructors

Constructor	Description
OpenApiToolDefinition(OpenApiFunctionDefinition openapi)	Creates an instance of OpenApiToolDefinition class.

Method Summary

Modifier and Type	Method	Description
static OpenApiToolDefinition	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of OpenApiToolDefinition from the JsonReader.
OpenApiFunctionDefinition	getOpenapi()	Get the openapi property: The openapi function definition.
String	getType()	Get the type property: The object type.
com.azure.json.JsonWriter	toJson(com.azure.json.JsonWriter jsonWriter)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.azure.json.JsonSerializable

toJson, toJson, toJsonBytes, toJsonString

Constructor Details

OpenApiToolDefinition

public OpenApiToolDefinition(OpenApiFunctionDefinition openapi)

Creates an instance of OpenApiToolDefinition class.

Parameters:

openapi - the openapi value to set.

Method Details

getType

public String getType()

Get the type property: The object type.

Overrides:

getType in class ToolDefinition

Returns:

the type value.

getOpenapi

public OpenApiFunctionDefinition getOpenapi()

Get the openapi property: The openapi function definition.

Returns:

the openapi value.

toJson

public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter)
                                 throws IOException

Specified by:

toJson in interface com.azure.json.JsonSerializable<ToolDefinition>

Overrides:

toJson in class ToolDefinition

Throws:

IOException

fromJson

public static OpenApiToolDefinition fromJson(com.azure.json.JsonReader jsonReader)
                                      throws IOException

Reads an instance of OpenApiToolDefinition from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of OpenApiToolDefinition if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IllegalStateException - If the deserialized JSON object was missing any required properties.

IOException - If an error occurs while reading the OpenApiToolDefinition.