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

AnalyzeBatchInput

AnalyzeBatchInput: JobDescriptor & JobManifest & { analysisInput: MultiLanguageBatchInput }

AnalyzeJobState

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

AnalyzePollerLike

AnalyzePollerLike: PollerLike<BeginAnalyzeOperationState, PaginatedAnalyzeResults>

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

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.

AspectRelationType

AspectRelationType: "opinion" | "aspect"

Defines values for AspectRelationType.

BeginAnalyzeHealthcareOperationState

BeginAnalyzeHealthcareOperationState: PollOperationState<PaginatedHealthcareEntities>

The status of a health operation

BeginAnalyzeOperationState

BeginAnalyzeOperationState: PollOperationState<PaginatedAnalyzeResults>

The status of an analyze operation

DetectLanguageErrorResult

DetectLanguageErrorResult: TextAnalyticsErrorResult

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

DetectLanguageOptions

DetectLanguageOptions: TextAnalyticsOperationOptions

Options for the detect languages operation.

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.

ExtractKeyPhrasesErrorResult

ExtractKeyPhrasesErrorResult: TextAnalyticsErrorResult

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

ExtractKeyPhrasesOptions

ExtractKeyPhrasesOptions: TextAnalyticsOperationOptions

Options for the extract key phrases operation.

ExtractKeyPhrasesResult

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

GeneratedClientAnalyzeResponse

GeneratedClientAnalyzeResponse: GeneratedClientAnalyzeHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: GeneratedClientAnalyzeHeaders } }

Contains response data for the analyze operation.

GeneratedClientAnalyzeStatusResponse

GeneratedClientAnalyzeStatusResponse: AnalyzeJobState & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: AnalyzeJobState } }

Contains response data for the analyzeStatus operation.

GeneratedClientCancelHealthJobResponse

GeneratedClientCancelHealthJobResponse: GeneratedClientCancelHealthJobHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: GeneratedClientCancelHealthJobHeaders } }

Contains response data for the cancelHealthJob operation.

GeneratedClientEntitiesLinkingResponse

GeneratedClientEntitiesLinkingResponse: EntityLinkingResult & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: EntityLinkingResult } }

Contains response data for the entitiesLinking operation.

GeneratedClientEntitiesRecognitionGeneralResponse

GeneratedClientEntitiesRecognitionGeneralResponse: EntitiesResult & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: EntitiesResult } }

Contains response data for the entitiesRecognitionGeneral operation.

GeneratedClientEntitiesRecognitionPiiResponse

GeneratedClientEntitiesRecognitionPiiResponse: PiiResult & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: PiiResult } }

Contains response data for the entitiesRecognitionPii operation.

GeneratedClientHealthResponse

GeneratedClientHealthResponse: GeneratedClientHealthHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: GeneratedClientHealthHeaders } }

Contains response data for the health operation.

GeneratedClientHealthStatusResponse

GeneratedClientHealthStatusResponse: HealthcareJobState & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: HealthcareJobState } }

Contains response data for the healthStatus operation.

GeneratedClientKeyPhrasesResponse

GeneratedClientKeyPhrasesResponse: KeyPhraseResult & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: KeyPhraseResult } }

Contains response data for the keyPhrases operation.

GeneratedClientLanguagesResponse

GeneratedClientLanguagesResponse: LanguageResult & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: LanguageResult } }

Contains response data for the languages operation.

GeneratedClientSentimentResponse

GeneratedClientSentimentResponse: SentimentResponse & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: SentimentResponse } }

Contains response data for the sentiment operation.

HealthPollerLike

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

HealthcareEntity

HealthcareEntity: Entity & { isNegated: boolean; links?: HealthcareEntityLink[] }

HealthcareErrorResult

HealthcareErrorResult: TextAnalyticsErrorResult

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

HealthcareJobState

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

InnerErrorCodeValue

InnerErrorCodeValue: "InvalidParameterValue" | "InvalidRequestBodyFormat" | "EmptyRequest" | "MissingInputRecords" | "InvalidDocument" | "ModelVersionIncorrect" | "InvalidDocumentBatch" | "UnsupportedLanguageCode" | "InvalidCountryHint" | string

Defines values for InnerErrorCodeValue.

OperationTracingOptions

