Package com.azure.ai.openai.assistants.models

Class CodeInterpreterToolDefinition

java.lang.Object

com.azure.ai.openai.assistants.models.ToolDefinition

com.azure.ai.openai.assistants.models.CodeInterpreterToolDefinition

All Implemented Interfaces:

com.azure.json.JsonSerializable<ToolDefinition>

public final class CodeInterpreterToolDefinition
extends ToolDefinition

The input definition information for a code interpreter tool as used to configure an assistant.

Constructor Summary

Constructors

Constructor	Description
CodeInterpreterToolDefinition()	Creates an instance of CodeInterpreterToolDefinition class.

Method Summary

Modifier and Type	Method	Description
static CodeInterpreterToolDefinition	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of CodeInterpreterToolDefinition from the JsonReader.
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

CodeInterpreterToolDefinition

public CodeInterpreterToolDefinition()

Creates an instance of CodeInterpreterToolDefinition class.

Method Details

toJson

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

Description copied from class: ToolDefinition

Specified by:

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

Overrides:

toJson in class ToolDefinition

Throws:

IOException

getType

public String getType()

Get the type property: The object type.

Overrides:

getType in class ToolDefinition

Returns:

the type value.

fromJson

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

Reads an instance of CodeInterpreterToolDefinition from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IOException - If an error occurs while reading the CodeInterpreterToolDefinition.