Package com.oracle.bmc.generativeaiinference.model

Class CohereChatResponseV2

java.lang.Object

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

com.oracle.bmc.generativeaiinference.model.BaseChatResponse

com.oracle.bmc.generativeaiinference.model.CohereChatResponseV2

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20231130")
public final class CohereChatResponseV2
extends BaseChatResponse

The response to the chat conversation.
Note: Objects should always be created or deserialized using the CohereChatResponseV2.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 CohereChatResponseV2.Builder, which maintain a set of all explicitly set fields called CohereChatResponseV2.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	CohereChatResponseV2.Builder
static class	CohereChatResponseV2.FinishReason	Why the generation stopped.

Nested classes/interfaces inherited from class com.oracle.bmc.generativeaiinference.model.BaseChatResponse

BaseChatResponse.ApiFormat

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
CohereChatResponseV2(String id, CohereAssistantMessageV2 message, CohereChatResponseV2.FinishReason finishReason, List<LogProbability> logProbabilities, String errorMessage, Usage usage)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static CohereChatResponseV2.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getErrorMessage()	If there is an error during the streaming scenario, then the errorMessage parameter contains details for the error.
CohereChatResponseV2.FinishReason	getFinishReason()	Why the generation stopped.
String	getId()	Unique identifier for the generated reply
List<LogProbability>	getLogProbabilities()	The log probabilities of the generated tokens.
CohereAssistantMessageV2	getMessage()
Usage	getUsage()
int	hashCode()
CohereChatResponseV2.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

CohereChatResponseV2

@Deprecated
public CohereChatResponseV2(String id,
                            CohereAssistantMessageV2 message,
                            CohereChatResponseV2.FinishReason finishReason,
                            List<LogProbability> logProbabilities,
                            String errorMessage,
                            Usage usage)

Deprecated.

Method Detail

builder

public static CohereChatResponseV2.Builder builder()

Create a new builder.

toBuilder

public CohereChatResponseV2.Builder toBuilder()

getId

public String getId()

Unique identifier for the generated reply

Returns:

the value

getMessage

public CohereAssistantMessageV2 getMessage()

getFinishReason

public CohereChatResponseV2.FinishReason getFinishReason()

Why the generation stopped.

Returns:

the value

getLogProbabilities

public List<LogProbability> getLogProbabilities()

The log probabilities of the generated tokens.

Returns:

the value

getErrorMessage

public String getErrorMessage()

If there is an error during the streaming scenario, then the errorMessage parameter contains details for the error.

Returns:

the value

getUsage

public Usage getUsage()

toString

public String toString()

Overrides:

toString in class BaseChatResponse

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Overrides:

toString in class BaseChatResponse

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class BaseChatResponse

hashCode

public int hashCode()

Overrides:

hashCode in class BaseChatResponse