OperationTracingOptions: OperationOptions["tracingOptions"]

PagedAsyncIterableAnalyzeResults

PagedAsyncIterableAnalyzeResults: PagedAsyncIterableIterator<AnalyzeResult, AnalyzeResult>

The results of an analyze job represented as a paginated iterator that iterates over the results of the requested tasks.

PagedAsyncIterableHealthEntities

PagedAsyncIterableHealthEntities: PagedAsyncIterableIterator<HealthcareResult, HealthcareEntitiesArray>

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

PiiTaskParametersDomain

PiiTaskParametersDomain: "phi" | "none" | string

Defines values for PiiTaskParametersDomain.

RecognizeCategorizedEntitiesErrorResult

RecognizeCategorizedEntitiesErrorResult: TextAnalyticsErrorResult

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

RecognizeCategorizedEntitiesOptions

RecognizeCategorizedEntitiesOptions: TextAnalyticsOperationOptions

Options for the recognize entities operation.

RecognizeCategorizedEntitiesResult

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

RecognizeLinkedEntitiesErrorResult

RecognizeLinkedEntitiesErrorResult: TextAnalyticsErrorResult

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

RecognizeLinkedEntitiesOptions

RecognizeLinkedEntitiesOptions: TextAnalyticsOperationOptions

Options for the recognize linked entities operation.

RecognizeLinkedEntitiesResult

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

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.

SentenceSentimentLabel

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

Defines values for SentenceSentimentLabel.

State

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

Defines values for State.

StringIndexType

StringIndexType: "TextElements_v8" | "UnicodeCodePoint" | "Utf16CodeUnit" | string

Defines values for StringIndexType.

StringIndexTypeResponse

StringIndexTypeResponse: "TextElements_v8" | "UnicodeCodePoint" | "Utf16CodeUnit"

Defines values for StringIndexTypeResponse.

TasksStateTasksDetails

TasksStateTasksDetails: TaskState & {}

TasksStateTasksEntityRecognitionPiiTasksItem

TasksStateTasksEntityRecognitionTasksItem

TasksStateTasksKeyPhraseExtractionTasksItem

TextAnalyticsResult

The result of a text analytics operation on a single input document.

TokenSentimentValue

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

Defines values for TokenSentimentValue.

WarningCode

WarningCode: "LongWordsInDocument" | "DocumentTruncated" | string

Defines values for WarningCode.

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 SDK_VERSION

SDK_VERSION: string = "5.1.0-beta.3"

Const jsEncodingUnit

jsEncodingUnit: "Utf16CodeUnit" = "Utf16CodeUnit"

Const logger

logger: any = createClientLogger("ai-text-analytics")

The @azure/logger configuration for this package.

Const packageName

packageName: "@azure/ai-text-analytics" = "@azure/ai-text-analytics"

Const packageVersion

packageVersion: "5.1.0-beta.3" = "5.1.0-beta.3"

Const serializer

serializer: any = new coreHttp.Serializer(Mappers, /* isXml */ false)

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

AddParamsToTask

  • AddParamsToTask<X>(task: X): { parameters?: X }

addEncodingParamToAnalyzeInput

  • addEncodingParamToAnalyzeInput(tasks: JobManifestTasks): GeneratedJobManifestTasks

addEncodingParamToTask

addStrEncodingParam

  • addStrEncodingParam<T>(options: T): T & { stringIndexType: StringIndexType }

combineSuccessfulAndErroneousDocuments

combineSuccessfulAndErroneousDocumentsWithStatisticsAndModelVersion

convertAspectRelationToOpinionSentiment

convertGeneratedSentenceSentiment

  • convertGeneratedSentenceSentiment(sentence: GeneratedSentenceSentiment, document: DocumentSentiment): SentenceSentiment

convertToDetectLanguageInput

convertToTextDocumentInput

  • convertToTextDocumentInput(inputs: string[], language: string): TextDocumentInput[]

createTextAnalyticsAzureKeyCredentialPolicy

  • createTextAnalyticsAzureKeyCredentialPolicy(credential: KeyCredential): RequestPolicyFactory

findOpinionIndex

getJobID

  • getJobID(operationLocation: string): string

handleInvalidDocumentBatch

  • handleInvalidDocumentBatch(error: any): any

