Share via


CompletionsFinishReason Struct

Definition

Representation of the manner in which a completions response concluded.

public readonly struct CompletionsFinishReason : IEquatable<Azure.AI.Inference.CompletionsFinishReason>
type CompletionsFinishReason = struct
Public Structure CompletionsFinishReason
Implements IEquatable(Of CompletionsFinishReason)
Inheritance
CompletionsFinishReason
Implements

Constructors

Name Description
CompletionsFinishReason(String)

Initializes a new instance of CompletionsFinishReason.

Properties

Name Description
ContentFiltered

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

Stopped

Completions ended normally and reached its end of token generation.

TokenLimitReached

Completions exhausted available token limits before generation could complete.

ToolCalls

Completion ended with the model calling a provided tool for output.

Methods

Name Description
Equals(CompletionsFinishReason)

Indicates whether the current object is equal to another object of the same type.

ToString()

Returns the fully qualified type name of this instance.

Operators

Name Description
Equality(CompletionsFinishReason, CompletionsFinishReason)

Determines if two CompletionsFinishReason values are the same.

Implicit(String to CompletionsFinishReason)

Converts a String to a CompletionsFinishReason.

Inequality(CompletionsFinishReason, CompletionsFinishReason)

Determines if two CompletionsFinishReason values are not the same.

Applies to