Variables
Const API_KEY_HEADER_NAME
API_KEY_HEADER_NAME: "Ocp-Apim-Subscription-Key" = "Ocp-Apim-Subscription-Key"
Const AnalyzeActionNames
AnalyzeActionNames: { EntityLinking: "EntityLinking"; EntityRecognition: "EntityRecognition"; KeyPhraseExtraction: "KeyPhraseExtraction"; LanguageDetection: "LanguageDetection"; PiiEntityRecognition: "PiiEntityRecognition"; SentimentAnalysis: "SentimentAnalysis" } = {EntityLinking: "EntityLinking",EntityRecognition: "EntityRecognition",KeyPhraseExtraction: "KeyPhraseExtraction",PiiEntityRecognition: "PiiEntityRecognition",LanguageDetection: "LanguageDetection",SentimentAnalysis: "SentimentAnalysis",} as const
Type declaration
-
EntityLinking: "EntityLinking"
-
EntityRecognition: "EntityRecognition"
-
KeyPhraseExtraction: "KeyPhraseExtraction"
-
LanguageDetection: "LanguageDetection"
-
PiiEntityRecognition: "PiiEntityRecognition"
-
SentimentAnalysis: "SentimentAnalysis"
Const AnalyzeBatchActionNames
AnalyzeBatchActionNames: { CustomEntityRecognition: "CustomEntityRecognition"; CustomMultiLabelClassification: "CustomMultiLabelClassification"; CustomSingleLabelClassification: "CustomSingleLabelClassification"; EntityLinking: "EntityLinking"; EntityRecognition: "EntityRecognition"; ExtractiveSummarization: "ExtractiveSummarization"; Healthcare: "Healthcare"; KeyPhraseExtraction: "KeyPhraseExtraction"; PiiEntityRecognition: "PiiEntityRecognition"; SentimentAnalysis: "SentimentAnalysis" } = {SentimentAnalysis: "SentimentAnalysis",EntityRecognition: "EntityRecognition",PiiEntityRecognition: "PiiEntityRecognition",KeyPhraseExtraction: "KeyPhraseExtraction",EntityLinking: "EntityLinking",Healthcare: "Healthcare",ExtractiveSummarization: "ExtractiveSummarization",CustomEntityRecognition: "CustomEntityRecognition",CustomSingleLabelClassification: "CustomSingleLabelClassification",CustomMultiLabelClassification: "CustomMultiLabelClassification",} as const
Type declaration
-
CustomEntityRecognition: "CustomEntityRecognition"
-
CustomMultiLabelClassification: "CustomMultiLabelClassification"
-
CustomSingleLabelClassification: "CustomSingleLabelClassification"
-
EntityLinking: "EntityLinking"
-
EntityRecognition: "EntityRecognition"
-
ExtractiveSummarization: "ExtractiveSummarization"
-
Healthcare: "Healthcare"
-
KeyPhraseExtraction: "KeyPhraseExtraction"
-
PiiEntityRecognition: "PiiEntityRecognition"
-
SentimentAnalysis: "SentimentAnalysis"
Const serializer
serializer: any = createSerializer(Mappers, /* isXml */ false)
Const textAnalyticsAzureKeyCredentialPolicyName
textAnalyticsAzureKeyCredentialPolicyName: "textAnalyticsAzureKeyCredentialPolicy" = "textAnalyticsAzureKeyCredentialPolicy"
Object literals
Const ActionCommon
ActionCommon: object
type
type: object
className
className: string = "ActionCommon"
name
name: string = "Composite"
modelProperties
modelProperties: object
disableServiceLogs
disableServiceLogs: object
defaultValue
defaultValue: boolean = false
serializedName
serializedName: string = "loggingOptOut"
type
type: object
name
name: string = "Boolean"
Const ActionCustom
ActionCustom: object
type
type: object
className
className: string = "ActionCustom"
name
name: string = "Composite"
modelProperties
modelProperties: object
deploymentName
deploymentName: object
required
required: boolean = true
serializedName
serializedName: string = "deploymentName"
type
type: object
name
name: string = "String"
projectName
projectName: object
required
required: boolean = true
serializedName
serializedName: string = "projectName"
type
type: object
name
name: string = "String"
Const ActionPrebuilt
ActionPrebuilt: object
type
type: object
className
className: string = "ActionPrebuilt"
name
name: string = "Composite"
modelProperties
modelProperties: object
modelVersion
modelVersion: object
defaultValue
defaultValue: string = "latest"
serializedName
serializedName: string = "modelVersion"
type
type: object
name
name: string = "String"
Const AnalyzeAction
AnalyzeAction: object
type
type: object
className
className: string = "AnalyzeAction"
name
name: string = "Composite"
uberParent
uberParent: string = "AnalyzeAction"
modelProperties
modelProperties: object
kind
kind: object
required
required: boolean = true
serializedName
serializedName: string = "kind"
type
type: object
name
name: string = "String"
polymorphicDiscriminator
polymorphicDiscriminator: object
clientName
clientName: string = "kind"
serializedName
serializedName: string = "kind"
Const AnalyzeBatchAction
AnalyzeBatchAction: object
serializedName
serializedName: string = "AnalyzeBatchAction"
type
type: object
className
className: string = "AnalyzeBatchAction"
name
name: string = "Composite"
uberParent
uberParent: string = "BatchActionState"
modelProperties
modelProperties: object
kind
kind: object
required
required: boolean = true
serializedName
serializedName: string = "kind"
type
type: object
name
name: string = "String"
polymorphicDiscriminator
polymorphicDiscriminator: object
clientName
clientName: string = "kind"
serializedName
serializedName: string = "kind"
Const AnalyzeTextCancelJobHeaders
AnalyzeTextCancelJobHeaders: object
type
type: object
className
className: string = "AnalyzeTextCancelJobHeaders"
name
name: string = "Composite"
modelProperties
modelProperties: object
operationLocation
operationLocation: object
serializedName
serializedName: string = "operation-location"
type
type: object
name
name: string = "String"
Const AnalyzeTextEntityLinkingInput
AnalyzeTextEntityLinkingInput: object
serializedName
serializedName: string = "EntityLinking"
type
type: object
className
className: string = "AnalyzeTextEntityLinkingInput"
name
name: string = "Composite"
polymorphicDiscriminator
polymorphicDiscriminator: any = AnalyzeAction.type.polymorphicDiscriminator
uberParent
uberParent: string = "AnalyzeAction"
modelProperties
modelProperties: object
analysisInput
analysisInput: object
serializedName
serializedName: string = "analysisInput"
type
type: object
className
className: string = "MultiLanguageAnalysisInput"
name
name: string = "Composite"
parameters
parameters: object
serializedName
serializedName: string = "parameters"
type
type: object
className
className: string = "EntityLinkingAction"
name
name: string = "Composite"
Const AnalyzeTextEntityRecognitionInput
AnalyzeTextEntityRecognitionInput: object
serializedName
serializedName: string = "EntityRecognition"
type
type: object
className
className: string = "AnalyzeTextEntityRecognitionInput"
name
name: string = "Composite"
polymorphicDiscriminator
polymorphicDiscriminator: any = AnalyzeAction.type.polymorphicDiscriminator
uberParent
uberParent: string = "AnalyzeAction"
modelProperties
modelProperties: object
analysisInput
analysisInput: object
serializedName
serializedName: string = "analysisInput"
type
type: object
className
className: string = "MultiLanguageAnalysisInput"
name
name: string = "Composite"
parameters
parameters: object
serializedName
serializedName: string = "parameters"
type
type: object
className
className: string = "EntityRecognitionAction"
name
name: string = "Composite"
Const AnalyzeTextJobState
AnalyzeTextJobState: object
type
type: object
className
className: string = "AnalyzeTextJobState"
name
name: string = "Composite"
modelProperties
modelProperties: object
Const AnalyzeTextJobStatistics
AnalyzeTextJobStatistics: object
type
type: object
className
className: string = "AnalyzeTextJobStatistics"
name
name: string = "Composite"
modelProperties
modelProperties: object
statistics
statistics: object
serializedName
serializedName: string = "statistics"
type
type: object
className
className: string = "TextDocumentBatchStatistics"
name
name: string = "Composite"
Const AnalyzeTextJobsInput
AnalyzeTextJobsInput: object
type
type: object
className
className: string = "AnalyzeTextJobsInput"
name
name: string = "Composite"
modelProperties
modelProperties: object
analysisInput
analysisInput: object
serializedName
serializedName: string = "analysisInput"
type
type: object
className
className: string = "MultiLanguageAnalysisInput"
name
name: string = "Composite"
displayName
displayName: object
serializedName
serializedName: string = "displayName"
type
type: object
name
name: string = "String"
tasks
tasks: object
required
required: boolean = true
serializedName
serializedName: string = "tasks"
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
className
className: string = "AnalyzeBatchAction"
name
name: string = "Composite"
Const AnalyzeTextKeyPhraseExtractionInput
AnalyzeTextKeyPhraseExtractionInput: object
serializedName
serializedName: string = "KeyPhraseExtraction"
type
type: object
className
className: string = "AnalyzeTextKeyPhraseExtractionInput"
name
name: string = "Composite"
polymorphicDiscriminator
polymorphicDiscriminator: any = AnalyzeAction.type.polymorphicDiscriminator
uberParent
uberParent: string = "AnalyzeAction"
modelProperties
modelProperties: object
analysisInput
analysisInput: object
serializedName
serializedName: string = "analysisInput"
type
type: object
className
className: string = "MultiLanguageAnalysisInput"
name
name: string = "Composite"
parameters
parameters: object
serializedName
serializedName: string = "parameters"
type
type: object
className
className: string = "KeyPhraseExtractionAction"
name
name: string = "Composite"
Const AnalyzeTextLROResult
AnalyzeTextLROResult: object
serializedName
serializedName: string = "AnalyzeTextLROResult"
type
type: object
className
className: string = "AnalyzeTextLROResult"
name
name: string = "Composite"
uberParent
uberParent: string = "TaskState"
modelProperties
modelProperties: object
kind
kind: object
required
required: boolean = true
serializedName
serializedName: string = "kind"
type
type: object
name
name: string = "String"
polymorphicDiscriminator
polymorphicDiscriminator: object
clientName
clientName: string = "kind"
serializedName
serializedName: string = "kind"
Const AnalyzeTextLanguageDetectionInput
AnalyzeTextLanguageDetectionInput: object
serializedName
serializedName: string = "LanguageDetection"
type
type: object
className
className: string = "AnalyzeTextLanguageDetectionInput"
name
name: string = "Composite"
polymorphicDiscriminator
polymorphicDiscriminator: any = AnalyzeAction.type.polymorphicDiscriminator
uberParent
uberParent: string = "AnalyzeAction"
modelProperties
modelProperties: object
analysisInput
analysisInput: object
serializedName
serializedName: string = "analysisInput"
type
type: object
className
className: string = "LanguageDetectionAnalysisInput"
name
name: string = "Composite"
parameters
parameters: object
serializedName
serializedName: string = "parameters"
type
type: object
className
className: string = "LanguageDetectionAction"
name
name: string = "Composite"
Const AnalyzeTextPiiEntitiesRecognitionInput
AnalyzeTextPiiEntitiesRecognitionInput: object
serializedName
serializedName: string = "PiiEntityRecognition"
type
type: object
className
className: string = "AnalyzeTextPiiEntitiesRecognitionInput"
name
name: string = "Composite"
polymorphicDiscriminator
polymorphicDiscriminator: any = AnalyzeAction.type.polymorphicDiscriminator
uberParent
uberParent: string = "AnalyzeAction"
modelProperties
modelProperties: object
analysisInput
analysisInput: object
serializedName
serializedName: string = "analysisInput"
type
type: object
className
className: string = "MultiLanguageAnalysisInput"
name
name: string = "Composite"
parameters
parameters: object
serializedName
serializedName: string = "parameters"
type
type: object
className
className: string = "PiiEntityRecognitionAction"
name
name: string = "Composite"
Const AnalyzeTextSentimentAnalysisInput
AnalyzeTextSentimentAnalysisInput: object
serializedName
serializedName: string = "SentimentAnalysis"
type
type: object
className
className: string = "AnalyzeTextSentimentAnalysisInput"
name
name: string = "Composite"
polymorphicDiscriminator
polymorphicDiscriminator: any = AnalyzeAction.type.polymorphicDiscriminator
uberParent
uberParent: string = "AnalyzeAction"
modelProperties
modelProperties: object
analysisInput
analysisInput: object
serializedName
serializedName: string = "analysisInput"
type
type: object
className
className: string = "MultiLanguageAnalysisInput"
name
name: string = "Composite"
parameters
parameters: object
serializedName
serializedName: string = "parameters"
type
type: object
className
className: string = "SentimentAnalysisAction"
name
name: string = "Composite"
Const AnalyzeTextSubmitJobHeaders
AnalyzeTextSubmitJobHeaders: object
type
type: object
className
className: string = "AnalyzeTextSubmitJobHeaders"
name
name: string = "Composite"
modelProperties
modelProperties: object
operationLocation
operationLocation: object
serializedName
serializedName: string = "operation-location"
type
type: object
name
name: string = "String"
Const AnalyzeTextTaskResult
AnalyzeTextTaskResult: object
type
type: object
className
className: string = "AnalyzeTextTaskResult"
name
name: string = "Composite"
uberParent
uberParent: string = "AnalyzeTextTaskResult"
modelProperties
modelProperties: object
kind
kind: object
required
required: boolean = true
serializedName
serializedName: string = "kind"
type
type: object
name
name: string = "String"
polymorphicDiscriminator
polymorphicDiscriminator: object
clientName
clientName: string = "kind"
serializedName
serializedName: string = "kind"
Const AssessmentSentiment
AssessmentSentiment: object
type
type: object
className
className: string = "AssessmentSentiment"
name
name: string = "Composite"
modelProperties
modelProperties: object
confidenceScores
confidenceScores: object
serializedName
serializedName: string = "confidenceScores"
type
type: object
className
className: string = "TargetConfidenceScores"
name
name: string = "Composite"
isNegated
isNegated: object
required
required: boolean = true
serializedName
serializedName: string = "isNegated"
type
type: object
name
name: string = "Boolean"
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"
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 BatchActionState
BatchActionState: object
type
type: object
className
className: string = "BatchActionState"
name
name: string = "Composite"
modelProperties
modelProperties: object
actionName
actionName: object
serializedName
serializedName: string = "taskName"
type
type: object
name
name: string = "String"
Const ClassificationCategory
ClassificationCategory: object
type
type: object
className
className: string = "ClassificationCategory"
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"
Const CustomEntitiesLROTask
CustomEntitiesLROTask: object
serializedName
serializedName: string = "CustomEntityRecognition"
type
type: object
className
className: string = "CustomEntitiesLROTask"
name
name: string = "Composite"
polymorphicDiscriminator
polymorphicDiscriminator: any = BatchActionState.type.polymorphicDiscriminator
uberParent
uberParent: string = "BatchActionState"
modelProperties
modelProperties: object
parameters
parameters: object
serializedName
serializedName: string = "parameters"
type
type: object
className
className: string = "CustomEntityRecognitionAction"
name
name: string = "Composite"
Const CustomEntitiesResult
CustomEntitiesResult: object
type
type: object
className
className: string = "CustomEntitiesResult"
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 = "CustomEntitiesResultDocumentsItem"
name
name: string = "Composite"
Const CustomEntitiesResultDocumentsItem
CustomEntitiesResultDocumentsItem: object
type
type: object
className
className: string = "CustomEntitiesResultDocumentsItem"
name
name: string = "Composite"
modelProperties
modelProperties: object
Const CustomEntityRecognitionAction
CustomEntityRecognitionAction: object
type
type: object
className
className: string = "CustomEntityRecognitionAction"
name
name: string = "Composite"
modelProperties
modelProperties: object
stringIndexType
stringIndexType: object
defaultValue
defaultValue: string = "Utf16CodeUnit"
serializedName
serializedName: string = "stringIndexType"
type
type: object
name
name: string = "String"
Const CustomEntityRecognitionLROResult
CustomEntityRecognitionLROResult: object
serializedName
serializedName: string = "CustomEntityRecognitionLROResults"
type
type: object
className
className: string = "CustomEntityRecognitionLROResult"
name
name: string = "Composite"
polymorphicDiscriminator
polymorphicDiscriminator: any = TaskState.type.polymorphicDiscriminator
uberParent
uberParent: string = "TaskState"
modelProperties
modelProperties: object
results
results: object
serializedName
serializedName: string = "results"
type
type: object
className
className: string = "CustomEntitiesResult"
name
name: string = "Composite"
Const CustomMultiLabelClassificationAction
CustomMultiLabelClassificationAction: object
type
type: object
className
className: string = "CustomMultiLabelClassificationAction"
name
name: string = "Composite"
modelProperties
modelProperties: object
Const CustomMultiLabelClassificationLROResult
CustomMultiLabelClassificationLROResult: object
serializedName
serializedName: string = "CustomMultiLabelClassificationLROResults"
type
type: object
className
className: string = "CustomMultiLabelClassificationLROResult"
name
name: string = "Composite"
polymorphicDiscriminator
polymorphicDiscriminator: any = TaskState.type.polymorphicDiscriminator
uberParent
uberParent: string = "TaskState"
modelProperties
modelProperties: object
results
results: object
serializedName
serializedName: string = "results"
type
type: object
className
className: string = "CustomMultiLabelClassificationResult"
name
name: string = "Composite"
Const CustomMultiLabelClassificationLROTask
CustomMultiLabelClassificationLROTask: object
serializedName
serializedName: string = "CustomMultiLabelClassification"
type
type: object
className
className: string = "CustomMultiLabelClassificationLROTask"
name
name: string = "Composite"
polymorphicDiscriminator
polymorphicDiscriminator: any = BatchActionState.type.polymorphicDiscriminator
uberParent
uberParent: string = "BatchActionState"
modelProperties
modelProperties: object
parameters
parameters: object
serializedName
serializedName: string = "parameters"
type
type: object
className
className: string = "CustomMultiLabelClassificationAction"
name
name: string = "Composite"
Const CustomMultiLabelClassificationResult
CustomMultiLabelClassificationResult: object
type
type: object
className
className: string = "CustomMultiLabelClassificationResult"
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 = "CustomMultiLabelClassificationResultDocumentsItem"
name
name: string = "Composite"
Const CustomMultiLabelClassificationResultDocumentsItem
CustomMultiLabelClassificationResultDocumentsItem: object
type
type: object
className
className: string = "CustomMultiLabelClassificationResultDocumentsItem"
name
name: string = "Composite"
modelProperties
modelProperties: object
Const CustomResult
CustomResult: object
type
type: object
className
className: string = "CustomResult"
name
name: string = "Composite"
modelProperties
modelProperties: object
deploymentName
deploymentName: object
required
required: boolean = true
serializedName
serializedName: string = "deploymentName"
type
type: object
name
name: string = "String"
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"
projectName
projectName: object
required
required: boolean = true
serializedName
serializedName: string = "projectName"
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 CustomSingleLabelClassificationAction
CustomSingleLabelClassificationAction: object
type
type: object
className
className: string = "CustomSingleLabelClassificationAction"
name
name: string = "Composite"
modelProperties
modelProperties: object
Const CustomSingleLabelClassificationLROResult
CustomSingleLabelClassificationLROResult: object
serializedName
serializedName: string = "CustomSingleLabelClassificationLROResults"
type
type: object
className
className: string = "CustomSingleLabelClassificationLROResult"
name
name: string = "Composite"
polymorphicDiscriminator
polymorphicDiscriminator: any = TaskState.type.polymorphicDiscriminator
uberParent
uberParent: string = "TaskState"
modelProperties
modelProperties: object
results
results: object
serializedName
serializedName: string = "results"
type
type: object
className
className: string = "CustomSingleLabelClassificationResult"
name
name: string = "Composite"
Const CustomSingleLabelClassificationLROTask
CustomSingleLabelClassificationLROTask: object
serializedName
serializedName: string = "CustomSingleLabelClassification"
type
type: object
className
className: string = "CustomSingleLabelClassificationLROTask"
name
name: string = "Composite"
polymorphicDiscriminator
polymorphicDiscriminator: any = BatchActionState.type.polymorphicDiscriminator
uberParent
uberParent: string = "BatchActionState"
modelProperties
modelProperties: object
parameters
parameters: object
serializedName
serializedName: string = "parameters"
type
type: object
className
className: string = "CustomSingleLabelClassificationAction"
name
name: string = "Composite"
Const CustomSingleLabelClassificationResult
CustomSingleLabelClassificationResult: object
type
type: object
className
className: string = "CustomSingleLabelClassificationResult"
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 = "CustomSingleLabelClassificationResultDocumentsItem"
name
name: string = "Composite"
Const CustomSingleLabelClassificationResultDocumentsItem
CustomSingleLabelClassificationResultDocumentsItem: object
type
type: object
className
className: string = "CustomSingleLabelClassificationResultDocumentsItem"
name
name: string = "Composite"
modelProperties
modelProperties: object
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 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 = "ErrorModel"
name
name: string = "Composite"
id
id: object
required
required: boolean = true
serializedName
serializedName: string = "id"
type
type: object
name
name: string = "String"
Const DocumentResult
DocumentResult: object
type
type: object
className
className: string = "DocumentResult"
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"
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 = "DocumentWarning"
name
name: string = "Composite"
Const DocumentWarning
DocumentWarning: object
type
type: object
className
className: string = "DocumentWarning"
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 EntitiesDocumentResult
EntitiesDocumentResult: object
type
type: object
className
className: string = "EntitiesDocumentResult"
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"
Const EntitiesLROTask
EntitiesLROTask: object
serializedName
serializedName: string = "EntityRecognition"
type
type: object
className
className: string = "EntitiesLROTask"
name
name: string = "Composite"
polymorphicDiscriminator
polymorphicDiscriminator: any = BatchActionState.type.polymorphicDiscriminator
uberParent
uberParent: string = "BatchActionState"
modelProperties
modelProperties: object
parameters
parameters: object
serializedName
serializedName: string = "parameters"
type
type: object
className
className: string = "EntityRecognitionAction"
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 = "EntitiesResultDocumentsItem"
name
name: string = "Composite"
Const EntitiesResultDocumentsItem
EntitiesResultDocumentsItem: object
type
type: object
className
className: string = "EntitiesResultDocumentsItem"
name
name: string = "Composite"
modelProperties
modelProperties: object
Const EntitiesTaskResult
EntitiesTaskResult: object
serializedName
serializedName: string = "EntityRecognitionResults"
type
type: object
className
className: string = "EntitiesTaskResult"
name
name: string = "Composite"
polymorphicDiscriminator
polymorphicDiscriminator: any = AnalyzeTextTaskResult.type.polymorphicDiscriminator
uberParent
uberParent: string = "AnalyzeTextTaskResult"
modelProperties
modelProperties: object
results
results: object
serializedName
serializedName: string = "results"
type
type: object
className
className: string = "EntitiesResult"
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"
length
length: object
required
required: boolean = true
serializedName
serializedName: string = "length"
type
type: object
name
name: string = "Number"
offset
offset: object
required
required: boolean = true
serializedName
serializedName: string = "offset"
type
type: object
name
name: string = "Number"
subCategory
subCategory: object
serializedName
serializedName: string = "subcategory"
type
type: object
name
name: string = "String"
text
text: object
required
required: boolean = true
serializedName
serializedName: string = "text"
type
type: object
name
name: string = "String"
Const EntityDataSource
EntityDataSource: object
type
type: object
className
className: string = "EntityDataSource"
name
name: string = "Composite"
modelProperties
modelProperties: object
entityId
entityId: object
required
required: boolean = true
serializedName
serializedName: string = "id"
type
type: object
name
name: string = "String"
name
name: object
required
required: boolean = true
serializedName
serializedName: string = "dataSource"
type
type: object
name
name: string = "String"
Const EntityLinkingAction
EntityLinkingAction: object
type
type: object
className
className: string = "EntityLinkingAction"
name
name: string = "Composite"
modelProperties
modelProperties: object
stringIndexType
stringIndexType: object
defaultValue
defaultValue: string = "Utf16CodeUnit"
serializedName
serializedName: string = "stringIndexType"
type
type: object
name
name: string = "String"
Const EntityLinkingLROResult
EntityLinkingLROResult: object
serializedName
serializedName: string = "EntityLinkingLROResults"
type
type: object
className
className: string = "EntityLinkingLROResult"
name
name: string = "Composite"
polymorphicDiscriminator
polymorphicDiscriminator: any = TaskState.type.polymorphicDiscriminator
uberParent
uberParent: string = "TaskState"
modelProperties
modelProperties: object
results
results: object
serializedName
serializedName: string = "results"
type
type: object
className
className: string = "EntityLinkingResult"
name
name: string = "Composite"
Const EntityLinkingLROTask
EntityLinkingLROTask: object
serializedName
serializedName: string = "EntityLinking"
type
type: object
className
className: string = "EntityLinkingLROTask"
name
name: string = "Composite"
polymorphicDiscriminator
polymorphicDiscriminator: any = BatchActionState.type.polymorphicDiscriminator
uberParent
uberParent: string = "BatchActionState"
modelProperties
modelProperties: object
parameters
parameters: object
serializedName
serializedName: string = "parameters"
type
type: object
className
className: string = "EntityLinkingAction"
name
name: string = "Composite"
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 = "EntityLinkingResultDocumentsItem"
name
name: string = "Composite"
Const EntityLinkingResultDocumentsItem
EntityLinkingResultDocumentsItem: object
type
type: object
className
className: string = "EntityLinkingResultDocumentsItem"
name
name: string = "Composite"
modelProperties
modelProperties: object
Const EntityLinkingTaskResult
EntityLinkingTaskResult: object
serializedName
serializedName: string = "EntityLinkingResults"
type
type: object
className
className: string = "EntityLinkingTaskResult"
name
name: string = "Composite"
polymorphicDiscriminator
polymorphicDiscriminator: any = AnalyzeTextTaskResult.type.polymorphicDiscriminator
uberParent
uberParent: string = "AnalyzeTextTaskResult"
modelProperties
modelProperties: object
results
results: object
serializedName
serializedName: string = "results"
type
type: object
className
className: string = "EntityLinkingResult"
name
name: string = "Composite"
Const EntityRecognitionAction
EntityRecognitionAction: object
type
type: object
className
className: string = "EntityRecognitionAction"
name
name: string = "Composite"
modelProperties
modelProperties: object
stringIndexType
stringIndexType: object
defaultValue
defaultValue: string = "Utf16CodeUnit"
serializedName
serializedName: string = "stringIndexType"
type
type: object
name
name: string = "String"
Const EntityRecognitionLROResult
EntityRecognitionLROResult: object
serializedName
serializedName: string = "EntityRecognitionLROResults"
type
type: object
className
className: string = "EntityRecognitionLROResult"
name
name: string = "Composite"
polymorphicDiscriminator
polymorphicDiscriminator: any = TaskState.type.polymorphicDiscriminator
uberParent
uberParent: string = "TaskState"
modelProperties
modelProperties: object
results
results: object
serializedName
serializedName: string = "results"
type
type: object
className
className: string = "EntitiesResult"
name
name: string = "Composite"
Const ErrorModel
ErrorModel: object
type
type: object
className
className: string = "ErrorModel"
name
name: string = "Composite"
additionalProperties
additionalProperties: object
type
type: object
name
name: string = "Object"
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 = "ErrorModel"
name
name: string = "Composite"
innererror
innererror: object
serializedName
serializedName: string = "innererror"
type
type: object
className
className: string = "InnerErrorModel"
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 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 = "ErrorModel"
name
name: string = "Composite"
Const ExtractedSummaryDocumentResult
ExtractedSummaryDocumentResult: object
type
type: object
className
className: string = "ExtractedSummaryDocumentResult"
name
name: string = "Composite"
modelProperties
modelProperties: object
sentences
sentences: 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 = "SummarySentence"
name
name: string = "Composite"
Const ExtractiveSummarizationAction
ExtractiveSummarizationAction: object
type
type: object
className
className: string = "ExtractiveSummarizationAction"
name
name: string = "Composite"
modelProperties
modelProperties: object
maxSentenceCount
maxSentenceCount: object
defaultValue
defaultValue: number = 3
serializedName
serializedName: string = "sentenceCount"
type
type: object
name
name: string = "Number"
orderBy
orderBy: object
defaultValue
defaultValue: string = "Offset"
serializedName
serializedName: string = "sortBy"
type
type: object
name
name: string = "String"
stringIndexType
stringIndexType: object
defaultValue
defaultValue: string = "Utf16CodeUnit"
serializedName
serializedName: string = "stringIndexType"
type
type: object
name
name: string = "String"
Const ExtractiveSummarizationLROResult
ExtractiveSummarizationLROResult: object
serializedName
serializedName: string = "ExtractiveSummarizationLROResults"
type
type: object
className
className: string = "ExtractiveSummarizationLROResult"
name
name: string = "Composite"
polymorphicDiscriminator
polymorphicDiscriminator: any = TaskState.type.polymorphicDiscriminator
uberParent
uberParent: string = "TaskState"
modelProperties
modelProperties: object
results
results: object
serializedName
serializedName: string = "results"
type
type: object
className
className: string = "ExtractiveSummarizationResult"
name
name: string = "Composite"
Const ExtractiveSummarizationLROTask
ExtractiveSummarizationLROTask: object
serializedName
serializedName: string = "ExtractiveSummarization"
type
type: object
className
className: string = "ExtractiveSummarizationLROTask"
name
name: string = "Composite"
polymorphicDiscriminator
polymorphicDiscriminator: any = BatchActionState.type.polymorphicDiscriminator
uberParent
uberParent: string = "BatchActionState"
modelProperties
modelProperties: object
parameters
parameters: object
serializedName
serializedName: string = "parameters"
type
type: object
className
className: string = "ExtractiveSummarizationAction"
name
name: string = "Composite"
Const ExtractiveSummarizationResult
ExtractiveSummarizationResult: object
type
type: object
className
className: string = "ExtractiveSummarizationResult"
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 = "ExtractiveSummarizationResultDocumentsItem"
name
name: string = "Composite"
Const ExtractiveSummarizationResultDocumentsItem
ExtractiveSummarizationResultDocumentsItem: object
type
type: object
className
className: string = "ExtractiveSummarizationResultDocumentsItem"
name
name: string = "Composite"
modelProperties
modelProperties: object
Const HealthcareAction
HealthcareAction: object
type
type: object
className
className: string = "HealthcareAction"
name
name: string = "Composite"
modelProperties
modelProperties: object
fhirVersion
fhirVersion: object
serializedName
serializedName: string = "fhirVersion"
type
type: object
name
name: string = "String"
stringIndexType
stringIndexType: object
defaultValue
defaultValue: string = "Utf16CodeUnit"
serializedName
serializedName: string = "stringIndexType"
type
type: object
name
name: string = "String"
Const HealthcareAssertion
HealthcareAssertion: object
type
type: object
className
className: string = "HealthcareAssertion"
name
name: string = "Composite"
modelProperties
modelProperties: object
association
association: object
serializedName
serializedName: string = "association"
type
type: object
allowedValues
allowedValues: Object = ["subject", "other"]
name
name: string = "Enum"
certainty
certainty: object
serializedName
serializedName: string = "certainty"
type
type: object
allowedValues
allowedValues: Object = ["positive","positivePossible","neutralPossible","negativePossible","negative"]
name
name: string = "Enum"
conditionality
conditionality: object
serializedName
serializedName: string = "conditionality"
type
type: object
allowedValues
allowedValues: Object = ["hypothetical", "conditional"]
name
name: string = "Enum"
Const HealthcareEntitiesDocumentResult
HealthcareEntitiesDocumentResult: object
type
type: object
className
className: string = "HealthcareEntitiesDocumentResult"
name
name: string = "Composite"
modelProperties
modelProperties: object
entities
entities: object
required
required: boolean = true
serializedName
serializedName: string = "entities"
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
className
className: string = "HealthcareEntity"
name
name: string = "Composite"
fhirBundle
fhirBundle: object
serializedName
serializedName: string = "fhirBundle"
type
type: object
name
name: string = "Dictionary"
value
value: object
type
type: object
name
name: string = "any"
relations
relations: object
required
required: boolean = true
serializedName
serializedName: string = "relations"
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
className
className: string = "HealthcareRelation"
name
name: string = "Composite"
Const HealthcareEntity
HealthcareEntity: object
type
type: object
className
className: string = "HealthcareEntity"
name
name: string = "Composite"
modelProperties
modelProperties: object
assertion
assertion: object
serializedName
serializedName: string = "assertion"
type
type: object
className
className: string = "HealthcareAssertion"
name
name: string = "Composite"
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"
dataSources
dataSources: object
serializedName
serializedName: string = "links"
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
className
className: string = "EntityDataSource"
name
name: string = "Composite"
length
length: object
required
required: boolean = true
serializedName
serializedName: string = "length"
type
type: object
name
name: string = "Number"
normalizedText
normalizedText: object
serializedName
serializedName: string = "name"
type
type: object
name
name: string = "String"
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 HealthcareLROResult
HealthcareLROResult: object
serializedName
serializedName: string = "HealthcareLROResults"
type
type: object
className
className: string = "HealthcareLROResult"
name
name: string = "Composite"
polymorphicDiscriminator
polymorphicDiscriminator: any = TaskState.type.polymorphicDiscriminator
uberParent
uberParent: string = "TaskState"
modelProperties
modelProperties: object
results
results: object
serializedName
serializedName: string = "results"
type
type: object
className
className: string = "HealthcareResult"
name
name: string = "Composite"
Const HealthcareLROTask
HealthcareLROTask: object
serializedName
serializedName: string = "Healthcare"
type
type: object
className
className: string = "HealthcareLROTask"
name
name: string = "Composite"
polymorphicDiscriminator
polymorphicDiscriminator: any = BatchActionState.type.polymorphicDiscriminator
uberParent
uberParent: string = "BatchActionState"
modelProperties
modelProperties: object
parameters
parameters: object
serializedName
serializedName: string = "parameters"
type
type: object
className
className: string = "HealthcareAction"
name
name: string = "Composite"
Const HealthcareRelation
HealthcareRelation: object
type
type: object
className
className: string = "HealthcareRelation"
name
name: string = "Composite"
modelProperties
modelProperties: object
entities
entities: object
required
required: boolean = true
serializedName
serializedName: string = "entities"
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
className
className: string = "HealthcareRelationEntity"
name
name: string = "Composite"
relationType
relationType: object
required
required: boolean = true
serializedName
serializedName: string = "relationType"
type
type: object
name
name: string = "String"
Const HealthcareRelationEntity
HealthcareRelationEntity: object
type
type: object
className
className: string = "HealthcareRelationEntity"
name
name: string = "Composite"
modelProperties
modelProperties: object
ref
ref: object
required
required: boolean = true
serializedName
serializedName: string = "ref"
type
type: object
name
name: string = "String"
role
role: object
required
required: boolean = true
serializedName
serializedName: string = "role"
type
type: object
name
name: string = "String"
Const HealthcareResult
HealthcareResult: object
type
type: object
className
className: string = "HealthcareResult"
name
name: string = "Composite"
modelProperties
modelProperties: object
documents
documents: object
required
required: boolean = true
serializedName
serializedName: string = "documents"
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
className
className: string = "HealthcareResultDocumentsItem"
name
name: string = "Composite"
Const HealthcareResultDocumentsItem
HealthcareResultDocumentsItem: object
type
type: object
className
className: string = "HealthcareResultDocumentsItem"
name
name: string = "Composite"
modelProperties
modelProperties: object
Const InnerErrorModel
InnerErrorModel: object
type
type: object
className
className: string = "InnerErrorModel"
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 = "InnerErrorModel"
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 JobErrors
JobErrors: object
type
type: object
className
className: string = "JobErrors"
name
name: string = "Composite"
modelProperties
modelProperties: object
errors
errors: object
serializedName
serializedName: string = "errors"
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
className
className: string = "ErrorModel"
name
name: string = "Composite"
Const JobMetadata
JobMetadata: object
type
type: object
className
className: string = "JobMetadata"
name
name: string = "Composite"
modelProperties
modelProperties: object
createdDateTime
createdDateTime: object
required
required: boolean = true
serializedName
serializedName: string = "createdDateTime"
type
type: object
name
name: string = "DateTime"
displayName
displayName: object
serializedName
serializedName: string = "displayName"
type
type: object
name
name: string = "String"
expirationDateTime
expirationDateTime: object
serializedName
serializedName: string = "expirationDateTime"
type
type: object
name
name: string = "DateTime"
jobId
jobId: object
required
required: boolean = true
serializedName
serializedName: string = "jobId"
type
type: object
name
name: string = "Uuid"
lastUpdateDateTime
lastUpdateDateTime: object
required
required: boolean = true
serializedName
serializedName: string = "lastUpdateDateTime"
type
type: object
name
name: string = "DateTime"
status
status: object
required
required: boolean = true
serializedName
serializedName: string = "status"
type
type: object
allowedValues
allowedValues: Object = ["notStarted","running","succeeded","partiallySucceeded","failed","cancelled","cancelling"]
name
name: string = "Enum"
Const JobState
JobState: object
type
type: object
className
className: string = "JobState"
name
name: string = "Composite"
modelProperties
modelProperties: object
createdOn
createdOn: object
required
required: boolean = true
serializedName
serializedName: string = "createdDateTime"
type
type: object
name
name: string = "DateTime"
displayName
displayName: object
serializedName
serializedName: string = "displayName"
type
type: object
name
name: string = "String"
errors
errors: object
serializedName
serializedName: string = "errors"
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
className
className: string = "ErrorModel"
name
name: string = "Composite"
expiresOn
expiresOn: object
serializedName
serializedName: string = "expirationDateTime"
type
type: object
name
name: string = "DateTime"
lastModifiedOn
lastModifiedOn: object
required
required: boolean = true
serializedName
serializedName: string = "lastUpdateDateTime"
type
type: object
name
name: string = "DateTime"
nextLink
nextLink: object
serializedName
serializedName: string = "nextLink"
type
type: object
name
name: string = "String"
operationId
operationId: object
required
required: boolean = true
serializedName
serializedName: string = "jobId"
type
type: object
name
name: string = "Uuid"
status
status: object
required
required: boolean = true
serializedName
serializedName: string = "status"
type
type: object
allowedValues
allowedValues: Object = ["notStarted","running","succeeded","partiallySucceeded","failed","cancelled","cancelling"]
name
name: string = "Enum"
Const KeyPhraseExtractionAction
KeyPhraseExtractionAction: object
type
type: object
className
className: string = "KeyPhraseExtractionAction"
name
name: string = "Composite"
modelProperties
modelProperties: object
Const KeyPhraseExtractionLROResult
KeyPhraseExtractionLROResult: object
serializedName
serializedName: string = "KeyPhraseExtractionLROResults"
type
type: object
className
className: string = "KeyPhraseExtractionLROResult"
name
name: string = "Composite"
polymorphicDiscriminator
polymorphicDiscriminator: any = TaskState.type.polymorphicDiscriminator
uberParent
uberParent: string = "TaskState"
modelProperties
modelProperties: object
results
results: object
serializedName
serializedName: string = "results"
type
type: object
className
className: string = "KeyPhraseResult"
name
name: string = "Composite"
Const KeyPhraseLROTask
KeyPhraseLROTask: object
serializedName
serializedName: string = "KeyPhraseExtraction"
type
type: object
className
className: string = "KeyPhraseLROTask"
name
name: string = "Composite"
polymorphicDiscriminator
polymorphicDiscriminator: any = BatchActionState.type.polymorphicDiscriminator
uberParent
uberParent: string = "BatchActionState"
modelProperties
modelProperties: object
parameters
parameters: object
serializedName
serializedName: string = "parameters"
type
type: object
className
className: string = "KeyPhraseExtractionAction"
name
name: string = "Composite"
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 = "KeyPhraseResultDocumentsItem"
name
name: string = "Composite"
Const KeyPhraseResultDocumentsItem
KeyPhraseResultDocumentsItem: object
type
type: object
className
className: string = "KeyPhraseResultDocumentsItem"
name
name: string = "Composite"
modelProperties
modelProperties: object
Const KeyPhraseTaskResult
KeyPhraseTaskResult: object
serializedName
serializedName: string = "KeyPhraseExtractionResults"
type
type: object
className
className: string = "KeyPhraseTaskResult"
name
name: string = "Composite"
polymorphicDiscriminator
polymorphicDiscriminator: any = AnalyzeTextTaskResult.type.polymorphicDiscriminator
uberParent
uberParent: string = "AnalyzeTextTaskResult"
modelProperties
modelProperties: object
results
results: object
serializedName
serializedName: string = "results"
type
type: object
className
className: string = "KeyPhraseResult"
name
name: string = "Composite"
Const KeyPhrasesDocumentResult
KeyPhrasesDocumentResult: object
type
type: object
className
className: string = "KeyPhrasesDocumentResult"
name
name: string = "Composite"
modelProperties
modelProperties: object
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"
Const KnownTextAnalysisErrorCode
KnownTextAnalysisErrorCode: object
Const LanguageDetectionAction
LanguageDetectionAction: object
type
type: object
className
className: string = "LanguageDetectionAction"
name
name: string = "Composite"
modelProperties
modelProperties: object
Const LanguageDetectionAnalysisInput
LanguageDetectionAnalysisInput: object
type
type: object
className
className: string = "LanguageDetectionAnalysisInput"
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 = "LanguageDetectionInput"
name
name: string = "Composite"
Const LanguageDetectionDocumentResult
LanguageDetectionDocumentResult: object
type
type: object
className
className: string = "LanguageDetectionDocumentResult"
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"
Const LanguageDetectionInput
LanguageDetectionInput: object
type
type: object
className
className: string = "LanguageDetectionInput"
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 LanguageDetectionResult
LanguageDetectionResult: object
type
type: object
className
className: string = "LanguageDetectionResult"
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 = "LanguageDetectionDocumentResult"
name
name: string = "Composite"
Const LanguageDetectionTaskResult
LanguageDetectionTaskResult: object
serializedName
serializedName: string = "LanguageDetectionResults"
type
type: object
className
className: string = "LanguageDetectionTaskResult"
name
name: string = "Composite"
polymorphicDiscriminator
polymorphicDiscriminator: any = AnalyzeTextTaskResult.type.polymorphicDiscriminator
uberParent
uberParent: string = "AnalyzeTextTaskResult"
modelProperties
modelProperties: object
results
results: object
serializedName
serializedName: string = "results"
type
type: object
className
className: string = "LanguageDetectionResult"
name
name: string = "Composite"
Const LinkedEntitiesDocumentResult
LinkedEntitiesDocumentResult: object
type
type: object
className
className: string = "LinkedEntitiesDocumentResult"
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"
Const LinkedEntity
LinkedEntity: object
type
type: object
className
className: string = "LinkedEntity"
name
name: string = "Composite"
modelProperties
modelProperties: object
bingEntitySearchApiId
bingEntitySearchApiId: object
serializedName
serializedName: string = "bingId"
type
type: object
name
name: string = "String"
dataSource
dataSource: object
required
required: boolean = true
serializedName
serializedName: string = "dataSource"
type
type: object
name
name: string = "String"
dataSourceEntityId
dataSourceEntityId: object
serializedName
serializedName: string = "id"
type
type: object
name
name: string = "String"
language
language: object
required
required: boolean = true
serializedName
serializedName: string = "language"
type
type: object
name
name: string = "String"
matches
matches: object
required
required: boolean = true
serializedName
serializedName: string = "matches"
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
className
className: string = "Match"
name
name: string = "Composite"
name
name: object
required
required: boolean = true
serializedName
serializedName: string = "name"
type
type: object
name
name: string = "String"
url
url: object
required
required: boolean = true
serializedName
serializedName: string = "url"
type
type: object
name
name: string = "String"
Const Match
Match: object
type
type: object
className
className: string = "Match"
name
name: string = "Composite"
modelProperties
modelProperties: object
confidenceScore
confidenceScore: object
required
required: boolean = true
serializedName
serializedName: string = "confidenceScore"
type
type: object
name
name: string = "Number"
length
length: object
required
required: boolean = true
serializedName
serializedName: string = "length"
type
type: object
name
name: string = "Number"
offset
offset: object
required
required: boolean = true
serializedName
serializedName: string = "offset"
type
type: object
name
name: string = "Number"
text
text: object
required
required: boolean = true
serializedName
serializedName: string = "text"
type
type: object
name
name: string = "String"
Const MultiClassificationDocumentResult
MultiClassificationDocumentResult: object
type
type: object
className
className: string = "MultiClassificationDocumentResult"
name
name: string = "Composite"
modelProperties
modelProperties: object
classifications
classifications: object
required
required: boolean = true
serializedName
serializedName: string = "class"
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
className
className: string = "ClassificationCategory"
name
name: string = "Composite"
Const MultiLanguageAnalysisInput
MultiLanguageAnalysisInput: object
type
type: object
className
className: string = "MultiLanguageAnalysisInput"
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 = "TextDocumentInput"
name
name: string = "Composite"
Const Pagination
Pagination: object
type
type: object
className
className: string = "Pagination"
name
name: string = "Composite"
modelProperties
modelProperties: object
nextLink
nextLink: object
serializedName
serializedName: string = "nextLink"
type
type: object
name
name: string = "String"
Const PiiEntitiesDocumentResult
PiiEntitiesDocumentResult: object
type
type: object
className
className: string = "PiiEntitiesDocumentResult"
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"
redactedText
redactedText: object
required
required: boolean = true
serializedName
serializedName: string = "redactedText"
type
type: object
name
name: string = "String"
Const PiiEntityRecognitionAction
PiiEntityRecognitionAction: object
type
type: object
className
className: string = "PiiEntityRecognitionAction"
name
name: string = "Composite"
modelProperties
modelProperties: object
categoriesFilter
categoriesFilter: object
serializedName
serializedName: string = "piiCategories"
constraints
constraints: object
UniqueItems
UniqueItems: boolean = true
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
name
name: string = "String"
domainFilter
domainFilter: object
defaultValue
defaultValue: string = "none"
serializedName
serializedName: string = "domain"
type
type: object
name
name: string = "String"
stringIndexType
stringIndexType: object
defaultValue
defaultValue: string = "Utf16CodeUnit"
serializedName
serializedName: string = "stringIndexType"
type
type: object
name
name: string = "String"
Const PiiEntityRecognitionLROResult
PiiEntityRecognitionLROResult: object
serializedName
serializedName: string = "PiiEntityRecognitionLROResults"
type
type: object
className
className: string = "PiiEntityRecognitionLROResult"
name
name: string = "Composite"
polymorphicDiscriminator
polymorphicDiscriminator: any = TaskState.type.polymorphicDiscriminator
uberParent
uberParent: string = "TaskState"
modelProperties
modelProperties: object
results
results: object
serializedName
serializedName: string = "results"
type
type: object
className
className: string = "PiiResult"
name
name: string = "Composite"
Const PiiLROTask
PiiLROTask: object
serializedName
serializedName: string = "PiiEntityRecognition"
type
type: object
className
className: string = "PiiLROTask"
name
name: string = "Composite"
polymorphicDiscriminator
polymorphicDiscriminator: any = BatchActionState.type.polymorphicDiscriminator
uberParent
uberParent: string = "BatchActionState"
modelProperties
modelProperties: object
parameters
parameters: object
serializedName
serializedName: string = "parameters"
type
type: object
className
className: string = "PiiEntityRecognitionAction"
name
name: string = "Composite"
Const PiiResult
PiiResult: object
type
type: object
className
className: string = "PiiResult"
name
name: string = "Composite"
modelProperties
modelProperties: object
documents
documents: object
required
required: boolean = true
serializedName
serializedName: string = "documents"
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
className
className: string = "PiiResultDocumentsItem"
name
name: string = "Composite"
Const PiiResultDocumentsItem
PiiResultDocumentsItem: object
type
type: object
className
className: string = "PiiResultDocumentsItem"
name
name: string = "Composite"
modelProperties
modelProperties: object
Const PiiTaskResult
PiiTaskResult: object
serializedName
serializedName: string = "PiiEntityRecognitionResults"
type
type: object
className
className: string = "PiiTaskResult"
name
name: string = "Composite"
polymorphicDiscriminator
polymorphicDiscriminator: any = AnalyzeTextTaskResult.type.polymorphicDiscriminator
uberParent
uberParent: string = "AnalyzeTextTaskResult"
modelProperties
modelProperties: object
results
results: object
serializedName
serializedName: string = "results"
type
type: object
className
className: string = "PiiResult"
name
name: string = "Composite"
Const PreBuiltResult
PreBuiltResult: object
type
type: object
className
className: string = "PreBuiltResult"
name
name: string = "Composite"
modelProperties
modelProperties: object
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 SentenceSentiment
SentenceSentiment: object
type
type: object
className
className: string = "SentenceSentiment"
name
name: string = "Composite"
modelProperties
modelProperties: object
assessments
assessments: object
serializedName
serializedName: string = "assessments"
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
className
className: string = "AssessmentSentiment"
name
name: string = "Composite"
confidenceScores
confidenceScores: object
serializedName
serializedName: string = "confidenceScores"
type
type: object
className
className: string = "SentimentConfidenceScores"
name
name: string = "Composite"
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"
sentiment
sentiment: object
required
required: boolean = true
serializedName
serializedName: string = "sentiment"
type
type: object
allowedValues
allowedValues: Object = ["positive", "neutral", "negative"]
name
name: string = "Enum"
targets
targets: object
serializedName
serializedName: string = "targets"
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
className
className: string = "SentenceTarget"
name
name: string = "Composite"
text
text: object
required
required: boolean = true
serializedName
serializedName: string = "text"
type
type: object
name
name: string = "String"
Const SentenceTarget
SentenceTarget: object
type
type: object
className
className: string = "SentenceTarget"
name
name: string = "Composite"
modelProperties
modelProperties: object
confidenceScores
confidenceScores: object
serializedName
serializedName: string = "confidenceScores"
type
type: object
className
className: string = "TargetConfidenceScores"
name
name: string = "Composite"
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"
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 = "TargetRelation"
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 SentimentAnalysisAction
SentimentAnalysisAction: object
type
type: object
className
className: string = "SentimentAnalysisAction"
name
name: string = "Composite"
modelProperties
modelProperties: object
includeOpinionMining
includeOpinionMining: object
defaultValue
defaultValue: boolean = false
serializedName
serializedName: string = "opinionMining"
type
type: object
name
name: string = "Boolean"
stringIndexType
stringIndexType: object
defaultValue
defaultValue: string = "Utf16CodeUnit"
serializedName
serializedName: string = "stringIndexType"
type
type: object
name
name: string = "String"
Const SentimentAnalysisLROTask
SentimentAnalysisLROTask: object
serializedName
serializedName: string = "SentimentAnalysis"
type
type: object
className
className: string = "SentimentAnalysisLROTask"
name
name: string = "Composite"
polymorphicDiscriminator
polymorphicDiscriminator: any = BatchActionState.type.polymorphicDiscriminator
uberParent
uberParent: string = "BatchActionState"
modelProperties
modelProperties: object
parameters
parameters: object
serializedName
serializedName: string = "parameters"
type
type: object
className
className: string = "SentimentAnalysisAction"
name
name: string = "Composite"
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 SentimentDocumentResult
SentimentDocumentResult: object
type
type: object
className
className: string = "SentimentDocumentResult"
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"
sentences
sentences: 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"
Const SentimentLROResult
SentimentLROResult: object
serializedName
serializedName: string = "SentimentAnalysisLROResults"
type
type: object
className
className: string = "SentimentLROResult"
name
name: string = "Composite"
polymorphicDiscriminator
polymorphicDiscriminator: any = TaskState.type.polymorphicDiscriminator
uberParent
uberParent: string = "TaskState"
modelProperties
modelProperties: object
results
results: object
serializedName
serializedName: string = "results"
type
type: object
className
className: string = "SentimentResponse"
name
name: string = "Composite"
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 = "SentimentResponseDocumentsItem"
name
name: string = "Composite"
Const SentimentResponseDocumentsItem
SentimentResponseDocumentsItem: object
type
type: object
className
className: string = "SentimentResponseDocumentsItem"
name
name: string = "Composite"
modelProperties
modelProperties: object
Const SentimentTaskResult
SentimentTaskResult: object
serializedName
serializedName: string = "SentimentAnalysisResults"
type
type: object
className
className: string = "SentimentTaskResult"
name
name: string = "Composite"
polymorphicDiscriminator
polymorphicDiscriminator: any = AnalyzeTextTaskResult.type.polymorphicDiscriminator
uberParent
uberParent: string = "AnalyzeTextTaskResult"
modelProperties
modelProperties: object
results
results: object
serializedName
serializedName: string = "results"
type
type: object
className
className: string = "SentimentResponse"
name
name: string = "Composite"
Const SingleClassificationDocumentResult
SingleClassificationDocumentResult: object
type
type: object
className
className: string = "SingleClassificationDocumentResult"
name
name: string = "Composite"
modelProperties
modelProperties: object
classification
classification: object
serializedName
serializedName: string = "class"
type
type: object
className
className: string = "ClassificationCategory"
name
name: string = "Composite"
Const SummarySentence
SummarySentence: object
type
type: object
className
className: string = "SummarySentence"
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"
rankScore
rankScore: object
required
required: boolean = true
serializedName
serializedName: string = "rankScore"
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 TargetConfidenceScores
TargetConfidenceScores: object
type
type: object
className
className: string = "TargetConfidenceScores"
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 TargetRelation
TargetRelation: object
type
type: object
className
className: string = "TargetRelation"
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 = ["assessment", "target"]
name
name: string = "Enum"
Const TaskState
TaskState: object
type
type: object
className
className: string = "TaskState"
name
name: string = "Composite"
modelProperties
modelProperties: object
lastUpdateDateTime
lastUpdateDateTime: object
required
required: boolean = true
serializedName
serializedName: string = "lastUpdateDateTime"
type
type: object
name
name: string = "DateTime"
status
status: object
required
required: boolean = true
serializedName
serializedName: string = "status"
type
type: object
allowedValues
allowedValues: Object = ["notStarted","running","succeeded","partiallySucceeded","failed","cancelled","cancelling"]
name
name: string = "Enum"
Const TasksState
TasksState: object
type
type: object
className
className: string = "TasksState"
name
name: string = "Composite"
modelProperties
modelProperties: object
tasks
tasks: object
serializedName
serializedName: string = "tasks"
type
type: object
className
className: string = "TasksStateTasks"
name
name: string = "Composite"
Const TasksStateTasks
TasksStateTasks: object
type
type: object
className
className: string = "TasksStateTasks"
name
name: string = "Composite"
modelProperties
modelProperties: object
completed
completed: object
required
required: boolean = true
serializedName
serializedName: string = "completed"
type
type: object
name
name: string = "Number"
failed
failed: object
required
required: boolean = true
serializedName
serializedName: string = "failed"
type
type: object
name
name: string = "Number"
inProgress
inProgress: object
required
required: boolean = true
serializedName
serializedName: string = "inProgress"
type
type: object
name
name: string = "Number"
items
items: object
serializedName
serializedName: string = "items"
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
className
className: string = "AnalyzeTextLROResult"
name
name: string = "Composite"
total
total: object
required
required: boolean = true
serializedName
serializedName: string = "total"
type
type: object
name
name: string = "Number"
Const TextDocumentBatchStatistics
TextDocumentBatchStatistics: object
type
type: object
className
className: string = "TextDocumentBatchStatistics"
name
name: string = "Composite"
modelProperties
modelProperties: object
documentCount
documentCount: object
required
required: boolean = true
serializedName
serializedName: string = "documentsCount"
type
type: object
name
name: string = "Number"
erroneousDocumentCount
erroneousDocumentCount: object
required
required: boolean = true
serializedName
serializedName: string = "erroneousDocumentsCount"
type
type: object
name
name: string = "Number"
transactionCount
transactionCount: object
required
required: boolean = true
serializedName
serializedName: string = "transactionsCount"
type
type: object
name
name: string = "Number"
validDocumentCount
validDocumentCount: object
required
required: boolean = true
serializedName
serializedName: string = "validDocumentsCount"
type
type: object
name
name: string = "Number"
Const TextDocumentInput
TextDocumentInput: object
type
type: object
className
className: string = "TextDocumentInput"
name
name: string = "Composite"
modelProperties
modelProperties: object
id
id: object
required
required: boolean = true
serializedName
serializedName: string = "id"
type
type: object
name
name: string = "String"
language
language: object
serializedName
serializedName: string = "language"
type
type: object
name
name: string = "String"
text
text: object
required
required: boolean = true
serializedName
serializedName: string = "text"
type
type: object
name
name: string = "String"
Const TextDocumentStatistics
TextDocumentStatistics: object
type
type: object
className
className: string = "TextDocumentStatistics"
name
name: string = "Composite"
modelProperties
modelProperties: object
characterCount
characterCount: object
required
required: boolean = true
serializedName
serializedName: string = "charactersCount"
type
type: object
name
name: string = "Number"
transactionCount
transactionCount: object
required
required: boolean = true
serializedName
serializedName: string = "transactionsCount"
type
type: object
name
name: string = "Number"
Const accept
accept: object
parameterPath
parameterPath: string = "accept"
mapper
mapper: object
defaultValue
defaultValue: string = "application/json"
isConstant
isConstant: boolean = true
serializedName
serializedName: string = "Accept"
type
type: object
name
name: string = "String"
Const analyzeOperationSpec
analyzeOperationSpec: object
headerParameters
headerParameters: Object = [Parameters.contentType, Parameters.accept]
httpMethod
httpMethod: string = "POST"
mediaType
mediaType: string = "json"
path
path: string = "/:analyze-text"
queryParameters
queryParameters: Object = [Parameters.apiVersion, Parameters.includeStatistics]
requestBody
requestBody: any = Parameters.body
serializer
serializer: any
urlParameters
urlParameters: Object = [Parameters.endpoint]
responses
responses: object
200
200: object
bodyMapper
bodyMapper: any = Mappers.AnalyzeTextTaskResult
default
default: object
bodyMapper
bodyMapper: any = Mappers.ErrorResponse
Const apiVersion
apiVersion: object
parameterPath
parameterPath: string = "apiVersion"
mapper
mapper: object
defaultValue
defaultValue: string = "2022-04-01-preview"
isConstant
isConstant: boolean = true
serializedName
serializedName: string = "api-version"
type
type: object
name
name: string = "String"
Const body
body: object
mapper
mapper: any = AnalyzeActionMapper
parameterPath
parameterPath: string = "body"
Const body1
body1: object
mapper
mapper: any = AnalyzeTextJobsInputMapper
parameterPath
parameterPath: string = "body"
Const cancelJobOperationSpec
cancelJobOperationSpec: object
headerParameters
headerParameters: Object = [Parameters.accept]
httpMethod
httpMethod: string = "POST"
path
path: string = "/analyze-text/jobs/{jobId}:cancel"
queryParameters
queryParameters: Object = [Parameters.apiVersion]
serializer
serializer: any
urlParameters
urlParameters: Object = [Parameters.endpoint, Parameters.jobId]
responses
responses: object
202
202: object
headersMapper
headersMapper: any = Mappers.AnalyzeTextCancelJobHeaders
default
default: object
bodyMapper
bodyMapper: any = Mappers.ErrorResponse
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"
Let discriminators
discriminators: object
AnalyzeAction
AnalyzeAction: any = AnalyzeAction
AnalyzeAction.EntityLinking
AnalyzeAction.EntityLinking: any = AnalyzeTextEntityLinkingInput
AnalyzeAction.EntityRecognition
AnalyzeAction.EntityRecognition: any = AnalyzeTextEntityRecognitionInput
AnalyzeAction.KeyPhraseExtraction
AnalyzeAction.KeyPhraseExtraction: any = AnalyzeTextKeyPhraseExtractionInput
AnalyzeAction.LanguageDetection
AnalyzeAction.LanguageDetection: any = AnalyzeTextLanguageDetectionInput
AnalyzeAction.PiiEntityRecognition
AnalyzeAction.PiiEntityRecognition: any = AnalyzeTextPiiEntitiesRecognitionInput
AnalyzeAction.SentimentAnalysis
AnalyzeAction.SentimentAnalysis: any = AnalyzeTextSentimentAnalysisInput
AnalyzeTextTaskResult
AnalyzeTextTaskResult: any = AnalyzeTextTaskResult
AnalyzeTextTaskResult.EntityLinkingResults
AnalyzeTextTaskResult.EntityLinkingResults: any = EntityLinkingTaskResult
AnalyzeTextTaskResult.EntityRecognitionResults
AnalyzeTextTaskResult.EntityRecognitionResults: any = EntitiesTaskResult
AnalyzeTextTaskResult.KeyPhraseExtractionResults
AnalyzeTextTaskResult.KeyPhraseExtractionResults: any = KeyPhraseTaskResult
AnalyzeTextTaskResult.LanguageDetectionResults
AnalyzeTextTaskResult.LanguageDetectionResults: any = LanguageDetectionTaskResult
AnalyzeTextTaskResult.PiiEntityRecognitionResults
AnalyzeTextTaskResult.PiiEntityRecognitionResults: any = PiiTaskResult
AnalyzeTextTaskResult.SentimentAnalysisResults
AnalyzeTextTaskResult.SentimentAnalysisResults: any = SentimentTaskResult
BatchActionState.AnalyzeBatchAction
BatchActionState.AnalyzeBatchAction: any = AnalyzeBatchAction
BatchActionState.CustomEntityRecognition
BatchActionState.CustomEntityRecognition: any = CustomEntitiesLROTask
BatchActionState.CustomMultiLabelClassification
BatchActionState.CustomMultiLabelClassification: any = CustomMultiLabelClassificationLROTask
BatchActionState.CustomSingleLabelClassification
BatchActionState.CustomSingleLabelClassification: any = CustomSingleLabelClassificationLROTask
BatchActionState.EntityLinking
BatchActionState.EntityLinking: any = EntityLinkingLROTask
BatchActionState.EntityRecognition
BatchActionState.EntityRecognition: any = EntitiesLROTask
BatchActionState.ExtractiveSummarization
BatchActionState.ExtractiveSummarization: any = ExtractiveSummarizationLROTask
BatchActionState.Healthcare
BatchActionState.Healthcare: any = HealthcareLROTask
BatchActionState.KeyPhraseExtraction
BatchActionState.KeyPhraseExtraction: any = KeyPhraseLROTask
BatchActionState.PiiEntityRecognition
BatchActionState.PiiEntityRecognition: any = PiiLROTask
BatchActionState.SentimentAnalysis
BatchActionState.SentimentAnalysis: any = SentimentAnalysisLROTask
TaskState.AnalyzeTextLROResult
TaskState.AnalyzeTextLROResult: any = AnalyzeTextLROResult
TaskState.CustomEntityRecognitionLROResults
TaskState.CustomEntityRecognitionLROResults: any = CustomEntityRecognitionLROResult
TaskState.CustomMultiLabelClassificationLROResults
TaskState.CustomMultiLabelClassificationLROResults: any = CustomMultiLabelClassificationLROResult
TaskState.CustomSingleLabelClassificationLROResults
TaskState.CustomSingleLabelClassificationLROResults: any = CustomSingleLabelClassificationLROResult
TaskState.EntityLinkingLROResults
TaskState.EntityLinkingLROResults: any = EntityLinkingLROResult
TaskState.EntityRecognitionLROResults
TaskState.EntityRecognitionLROResults: any = EntityRecognitionLROResult
TaskState.ExtractiveSummarizationLROResults
TaskState.ExtractiveSummarizationLROResults: any = ExtractiveSummarizationLROResult
TaskState.HealthcareLROResults
TaskState.HealthcareLROResults: any = HealthcareLROResult
TaskState.KeyPhraseExtractionLROResults
TaskState.KeyPhraseExtractionLROResults: any = KeyPhraseExtractionLROResult
TaskState.PiiEntityRecognitionLROResults
TaskState.PiiEntityRecognitionLROResults: any = PiiEntityRecognitionLROResult
TaskState.SentimentAnalysisLROResults
TaskState.SentimentAnalysisLROResults: any = SentimentLROResult
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 includeStatistics
includeStatistics: object
parameterPath
parameterPath: Object = ["options", "includeStatistics"]
mapper
mapper: object
serializedName
serializedName: string = "showStats"
type
type: object
name
name: string = "Boolean"
Const jobId
jobId: object
parameterPath
parameterPath: string = "jobId"
mapper
mapper: object
required
required: boolean = true
serializedName
serializedName: string = "jobId"
type
type: object
name
name: string = "Uuid"
Const jobStatusOperationSpec
jobStatusOperationSpec: object
headerParameters
headerParameters: Object = [Parameters.accept]
httpMethod
httpMethod: string = "GET"
path
path: string = "/analyze-text/jobs/{jobId}"
queryParameters
queryParameters: Object = [Parameters.top, Parameters.skip, Parameters.includeStatistics]
serializer
serializer: any
urlParameters
urlParameters: Object = [Parameters.endpoint, Parameters.jobId]
responses
responses: object
200
200: object
bodyMapper
bodyMapper: any = Mappers.AnalyzeTextJobState
default
default: object
bodyMapper
bodyMapper: any = Mappers.ErrorResponse
Const skip
skip: object
parameterPath
parameterPath: Object = ["options", "skip"]
mapper
mapper: object
serializedName
serializedName: string = "skip"
type
type: object
name
name: string = "Number"
Const submitJobOperationSpec
submitJobOperationSpec: object
headerParameters
headerParameters: Object = [Parameters.contentType, Parameters.accept]
httpMethod
httpMethod: string = "POST"
mediaType
mediaType: string = "json"
path
path: string = "/analyze-text/jobs"
queryParameters
queryParameters: Object = [Parameters.apiVersion]
requestBody
requestBody: any = Parameters.body1
serializer
serializer: any
urlParameters
urlParameters: Object = [Parameters.endpoint]
responses
responses: object
202
202: object
headersMapper
headersMapper: any = Mappers.AnalyzeTextSubmitJobHeaders
default
default: object
bodyMapper
bodyMapper: any = Mappers.ErrorResponse
Const top
top: object
parameterPath
parameterPath: Object = ["options", "top"]
mapper
mapper: object
serializedName
serializedName: string = "top"
type
type: object
name
name: string = "Number"
Parameters object for a text analysis task using custom models.