intoTextAnalyticsError

  • intoTextAnalyticsError(errorModel: GeneratedTextAnalyticsErrorModel | InnerError): TextAnalyticsError

isStringArray

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

makeAnalyzeSentimentErrorResult

makeAnalyzeSentimentResult

makeAnalyzeSentimentResultArray

makeDetectLanguageErrorResult

makeDetectLanguageResult

makeDetectLanguageResultArray

makeExtractKeyPhrasesErrorResult

makeExtractKeyPhrasesResult

makeExtractKeyPhrasesResultArray

makeRecognizeCategorizedEntitiesErrorResult

makeRecognizeCategorizedEntitiesResult

makeRecognizeCategorizedEntitiesResultArray

makeRecognizeLinkedEntitiesErrorResult

makeRecognizeLinkedEntitiesResult

makeRecognizeLinkedEntitiesResultArray

makeRecognizePiiEntitiesErrorResult

makeRecognizePiiEntitiesResult

makeRecognizePiiEntitiesResultArray

makeTextAnalyticsErrorResult

makeTextAnalyticsSuccessResult

nextLinkToTopAndSkip

  • nextLinkToTopAndSkip(nextLink: string): PageParam

processAndCombineSuccessfulAndErroneousDocuments

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 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 AspectConfidenceScoreLabel

AspectConfidenceScoreLabel: object

type

type: object

className

className: string = "AspectConfidenceScoreLabel"

name

name: string = "Composite"

modelProperties

modelProperties: object

negative

negative: object

required

required: boolean = true

serializedName

serializedName: string = "negative"

type

type: object

name

name: string = "Number"

positive

positive: object

required

required: boolean = true

serializedName

serializedName: string = "positive"

type

type: object

name

name: string = "Number"

Const AspectRelation

AspectRelation: object

type

type: object

className

className: string = "AspectRelation"

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"

relationType

relationType: object

required

required: boolean = true

serializedName

serializedName: string = "relationType"

type

type: object

allowedValues

allowedValues: string[] = ["opinion", "aspect"]

name

name: string = "Enum"

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

modelVersion

modelVersion: object

defaultValue

defaultValue: string = "latest"

serializedName

serializedName: string = "model-version"

type

type: object

name

name: string = "String"

stringIndexType

stringIndexType: object

defaultValue

defaultValue: string = "TextElements_v8"

serializedName

serializedName: string = "stringIndexType"

type

type: object

allowedValues

allowedValues: string[] = ["TextElements_v8","UnicodeCodePoint","Utf16CodeUnit"]

name

name: string = "Enum"

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"

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 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 HealthcareEntity

HealthcareEntity: object

type

type: object

className

className: string = "HealthcareEntity"

name

name: string = "Composite"

modelProperties

modelProperties: object

isNegated

isNegated: object

required

required: boolean = true

serializedName

serializedName: string = "isNegated"

type

type: object

name

name: string = "Boolean"

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"

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

bidirectional

bidirectional: object

required

required: boolean = true

serializedName

serializedName: string = "bidirectional"

type

type: object

name

name: string = "Boolean"

relationType

relationType: object

required

required: boolean = true

serializedName

serializedName: string = "relationType"

type

type: object

name

name: string = "String"

source

source: object

required

required: boolean = true

serializedName

serializedName: string = "source"

type

type: object

name

name: string = "String"

target

target: object

required

required: boolean = true

serializedName

serializedName: string = "target"

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

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"

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"

displayName

displayName: object

serializedName

serializedName: string = "displayName"

type

type: object

name

name: string = "String"

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","partiallySucceeded"]

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

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"

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

className

className: string = "PiiTaskParameters"

name

name: string = "Composite"

Const PiiTaskParameters

PiiTaskParameters: object

type

type: object

className

className: string = "PiiTaskParameters"

name

name: string = "Composite"

modelProperties

modelProperties: object

domain

domain: object

defaultValue

defaultValue: string = "none"

serializedName

serializedName: string = "domain"

type

type: object

name

name: string = "String"

modelVersion

modelVersion: object

defaultValue

defaultValue: string = "latest"

serializedName

serializedName: string = "model-version"

type

type: object

name

name: string = "String"

stringIndexType

stringIndexType: object

defaultValue

defaultValue: string = "TextElements_v8"

