Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/ai-text-analytics

Package version

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

ActionResult

ActionResult<TSuccess>: { completedOn: Date; results: TSuccess } | TextAnalyticsActionErrorResult

Type parameters

  • TSuccess

AnalyzeActionsPollerLike

AnalyzeActionsPollerLike: PollerLike<AnalyzeActionsOperationState, PagedAnalyzeActionsResult>

Result type of the Begin Analyze Actions Long-Running-Operation (LRO).

AnalyzeBatchInput

AnalyzeBatchInput: JobDescriptor & JobManifest & { analysisInput: MultiLanguageBatchInput }

AnalyzeHealthcareEntitiesErrorResult

AnalyzeHealthcareEntitiesErrorResult: TextAnalyticsErrorResult

An error result from the healthcare operation on a single document.

AnalyzeHealthcareEntitiesPollerLike

AnalyzeHealthcareEntitiesPollerLike: PollerLike<AnalyzeHealthcareOperationState, PagedAnalyzeHealthcareEntitiesResult>

Result type of the Health Long-Running-Operation (LRO)

AnalyzeHealthcareEntitiesResult

The result of the healthcare operation on a single document.

AnalyzeJobMetadata

AnalyzeJobMetadata: JobMetadata & { displayName?: undefined | string }

AnalyzeJobState

AnalyzeJobState: AnalyzeJobMetadata & TasksState & Pagination & { errors?: TextAnalyticsError[]; statistics?: TextDocumentBatchStatistics }

AnalyzeSentimentAction

AnalyzeSentimentAction: { disableServiceLogs?: undefined | false | true; includeOpinionMining?: undefined | false | true; modelVersion?: undefined | string; stringIndexType?: StringIndexType }

Options for an analyze sentiment action.

Type declaration

  • Optional 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 includeOpinionMining?: undefined | false | true

    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: https://docs.microsoft.com/azure/cognitive-services/text-analytics/how-tos/text-analytics-how-to-sentiment-analysis?tabs=version-3-1#opinion-mining

  • Optional modelVersion?: undefined | string

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

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

AnalyzeSentimentActionErrorResult

AnalyzeSentimentActionErrorResult: TextAnalyticsActionErrorResult

The error of an analyze sentiment action.

AnalyzeSentimentActionResult

The result of an analyze sentiment action.

AnalyzeSentimentErrorResult

AnalyzeSentimentErrorResult: TextAnalyticsErrorResult

An error result from the analyze sentiment operation on a single document.

AnalyzeSentimentResult

The result of the analyze sentiment operation on a single document.

Association

Association: "subject" | "other"

Defines values for Association.

Certainty

Certainty: "positive" | "positivePossible" | "neutralPossible" | "negativePossible" | "negative"

Defines values for Certainty.

Conditionality

Conditionality: "hypothetical" | "conditional"

Defines values for Conditionality.

DetectLanguageErrorResult

DetectLanguageErrorResult: TextAnalyticsErrorResult

An error result from the detect languge operation on a single document.

DetectLanguageResult

The result of the detect language operation on a single document.

DocumentSentimentLabel

DocumentSentimentLabel: "positive" | "neutral" | "negative" | "mixed"

Defines values for DocumentSentimentLabel.

ErrorCode

An Error Code returned from the Text Analytics service. Possible values include:

For more information about the error, see the message property of the associated error.

ErrorCodeValue

ErrorCodeValue: "InvalidRequest" | "InvalidArgument" | "InternalServerError" | "ServiceUnavailable" | "NotFound"

Defines values for ErrorCodeValue.

ExtractKeyPhrasesActionErrorResult

ExtractKeyPhrasesActionErrorResult: TextAnalyticsActionErrorResult

The error of a extract key phrases action.

ExtractKeyPhrasesActionResult

The result of a extract key phrases action.

ExtractKeyPhrasesErrorResult

ExtractKeyPhrasesErrorResult: TextAnalyticsErrorResult

An error result from the extract key phrases operation on a single document.

ExtractKeyPhrasesResult

The result of the extract key phrases operation on a single document.

GeneratedClientAnalyzeResponse

GeneratedClientAnalyzeResponse: GeneratedClientAnalyzeHeaders

Contains response data for the analyze operation.

GeneratedClientAnalyzeStatusResponse

GeneratedClientAnalyzeStatusResponse: AnalyzeJobState

Contains response data for the analyzeStatus operation.

GeneratedClientCancelHealthJobResponse

GeneratedClientCancelHealthJobResponse: GeneratedClientCancelHealthJobHeaders

Contains response data for the cancelHealthJob operation.

GeneratedClientEntitiesLinkingResponse

GeneratedClientEntitiesLinkingResponse: EntityLinkingResult

Contains response data for the entitiesLinking operation.

GeneratedClientEntitiesRecognitionGeneralResponse

GeneratedClientEntitiesRecognitionGeneralResponse: EntitiesResult

Contains response data for the entitiesRecognitionGeneral operation.

GeneratedClientEntitiesRecognitionPiiResponse

GeneratedClientEntitiesRecognitionPiiResponse: PiiResult

Contains response data for the entitiesRecognitionPii operation.

GeneratedClientHealthResponse

GeneratedClientHealthResponse: GeneratedClientHealthHeaders

Contains response data for the health operation.

GeneratedClientHealthStatusResponse

GeneratedClientHealthStatusResponse: HealthcareJobState

Contains response data for the healthStatus operation.

GeneratedClientKeyPhrasesResponse

GeneratedClientKeyPhrasesResponse: KeyPhraseResult

Contains response data for the keyPhrases operation.

GeneratedClientLanguagesResponse

GeneratedClientLanguagesResponse: LanguageResult

Contains response data for the languages operation.

GeneratedClientSentimentResponse

GeneratedClientSentimentResponse: SentimentResponse

Contains response data for the sentiment operation.

HealthcareEntity

HealthcareEntity: Entity & { assertion?: HealthcareAssertion; links?: HealthcareEntityLink[]; name?: undefined | string }

A healthcare entity represented as a node in a directed graph where the edges are a particular type of relationship between the source and target nodes.

Optional assertion

Whether the entity is negated.

category

category: string

Entity type.

confidenceScore

confidenceScore: number

Confidence score between 0 and 1 of the extracted entity.

dataSources

dataSources: EntityDataSource[]

