Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/ai-text-analytics - v1.0.0-preview.1

Package version

Index

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

AnalyzeSentimentResult

AnalyzeSentimentResult: AnalyzeSentimentSuccessResult | AnalyzeSentimentErrorResult

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

DetectLanguageResult

DetectLanguageResult: DetectLanguageSuccessResult | DetectLanguageErrorResult

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

DocumentSentimentValue

DocumentSentimentValue: "positive" | "neutral" | "negative" | "mixed"

Defines values for DocumentSentimentValue. Possible values include: 'positive', 'neutral', 'negative', 'mixed'

readonly
enum

{string}

EntitiesLinkingResponse

EntitiesLinkingResponse: EntityLinkingResult & object

Contains response data for the entitiesLinking operation.

EntitiesRecognitionGeneralResponse

EntitiesRecognitionGeneralResponse: EntitiesResult & object

Contains response data for the entitiesRecognitionGeneral operation.

EntitiesRecognitionPiiResponse

EntitiesRecognitionPiiResponse: EntitiesResult & object

Contains response data for the entitiesRecognitionPii operation.

ErrorCodeValue

ErrorCodeValue: "invalidRequest" | "invalidArgument" | "internalServerError" | "serviceUnavailable"

Defines values for ErrorCodeValue. Possible values include: 'invalidRequest', 'invalidArgument', 'internalServerError', 'serviceUnavailable'

readonly
enum

{string}

ExtractKeyPhrasesResult

ExtractKeyPhrasesResult: ExtractKeyPhrasesSuccessResult | ExtractKeyPhrasesErrorResult

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

InnerErrorCodeValue

InnerErrorCodeValue: "invalidParameterValue" | "invalidRequestBodyFormat" | "emptyRequest" | "missingInputRecords" | "invalidDocument" | "modelVersionIncorrect" | "invalidDocumentBatch" | "unsupportedLanguageCode" | "invalidCountryHint"

Defines values for InnerErrorCodeValue. Possible values include: 'invalidParameterValue', 'invalidRequestBodyFormat', 'emptyRequest', 'missingInputRecords', 'invalidDocument', 'modelVersionIncorrect', 'invalidDocumentBatch', 'unsupportedLanguageCode', 'invalidCountryHint'

readonly
enum

{string}

KeyPhrasesResponse

KeyPhrasesResponse: KeyPhraseResult & object

Contains response data for the keyPhrases operation.

LanguagesResponse

LanguagesResponse: LanguageResult & object

Contains response data for the languages operation.

RecognizeEntitiesResult

RecognizeEntitiesResult: RecognizeEntitiesSuccessResult | RecognizeEntitiesErrorResult

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

RecognizeLinkedEntitiesResult

RecognizeLinkedEntitiesResult: RecognizeLinkedEntitiesSuccessResult | RecognizeLinkedEntitiesErrorResult

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

SentenceSentimentValue

SentenceSentimentValue: "positive" | "neutral" | "negative"

Defines values for SentenceSentimentValue. Possible values include: 'positive', 'neutral', 'negative'

readonly
enum

{string}

SentimentResponse2

SentimentResponse2: SentimentResponse & object

Contains response data for the sentiment operation.

TextAnalyticsResult

TextAnalyticsResult: TextAnalyticsSuccessResult | TextAnalyticsErrorResult

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

Variables

Const SDK_VERSION

SDK_VERSION: string = "1.0.0-preview.1"

Const logger

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

The @azure/logger configuration for this package.

Functions

createSpan

  • createSpan<T>(operationName: string, operationOptions: T): object

  • Creates a span using the global tracer.

    Type parameters

    • T: OperationOptions

    Parameters

    • operationName: string
    • operationOptions: T

    Returns object

makeAnalyzeSentimentErrorResult

makeAnalyzeSentimentResult

makeAnalyzeSentimentResultCollection

makeDetectLanguageErrorResult

makeDetectLanguageResult

makeDetectLanguageResultCollection

makeExtractKeyPhrasesErrorResult

makeExtractKeyPhrasesResult

makeExtractKeyPhrasesResultCollection

makeRecognizeEntitiesErrorResult

makeRecognizeEntitiesResult

makeRecognizeEntitiesResultCollection

makeRecognizeLinkedEntitiesErrorResult

makeRecognizeLinkedEntitiesResult

makeRecognizeLinkedEntitiesResultCollection

makeTextAnalysisErrorResult

makeTextAnalysisResult

sortByPreviousIdOrder

  • sortByPreviousIdOrder<T, U>(sortedArray: T[], unsortedArray: U[]): U[]

  • Given a sorted array of input objects (with a unique ID) and an unsorted array of results, return a sorted array of results.

    Type parameters

    Parameters

    • sortedArray: T[]

      An array of entries sorted by id

    • unsortedArray: U[]

      An array of entries that contain id but are not sorted

    Returns U[]

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

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"

score

score: object

required

required: boolean = true

serializedName

serializedName: string = "score"

type

type: object

name

name: string = "Number"

Const DocumentEntities

DocumentEntities: object

serializedName

serializedName: string = "DocumentEntities"

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"

Const DocumentError

DocumentError: object

serializedName

serializedName: string = "DocumentError"

type

type: object

className