serializedName

serializedName: string = "stringIndexType"

type

type: object

allowedValues

allowedValues: string[] = ["TextElements_v8","UnicodeCodePoint","Utf16CodeUnit"]

name

name: string = "Enum"

Const SentenceAspect

SentenceAspect: object

type

type: object

className

className: string = "SentenceAspect"

name

name: string = "Composite"

modelProperties

modelProperties: object

confidenceScores

confidenceScores: object

serializedName

serializedName: string = "confidenceScores"

type

type: object

className

className: string = "AspectConfidenceScoreLabel"

name

name: string = "Composite"

offset

offset: object

required

required: boolean = true

serializedName

serializedName: string = "offset"

type

type: object

name

name: string = "Number"

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 = "AspectRelation"

name

name: string = "Composite"

sentiment

sentiment: object

required

required: boolean = true

serializedName

serializedName: string = "sentiment"

type

type: object

allowedValues

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

name

name: string = "Enum"

text

text: object

required

required: boolean = true

serializedName

serializedName: string = "text"

type

type: object

name

name: string = "String"

Const SentenceOpinion

SentenceOpinion: object

type

type: object

className

className: string = "SentenceOpinion"

name

name: string = "Composite"

modelProperties

modelProperties: object

confidenceScores

confidenceScores: object

serializedName

serializedName: string = "confidenceScores"

type

type: object

className

className: string = "AspectConfidenceScoreLabel"

name

name: string = "Composite"

isNegated

isNegated: object

required

required: boolean = true

serializedName

serializedName: string = "isNegated"

type

type: object

name

name: string = "Boolean"

offset

offset: object

required

required: boolean = true

serializedName

serializedName: string = "offset"

type

type: object

name

name: string = "Number"

sentiment

sentiment: object

required

required: boolean = true

serializedName

serializedName: string = "sentiment"

type

type: object

allowedValues

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

name

name: string = "Enum"

text

text: object

required

required: boolean = true

serializedName

serializedName: string = "text"

type

type: object

name

name: string = "String"

Const SentenceSentiment

SentenceSentiment: object

type

type: object

className

className: string = "SentenceSentiment"

name

name: string = "Composite"

modelProperties

modelProperties: object

aspects

aspects: object

serializedName

serializedName: string = "aspects"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "SentenceAspect"

name

name: string = "Composite"

confidenceScores

confidenceScores: object

serializedName

serializedName: string = "confidenceScores"

type

type: object

className

className: string = "SentimentConfidenceScores"

name

name: string = "Composite"

offset

offset: object

required

required: boolean = true

serializedName

serializedName: string = "offset"

type

type: object

name

name: string = "Number"

opinions

opinions: object

serializedName

serializedName: string = "opinions"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "SentenceOpinion"

name

name: string = "Composite"

sentiment

sentiment: object

required

required: boolean = true

serializedName

serializedName: string = "sentiment"

type

type: object

allowedValues

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

name

name: string = "Enum"

text

text: object

required

required: boolean = true

serializedName

serializedName: string = "text"

type

type: object

name

name: string = "String"

Const SentimentConfidenceScores

SentimentConfidenceScores: object

type

type: object

className

className: string = "SentimentConfidenceScores"

name

name: string = "Composite"

modelProperties

modelProperties: object

negative

negative: object

required

required: boolean = true

serializedName

serializedName: string = "negative"

type

type: object

name

name: string = "Number"

neutral

neutral: object

required

required: boolean = true

serializedName

serializedName: string = "neutral"

type

type: object

name

name: string = "Number"

positive

positive: object

required

required: boolean = true

serializedName

serializedName: string = "positive"

type

type: object

name

name: string = "Number"

Const SentimentResponse

SentimentResponse: object

type

type: object

className

className: string = "SentimentResponse"

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 = "DocumentSentiment"

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 TaskState

TaskState: object

type

type: object

className

className: string = "TaskState"

name

name: string = "Composite"

modelProperties

modelProperties: object

lastUpdateDateTime

lastUpdateDateTime: object

required

required: boolean = true

serializedName

serializedName: string = "lastUpdateDateTime"

type

type: object

name

name: string = "DateTime"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

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","partiallySucceeded"]

name

name: string = "Enum"

Const TasksState

TasksState: object

