ExtractiveSummarizationAction interface

Package:

@azure/ai-language-text

Supported parameters for an Extractive Summarization task.

Extends

ActionPrebuilt

Properties

maxSentenceCount	The max number of sentences to be part of the summary.
orderBy	The sorting criteria to use for the results of Extractive Summarization.
stringIndexType	Specifies the measurement unit used to calculate the offset and length properties. For a list of possible values, see KnownStringIndexType. The default is the JavaScript's default which is "Utf16CodeUnit".

Inherited Properties

disableServiceLogs	If set to true, you opt-out of having your text input logged for troubleshooting. By default, Cognitive Language Service logs your input text for 48 hours, solely to allow for troubleshooting issues. Setting this parameter to true, disables in logging and may limit our ability to remediate issues that occur. Default is false.
modelVersion	The version of the model to be used by the action.

Property Details

maxSentenceCount

The max number of sentences to be part of the summary.

maxSentenceCount?: number

Property Value

number

orderBy

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

orderBy?: string

Property Value

string

stringIndexType

Specifies the measurement unit used to calculate the offset and length properties. For a list of possible values, see KnownStringIndexType.

The default is the JavaScript's default which is "Utf16CodeUnit".

stringIndexType?: string

Property Value

string

Inherited Property Details

disableServiceLogs

If set to true, you opt-out of having your text input logged for troubleshooting. By default, Cognitive Language Service logs your input text for 48 hours, solely to allow for troubleshooting issues. Setting this parameter to true, disables in logging and may limit our ability to remediate issues that occur.

Default is false.

disableServiceLogs?: boolean

Property Value

boolean

Inherited From ActionPrebuilt.disableServiceLogs

modelVersion

The version of the model to be used by the action.

modelVersion?: string

Property Value

string

Inherited From ActionPrebuilt.modelVersion