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

Enum Constant	Description
RERANK	The document is not filtered by original search score threshold, but is filtered by rerank score and `top_n_documents` configure.
SCORE	The document is filtered by original search score threshold defined by `strictness` configure.

Method Summary

Modifier and Type	Method	Description
static AzureChatExtensionRetrieveDocumentFilterReason	fromString(String value)	Parses a serialized value to a AzureChatExtensionRetrieveDocumentFilterReason instance.
String	toString()
static AzureChatExtensionRetrieveDocumentFilterReason	valueOf(String name)	Returns the enum constant of this type with the specified name.
static AzureChatExtensionRetrieveDocumentFilterReason[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SCORE

public static final AzureChatExtensionRetrieveDocumentFilterReason SCORE

The document is filtered by original search score threshold defined by `strictness` configure.

RERANK

public static final AzureChatExtensionRetrieveDocumentFilterReason 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

public static AzureChatExtensionRetrieveDocumentFilterReason[] 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

public static AzureChatExtensionRetrieveDocumentFilterReason valueOf(String name)

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 name

NullPointerException - if the argument is null

fromString

public static AzureChatExtensionRetrieveDocumentFilterReason fromString(String value)

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

public String toString()

Overrides:

toString in class Enum<AzureChatExtensionRetrieveDocumentFilterReason>