Class SemanticSearchResultsType

java.lang.Object

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

com.azure.search.documents.models.SemanticSearchResultsType

All Implemented Interfaces:

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

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

Type of partial response that was returned for a semantic ranking request.

Field Summary

Fields

Modifier and Type	Field	Description
static final SemanticSearchResultsType	BASE_RESULTS	Results without any semantic enrichment or reranking.
static final SemanticSearchResultsType	RERANKED_RESULTS	Results have been reranked with the reranker model and will include semantic captions.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static SemanticSearchResultsType	fromString(String name)	Creates or finds a SemanticSearchResultsType from its string representation.
static Collection<SemanticSearchResultsType>	values()	Gets known SemanticSearchResultsType 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

BASE_RESULTS

public static final SemanticSearchResultsType BASE_RESULTS

Results without any semantic enrichment or reranking.

RERANKED_RESULTS

public static final SemanticSearchResultsType RERANKED_RESULTS

Results have been reranked with the reranker model and will include semantic captions. They will not include any answers, answers highlights or caption highlights.

Constructor Details

SemanticSearchResultsType

@Deprecated
public SemanticSearchResultsType()

Deprecated.

Use the fromString(String) factory method.

Creates a new instance of SemanticSearchResultsType value.

Method Details

fromString

public static SemanticSearchResultsType fromString(String name)

Creates or finds a SemanticSearchResultsType from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding SemanticSearchResultsType.

values

public static Collection<SemanticSearchResultsType> values()

Gets known SemanticSearchResultsType values.

Returns:

known SemanticSearchResultsType values.