Share via

AzureChatExtensionRetrieveDocumentFilterReason Enum

  • Reference
Package:
com.azure.ai.openai.models
Maven Artifact:
com.azure:azure-ai-openai:1.0.0-beta.12
  • java.lang.Object
    • java.lang.Enum
      • com.azure.ai.openai.models.AzureChatExtensionRetrieveDocumentFilterReason

public enum AzureChatExtensionRetrieveDocumentFilterReason
extends Enum<AzureChatExtensionRetrieveDocumentFilterReason>

The reason for filtering the retrieved document.

Fields

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.

Methods inherited from java.lang.Enum

valueOf clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString

Methods inherited from java.lang.Object

getClass notify notifyAll wait wait wait

Methods

fromString(String value)

public static AzureChatExtensionRetrieveDocumentFilterReason fromString(String value)

Parses a serialized value to a AzureChatExtensionRetrieveDocumentFilterReason instance.

Parameters

value
String
the serialized value to parse.

Returns

AzureChatExtensionRetrieveDocumentFilterReason
the parsed AzureChatExtensionRetrieveDocumentFilterReason object, or null if unable to parse.

toString()

public String toString()

Returns

String
Overrides
java.lang.Enum.toString()

valueOf(String name)

public static AzureChatExtensionRetrieveDocumentFilterReason valueOf(String name)

Parameters

name
String

Returns

AzureChatExtensionRetrieveDocumentFilterReason

values()

public static AzureChatExtensionRetrieveDocumentFilterReason[] values()

Returns

AzureChatExtensionRetrieveDocumentFilterReason[]

Applies to