ApiError Class

  • java.lang.Object
    • com.azure.ai.agents.models.ApiError

Implements

public final class ApiError
implements JsonSerializable<ApiError>

The ApiError model.

Method Summary

Modifier and Type Method and Description
static ApiError fromJson(JsonReader jsonReader)

Reads an instance of ApiError from the JsonReader.

Map<String,BinaryData> getAdditionalInfo()

Get the additionalInfo property: Additional structured information about the failure.

String getCode()

Get the code property: The code property.

Map<String,BinaryData> getDebugInfo()

Get the debugInfo property: Diagnostic information supplied by the service for troubleshooting.

List<ApiError> getDetails()

Get the details property: Additional errors that contributed to this failure.

String getMessage()

Get the message property: The message property.

com.openai.models.ErrorObject.Misalignment getMisalignment()

Get the misalignment property: The misalignment property.

String getParam()

Get the param property: The param property.

String getType()

Get the type property: The type property.

JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

Method Details

fromJson

public static ApiError fromJson(JsonReader jsonReader)

Reads an instance of ApiError from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IOException

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

getAdditionalInfo

public Map<String,BinaryData> getAdditionalInfo()

Get the additionalInfo property: Additional structured information about the failure.

Returns:

the additionalInfo value.

getCode

public String getCode()

Get the code property: The code property.

Returns:

the code value.

getDebugInfo

public Map<String,BinaryData> getDebugInfo()

Get the debugInfo property: Diagnostic information supplied by the service for troubleshooting.

Returns:

the debugInfo value.

getDetails

public List<ApiError> getDetails()

Get the details property: Additional errors that contributed to this failure.

Returns:

the details value.

getMessage

public String getMessage()

Get the message property: The message property.

Returns:

the message value.

getMisalignment

public ErrorObject.Misalignment getMisalignment()

Get the misalignment property: The misalignment property.

Returns:

the misalignment value.

getParam

public String getParam()

Get the param property: The param property.

Returns:

the param value.

getType

public String getType()

Get the type property: The type property.

Returns:

the type value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to