Package com.azure.ai.openai.models

Class MaxTokensFinishDetails

java.lang.Object

com.azure.ai.openai.models.ChatFinishDetails

com.azure.ai.openai.models.MaxTokensFinishDetails

All Implemented Interfaces:

com.azure.json.JsonSerializable<ChatFinishDetails>

public final class MaxTokensFinishDetails
extends ChatFinishDetails

A structured representation of a stop reason that signifies a token limit was reached before the model could naturally complete.

Method Summary

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

Method Details

getType

public String getType()

Get the type property: The object type.

Overrides:

getType in class ChatFinishDetails

Returns:

the type value.

toJson

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

Specified by:

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

Overrides:

toJson in class ChatFinishDetails

Throws:

IOException

fromJson

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

Reads an instance of MaxTokensFinishDetails from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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