ExtractSummaryAction | @azure/ai-text-analytics

Options for an extract summary action.

Hierarchy

TextAnalyticsAction
- ExtractSummaryAction

Index

Properties

Optional actionName

actionName: undefined | string

The preferred name for this action.

Optional disableServiceLogs

disableServiceLogs: undefined | false | true

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

Optional maxSentenceCount

maxSentenceCount: undefined | number

Specifies the number of summary sentences to return. The default number of sentences is 3.

Optional modelVersion

modelVersion: undefined | string

The version of the text analytics model used by this operation on this batch of input documents.

Optional orderBy

orderBy: undefined | string

Specifies how to sort the returned sentences. Please refer to {@link KnownSummarySentencesOrderBy} for possible values.

Optional stringIndexType

stringIndexType: StringIndexType

Specifies the measurement unit used to calculate the offset and length properties. Possible units are "TextElements_v8", "UnicodeCodePoint", and "Utf16CodeUnit". The default is the JavaScript's default which is "Utf16CodeUnit".