BeginAnalyzeHealthcareEntitiesOptions | @azure/ai-text-analytics

Options for the begin analyze healthcare entities operation.

Hierarchy

TextAnalyticsOperationOptions
- BeginAnalyzeHealthcareEntitiesOptions

Index

Properties

Optional disableServiceLogs

disableServiceLogs: undefined | false | true

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.

Optional includeStatistics

includeStatistics: undefined | false | true

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

Optional modelVersion

modelVersion: undefined | string

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

Optional resumeFrom

resumeFrom: undefined | string

A serialized poller which can be used to resume an existing paused Long-Running-Operation.

Optional stringIndexType

stringIndexType: StringIndexType

Delay to wait until next poll, in milliseconds.

Optional updateIntervalInMs

updateIntervalInMs: undefined | number

Delay to wait until next poll, in milliseconds.