Class SemanticErrorMode

java.lang.Object

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

com.azure.search.documents.models.SemanticErrorMode

All Implemented Interfaces:

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

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

Allows the user to choose whether a semantic call should fail completely, or to return partial results.

Field Summary

Fields

Modifier and Type	Field	Description
static final SemanticErrorMode	FAIL	If there is an exception during the semantic processing step, the query will fail and return the appropriate HTTP code depending on the error.
static final SemanticErrorMode	PARTIAL	If the semantic processing fails, partial results still return.

Constructor Summary

Constructors

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

Method Summary

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

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

equals, fromString, getValue, hashCode, toString, values

Methods inherited from class Object

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

Field Details

PARTIAL

public static final SemanticErrorMode PARTIAL

If the semantic processing fails, partial results still return. The definition of partial results depends on what semantic step failed and what was the reason for failure.

FAIL

public static final SemanticErrorMode FAIL

If there is an exception during the semantic processing step, the query will fail and return the appropriate HTTP code depending on the error.

Constructor Details

SemanticErrorMode

@Deprecated
public SemanticErrorMode()

Deprecated.

Use the fromString(String) factory method.

Creates a new instance of SemanticErrorMode value.

Method Details

fromString

public static SemanticErrorMode fromString(String name)

Creates or finds a SemanticErrorMode from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding SemanticErrorMode.

values

public static Collection<SemanticErrorMode> values()

Gets known SemanticErrorMode values.

Returns:

known SemanticErrorMode values.