SemanticSearchResultsType Class

public final class SemanticSearchResultsType
extends ExpandableStringEnum<SemanticSearchResultsType>

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

Field Summary

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

Constructor Description
SemanticSearchResultsType()

Deprecated

Use the fromString(String name) factory method.

Creates a new instance of SemanticSearchResultsType value.

Method Summary

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

Methods inherited from java.lang.Object

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

Gets known SemanticSearchResultsType values.

Returns:

known SemanticSearchResultsType values.

Applies to