Share via

Choice Class

Package:
com.azure.ai.openai.models
Maven Artifact:
com.azure:azure-ai-openai:1.0.0-beta.16
  • java.lang.Object
    • com.azure.ai.openai.models.Choice

Implements

JsonSerializable<Choice>

public final class Choice
implements JsonSerializable<Choice>

The representation of a single prompt completion as part of an overall completions request. 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 Choice fromJson(JsonReader jsonReader)

Reads an instance of Choice from the JsonReader.
ContentFilterResultsForChoice getContentFilterResults()

Get the contentFilterResults property: Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not.
CompletionsFinishReason getFinishReason()

Get the finishReason property: Reason for finishing.
int getIndex()

Get the index property: The ordered index associated with this completions choice.
CompletionsLogProbabilityModel getLogprobs()

Get the logprobs property: The log probabilities model for tokens associated with this completions choice.
String getText()

Get the text property: The generated text for a given completions prompt.
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 Choice fromJson(JsonReader jsonReader)

Reads an instance of Choice from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getContentFilterResults

public ContentFilterResultsForChoice getContentFilterResults()

Get the contentFilterResults property: Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not.

Returns:

the contentFilterResults value.

getFinishReason

public CompletionsFinishReason getFinishReason()

Get the finishReason property: Reason for finishing.

Returns:

the finishReason value.

getIndex

public int getIndex()

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

Returns:

the index value.

getLogprobs

public CompletionsLogProbabilityModel getLogprobs()

Get the logprobs property: The log probabilities model for tokens associated with this completions choice.

Returns:

the logprobs value.

getText

public String getText()

Get the text property: The generated text for a given completions prompt.

Returns:

the text value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to