Package com.azure.ai.openai.models

Class CompletionsFinishReason

java.lang.Object

com.azure.core.util.ExpandableStringEnum<CompletionsFinishReason>

com.azure.ai.openai.models.CompletionsFinishReason

public final class CompletionsFinishReason
extends com.azure.core.util.ExpandableStringEnum<CompletionsFinishReason>

Representation of the manner in which a completions response concluded.

Field Summary

Fields

Modifier and Type	Field	Description
static final CompletionsFinishReason	CONTENT_FILTERED	Completions generated a response that was identified as potentially sensitive per content moderation policies.
static final CompletionsFinishReason	FUNCTION_CALL	Completion ended normally, with the model requesting a function to be called.
static final CompletionsFinishReason	STOPPED	Completions ended normally and reached its end of token generation.
static final CompletionsFinishReason	TOKEN_LIMIT_REACHED	Completions exhausted available token limits before generation could complete.

Constructor Summary

Constructors

Constructor	Description
CompletionsFinishReason()	Deprecated. Use the fromString(String) factory method.

Method Summary

Modifier and Type	Method	Description
static CompletionsFinishReason	fromString(String name)	Creates or finds a CompletionsFinishReason from its string representation.
static Collection<CompletionsFinishReason>	values()	Gets known CompletionsFinishReason values.

Methods inherited from class com.azure.core.util.ExpandableStringEnum

equals, fromString, hashCode, toString, values

Methods inherited from class java.lang.Object

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

Field Details

STOPPED

public static final CompletionsFinishReason STOPPED

Completions ended normally and reached its end of token generation.

TOKEN_LIMIT_REACHED

public static final CompletionsFinishReason TOKEN_LIMIT_REACHED

Completions exhausted available token limits before generation could complete.

CONTENT_FILTERED

public static final CompletionsFinishReason CONTENT_FILTERED

Completions generated a response that was identified as potentially sensitive per content moderation policies.

FUNCTION_CALL

public static final CompletionsFinishReason FUNCTION_CALL

Completion ended normally, with the model requesting a function to be called.

Constructor Details

CompletionsFinishReason

@Deprecated
public CompletionsFinishReason()

Deprecated.

Use the fromString(String) factory method.

Creates a new instance of CompletionsFinishReason value.

Method Details

fromString

public static CompletionsFinishReason fromString(String name)

Creates or finds a CompletionsFinishReason from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding CompletionsFinishReason.

values

public static Collection<CompletionsFinishReason> values()

Gets known CompletionsFinishReason values.

Returns:

known CompletionsFinishReason values.