Entity references in known data sources.

length

length: number

Length for the entity text. Use of different 'stringIndexType' values can affect the length returned.

Optional normalizedText

normalizedText: undefined | string

Normalized name for the entity. For example, the normalized text for "histologically" is "histologic".

offset

offset: number

Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned.

Optional subCategory

subCategory: undefined | string

(Optional) Entity sub type.

text

text: string

Entity text as appears in the request.

HealthcareEntityRelationRoleType

HealthcareEntityRelationRoleType: string

The type of different roles a healthcare entity can play in a relation.

HealthcareJobState

HealthcareJobState: JobMetadata & Pagination & { errors?: TextAnalyticsError[]; results?: HealthcareResult }

InnerErrorCodeValue

InnerErrorCodeValue: string

Defines values for InnerErrorCodeValue.
KnownInnerErrorCodeValue can be used interchangeably with InnerErrorCodeValue, this enum contains the known values that the service supports.

Know values supported by the service

InvalidParameterValue
InvalidRequestBodyFormat
EmptyRequest
MissingInputRecords
InvalidDocument
ModelVersionIncorrect
InvalidDocumentBatch
UnsupportedLanguageCode
InvalidCountryHint

PagedAsyncIterableAnalyzeActionsResult

PagedAsyncIterableAnalyzeActionsResult: PagedAsyncIterableIterator<AnalyzeActionsResult, AnalyzeActionsResult>

The results of an analyze Actions operation represented as a paged iterator that iterates over the results of the requested actions.

PagedAsyncIterableAnalyzeHealthcareEntitiesResult

PagedAsyncIterableAnalyzeHealthcareEntitiesResult: PagedAsyncIterableIterator<AnalyzeHealthcareEntitiesResult, AnalyzeHealthcareEntitiesResultArray>

The results of a healthcare operation represented as a paged iterator that can either iterate over the results on a document-by-document basis or, by byPage(), can iterate over pages of documents.

PiiCategory

PiiCategory: string

Defines values for PiiCategory.
KnownPiiCategory can be used interchangeably with PiiCategory, this enum contains the known values that the service supports.

Know values supported by the service

ABARoutingNumber
ARNationalIdentityNumber
AUBankAccountNumber
AUDriversLicenseNumber
AUMedicalAccountNumber
AUPassportNumber
AUTaxFileNumber
AUBusinessNumber
AUCompanyNumber
ATIdentityCard
ATTaxIdentificationNumber
ATValueAddedTaxNumber
AzureDocumentDBAuthKey
AzureIAASDatabaseConnectionAndSQLString
AzureIoTConnectionString
AzurePublishSettingPassword
AzureRedisCacheString
AzureSAS
AzureServiceBusString
AzureStorageAccountKey
AzureStorageAccountGeneric
BENationalNumber
BENationalNumberV2
BEValueAddedTaxNumber
BRCPFNumber
BRLegalEntityNumber
BRNationalIDRG
BGUniformCivilNumber
CABankAccountNumber
CADriversLicenseNumber
CAHealthServiceNumber
CAPassportNumber
CAPersonalHealthIdentification
CASocialInsuranceNumber
CLIdentityCardNumber
CNResidentIdentityCardNumber
CreditCardNumber
HRIdentityCardNumber
HRNationalIDNumber
HRPersonalIdentificationNumber
HRPersonalIdentificationOIBNumberV2
CYIdentityCard
CYTaxIdentificationNumber
CZPersonalIdentityNumber
CZPersonalIdentityV2
DKPersonalIdentificationNumber
DKPersonalIdentificationV2
DrugEnforcementAgencyNumber
EEPersonalIdentificationCode
EUDebitCardNumber
EUDriversLicenseNumber
EUGPSCoordinates
EUNationalIdentificationNumber
EUPassportNumber
EUSocialSecurityNumber
EUTaxIdentificationNumber
FIEuropeanHealthNumber
FINationalID
FINationalIDV2
FIPassportNumber
FRDriversLicenseNumber
FRHealthInsuranceNumber
FRNationalID
FRPassportNumber
FRSocialSecurityNumber
FRTaxIdentificationNumber
FRValueAddedTaxNumber
DEDriversLicenseNumber
DEPassportNumber
DEIdentityCardNumber
DETaxIdentificationNumber
DEValueAddedNumber
GRNationalIDCard
GRNationalIDV2
GRTaxIdentificationNumber
HKIdentityCardNumber
HUValueAddedNumber
HUPersonalIdentificationNumber
HUTaxIdentificationNumber
INPermanentAccount
INUniqueIdentificationNumber
IDIdentityCardNumber
InternationalBankingAccountNumber
IEPersonalPublicServiceNumber
IEPersonalPublicServiceNumberV2
ILBankAccountNumber
ILNationalID
ITDriversLicenseNumber
ITFiscalCode
ITValueAddedTaxNumber
JPBankAccountNumber
JPDriversLicenseNumber
JPPassportNumber
JPResidentRegistrationNumber
JPSocialInsuranceNumber
JPMyNumberCorporate
JPMyNumberPersonal
JPResidenceCardNumber
LVPersonalCode
LTPersonalCode
LUNationalIdentificationNumberNatural
LUNationalIdentificationNumberNonNatural
MYIdentityCardNumber
MTIdentityCardNumber
MTTaxIDNumber
NLCitizensServiceNumber
NLCitizensServiceNumberV2
NLTaxIdentificationNumber
NLValueAddedTaxNumber
NZBankAccountNumber
NZDriversLicenseNumber
NZInlandRevenueNumber
NZMinistryOfHealthNumber
NZSocialWelfareNumber
NOIdentityNumber
PHUnifiedMultiPurposeIDNumber
PLIdentityCard
PLNationalID
PLNationalIDV2
PLPassportNumber
PLTaxIdentificationNumber
PLREGONNumber
PTCitizenCardNumber
PTCitizenCardNumberV2
PTTaxIdentificationNumber
ROPersonalNumericalCode
RUPassportNumberDomestic
RUPassportNumberInternational
SANationalID
SGNationalRegistrationIdentityCardNumber
SKPersonalNumber
SITaxIdentificationNumber
SIUniqueMasterCitizenNumber
ZAIdentificationNumber
KRResidentRegistrationNumber
ESDNI
ESSocialSecurityNumber
ESTaxIdentificationNumber
SQLServerConnectionString
SENationalID
SENationalIDV2
SEPassportNumber
SETaxIdentificationNumber
SWIFTCode
CHSocialSecurityNumber
TWNationalID
TWPassportNumber
TWResidentCertificate
THPopulationIdentificationCode
TRNationalIdentificationNumber
UKDriversLicenseNumber
UKElectoralRollNumber
UKNationalHealthNumber
UKNationalInsuranceNumber
UKUniqueTaxpayerNumber
USUKPassportNumber
USBankAccountNumber
USDriversLicenseNumber
USIndividualTaxpayerIdentification
USSocialSecurityNumber
UAPassportNumberDomestic
UAPassportNumberInternational
Organization
Email
URL
Age
PhoneNumber
IPAddress
Date
Person
Address
All
Default