type

type: object

className

className: string = "TasksState"

name

name: string = "Composite"

modelProperties

modelProperties: object

tasks

tasks: object

serializedName

serializedName: string = "tasks"

type

type: object

className

className: string = "TasksStateTasks"

name

name: string = "Composite"

Const TasksStateTasks

TasksStateTasks: object

type

type: object

className

className: string = "TasksStateTasks"

name

name: string = "Composite"

modelProperties

modelProperties: object

completed

completed: object

required

required: boolean = true

serializedName

serializedName: string = "completed"

type

type: object

name

name: string = "Number"

details

details: object

serializedName

serializedName: string = "details"

type

type: object

className

className: string = "TaskState"

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 = "TasksStateTasksEntityRecognitionPiiTasksItem"

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 = "TasksStateTasksEntityRecognitionTasksItem"

name

name: string = "Composite"

failed

failed: object

required

required: boolean = true

serializedName

serializedName: string = "failed"

type

type: object

name

name: string = "Number"

inProgress

inProgress: object

required

required: boolean = true

serializedName

serializedName: string = "inProgress"

type

type: object

name

name: string = "Number"

keyPhraseExtractionTasks

keyPhraseExtractionTasks: object

serializedName

serializedName: string = "keyPhraseExtractionTasks"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "TasksStateTasksKeyPhraseExtractionTasksItem"

name

name: string = "Composite"

total

total: object

required

required: boolean = true

serializedName

serializedName: string = "total"

type

type: object

name

name: string = "Number"

Const TasksStateTasksDetails

TasksStateTasksDetails: object

type

type: object

className

className: string = "TasksStateTasksDetails"

name

name: string = "Composite"

modelProperties

modelProperties: object

Const TasksStateTasksEntityRecognitionPiiTasksItem

TasksStateTasksEntityRecognitionPiiTasksItem: object

type

type: object

className

className: string = "TasksStateTasksEntityRecognitionPiiTasksItem"

name

name: string = "Composite"

modelProperties

modelProperties: object

Const TasksStateTasksEntityRecognitionTasksItem

TasksStateTasksEntityRecognitionTasksItem: object

type

type: object

className

className: string = "TasksStateTasksEntityRecognitionTasksItem"

name

name: string = "Composite"

modelProperties

modelProperties: object

Const TasksStateTasksKeyPhraseExtractionTasksItem

TasksStateTasksKeyPhraseExtractionTasksItem: object

type

type: object

className

className: string = "TasksStateTasksKeyPhraseExtractionTasksItem"

name

name: string = "Composite"

modelProperties

modelProperties: object

Const TextAnalyticsError

TextAnalyticsError: object

type

type: object

className

className: string = "TextAnalyticsError"

name

name: string = "Composite"

modelProperties

modelProperties: object

code

code: object

required

required: boolean = true

serializedName

serializedName: string = "code"

type

type: object

allowedValues

allowedValues: string[] = ["InvalidRequest","InvalidArgument","InternalServerError","ServiceUnavailable","NotFound"]

name

name: string = "Enum"

details

details: object

serializedName

serializedName: string = "details"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "TextAnalyticsError"

name

name: string = "Composite"

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 TextAnalyticsWarning

TextAnalyticsWarning: object

type

type: object

className

className: string = "TextAnalyticsWarning"

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"

message

message: object

required

required: boolean = true

serializedName

serializedName: string = "message"

type

type: object

name

name: string = "String"

Const TextDocumentBatchStatistics

TextDocumentBatchStatistics: object

type

type: object

className

className: string = "TextDocumentBatchStatistics"

name

name: string = "Composite"

modelProperties

modelProperties: object

documentCount

documentCount: object

required

required: boolean = true

serializedName

serializedName: string = "documentsCount"

type

type: object

name

name: string = "Number"

erroneousDocumentCount

erroneousDocumentCount: object

required

required: boolean = true

serializedName

serializedName: string = "erroneousDocumentsCount"

type

type: object

name

name: string = "Number"

transactionCount

transactionCount: object

required

required: boolean = true

serializedName

serializedName: string = "transactionsCount"

type

type: object

name

name: string = "Number"

validDocumentCount

validDocumentCount: object

required

required: boolean = true

serializedName

serializedName: string = "validDocumentsCount"

