Package com.oracle.bmc.generativeaiinference.model

Class ChatChoice

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.generativeaiinference.model.ChatChoice

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20231130")
public final class ChatChoice
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Represents a single instance of the chat response.
Note: Objects should always be created or deserialized using the ChatChoice.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the ChatChoice.Builder, which maintain a set of all explicitly set fields called ChatChoice.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ChatChoice.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
ChatChoice(Integer index, Message message, String finishReason, Logprobs logprobs, Usage usage, GroundingMetadata groundingMetadata)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static ChatChoice.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getFinishReason()	The reason why the model stopped generating tokens.
GroundingMetadata	getGroundingMetadata()
Integer	getIndex()	The index of the chat.
Logprobs	getLogprobs()
Message	getMessage()
Usage	getUsage()
int	hashCode()
ChatChoice.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ChatChoice

@Deprecated
@ConstructorProperties({"index","message","finishReason","logprobs","usage","groundingMetadata"})
public ChatChoice(Integer index,
                  Message message,
                  String finishReason,
                  Logprobs logprobs,
                  Usage usage,
                  GroundingMetadata groundingMetadata)

Deprecated.

Method Detail

builder

public static ChatChoice.Builder builder()

Create a new builder.

toBuilder

public ChatChoice.Builder toBuilder()

getIndex

public Integer getIndex()

The index of the chat.

Returns:

the value

getMessage

public Message getMessage()

getFinishReason

public String getFinishReason()

The reason why the model stopped generating tokens.

Stops if the model hits a natural stop point or a provided stop sequence. Returns the length if the tokens reach the specified maximum number of tokens.

Returns:

the value

getLogprobs

public Logprobs getLogprobs()

getUsage

public Usage getUsage()

getGroundingMetadata

public GroundingMetadata getGroundingMetadata()

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel