StreamingChatChoiceUpdate Class

Package:
com.azure.ai.inference.models
Maven Artifact:
com.azure:azure-ai-inference:1.0.0-beta.5
  • java.lang.Object
    • com.azure.ai.inference.models.StreamingChatChoiceUpdate

Implements

JsonSerializable<StreamingChatChoiceUpdate>

public final class StreamingChatChoiceUpdate
implements JsonSerializable<StreamingChatChoiceUpdate>

Represents an update to a single prompt completion when the service is streaming updates using Server Sent Events (SSE). Generally, `n` choices are generated per provided prompt with a default value of 1. Token limits and other settings may limit the number of choices generated.

Method Summary

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

Reads an instance of StreamingChatChoiceUpdate from the JsonReader.
StreamingChatResponseMessageUpdate getDelta()

Get the delta property: An update to the chat message for a given chat completions prompt.
CompletionsFinishReason getFinishReason()

Get the finishReason property: The reason that this chat completions choice completed its generated.
int getIndex()

Get the index property: The ordered index associated with this chat completions choice.
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 StreamingChatChoiceUpdate fromJson(JsonReader jsonReader)

Reads an instance of StreamingChatChoiceUpdate from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getDelta

public StreamingChatResponseMessageUpdate getDelta()

Get the delta property: An update to the chat message for a given chat completions prompt.

Returns:

the delta value.

getFinishReason

public CompletionsFinishReason getFinishReason()

Get the finishReason property: The reason that this chat completions choice completed its generated.

Returns:

the finishReason value.

getIndex

public int getIndex()

Get the index property: The ordered index associated with this chat completions choice.

Returns:

the index value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to