Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/cognitiveservices-textanalytics

Package version

Index

Classes

Interfaces

Type aliases

Object literals

Type aliases

DetectLanguageResponse

DetectLanguageResponse: LanguageBatchResult & object

Contains response data for the detectLanguage operation.

EntitiesResponse

EntitiesResponse: EntitiesBatchResult & object

Contains response data for the entities operation.

KeyPhrasesResponse

KeyPhrasesResponse: KeyPhraseBatchResult & object

Contains response data for the keyPhrases operation.

SentimentResponse

SentimentResponse: object

Contains response data for the sentiment operation.

Type declaration

Object literals

Const DetectedLanguage

DetectedLanguage: object

serializedName

serializedName: string = "DetectedLanguage"

type

type: object

className

className: string = "DetectedLanguage"

name

name: string = "Composite"

modelProperties

modelProperties: object

iso6391Name

iso6391Name: object

serializedName

serializedName: string = "iso6391Name"

type

type: object

name

name: string = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

score

score: object

serializedName

serializedName: string = "score"

type

type: object

name

name: string = "Number"

Const DocumentStatistics

DocumentStatistics: object

serializedName

serializedName: string = "DocumentStatistics"

type

type: object

className

className: string = "DocumentStatistics"

name

name: string = "Composite"

modelProperties

modelProperties: object

charactersCount

charactersCount: object

serializedName

serializedName: string = "charactersCount"

type

type: object

name

name: string = "Number"

transactionsCount

transactionsCount: object

serializedName

serializedName: string = "transactionsCount"

type

type: object

name

name: string = "Number"

Const EntitiesBatchResult

EntitiesBatchResult: object

serializedName

serializedName: string = "EntitiesBatchResult"

type

type: object

className

className: string = "EntitiesBatchResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

documents

documents: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "documents"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "EntitiesBatchResultItem"

name

name: string = "Composite"

errors

errors: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "errors"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ErrorRecord"

name

name: string = "Composite"

statistics

statistics: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "statistics"

type

type: object

className

className: string = "RequestStatistics"

name

name: string = "Composite"

Const EntitiesBatchResultItem

EntitiesBatchResultItem: object

serializedName

serializedName: string = "EntitiesBatchResultItem"

type

type: object

className

className: string = "EntitiesBatchResultItem"

name

name: string = "Composite"

modelProperties

modelProperties: object

entities

entities: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "entities"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "EntityRecord"

name

name: string = "Composite"

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

statistics

statistics: object

serializedName

serializedName: string = "statistics"

type

type: object

className

className: string = "DocumentStatistics"

name

name: string = "Composite"

Const EntityRecord

EntityRecord: object

serializedName

serializedName: string = "EntityRecord"

type

type: object

className

className: string = "EntityRecord"

name

name: string = "Composite"

modelProperties

modelProperties: object

bingId

bingId: object

serializedName

serializedName: string = "bingId"

type

type: object

name

name: string = "String"

matches

matches: object

serializedName

serializedName: string = "matches"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "MatchRecord"

name

name: string = "Composite"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

subType

subType: object

serializedName

serializedName: string = "subType"

type

type: object

name

name: string = "String"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: string = "String"

wikipediaId

wikipediaId: object

serializedName

serializedName: string = "wikipediaId"

type

type: object

name

name: string = "String"

wikipediaLanguage

wikipediaLanguage: object

serializedName

serializedName: string = "wikipediaLanguage"

type

type: object

name

name: string = "String"

wikipediaUrl

wikipediaUrl: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "wikipediaUrl"

type

type: object

name

name: string = "String"

Const ErrorRecord

ErrorRecord: object

serializedName

serializedName: string = "ErrorRecord"

type

type: object

className

className: string = "ErrorRecord"

name

name: string = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: string = "String"

Const ErrorResponse

ErrorResponse: object

serializedName

serializedName: string = "ErrorResponse"

type

type: object

className

className: string = "ErrorResponse"

name

name: string = "Composite"

modelProperties

modelProperties: object

code

code: object

serializedName

serializedName: string = "code"

type

type: object

name

name: string = "String"

innerError

innerError: object

serializedName

serializedName: string = "innerError"

type

type: object

className

className: string = "InternalError"

name

name: string = "Composite"

message

message: object

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 InternalError

InternalError: object

serializedName

serializedName: string = "InternalError"

type

type: object

className

className: string = "InternalError"

name

name: string = "Composite"

modelProperties

modelProperties: object

code

code: object

serializedName

serializedName: string = "code"

type

type: object

name

name: string = "String"

innerError

innerError: object

serializedName

serializedName: string = "innerError"

type

type: object

className

className: string = "InternalError"

name

name: string = "Composite"

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: string = "String"

Const KeyPhraseBatchResult

KeyPhraseBatchResult: object

serializedName

serializedName: string = "KeyPhraseBatchResult"

type

type: object

className

className: string = "KeyPhraseBatchResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

documents

documents: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "documents"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "KeyPhraseBatchResultItem"

name

name: string = "Composite"

errors

errors: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "errors"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ErrorRecord"

name

name: string = "Composite"

statistics

statistics: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "statistics"

type

type: object

className

className: string = "RequestStatistics"

name

name: string = "Composite"

Const KeyPhraseBatchResultItem

KeyPhraseBatchResultItem: object

serializedName

serializedName: string = "KeyPhraseBatchResultItem"

type

type: object

className

className: string = "KeyPhraseBatchResultItem"

name

name: string = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

keyPhrases

keyPhrases: object

readOnly

readOnly: 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 = "DocumentStatistics"

name

name: string = "Composite"