PiiTaskParametersDomain

PiiTaskParametersDomain: string

Defines values for PiiTaskParametersDomain.
KnownPiiTaskParametersDomain can be used interchangeably with PiiTaskParametersDomain, this enum contains the known values that the service supports.

Know values supported by the service

phi
none

RecognizeCategorizedEntitiesAction

RecognizeCategorizedEntitiesAction: { disableServiceLogs?: undefined | false | true; modelVersion?: undefined | string; stringIndexType?: StringIndexType }

Options for an entities recognition action.

Type declaration

  • Optional 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 modelVersion?: undefined | string

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

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

RecognizeCategorizedEntitiesActionErrorResult

RecognizeCategorizedEntitiesActionErrorResult: TextAnalyticsActionErrorResult

The error of a recognize categorized entities action.

RecognizeCategorizedEntitiesActionResult

The result of a recognize categorized entities action.

RecognizeCategorizedEntitiesErrorResult

RecognizeCategorizedEntitiesErrorResult: TextAnalyticsErrorResult

An error result from the recognize entities operation on a single document.

RecognizeCategorizedEntitiesResult

The result of the recognize entities operation on a single document.

RecognizeLinkedEntitiesAction

RecognizeLinkedEntitiesAction: { disableServiceLogs?: undefined | false | true; modelVersion?: undefined | string; stringIndexType?: StringIndexType }

Options for an entities linking action.

Type declaration

  • Optional 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 modelVersion?: undefined | string

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

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

RecognizeLinkedEntitiesActionErrorResult

RecognizeLinkedEntitiesActionErrorResult: TextAnalyticsActionErrorResult

The error of a recognize linked entities action.

RecognizeLinkedEntitiesActionResult

The result of a recognize linked entities action.

RecognizeLinkedEntitiesErrorResult

RecognizeLinkedEntitiesErrorResult: TextAnalyticsErrorResult

An error result from the recognize linked entities operation on a single document.

RecognizeLinkedEntitiesResult

The result of the recognize linked entities operation on a single document.

RecognizePiiEntitiesAction

RecognizePiiEntitiesAction: { disableServiceLogs?: undefined | false | true; domain?: PiiEntityDomainType; modelVersion?: undefined | string; stringIndexType?: StringIndexType }

Options for a Pii entities recognition action.

Type declaration

  • Optional disableServiceLogs?: undefined | false | true

    If set to false, you opt-in to have your text input logged for troubleshooting. By default, Text Analytics will not log your input text for pii entities recognition. Setting this parameter to false, enables input logging.

  • Optional domain?: PiiEntityDomainType

    Filters entities to ones only included in the specified domain (e.g., if set to 'PHI', entities in the Protected Healthcare Information domain will only be returned). @see https://aka.ms/tanerpii for more information.

  • Optional modelVersion?: undefined | string

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

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

RecognizePiiEntitiesActionErrorResult

RecognizePiiEntitiesActionErrorResult: TextAnalyticsActionErrorResult

The error of a recognize pii entities action.

RecognizePiiEntitiesActionResult

The result of a recognize pii entities action.

RecognizePiiEntitiesErrorResult

RecognizePiiEntitiesErrorResult: TextAnalyticsErrorResult

An error result from the recognize entities operation on a single document.

RecognizePiiEntitiesResult

The result of the recognize entities operation on a single document.

RelationType

RelationType: string

Defines values for RelationType.
KnownRelationType can be used interchangeably with RelationType, this enum contains the known values that the service supports.

Know values supported by the service

Abbreviation
DirectionOfBodyStructure
DirectionOfCondition
DirectionOfExamination
DirectionOfTreatment
DosageOfMedication
FormOfMedication
FrequencyOfMedication
FrequencyOfTreatment
QualifierOfCondition
RelationOfExamination
RouteOfMedication
TimeOfCondition
TimeOfEvent
TimeOfExamination
TimeOfMedication
TimeOfTreatment
UnitOfCondition
UnitOfExamination
ValueOfCondition
ValueOfExamination

SentenceSentimentLabel

SentenceSentimentLabel: "positive" | "neutral" | "negative"

Defines values for SentenceSentimentLabel.

State

State: "notStarted" | "running" | "succeeded" | "failed" | "rejected" | "cancelled" | "cancelling" | "partiallyCompleted"

Defines values for State.

StringIndexType

StringIndexType: "TextElement_v8" | "UnicodeCodePoint" | "Utf16CodeUnit"

Defines values for StringIndexType.
KnownStringIndexType can be used interchangeably with StringIndexType, this enum contains the known values that the service supports.

Know values supported by the service

TextElement_v8: Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo.
UnicodeCodePoint: Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python.
Utf16CodeUnit: Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript. Measurement units that can used to calculate the offset and length properties.

TargetRelationType

TargetRelationType: "assessment" | "target"

Defines values for TargetRelationType.

TasksStateTasksDetails

TasksStateTasksDetails: TaskState & {}

TasksStateTasksEntityLinkingTasksItem

TasksStateTasksEntityRecognitionPiiTasksItem

TasksStateTasksEntityRecognitionTasksItem

TasksStateTasksKeyPhraseExtractionTasksItem

TasksStateTasksSentimentAnalysisTasksItem

TokenSentimentValue

TokenSentimentValue: "positive" | "mixed" | "negative"

Defines values for TokenSentimentValue.

WarningCode

WarningCode: string

Defines values for WarningCode.
KnownWarningCode can be used interchangeably with WarningCode, this enum contains the known values that the service supports.

Know values supported by the service

