CompletionsFinishReason Struct

Definition

Namespace:

Azure.AI.OpenAI

Assembly:

Azure.AI.OpenAI.dll

Package:

Azure.AI.OpenAI v1.0.0-beta.17

Source:

CompletionsFinishReason.cs

Representation of the manner in which a completions response concluded.

public readonly struct CompletionsFinishReason : IEquatable<Azure.AI.OpenAI.CompletionsFinishReason>

type CompletionsFinishReason = struct

Public Structure CompletionsFinishReason
Implements IEquatable(Of CompletionsFinishReason)

Inheritance

ValueType

CompletionsFinishReason

Implements

IEquatable<CompletionsFinishReason>

Constructors

CompletionsFinishReason(String)

Initializes a new instance of CompletionsFinishReason.

Properties

ContentFiltered	Completions generated a response that was identified as potentially sensitive per content moderation policies.
FunctionCall	Completion ended normally, with the model requesting a function to be called.
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

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

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.