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

AnalyzeSentimentErrorResult

AnalyzeSentimentErrorResult: TextAnalyticsErrorResult

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

AnalyzeSentimentResult

AnalyzeSentimentResult: AnalyzeSentimentSuccessResult | AnalyzeSentimentErrorResult

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

AspectRelationType

AspectRelationType: "opinion" | "aspect"

Defines values for AspectRelationType.

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

DetectLanguageResult: DetectLanguageSuccessResult | DetectLanguageErrorResult

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

DocumentSentimentLabel

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

Defines values for DocumentSentimentLabel.

ErrorCode

ErrorCode: ErrorCodeValue | InnerErrorCodeValue

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"

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

ExtractKeyPhrasesResult: ExtractKeyPhrasesSuccessResult | ExtractKeyPhrasesErrorResult

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

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: PiiEntitiesResult & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: PiiEntitiesResult } }

Contains response data for the entitiesRecognitionPii 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.

InnerErrorCodeValue

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

Defines values for InnerErrorCodeValue.

OperationTracingOptions

OperationTracingOptions: OperationOptions["tracingOptions"]

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

RecognizeCategorizedEntitiesResult: RecognizeCategorizedEntitiesSuccessResult | RecognizeCategorizedEntitiesErrorResult

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

RecognizeLinkedEntitiesResult: RecognizeLinkedEntitiesSuccessResult | RecognizeLinkedEntitiesErrorResult

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

RecognizePiiEntitiesResult: RecognizePiiEntitiesSuccessResult | RecognizePiiEntitiesErrorResult

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

SentenceSentimentLabel

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

Defines values for SentenceSentimentLabel.

StringIndexType

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

Defines values for StringIndexType.

TextAnalyticsResult

TextAnalyticsResult: TextAnalyticsSuccessResult | TextAnalyticsErrorResult

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"

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

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.2" = "5.1.0-beta.2"

Const serializer

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

Functions

addStrEncodingParam

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

convertAspectRelationToOpinionSentiment

convertGeneratedSentenceSentiment

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

  • Converts a sentence sentiment object returned by the service to another that is user-friendly.

    Parameters

    • sentence: GeneratedSentenceSentiment

      The sentence sentiment object to be converted.

    • document: DocumentSentiment

    Returns SentenceSentiment

    The user-friendly sentence sentiment object.

convertToDetectLanguageInput

convertToTextDocumentInput

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

createTextAnalyticsAzureKeyCredentialPolicy

  • createTextAnalyticsAzureKeyCredentialPolicy(credential: KeyCredential): RequestPolicyFactory

  • Create an HTTP pipeline policy to authenticate a request using an AzureKeyCredential for Text Analytics

    Parameters

    • credential: KeyCredential

    Returns RequestPolicyFactory

findOpinionIndex

intoTextAnalyticsError

  • intoTextAnalyticsError(errorModel: GeneratedTextAnalyticsErrorModel | InnerError): TextAnalyticsError

  • Helper function for converting nested service error into the unified TextAnalyticsError

    Parameters

    • errorModel: GeneratedTextAnalyticsErrorModel | InnerError

    Returns 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

Object literals

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: Object = ["opinion", "aspect"]

name

name: string = "Enum"

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 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: Object = ["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 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 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 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 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 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 PiiEntitiesResult

PiiEntitiesResult: object

type

type: object

className

className: string = "PiiEntitiesResult"

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 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: Object = ["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: Object = ["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: Object = ["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 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

name

name: string = "String"

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 contentType

contentType: object

parameterPath

parameterPath: Object = ["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: Object = ["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: Object = [Parameters.contentType]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/entities/linking"

queryParameters

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

requestBody

requestBody: any = Parameters.input

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.endpoint]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.EntityLinkingResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const entitiesRecognitionGeneralOperationSpec

entitiesRecognitionGeneralOperationSpec: object

headerParameters

headerParameters: Object = [Parameters.contentType]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

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

queryParameters

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

requestBody

requestBody: any = Parameters.input

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.endpoint]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.EntitiesResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const entitiesRecognitionPiiOperationSpec

entitiesRecognitionPiiOperationSpec: object

headerParameters

headerParameters: Object = [Parameters.contentType]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

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

queryParameters

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

requestBody

requestBody: any = Parameters.input

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.endpoint]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.PiiEntitiesResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const includeStatistics

includeStatistics: object

parameterPath

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

mapper

mapper: object

serializedName

serializedName: string = "includeStatistics"

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 keyPhrasesOperationSpec

keyPhrasesOperationSpec: object

headerParameters

headerParameters: Object = [Parameters.contentType]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/keyPhrases"

queryParameters

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

requestBody

requestBody: any = Parameters.input

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.endpoint]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.KeyPhraseResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const languagesOperationSpec

languagesOperationSpec: object

headerParameters

headerParameters: Object = [Parameters.contentType]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/languages"

queryParameters

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

requestBody

requestBody: any = Parameters.input1

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.endpoint]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.LanguageResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const modelVersion

modelVersion: object

parameterPath

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

mapper

mapper: object

serializedName

serializedName: string = "model-version"

type

type: object

name

name: string = "String"

Const opinionMining

opinionMining: object

parameterPath

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

mapper

mapper: object

serializedName

serializedName: string = "opinionMining"

type

type: object

name

name: string = "Boolean"

Const sentimentOperationSpec

sentimentOperationSpec: object

headerParameters

headerParameters: Object = [Parameters.contentType]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/sentiment"

queryParameters

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

requestBody

requestBody: any = Parameters.input

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.endpoint]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.SentimentResponse

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const stringIndexType

stringIndexType: object

parameterPath

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

mapper

mapper: object

defaultValue

defaultValue: string = "TextElements_v8"

serializedName

serializedName: string = "stringIndexType"

type

type: object

name

name: string = "String"

Generated using TypeDoc