LongWordsInDocument
DocumentTruncated

Variables

Const API_KEY_HEADER_NAME

API_KEY_HEADER_NAME: "Ocp-Apim-Subscription-Key" = "Ocp-Apim-Subscription-Key"

Const DEFAULT_COGNITIVE_SCOPE

DEFAULT_COGNITIVE_SCOPE: "https://cognitiveservices.azure.com/.default" = "https://cognitiveservices.azure.com/.default"

Const jsEncodingUnit

jsEncodingUnit: "Utf16CodeUnit" = "Utf16CodeUnit"

Const serializer

serializer: any = coreClient.createSerializer(Mappers, /* isXml */ false)

Const textAnalyticsAzureKeyCredentialPolicyName

textAnalyticsAzureKeyCredentialPolicyName: "textAnalyticsAzureKeyCredentialPolicy" = "textAnalyticsAzureKeyCredentialPolicy"

The programmatic identifier of the textAnalyticsAzureKeyCredentialPolicy.

Const url

url: { constructor: any; prototype: __type; createObjectURL: any; revokeObjectURL: any } = URL

Type declaration

  • constructor: function
    • Parameters

      • url: string
      • Optional base: string | __type

      Returns __type

  • prototype: __type
  • createObjectURL: function
    • createObjectURL(object: any): string
    • Parameters

      • object: any

      Returns string

  • revokeObjectURL: function
    • revokeObjectURL(url: string): void
    • Parameters

      • url: string

      Returns void

Const urlSearchParams

urlSearchParams: { constructor: any; prototype: __type } = URLSearchParams

Type declaration

  • constructor: function
    • new __type(init?: string[][] | Record<string, string> | string | __type): __type
    • Parameters

      • Optional init: string[][] | Record<string, string> | string | __type

      Returns __type

  • prototype: __type

Functions

isStringArray

  • isStringArray(documents: any[]): documents is string[]

setStrEncodingParamValue

  • setStrEncodingParamValue(stringIndexType?: GeneratedStringIndexType): GeneratedStringIndexType

Object literals

Const AnalyzeBatchInput

AnalyzeBatchInput: object

type

type: object

className

className: string = "AnalyzeBatchInput"

name

name: string = "Composite"

modelProperties

modelProperties: object

analysisInput

analysisInput: object

serializedName

serializedName: string = "analysisInput"

type

type: object

className

className: string = "MultiLanguageBatchInput"

name

name: string = "Composite"

Const AnalyzeJobMetadata

AnalyzeJobMetadata: object

type

type: object

className

className: string = "AnalyzeJobMetadata"

name

name: string = "Composite"

modelProperties

modelProperties: object

displayName

displayName: object

serializedName

serializedName: string = "displayName"

type

type: object

name

name: string = "String"

Const AnalyzeJobState

AnalyzeJobState: object

type

type: object

className

className: string = "AnalyzeJobState"

name

name: string = "Composite"

modelProperties

modelProperties: object

errors

errors: object

serializedName

serializedName: string = "errors"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "TextAnalyticsError"

name

name: string = "Composite"

statistics

statistics: object

serializedName

serializedName: string = "statistics"

type

type: object

className

className: string = "TextDocumentBatchStatistics"

name

name: string = "Composite"

Const Components15Gvwi3SchemasTasksstatePropertiesTasksPropertiesEntityrecognitiontasksItemsAllof1

Components15Gvwi3SchemasTasksstatePropertiesTasksPropertiesEntityrecognitiontasksItemsAllof1: object

type

type: object

className

className: string = "Components15Gvwi3SchemasTasksstatePropertiesTasksPropertiesEntityrecognitiontasksItemsAllof1"

name

name: string = "Composite"

modelProperties

modelProperties: object

results

results: object

serializedName

serializedName: string = "results"

type

type: object

className

className: string = "EntitiesResult"

name

name: string = "Composite"

Const Components15X8E9LSchemasTasksstatePropertiesTasksPropertiesEntityrecognitionpiitasksItemsAllof1

Components15X8E9LSchemasTasksstatePropertiesTasksPropertiesEntityrecognitionpiitasksItemsAllof1: object

type

type: object

className

className: string = "Components15X8E9LSchemasTasksstatePropertiesTasksPropertiesEntityrecognitionpiitasksItemsAllof1"

name

name: string = "Composite"

modelProperties

modelProperties: object

results

results: object

serializedName

serializedName: string = "results"

type

type: object

className

className: string = "PiiResult"

name

name: string = "Composite"

Const Components1C6O47FSchemasTasksstatePropertiesTasksPropertiesSentimentanalysistasksItemsAllof1

Components1C6O47FSchemasTasksstatePropertiesTasksPropertiesSentimentanalysistasksItemsAllof1: object

type

type: object

className

className: string = "Components1C6O47FSchemasTasksstatePropertiesTasksPropertiesSentimentanalysistasksItemsAllof1"

name

name: string = "Composite"

modelProperties

modelProperties: object

results

results: object

serializedName

serializedName: string = "results"

type

type: object

className

className: string = "SentimentResponse"

name

name: string = "Composite"

Const Components1D9IzucSchemasTasksstatePropertiesTasksPropertiesKeyphraseextractiontasksItemsAllof1

Components1D9IzucSchemasTasksstatePropertiesTasksPropertiesKeyphraseextractiontasksItemsAllof1: object

type

type: object

className

className: string = "Components1D9IzucSchemasTasksstatePropertiesTasksPropertiesKeyphraseextractiontasksItemsAllof1"

name

name: string = "Composite"

modelProperties

modelProperties: object

results

results: object

serializedName

serializedName: string = "results"

type

type: object

className

className: string = "KeyPhraseResult"

name

name: string = "Composite"

Const ComponentsIfu7BjSchemasTasksstatePropertiesTasksPropertiesEntitylinkingtasksItemsAllof1

ComponentsIfu7BjSchemasTasksstatePropertiesTasksPropertiesEntitylinkingtasksItemsAllof1: object

type

type: object

className

className: string = "ComponentsIfu7BjSchemasTasksstatePropertiesTasksPropertiesEntitylinkingtasksItemsAllof1"

name

name: string = "Composite"

modelProperties

modelProperties: object

results

results: object

serializedName

serializedName: string = "results"

type

type: object

className

className: string = "EntityLinkingResult"

