Package com.azure.ai.openai.models
Enum AzureChatExtensionRetrieveDocumentFilterReason
java.lang.Object
java.lang.Enum<AzureChatExtensionRetrieveDocumentFilterReason>
com.azure.ai.openai.models.AzureChatExtensionRetrieveDocumentFilterReason
- All Implemented Interfaces:
Serializable,Comparable<AzureChatExtensionRetrieveDocumentFilterReason>,java.lang.constant.Constable
public enum AzureChatExtensionRetrieveDocumentFilterReason
extends Enum<AzureChatExtensionRetrieveDocumentFilterReason>
The reason for filtering the retrieved document.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum Constants -
Method Summary
Modifier and TypeMethodDescriptionfromString(String value) Parses a serialized value to a AzureChatExtensionRetrieveDocumentFilterReason instance.toString()Returns the enum constant of this type with the specified name.values()Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
SCORE
The document is filtered by original search score threshold defined by `strictness` configure. -
RERANK
The document is not filtered by original search score threshold, but is filtered by rerank score and `top_n_documents` configure.
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum type has no constant with the specified nameNullPointerException- if the argument is null
-
fromString
Parses a serialized value to a AzureChatExtensionRetrieveDocumentFilterReason instance.- Parameters:
value- the serialized value to parse.- Returns:
- the parsed AzureChatExtensionRetrieveDocumentFilterReason object, or null if unable to parse.
-
toString
- Overrides:
toStringin classEnum<AzureChatExtensionRetrieveDocumentFilterReason>
-