type

type: object

name

name: string = "Number"

Const TextDocumentInput

TextDocumentInput: object

type

type: object

className

className: string = "TextDocumentInput"

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"

language

language: object

serializedName

serializedName: string = "language"

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 TextDocumentStatistics

TextDocumentStatistics: object

type

type: object

className

className: string = "TextDocumentStatistics"

name

name: string = "Composite"

modelProperties

modelProperties: object

characterCount

characterCount: object

required

required: boolean = true

serializedName

serializedName: string = "charactersCount"

type

type: object

name

name: string = "Number"

transactionCount

transactionCount: object

required

required: boolean = true

serializedName

serializedName: string = "transactionsCount"

type

type: object

name

name: string = "Number"

Const accept

accept: object

parameterPath

parameterPath: string = "accept"

mapper

mapper: object

defaultValue

defaultValue: string = "application/json, text/json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Accept"

type

type: object

name

name: string = "String"

Const accept1

accept1: object

parameterPath

parameterPath: string = "accept"

mapper

mapper: object

defaultValue

defaultValue: string = "application/json, text/json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Accept"

type

type: object

name

name: string = "String"

Const analyzeOperationSpec

analyzeOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.contentType, Parameters.accept]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/analyze"

requestBody

requestBody: any = Parameters.body

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

202

202: object

headersMapper

headersMapper: any = Mappers.GeneratedClientAnalyzeHeaders

400

400: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

isError

isError: boolean = true

500

500: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

isError

isError: boolean = true

Const analyzeStatusOperationSpec

analyzeStatusOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept1]

httpMethod

httpMethod: string = "GET"

path

path: string = "/analyze/jobs/{jobId}"

queryParameters

queryParameters: any[] = [Parameters.includeStatistics,Parameters.top,Parameters.skip]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint, Parameters.jobId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.AnalyzeJobState

404

404: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

isError

isError: boolean = true

500

500: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

isError

isError: boolean = true

Const body

body: object

mapper

mapper: any = AnalyzeBatchInputMapper

parameterPath

parameterPath: string[] = ["options", "body"]

Const cancelHealthJobOperationSpec

cancelHealthJobOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept1]

httpMethod

httpMethod: string = "DELETE"

path

path: string = "/entities/health/jobs/{jobId}"

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint, Parameters.jobId1]

responses

responses: object

202

202: object

headersMapper

headersMapper: any = Mappers.GeneratedClientCancelHealthJobHeaders

404

404: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

isError

isError: boolean = true

500

500: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

isError

isError: boolean = true

Const contentType

contentType: object

parameterPath

parameterPath: string[] = ["options", "contentType"]

mapper

mapper: object

defaultValue

defaultValue: string = "application/json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Content-Type"

type

type: object

name

name: string = "String"

Const domain

domain: object

parameterPath

parameterPath: string[] = ["options", "domain"]

mapper

mapper: object

serializedName

serializedName: string = "domain"

type

type: object

name

name: string = "String"

Const endpoint

endpoint: object

parameterPath

parameterPath: string = "endpoint"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "Endpoint"

type

type: object

name

name: string = "String"

Const entitiesLinkingOperationSpec

entitiesLinkingOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.contentType, Parameters.accept]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/entities/linking"

queryParameters

queryParameters: any[] = [Parameters.includeStatistics,Parameters.modelVersion,Parameters.stringIndexType]

requestBody

requestBody: any = Parameters.input

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.EntityLinkingResult

400

400: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

isError

isError: boolean = true

500

500: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

isError

isError: boolean = true

Const entitiesRecognitionGeneralOperationSpec

entitiesRecognitionGeneralOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.contentType, Parameters.accept]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/entities/recognition/general"

queryParameters

queryParameters: any[] = [Parameters.includeStatistics,Parameters.modelVersion,Parameters.stringIndexType]

requestBody

requestBody: any = Parameters.input

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.EntitiesResult

400

400: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

isError

isError: boolean = true

500

500: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

isError

isError: boolean = true

Const entitiesRecognitionPiiOperationSpec

entitiesRecognitionPiiOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.contentType, Parameters.accept]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/entities/recognition/pii"

queryParameters

queryParameters: any[] = [Parameters.includeStatistics,Parameters.modelVersion,Parameters.stringIndexType,Parameters.domain]