name

name: string = "Composite"

Const DetectLanguageInput

DetectLanguageInput: object

type

type: object

className

className: string = "DetectLanguageInput"

name

name: string = "Composite"

modelProperties

modelProperties: object

countryHint

countryHint: object

serializedName

serializedName: string = "countryHint"

type

type: object

name

name: string = "String"

id

id: object

required

required: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

text

text: object

required

required: boolean = true

serializedName

serializedName: string = "text"

type

type: object

name

name: string = "String"

Const DetectedLanguage

DetectedLanguage: object

type

type: object

className

className: string = "DetectedLanguage"

name

name: string = "Composite"

modelProperties

modelProperties: object

confidenceScore

confidenceScore: object

required

required: boolean = true

serializedName

serializedName: string = "confidenceScore"

type

type: object

name

name: string = "Number"

iso6391Name

iso6391Name: object

required

required: boolean = true

serializedName

serializedName: string = "iso6391Name"

type

type: object

name

name: string = "String"

name

name: object

required

required: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

Const DocumentEntities

DocumentEntities: object

type

type: object

className

className: string = "DocumentEntities"

name

name: string = "Composite"

modelProperties

modelProperties: object

entities

entities: object

required

required: boolean = true

serializedName

serializedName: string = "entities"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "Entity"

name

name: string = "Composite"

id

id: object

required

required: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

statistics

statistics: object

serializedName

serializedName: string = "statistics"

type

type: object

className

className: string = "TextDocumentStatistics"

name

name: string = "Composite"

warnings

warnings: object

required

required: boolean = true

serializedName

serializedName: string = "warnings"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "TextAnalyticsWarning"

name

name: string = "Composite"

Const DocumentError

DocumentError: object

type

type: object

className

className: string = "DocumentError"

name

name: string = "Composite"

modelProperties

modelProperties: object

error

error: object

serializedName

serializedName: string = "error"

type

type: object

className

className: string = "TextAnalyticsError"

name

name: string = "Composite"

id

id: object

required

required: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

Const DocumentHealthcareEntities

DocumentHealthcareEntities: object

type

type: object

className

className: string = "DocumentHealthcareEntities"

name

name: string = "Composite"

modelProperties

modelProperties: object

entities

entities: object

required

required: boolean = true

serializedName

serializedName: string = "entities"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "HealthcareEntity"

name

name: string = "Composite"

id

id: object

required

required: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

relations

relations: object

required

required: boolean = true

serializedName

serializedName: string = "relations"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "HealthcareRelation"

name

name: string = "Composite"

statistics

statistics: object

serializedName

serializedName: string = "statistics"

type

type: object

className

className: string = "TextDocumentStatistics"

name

name: string = "Composite"

warnings

warnings: object

required

required: boolean = true

serializedName

serializedName: string = "warnings"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "TextAnalyticsWarning"

name

name: string = "Composite"

Const DocumentKeyPhrases

DocumentKeyPhrases: object

type

type: object

className

className: string = "DocumentKeyPhrases"

name

name: string = "Composite"

modelProperties

modelProperties: object

id

id: object

required

required: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

keyPhrases

keyPhrases: object

required

required: boolean = true

serializedName

serializedName: string = "keyPhrases"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

statistics

statistics: object

serializedName

serializedName: string = "statistics"

type

type: object

className

className: string = "TextDocumentStatistics"

name

name: string = "Composite"

warnings

warnings: object

required

required: boolean = true

serializedName

serializedName: string = "warnings"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "TextAnalyticsWarning"

name

name: string = "Composite"

Const DocumentLanguage

DocumentLanguage: object

type

type: object

className

className: string = "DocumentLanguage"

name

name: string = "Composite"

modelProperties

modelProperties: object

detectedLanguage

detectedLanguage: object

serializedName

serializedName: string = "detectedLanguage"

type

type: object

className

className: string = "DetectedLanguage"

name

name: string = "Composite"

id

id: object

required

required: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

statistics

statistics: object

serializedName

serializedName: string = "statistics"

type

type: object

className

className: string = "TextDocumentStatistics"

name

name: string = "Composite"

warnings

warnings: object

required

required: boolean = true

serializedName

serializedName: string = "warnings"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "TextAnalyticsWarning"

name

name: string = "Composite"

Const DocumentLinkedEntities

DocumentLinkedEntities: object

type

type: object

className

className: string = "DocumentLinkedEntities"

name

name: string = "Composite"

modelProperties

modelProperties: object

entities

entities: object

required

required: boolean = true

serializedName

serializedName: string = "entities"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "LinkedEntity"

name

name: string = "Composite"

id

id: object

required

required: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

statistics

statistics: object

serializedName

serializedName: string = "statistics"

type

type: object

className

className: string = "TextDocumentStatistics"

name

name: string = "Composite"

warnings

warnings: object

required

required: boolean = true

serializedName

serializedName: string = "warnings"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "TextAnalyticsWarning"

name

name: string = "Composite"

Const DocumentSentiment

DocumentSentiment: object

type

type: object

className

className: string = "DocumentSentiment"

name

name: string = "Composite"

modelProperties

modelProperties: object

confidenceScores

confidenceScores: object

serializedName

serializedName: string = "confidenceScores"

type

type: object

className

className: string = "SentimentConfidenceScores"

name

name: string = "Composite"

id

id: object

required

required: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

sentenceSentiments

sentenceSentiments: object

required

required: boolean = true

serializedName

serializedName: string = "sentences"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "SentenceSentiment"

name

name: string = "Composite"

sentiment

sentiment: object

required

required: boolean = true

serializedName

serializedName: string = "sentiment"

type

type: object

allowedValues

allowedValues: string[] = ["positive", "neutral", "negative", "mixed"]

name

name: string = "Enum"

statistics

statistics: object

serializedName

serializedName: string = "statistics"

type

type: object

className

className: string = "TextDocumentStatistics"

name

name: string = "Composite"

warnings

warnings: object

required

required: boolean = true

serializedName

serializedName: string = "warnings"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "TextAnalyticsWarning"

name

name: string = "Composite"

Const EntitiesResult

EntitiesResult: object

type

type: object

className

className: string = "EntitiesResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

documents

documents: object

required

required: boolean = true

serializedName

serializedName: string = "documents"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "DocumentEntities"

name

