Package com.azure.ai.textanalytics.models

Class ExtractiveSummarySentencesOrder

java.lang.Object

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

com.azure.ai.textanalytics.models.ExtractiveSummarySentencesOrder

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

The sorting criteria to use for the results of Extractive Summarization.

Field Summary

Fields

Modifier and Type	Field	Description
static final ExtractiveSummarySentencesOrder	OFFSET	Indicates that results should be sorted in order of appearance in the text.
static final ExtractiveSummarySentencesOrder	RANK	Indicates that results should be sorted in order of importance (i.e.

Constructor Summary

Constructors

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

Method Summary

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

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

equals, fromString, hashCode, toString, values

Methods inherited from class java.lang.Object

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

Field Details

OFFSET

public static final ExtractiveSummarySentencesOrder OFFSET

Indicates that results should be sorted in order of appearance in the text.

RANK

public static final ExtractiveSummarySentencesOrder RANK

Indicates that results should be sorted in order of importance (i.e. rank score) according to the model.

Constructor Details

ExtractiveSummarySentencesOrder

@Deprecated
public ExtractiveSummarySentencesOrder()

Deprecated.

Use the fromString(String) factory method.

Creates a new instance of ExtractiveSummarySentencesOrder value.

Method Details

fromString

public static ExtractiveSummarySentencesOrder fromString(String name)

Creates or finds a ExtractiveSummarySentencesOrder from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding ExtractiveSummarySentencesOrder.

values

public static Collection<ExtractiveSummarySentencesOrder> values()

Gets known ExtractiveSummarySentencesOrder values.

Returns:

known ExtractiveSummarySentencesOrder values.