Const LanguageBatchInput

LanguageBatchInput: object

serializedName

serializedName: string = "LanguageBatchInput"

type

type: object

className

className: string = "LanguageBatchInput"

name

name: string = "Composite"

modelProperties

modelProperties: object

documents

documents: object

serializedName

serializedName: string = "documents"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "LanguageInput"

name

name: string = "Composite"

Const LanguageBatchResult

LanguageBatchResult: object

serializedName

serializedName: string = "LanguageBatchResult"

type

type: object

className

className: string = "LanguageBatchResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

documents

documents: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "documents"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "LanguageBatchResultItem"

name

name: string = "Composite"

errors

errors: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "errors"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ErrorRecord"

name

name: string = "Composite"

statistics

statistics: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "statistics"

type

type: object

className

className: string = "RequestStatistics"

name

name: string = "Composite"

Const LanguageBatchResultItem

LanguageBatchResultItem: object

serializedName

serializedName: string = "LanguageBatchResultItem"

type

type: object

className

className: string = "LanguageBatchResultItem"

name

name: string = "Composite"

modelProperties

modelProperties: object

detectedLanguages

detectedLanguages: object

serializedName

serializedName: string = "detectedLanguages"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "DetectedLanguage"

name

name: string = "Composite"

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

statistics

statistics: object

serializedName

serializedName: string = "statistics"

type

type: object

className

className: string = "DocumentStatistics"

name

name: string = "Composite"

Const LanguageInput

LanguageInput: object

serializedName

serializedName: string = "LanguageInput"

type

type: object

className

className: string = "LanguageInput"

name

name: string = "Composite"

modelProperties

modelProperties: object

countryHint

countryHint: object

serializedName

serializedName: string = "countryHint"

type

type: object

name

name: string = "String"

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

text

text: object

serializedName

serializedName: string = "text"

type

type: object

name

name: string = "String"

Const MatchRecord

MatchRecord: object

serializedName

serializedName: string = "MatchRecord"

type

type: object

className

className: string = "MatchRecord"

name

name: string = "Composite"

modelProperties

modelProperties: object

entityTypeScore

entityTypeScore: object

serializedName

serializedName: string = "entityTypeScore"

type

type: object

name

name: string = "Number"

length

length: object

serializedName

serializedName: string = "length"

type

type: object

name

name: string = "Number"

offset

offset: object

serializedName

serializedName: string = "offset"

type

type: object

name

name: string = "Number"

text

text: object

serializedName

serializedName: string = "text"

type

type: object

name

name: string = "String"

wikipediaScore

wikipediaScore: object

serializedName

serializedName: string = "wikipediaScore"

type

type: object

name

name: string = "Number"

Const MultiLanguageBatchInput

MultiLanguageBatchInput: object

serializedName

serializedName: string = "MultiLanguageBatchInput"

type

type: object

className

className: string = "MultiLanguageBatchInput"

name

name: string = "Composite"

modelProperties

modelProperties: object

documents

documents: object

serializedName

serializedName: string = "documents"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "MultiLanguageInput"

name

name: string = "Composite"

Const MultiLanguageInput

MultiLanguageInput: object

serializedName

serializedName: string = "MultiLanguageInput"

type

type: object

className

className: string = "MultiLanguageInput"

name

name: string = "Composite"

modelProperties

modelProperties: object

id

id: object

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

serializedName

serializedName: string = "text"

type

type: object

name

name: string = "String"

Const RequestStatistics

RequestStatistics: object

serializedName

serializedName: string = "RequestStatistics"

type

type: object

className

className: string = "RequestStatistics"

name

name: string = "Composite"

modelProperties

modelProperties: object

documentsCount

documentsCount: object

serializedName

serializedName: string = "documentsCount"

type

type: object

name

name: string = "Number"

erroneousDocumentsCount

erroneousDocumentsCount: object

serializedName

serializedName: string = "erroneousDocumentsCount"

type

type: object

name

name: string = "Number"

transactionsCount

transactionsCount: object

serializedName

serializedName: string = "transactionsCount"

type

type: object

name

name: string = "Number"

validDocumentsCount

validDocumentsCount: object

serializedName

serializedName: string = "validDocumentsCount"

type

type: object

name

name: string = "Number"

Const SentimentBatchResult

SentimentBatchResult: object

serializedName

serializedName: string = "SentimentBatchResult"

type

type: object

className

className: string = "SentimentBatchResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

documents

documents: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "documents"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "SentimentBatchResultItem"

name

name: string = "Composite"

errors

errors: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "errors"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ErrorRecord"

name

name: string = "Composite"

statistics

statistics: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "statistics"

type

type: object

className

className: string = "RequestStatistics"

name

name: string = "Composite"

Const SentimentBatchResultItem

SentimentBatchResultItem: object

serializedName

serializedName: string = "SentimentBatchResultItem"

type

type: object

className

className: string = "SentimentBatchResultItem"

name

name: string = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

score

score: object

serializedName

serializedName: string = "score"

type

type: object

name

name: string = "Number"

statistics

statistics: object

serializedName

serializedName: string = "statistics"

type

type: object

className

className: string = "DocumentStatistics"

name

name: string = "Composite"

Const endpoint

endpoint: object

parameterPath

parameterPath: string = "endpoint"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

defaultValue

defaultValue: string = ""

required

required: boolean = true

serializedName

serializedName: string = "Endpoint"

type

type: object

name

name: string = "String"

Const showStats

showStats: object

parameterPath

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

mapper

mapper: object

serializedName

serializedName: string = "showStats"

type

type: object

name

name: string = "Boolean"

Generated using TypeDoc