SemanticErrorReason Class

Package:

com.azure.search.documents.models

Maven Artifact:

com.azure:azure-search-documents:11.6.5

• java.lang.Object
• • com.azure.core.util.ExpandableStringEnum<T>
  • • com.azure.search.documents.models.SemanticErrorReason

public final class SemanticErrorReason
extends ExpandableStringEnum<SemanticErrorReason>

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

Field Summary

Modifier and Type	Field and 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

Constructor	Description
SemanticErrorReason()	Deprecated Use the fromString(String name) factory method. Creates a new instance of SemanticErrorReason value.

Method Summary

Modifier and Type	Method and 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 ExpandableStringEnum

<T>fromString <T>values equals hashCode toString

Methods inherited from java.lang.Object

clone finalize getClass notify notifyAll wait wait wait

Field Details

CAPACITY_OVERLOADED

public static final SemanticErrorReason CAPACITY_OVERLOADED

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

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.

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 name) 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 values()

Gets known SemanticErrorReason values.

Returns:

known SemanticErrorReason values.