name: string = "Composite"

errors

errors: object

required

required: boolean = true

serializedName

serializedName: string = "errors"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "DocumentError"

name

name: string = "Composite"

modelVersion

modelVersion: object

required

required: boolean = true

serializedName

serializedName: string = "modelVersion"

type

type: object

name

name: string = "String"

statistics

statistics: object

serializedName

serializedName: string = "statistics"

type

type: object

className

className: string = "TextDocumentBatchStatistics"

name

name: string = "Composite"

Const EntitiesTask

EntitiesTask: object

type

type: object

className

className: string = "EntitiesTask"

name

name: string = "Composite"

modelProperties

modelProperties: object

parameters

parameters: object

serializedName

serializedName: string = "parameters"

type

type: object

className

className: string = "EntitiesTaskParameters"

name

name: string = "Composite"

Const EntitiesTaskParameters

EntitiesTaskParameters: object

type

type: object

className

className: string = "EntitiesTaskParameters"

name

name: string = "Composite"

modelProperties

modelProperties: object

loggingOptOut

loggingOptOut: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "loggingOptOut"

type

type: object

name

name: string = "Boolean"

modelVersion

modelVersion: object

defaultValue

defaultValue: string = "latest"

serializedName

serializedName: string = "model-version"

type

type: object

name

name: string = "String"

stringIndexType

stringIndexType: object

serializedName

serializedName: string = "stringIndexType"

type

type: object

name

name: string = "String"

Const Entity

Entity: object

type

type: object

className

className: string = "Entity"

name

name: string = "Composite"

modelProperties

modelProperties: object

category

category: object

required

required: boolean = true

serializedName

serializedName: string = "category"

type

type: object

name

name: string = "String"

confidenceScore

confidenceScore: object

required

required: boolean = true

serializedName

serializedName: string = "confidenceScore"

type

type: object

name

name: string = "Number"

length

length: object

required

required: boolean = true

serializedName

serializedName: string = "length"

type

type: object

name

name: string = "Number"

offset

offset: object

required

required: boolean = true

serializedName

serializedName: string = "offset"

type

type: object

name

name: string = "Number"

subCategory

subCategory: object

serializedName

serializedName: string = "subcategory"

type

type: object

name

name: string = "String"

text

text: object

required

required: boolean = true

serializedName

serializedName: string = "text"

type

type: object

name

name: string = "String"

Const EntityLinkingResult

EntityLinkingResult: object

type

type: object

className

className: string = "EntityLinkingResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

documents

documents: object

required

required: boolean = true

serializedName

serializedName: string = "documents"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "DocumentLinkedEntities"

name

name: string = "Composite"

errors

errors: object

required

required: boolean = true

serializedName

serializedName: string = "errors"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "DocumentError"

name

name: string = "Composite"

modelVersion

modelVersion: object

required

required: boolean = true

serializedName

serializedName: string = "modelVersion"

type

type: object

name

name: string = "String"

statistics

statistics: object

serializedName

serializedName: string = "statistics"

type

type: object

className

className: string = "TextDocumentBatchStatistics"

name

name: string = "Composite"

Const EntityLinkingTask

EntityLinkingTask: object

type

type: object

className

className: string = "EntityLinkingTask"

name

name: string = "Composite"

modelProperties

modelProperties: object

parameters

parameters: object

serializedName

serializedName: string = "parameters"

type

type: object

className

className: string = "EntityLinkingTaskParameters"

name

name: string = "Composite"

Const EntityLinkingTaskParameters

EntityLinkingTaskParameters: object

type

type: object

className

className: string = "EntityLinkingTaskParameters"

name

name: string = "Composite"

modelProperties

modelProperties: object

loggingOptOut

loggingOptOut: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "loggingOptOut"

type

type: object

name

name: string = "Boolean"

modelVersion

modelVersion: object

defaultValue

defaultValue: string = "latest"

serializedName

serializedName: string = "model-version"

type

type: object

name

name: string = "String"

stringIndexType

stringIndexType: object

serializedName

serializedName: string = "stringIndexType"

type

type: object

name

name: string = "String"

Const ErrorResponse

ErrorResponse: object

type

type: object

className

className: string = "ErrorResponse"

name

name: string = "Composite"

modelProperties

modelProperties: object

error

error: object

serializedName

serializedName: string = "error"

type

type: object

className

className: string = "TextAnalyticsError"

name

name: string = "Composite"

Const GeneratedClientAnalyzeHeaders

GeneratedClientAnalyzeHeaders: object

type

type: object

className

className: string = "GeneratedClientAnalyzeHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

operationLocation

operationLocation: object

serializedName

serializedName: string = "operation-location"

type

type: object

name

name: string = "String"

Const GeneratedClientCancelHealthJobHeaders

GeneratedClientCancelHealthJobHeaders: object

type

type: object

className

className: string = "GeneratedClientCancelHealthJobHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

operationLocation

operationLocation: object

serializedName

serializedName: string = "operation-location"

type

type: object

name

name: string = "String"

Const GeneratedClientHealthHeaders

GeneratedClientHealthHeaders: object

type

type: object

className

className: string = "GeneratedClientHealthHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

operationLocation

operationLocation: object

serializedName

serializedName: string = "operation-location"

type

type: object

name

name: string = "String"

Const HealthcareAssertion

HealthcareAssertion: object

type

type: object

className

className: string = "HealthcareAssertion"

name

name: string = "Composite"

modelProperties

modelProperties: object

association

association: object

serializedName

serializedName: string = "association"

type

type: object

allowedValues

allowedValues: string[] = ["subject", "other"]

name

name: string = "Enum"

certainty

certainty: object

serializedName

serializedName: string = "certainty"

type

type: object

allowedValues

allowedValues: string[] = ["positive","positivePossible","neutralPossible","negativePossible","negative"]

name

name: string = "Enum"

conditionality

conditionality: object

serializedName

serializedName: string = "conditionality"

type

type: object

allowedValues

allowedValues: string[] = ["hypothetical", "conditional"]

name

name: string = "Enum"

Const HealthcareEntity

HealthcareEntity: object

type

type: object

className

className: string = "HealthcareEntity"

name

name: string = "Composite"

modelProperties

modelProperties: object

assertion

assertion: object

serializedName

serializedName: string = "assertion"

type

type: object

className

className: string = "HealthcareAssertion"

