Share via

BatchErrorDatum Class

  • Reference
Package:
com.azure.ai.openai.models
Maven Artifact:
com.azure:azure-ai-openai:1.0.0-beta.12
  • java.lang.Object
    • com.azure.ai.openai.models.BatchErrorDatum

Implements

JsonSerializable<BatchErrorDatum>

public final class BatchErrorDatum
implements JsonSerializable<BatchErrorDatum>

A Datum containing information about a Batch Error.

Method Summary

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

Reads an instance of BatchErrorDatum from the JsonReader.
String getCode()

Get the code property: An error code identifying the error type.
Integer getLine()

Get the line property: The line number of the input file where the error occurred, if applicable.
String getMessage()

Get the message property: A human-readable message providing more details about the error.
String getParam()

Get the param property: The name of the parameter that caused the error, if applicable.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

fromJson

public static BatchErrorDatum fromJson(JsonReader jsonReader)

Reads an instance of BatchErrorDatum from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of BatchErrorDatum 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 BatchErrorDatum.

getCode

public String getCode()

Get the code property: An error code identifying the error type.

Returns:

the code value.

getLine

public Integer getLine()

Get the line property: The line number of the input file where the error occurred, if applicable.

Returns:

the line value.

getMessage

public String getMessage()

Get the message property: A human-readable message providing more details about the error.

Returns:

the message value.

getParam

public String getParam()

Get the param property: The name of the parameter that caused the error, if applicable.

Returns:

the param value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to