Package com.azure.search.documents.models

Class SemanticErrorReason

java.lang.Object

com.azure.core.util.ExpandableStringEnum<SemanticErrorReason>

com.azure.search.documents.models.SemanticErrorReason

All Implemented Interfaces:

com.azure.core.util.ExpandableEnum<String>

public final class SemanticErrorReason
extends com.azure.core.util.ExpandableStringEnum<SemanticErrorReason>

Reason that a partial response was returned for a semantic ranking request.

Field Summary

Fields

Modifier and Type	Field	Description
static final SemanticErrorReason	CAPACITY_OVERLOADED	The request was throttled.
static final SemanticErrorReason	MAX_WAIT_EXCEEDED	If `semanticMaxWaitInMilliseconds` was set and the semantic processing duration exceeded that value.
static final SemanticErrorReason	TRANSIENT	At least one step of the semantic process failed.

Constructor Summary

Constructors

Constructor	Description
SemanticErrorReason()	Deprecated. Use the fromString(String) factory method.

Method Summary

Modifier and Type	Method	Description
static SemanticErrorReason	fromString(String name)	Creates or finds a SemanticErrorReason from its string representation.
static Collection<SemanticErrorReason>	values()	Gets known SemanticErrorReason values.

Methods inherited from class com.azure.core.util.ExpandableStringEnum

equals, fromString, getValue, hashCode, toString, values

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

MAX_WAIT_EXCEEDED

public static final SemanticErrorReason MAX_WAIT_EXCEEDED

If `semanticMaxWaitInMilliseconds` was set and the semantic processing duration exceeded that value. Only the base results were returned.

CAPACITY_OVERLOADED

public static final SemanticErrorReason CAPACITY_OVERLOADED

The request was throttled. Only the base results were returned.

TRANSIENT

public static final SemanticErrorReason TRANSIENT

At least one step of the semantic process failed.

Constructor Details

SemanticErrorReason

@Deprecated
public SemanticErrorReason()

Deprecated.

Use the fromString(String) factory method.

Creates a new instance of SemanticErrorReason value.

Method Details

fromString

public static SemanticErrorReason fromString(String name)

Creates or finds a SemanticErrorReason from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding SemanticErrorReason.

values

public static Collection<SemanticErrorReason> values()

Gets known SemanticErrorReason values.

Returns:

known SemanticErrorReason values.