name

name: string = "Composite"

links

links: object

serializedName

serializedName: string = "links"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "HealthcareEntityLink"

name

name: string = "Composite"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

Const HealthcareEntityLink

HealthcareEntityLink: object

type

type: object

className

className: string = "HealthcareEntityLink"

name

name: string = "Composite"

modelProperties

modelProperties: object

dataSource

dataSource: object

required

required: boolean = true

serializedName

serializedName: string = "dataSource"

type

type: object

name

name: string = "String"

id

id: object

required

required: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

Const HealthcareJobState

HealthcareJobState: object

type

type: object

className

className: string = "HealthcareJobState"

name

name: string = "Composite"

modelProperties

modelProperties: object

errors

errors: object

serializedName

serializedName: string = "errors"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "TextAnalyticsError"

name

name: string = "Composite"

results

results: object

serializedName

serializedName: string = "results"

type

type: object

className

className: string = "HealthcareResult"

name

name: string = "Composite"

Const HealthcareRelation

HealthcareRelation: object

type

type: object

className

className: string = "HealthcareRelation"

name

name: string = "Composite"

modelProperties

modelProperties: object

entities

entities: object

required

required: boolean = true

serializedName

serializedName: string = "entities"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "HealthcareRelationEntity"

name

name: string = "Composite"

relationType

relationType: object

required

required: boolean = true

serializedName

serializedName: string = "relationType"

type

type: object

name

name: string = "String"

Const HealthcareRelationEntity

HealthcareRelationEntity: object

type

type: object

className

className: string = "HealthcareRelationEntity"

name

name: string = "Composite"

modelProperties

modelProperties: object

ref

ref: object

required

required: boolean = true

serializedName

serializedName: string = "ref"

type

type: object

name

name: string = "String"

role

role: object

required

required: boolean = true

serializedName

serializedName: string = "role"

type

type: object

name

name: string = "String"

Const HealthcareResult

HealthcareResult: object

type

type: object

className

className: string = "HealthcareResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

documents

documents: object

required

required: boolean = true

serializedName

serializedName: string = "documents"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "DocumentHealthcareEntities"

name

name: string = "Composite"

errors

errors: object

required

required: boolean = true

serializedName

serializedName: string = "errors"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "DocumentError"

name

name: string = "Composite"

modelVersion

modelVersion: object

required

required: boolean = true

serializedName

serializedName: string = "modelVersion"

type

type: object

name

name: string = "String"

statistics

statistics: object

serializedName

serializedName: string = "statistics"

type

type: object

className

className: string = "TextDocumentBatchStatistics"

name

name: string = "Composite"

Const InnerError

InnerError: object

type

type: object

className

className: string = "InnerError"

name

name: string = "Composite"

modelProperties

modelProperties: object

code

code: object

required

required: boolean = true

serializedName

serializedName: string = "code"

type

type: object

name

name: string = "String"

details

details: object

serializedName

serializedName: string = "details"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

name

name: string = "String"

innererror

innererror: object

serializedName

serializedName: string = "innererror"

type

type: object

className

className: string = "InnerError"

name

name: string = "Composite"

message

message: object

required

required: boolean = true

serializedName

serializedName: string = "message"

type

type: object

name

name: string = "String"

target

target: object

serializedName

serializedName: string = "target"

type

type: object

name

name: string = "String"

Const JobDescriptor

JobDescriptor: object

type

type: object

className

className: string = "JobDescriptor"

name

name: string = "Composite"

modelProperties

modelProperties: object

displayName

displayName: object

serializedName

serializedName: string = "displayName"

type

type: object

name

name: string = "String"

Const JobManifest

JobManifest: object

type

type: object

className

className: string = "JobManifest"

name

name: string = "Composite"

modelProperties

modelProperties: object

tasks

tasks: object

serializedName

serializedName: string = "tasks"

type

type: object

className

className: string = "JobManifestTasks"

name

name: string = "Composite"

Const JobManifestTasks

JobManifestTasks: object

type

type: object

className

className: string = "JobManifestTasks"

name

name: string = "Composite"

modelProperties

modelProperties: object

entityLinkingTasks

entityLinkingTasks: object

serializedName

serializedName: string = "entityLinkingTasks"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "EntityLinkingTask"

name

name: string = "Composite"

entityRecognitionPiiTasks

entityRecognitionPiiTasks: object

serializedName

serializedName: string = "entityRecognitionPiiTasks"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "PiiTask"

name

name: string = "Composite"

entityRecognitionTasks

entityRecognitionTasks: object

serializedName

serializedName: string = "entityRecognitionTasks"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "EntitiesTask"

name

name: string = "Composite"

keyPhraseExtractionTasks

keyPhraseExtractionTasks: object

serializedName

serializedName: string = "keyPhraseExtractionTasks"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "KeyPhrasesTask"

name

name: string = "Composite"

sentimentAnalysisTasks

sentimentAnalysisTasks: object

serializedName

serializedName: string = "sentimentAnalysisTasks"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "SentimentAnalysisTask"

name

name: string = "Composite"

Const JobMetadata

JobMetadata: object

type

type: object

className

className: string = "JobMetadata"

name

name: string = "Composite"

modelProperties

modelProperties: object

createdDateTime

createdDateTime: object

required

required: boolean = true

serializedName

serializedName: string = "createdDateTime"

type

type: object

name

name: string = "DateTime"

expirationDateTime

expirationDateTime: object

serializedName

serializedName: string = "expirationDateTime"

type

type: object

name

name: string = "DateTime"

jobId

jobId: object

required

required: boolean = true

serializedName

serializedName: string = "jobId"

type

type: object

name

name: string = "Uuid"

lastUpdateDateTime

lastUpdateDateTime: object

required

required: boolean = true

serializedName

serializedName: string = "lastUpdateDateTime"

type

type: object

name

name: string = "DateTime"

status

status: object

required

required: boolean = true

serializedName

serializedName: string = "status"

type

type: object

allowedValues

allowedValues: string[] = ["notStarted","running","succeeded","failed","rejected","cancelled","cancelling","partiallyCompleted"]

name

name: string = "Enum"

Const KeyPhraseResult

KeyPhraseResult: object

type

type: object

className

className: string = "KeyPhraseResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

documents

documents: object

required

required: boolean = true

serializedName

