AnalyzeSentimentOptions interface

Options for the analyze sentiment operation.

Extends

Properties

abortSignal

The signal which can be used to abort requests.

disableServiceLogs

If set to true (the default for beginAnalyzeHealthcareEntities and recognizePiiEntities), 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.

includeOpinionMining

Whether to mine the opinions of a sentence and conduct more granular analysis around the aspects of a product or service (also known as aspect-based sentiment analysis). If set to true, the returned SentenceSentiment objects will have property opinions containing the result of this analysis. More information about the feature can be found here: <xref:https%3A%2F%2Fdocs.microsoft.com%2Fazure%2Fcognitive-services%2Ftext-analytics%2Fhow-tos%2Ftext-analytics-how-to-sentiment-analysis%3Ftabs%3Dversion-3-1%23opinion-mining>

includeStatistics

If set to true, response will contain input and document level statistics.

modelVersion

This value indicates which model will be used for scoring. If a model-version is not specified, the API should default to the latest, non-preview version. For supported model versions, see operation-specific documentation, for example: https://docs.microsoft.com/azure/cognitive-services/text-analytics/how-tos/text-analytics-how-to-sentiment-analysis#model-versioning

onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.

requestOptions

Options used when creating and sending HTTP requests for this operation.

serializerOptions

Options to override serialization/de-serialization behavior.

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".

tracingOptions

Options used when tracing is enabled.

Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

disableServiceLogs

If set to true (the default for beginAnalyzeHealthcareEntities and recognizePiiEntities), 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.

disableServiceLogs?: boolean

Property Value

boolean

includeOpinionMining

Whether to mine the opinions of a sentence and conduct more granular analysis around the aspects of a product or service (also known as aspect-based sentiment analysis). If set to true, the returned SentenceSentiment objects will have property opinions containing the result of this analysis. More information about the feature can be found here: <xref:https%3A%2F%2Fdocs.microsoft.com%2Fazure%2Fcognitive-services%2Ftext-analytics%2Fhow-tos%2Ftext-analytics-how-to-sentiment-analysis%3Ftabs%3Dversion-3-1%23opinion-mining>

includeOpinionMining?: boolean

Property Value

boolean

includeStatistics

If set to true, response will contain input and document level statistics.

includeStatistics?: boolean

Property Value

boolean

modelVersion

This value indicates which model will be used for scoring. If a model-version is not specified, the API should default to the latest, non-preview version. For supported model versions, see operation-specific documentation, for example: https://docs.microsoft.com/azure/cognitive-services/text-analytics/how-tos/text-analytics-how-to-sentiment-analysis#model-versioning

modelVersion?: string

Property Value

string

onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.

onResponse?: RawResponseCallback

Property Value

RawResponseCallback

requestOptions

Options used when creating and sending HTTP requests for this operation.

requestOptions?: OperationRequestOptions

Property Value

OperationRequestOptions

serializerOptions

Options to override serialization/de-serialization behavior.

serializerOptions?: SerializerOptions

Property Value

SerializerOptions

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".

stringIndexType?: StringIndexType

Property Value

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions