Package com.alibaba.cloud.ai.dashscope.spec

Record Class DashScopeApiSpec.ChatCompletionOutput

java.lang.Object

java.lang.Record

com.alibaba.cloud.ai.dashscope.spec.DashScopeApiSpec.ChatCompletionOutput

Record Components:

text - chat completion text if result format is text.

choices - A list of chat completion choices. Can be more than one if n is greater than 1. used in conjunction with the seed request parameter to understand when backend changes have been made that might impact determinism.

Enclosing class:

DashScopeApiSpec

public static record DashScopeApiSpec.ChatCompletionOutput(String text, List<DashScopeApiSpec.ChatCompletionOutput.Choice> choices, DashScopeApiSpec.SearchInfo searchInfo)
extends Record

Represents a chat completion response returned by model, based on the provided input.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	DashScopeApiSpec.ChatCompletionOutput.Choice	Chat completion choice.

Constructor Summary

Constructors

Constructor	Description
ChatCompletionOutput(String text, List<DashScopeApiSpec.ChatCompletionOutput.Choice> choices, DashScopeApiSpec.SearchInfo searchInfo)	Creates an instance of a ChatCompletionOutput record class.

Method Summary

Modifier and Type	Method	Description
List<DashScopeApiSpec.ChatCompletionOutput.Choice>	choices()	Returns the value of the choices record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
DashScopeApiSpec.SearchInfo	searchInfo()	Returns the value of the searchInfo record component.
String	text()	Returns the value of the text record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

ChatCompletionOutput

public ChatCompletionOutput(String text,
 List<DashScopeApiSpec.ChatCompletionOutput.Choice> choices,
 DashScopeApiSpec.SearchInfo searchInfo)

Creates an instance of a ChatCompletionOutput record class.

Parameters:

text - the value for the text record component

choices - the value for the choices record component

searchInfo - the value for the searchInfo record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

text

public String text()

Returns the value of the text record component.

Returns:

the value of the text record component

choices

public List<DashScopeApiSpec.ChatCompletionOutput.Choice> choices()

Returns the value of the choices record component.

Returns:

the value of the choices record component

searchInfo

public DashScopeApiSpec.SearchInfo searchInfo()

Returns the value of the searchInfo record component.

Returns:

the value of the searchInfo record component