Package com.azure.ai.inference.models
Class CompletionsFinishReason
java.lang.Object
com.azure.core.util.ExpandableStringEnum<CompletionsFinishReason>
com.azure.ai.inference.models.CompletionsFinishReason
- All Implemented Interfaces:
com.azure.core.util.ExpandableEnum<String>
public final class CompletionsFinishReason
extends com.azure.core.util.ExpandableStringEnum<CompletionsFinishReason>
Representation of the manner in which a completions response concluded.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final CompletionsFinishReason
Completions generated a response that was identified as potentially sensitive per content moderation policies.static final CompletionsFinishReason
Completions ended normally and reached its end of token generation.static final CompletionsFinishReason
Completions exhausted available token limits before generation could complete.static final CompletionsFinishReason
Completion ended with the model calling a provided tool for output. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic 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, getValue, hashCode, toString, values
-
Field Details
-
STOPPED
Completions ended normally and reached its end of token generation. -
TOKEN_LIMIT_REACHED
Completions exhausted available token limits before generation could complete. -
CONTENT_FILTERED
Completions generated a response that was identified as potentially sensitive per content moderation policies. -
TOOL_CALLS
Completion ended with the model calling a provided tool for output.
-
-
Constructor Details
-
CompletionsFinishReason
Deprecated.Use thefromString(String)
factory method.Creates a new instance of CompletionsFinishReason value.
-
-
Method Details
-
fromString
Creates or finds a CompletionsFinishReason from its string representation.- Parameters:
name
- a name to look for.- Returns:
- the corresponding CompletionsFinishReason.
-
values
Gets known CompletionsFinishReason values.- Returns:
- known CompletionsFinishReason values.
-
fromString(String)
factory method.