className: string = "DocumentError"

name

name: string = "Composite"

modelProperties

modelProperties: object

error

error: object

required

required: boolean = true

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

serializedName

serializedName: string = "DocumentKeyPhrases"

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"

Const DocumentLanguage

DocumentLanguage: object

serializedName

serializedName: string = "DocumentLanguage"

type

type: object

className

className: string = "DocumentLanguage"

name

name: string = "Composite"

modelProperties

modelProperties: object

detectedLanguages

detectedLanguages: object

required

required: boolean = true

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

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"

Const DocumentLinkedEntities

DocumentLinkedEntities: object

serializedName

serializedName: string = "DocumentLinkedEntities"

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"

Const DocumentSentiment

DocumentSentiment: object

serializedName

serializedName: string = "DocumentSentiment"

type

type: object

className

className: string = "DocumentSentiment"

name

name: string = "Composite"

modelProperties

modelProperties: object

documentScores

documentScores: object

required

required: boolean = true

serializedName

serializedName: string = "documentScores"

type

type: object

className

className: string = "SentimentConfidenceScorePerLabel"

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"

Const EntitiesResult

EntitiesResult: object

serializedName

serializedName: string = "EntitiesResult"

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

serializedName

serializedName: string = "Entity"

type

type: object

className

className: string = "Entity"

name

name: string = "Composite"

modelProperties

modelProperties: object

length

length: object

required

required: boolean = true

serializedName

serializedName: string = "length"

type

type: object

name

name: string = "Number"

offset

offset: object

required

required: boolean = true

serializedName

serializedName: string = "offset"

type

type: object

name

name: string = "Number"

score

score: object

required

required: boolean = true

serializedName

serializedName: string = "score"

type

type: object

name

name: string = "Number"

subtype

subtype: object

serializedName

serializedName: string = "subtype"

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"

type

type: object

required

required: boolean = true

serializedName

serializedName: string = "type"

type

type: object

name

name: string = "String"

Const EntityLinkingResult

EntityLinkingResult: object

serializedName

serializedName: string = "EntityLinkingResult"

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 InnerError

InnerError: object

serializedName

serializedName: string = "InnerError"

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

allowedValues

allowedValues: Object = ["invalidParameterValue","invalidRequestBodyFormat","emptyRequest","missingInputRecords","invalidDocument","modelVersionIncorrect","invalidDocumentBatch","unsupportedLanguageCode","invalidCountryHint"]

name

name: string = "Enum"

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

serializedName

serializedName: string = "KeyPhraseResult"

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

serializedName

serializedName: string = "LanguageBatchInput"

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

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

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 LanguageResult

LanguageResult: object

serializedName

serializedName: string = "LanguageResult"

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

serializedName

serializedName: string = "LinkedEntity"

type

type: object

className

className: string = "LinkedEntity"

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

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

serializedName

serializedName: string = "Match"

type

type: object

className

className: string = "Match"

name

name: string = "Composite"

modelProperties

modelProperties: object

length

length: object

required

required: boolean = true

serializedName

serializedName: string = "length"

type

type: object

name

name: string = "Number"

offset

offset: object

required

required: boolean = true

serializedName

serializedName: string = "offset"

type

type: object

name

name: string = "Number"

score

score: object

required

required: boolean = true

serializedName

serializedName: string = "score"

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

serializedName

serializedName: string = "MultiLanguageBatchInput"

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

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 SentenceSentiment

SentenceSentiment: object

serializedName

serializedName: string = "SentenceSentiment"

type

type: object

className

className: string = "SentenceSentiment"

name

name: string = "Composite"

modelProperties

modelProperties: object

length

length: object

required

required: boolean = true

serializedName

serializedName: string = "length"

type

type: object

name

name: string = "Number"

offset

offset: object

required

required: boolean = true

serializedName

serializedName: string = "offset"

type

type: object

name

name: string = "Number"

sentenceScores

sentenceScores: object

required

required: boolean = true

serializedName

serializedName: string = "sentenceScores"

type

type: object

className

className: string = "SentimentConfidenceScorePerLabel"

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"

warnings

warnings: object

serializedName

serializedName: string = "warnings"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const SentimentConfidenceScorePerLabel

SentimentConfidenceScorePerLabel: object

serializedName

serializedName: string = "SentimentConfidenceScorePerLabel"

type

type: object

className

className: string = "SentimentConfidenceScorePerLabel"

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

serializedName

serializedName: string = "SentimentResponse"

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

serializedName

serializedName: string = "TextAnalyticsError"

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: Object = ["invalidRequest","invalidArgument","internalServerError","serviceUnavailable"]

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 TextDocumentBatchStatistics

TextDocumentBatchStatistics: object

serializedName

serializedName: string = "TextDocumentBatchStatistics"

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 TextDocumentStatistics

TextDocumentStatistics: object

serializedName

serializedName: string = "TextDocumentStatistics"

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

includeStatistics: object

parameterPath

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

mapper

mapper: object

serializedName

serializedName: string = "showStats"

type

type: object

name

name: string = "Boolean"

Const modelVersion

modelVersion: object

parameterPath

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

mapper

mapper: object

serializedName

serializedName: string = "model-version"

type

type: object

name

name: string = "String"

Generated using TypeDoc