serializedName: string = "documents"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "DocumentKeyPhrases"

name

name: string = "Composite"

errors

errors: object

required

required: boolean = true

serializedName

serializedName: string = "errors"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "DocumentError"

name

name: string = "Composite"

modelVersion

modelVersion: object

required

required: boolean = true

serializedName

serializedName: string = "modelVersion"

type

type: object

name

name: string = "String"

statistics

statistics: object

serializedName

serializedName: string = "statistics"

type

type: object

className

className: string = "TextDocumentBatchStatistics"

name

name: string = "Composite"

Const KeyPhrasesTask

KeyPhrasesTask: object

type

type: object

className

className: string = "KeyPhrasesTask"

name

name: string = "Composite"

modelProperties

modelProperties: object

parameters

parameters: object

serializedName

serializedName: string = "parameters"

type

type: object

className

className: string = "KeyPhrasesTaskParameters"

name

name: string = "Composite"

Const KeyPhrasesTaskParameters

KeyPhrasesTaskParameters: object

type

type: object

className

className: string = "KeyPhrasesTaskParameters"

name

name: string = "Composite"

modelProperties

modelProperties: object

loggingOptOut

loggingOptOut: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "loggingOptOut"

type

type: object

name

name: string = "Boolean"

modelVersion

modelVersion: object

defaultValue

defaultValue: string = "latest"

serializedName

serializedName: string = "model-version"

type

type: object

name

name: string = "String"

Const LanguageBatchInput

LanguageBatchInput: object

type

type: object

className

className: string = "LanguageBatchInput"

name

name: string = "Composite"

modelProperties

modelProperties: object

documents

documents: object

required

required: boolean = true

serializedName

serializedName: string = "documents"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "DetectLanguageInput"

name

name: string = "Composite"

Const LanguageResult

LanguageResult: object

type

type: object

className

className: string = "LanguageResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

documents

documents: object

required

required: boolean = true

serializedName

serializedName: string = "documents"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "DocumentLanguage"

name

name: string = "Composite"

errors

errors: object

required

required: boolean = true

serializedName

serializedName: string = "errors"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "DocumentError"

name

name: string = "Composite"

modelVersion

modelVersion: object

required

required: boolean = true

serializedName

serializedName: string = "modelVersion"

type

type: object

name

name: string = "String"

statistics

statistics: object

serializedName

serializedName: string = "statistics"

type

type: object

className

className: string = "TextDocumentBatchStatistics"

name

name: string = "Composite"

Const LinkedEntity

LinkedEntity: object

type

type: object

className

className: string = "LinkedEntity"

name

name: string = "Composite"

modelProperties

modelProperties: object

bingEntitySearchApiId

bingEntitySearchApiId: object

serializedName

serializedName: string = "bingId"

type

type: object

name

name: string = "String"

dataSource

dataSource: object

required

required: boolean = true

serializedName

serializedName: string = "dataSource"

type

type: object

name

name: string = "String"

dataSourceEntityId

dataSourceEntityId: object

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

language

language: object

required

required: boolean = true

serializedName

serializedName: string = "language"

type

type: object

name

name: string = "String"

matches

matches: object

required

required: boolean = true

serializedName

serializedName: string = "matches"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "Match"

name

name: string = "Composite"

name

name: object

required

required: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

url

url: object

required

required: boolean = true

serializedName

serializedName: string = "url"

type

type: object

name

name: string = "String"

Const Match

Match: object

type

type: object

className

className: string = "Match"

name

name: string = "Composite"

modelProperties

modelProperties: object

confidenceScore

confidenceScore: object

required

required: boolean = true

serializedName

serializedName: string = "confidenceScore"

type

type: object

name

name: string = "Number"

length

length: object

required

required: boolean = true

serializedName

serializedName: string = "length"

type

type: object

name

name: string = "Number"

offset

offset: object

required

required: boolean = true

serializedName

serializedName: string = "offset"

type

type: object

name

name: string = "Number"

text

text: object

required

required: boolean = true

serializedName

serializedName: string = "text"

type

type: object

name

name: string = "String"

Const MultiLanguageBatchInput

MultiLanguageBatchInput: object

type

type: object

className

className: string = "MultiLanguageBatchInput"

name

name: string = "Composite"

modelProperties

modelProperties: object

documents

documents: object

required

required: boolean = true

serializedName

serializedName: string = "documents"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "TextDocumentInput"

name

name: string = "Composite"

Const Pagination

Pagination: object

type

type: object

className

className: string = "Pagination"

name

name: string = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "@nextLink"

type

type: object

name

name: string = "String"

Const PiiDocumentEntities

PiiDocumentEntities: object

type

type: object

className

className: string = "PiiDocumentEntities"

name

name: string = "Composite"

modelProperties

modelProperties: object

entities

entities: object

required

required: boolean = true

serializedName

serializedName: string = "entities"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "Entity"

name

name: string = "Composite"

id

id: object

required

required: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

redactedText

redactedText: object

required

required: boolean = true

serializedName

serializedName: string = "redactedText"

type

type: object

name

name: string = "String"

statistics

statistics: object

serializedName

serializedName: string = "statistics"

type

type: object

className

className: string = "TextDocumentStatistics"

name

name: string = "Composite"

warnings

warnings: object

required

required: boolean = true

serializedName

serializedName: string = "warnings"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "TextAnalyticsWarning"

name

name: string = "Composite"

Const PiiResult

PiiResult: object

type

type: object

className

className: string = "PiiResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

documents

documents: object

required

required: boolean = true

serializedName

serializedName: string = "documents"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "PiiDocumentEntities"

name

name: string = "Composite"

errors

errors: object

required

required: boolean = true

serializedName

serializedName: string = "errors"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "DocumentError"

name

name: string = "Composite"

modelVersion

modelVersion: object

required

required: boolean = true

serializedName

serializedName: string = "modelVersion"

type

type: object

name

name: string = "String"

statistics

statistics: object

serializedName

serializedName: string = "statistics"

type

type: object

className

className: string = "TextDocumentBatchStatistics"

name

name: string = "Composite"

Const PiiTask

PiiTask: object

type

type: object

className

className: string = "PiiTask"

name

name: string = "Composite"

modelProperties

modelProperties: object

parameters

parameters: object

serializedName

serializedName: string = "parameters"

type

type: object