Package de.xima.fc.prompt.ms.impl.service.generic_oai.client.json

Class ApiChatCompletionsResponseChoice

java.lang.Object

de.xima.fc.prompt.ms.impl.service.generic_oai.client.json.ApiChatCompletionsResponseChoice

public final class ApiChatCompletionsResponseChoice
extends Object

A chat completion choices returned by the chat completion endpoint.

Since:

8.5.0

Field Summary

Fields

Modifier and Type	Field	Description
static String	FINISH_REASON_CONTENT_FILTER
static String	FINISH_REASON_FUNCTION_CALL
static String	FINISH_REASON_LENGTH
static String	FINISH_REASON_STOP
static String	FINISH_REASON_TOOL_CALLS

Method Summary

Modifier and Type	Method	Description
String	finishReason()	The reason the model stopped generating tokens.
Long	index()	The index of the choice in the list of choices.
ApiChatCompletionsResponseChoiceLogProbs	logProbs()	Log probability information for the choice.
ApiChatCompletionsResponseChoiceMessage	message()	A chat completion message generated by the model.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FINISH_REASON_CONTENT_FILTER

public static final String FINISH_REASON_CONTENT_FILTER

See Also:

Constant Field Values

FINISH_REASON_FUNCTION_CALL

public static final String FINISH_REASON_FUNCTION_CALL

See Also:

Constant Field Values

FINISH_REASON_LENGTH

public static final String FINISH_REASON_LENGTH

See Also:

Constant Field Values

FINISH_REASON_STOP

public static final String FINISH_REASON_STOP

See Also:

Constant Field Values

FINISH_REASON_TOOL_CALLS

public static final String FINISH_REASON_TOOL_CALLS

See Also:

Constant Field Values

Method Detail

finishReason

public String finishReason()

The reason the model stopped generating tokens. This will be stop if the model hit a natural stop point or a provided stop sequence, length if the maximum number of tokens specified in the request was reached, content_filter if content was omitted due to a flag from our content filters, tool_calls if the model called a tool, or function_call (deprecated) if the model called a function.

Returns:

The finish reason.

index

public Long index()

The index of the choice in the list of choices.

Returns:

The index.

logProbs

public ApiChatCompletionsResponseChoiceLogProbs logProbs()

Log probability information for the choice.

Returns:

The log probabilities.

message

public ApiChatCompletionsResponseChoiceMessage message()

A chat completion message generated by the model.

Returns:

The generated message.