requestBody

requestBody: any = Parameters.input

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.PiiResult

400

400: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

isError

isError: boolean = true

500

500: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

isError

isError: boolean = true

Const healthOperationSpec

healthOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.contentType, Parameters.accept]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/entities/health/jobs"

queryParameters

queryParameters: any[] = [Parameters.modelVersion, Parameters.stringIndexType]

requestBody

requestBody: any = Parameters.input

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

202

202: object

headersMapper

headersMapper: any = Mappers.GeneratedClientHealthHeaders

400

400: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

isError

isError: boolean = true

500

500: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

isError

isError: boolean = true

Const healthStatusOperationSpec

healthStatusOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept1]

httpMethod

httpMethod: string = "GET"

path

path: string = "/entities/health/jobs/{jobId}"

queryParameters

queryParameters: any[] = [Parameters.includeStatistics,Parameters.top,Parameters.skip]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint, Parameters.jobId1]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.HealthcareJobState

404

404: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

isError

isError: boolean = true

500

500: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

isError

isError: boolean = true

Const includeStatistics

includeStatistics: object

parameterPath

parameterPath: string[] = ["options", "includeStatistics"]

mapper

mapper: object

serializedName

serializedName: string = "showStats"

type

type: object

name

name: string = "Boolean"

Const input

input: object

mapper

mapper: any = MultiLanguageBatchInputMapper

parameterPath

parameterPath: string = "input"

Const input1

input1: object

mapper

mapper: any = LanguageBatchInputMapper

parameterPath

parameterPath: string = "input"

Const jobId

jobId: object

parameterPath

parameterPath: string = "jobId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "jobId"

type

type: object

name

name: string = "String"

Const jobId1

jobId1: object

parameterPath

parameterPath: string = "jobId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "jobId"

type

type: object

name

name: string = "Uuid"

Const keyPhrasesOperationSpec

keyPhrasesOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.contentType, Parameters.accept]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/keyPhrases"

queryParameters

queryParameters: any[] = [Parameters.includeStatistics, Parameters.modelVersion]

requestBody

requestBody: any = Parameters.input

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.KeyPhraseResult

400

400: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

isError

isError: boolean = true

500

500: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

isError

isError: boolean = true

Const languagesOperationSpec

languagesOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.contentType, Parameters.accept]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/languages"

queryParameters

queryParameters: any[] = [Parameters.includeStatistics, Parameters.modelVersion]

requestBody

requestBody: any = Parameters.input1

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.LanguageResult

400

400: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

isError

isError: boolean = true

500

500: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

isError

isError: boolean = true

Const modelVersion

modelVersion: object

parameterPath

parameterPath: string[] = ["options", "modelVersion"]

mapper

mapper: object

serializedName

serializedName: string = "model-version"

type

type: object

name

name: string = "String"

Const opinionMining

opinionMining: object

parameterPath

parameterPath: string[] = ["options", "opinionMining"]

mapper

mapper: object

serializedName

serializedName: string = "opinionMining"

type

type: object

name

name: string = "Boolean"

Const sentimentOperationSpec

sentimentOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.contentType, Parameters.accept]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/sentiment"

queryParameters

queryParameters: any[] = [Parameters.includeStatistics,Parameters.modelVersion,Parameters.stringIndexType,Parameters.opinionMining]

requestBody

requestBody: any = Parameters.input

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.SentimentResponse

400

400: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

isError

isError: boolean = true

500

500: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

isError

isError: boolean = true

Const skip

skip: object

parameterPath

parameterPath: string[] = ["options", "skip"]

mapper

mapper: object

serializedName

serializedName: string = "$skip"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: string = "Number"

Const stringIndexType

stringIndexType: object

parameterPath

parameterPath: string[] = ["options", "stringIndexType"]

mapper

mapper: object

defaultValue

defaultValue: string = "TextElements_v8"

serializedName

serializedName: string = "stringIndexType"

type

type: object

name

name: string = "String"

Const top

top: object

parameterPath

parameterPath: string[] = ["options", "top"]

mapper

mapper: object

defaultValue

defaultValue: number = 20

serializedName

serializedName: string = "$top"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 50

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: string = "Number"

Generated using TypeDoc