DescribeEntityRecognizer VB.NET Example
' This example requires the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim rest As New Chilkat.Rest
Dim success As Boolean
Dim authAws As New Chilkat.AuthAws
authAws.AccessKey = "AWS_ACCESS_KEY"
authAws.SecretKey = "AWS_SECRET_KEY"
' Don't forget to change the region to your particular region. (Also make the same change in the call to Connect below.)
authAws.Region = "us-west-2"
authAws.ServiceName = "comprehend"
' SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
rest.SetAuthAws(authAws)
' URL: https://comprehend.us-west-2.amazonaws.com/
' Use the same region as specified above.
success = rest.Connect("comprehend.us-west-2.amazonaws.com",443,True,True)
If (success <> True) Then
Debug.WriteLine("ConnectFailReason: " & rest.ConnectFailReason)
Debug.WriteLine(rest.LastErrorText)
Exit Sub
End If
' The following code creates the JSON request body.
' The JSON created by this code is shown below.
' Use this online tool to generate code from sample JSON:
' Generate Code to Create JSON
Dim json As New Chilkat.JsonObject
json.UpdateString("EntityRecognizerArn","string")
' The JSON request body created by the above code:
' {
' "EntityRecognizerArn": "string"
' }
rest.AddHeader("Content-Type","application/x-amz-json-1.1")
rest.AddHeader("X-Amz-Target","Comprehend_20171127.DescribeEntityRecognizer")
Dim sbRequestBody As New Chilkat.StringBuilder
json.EmitSb(sbRequestBody)
Dim sbResponseBody As New Chilkat.StringBuilder
success = rest.FullRequestSb("POST","/",sbRequestBody,sbResponseBody)
If (success <> True) Then
Debug.WriteLine(rest.LastErrorText)
Exit Sub
End If
Dim respStatusCode As Integer = rest.ResponseStatusCode
Debug.WriteLine("response status code = " & respStatusCode)
If (respStatusCode <> 200) Then
Debug.WriteLine("Response Header:")
Debug.WriteLine(rest.ResponseHeader)
Debug.WriteLine("Response Body:")
Debug.WriteLine(sbResponseBody.GetAsString())
Exit Sub
End If
Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
' The following code parses the JSON response.
' A sample JSON response is shown below the sample code.
' Use this online tool to generate parsing code from sample JSON:
' Generate Parsing Code from JSON
Dim AnnotationDataS3Uri As String
Dim DocumentType As String
Dim SourceDocumentsS3Uri As String
Dim Split As String
Dim j As Integer
Dim count_j As Integer
Dim strVal As String
Dim v_Type As String
Dim EvaluationMetricsF1Score As Integer
Dim EvaluationMetricsPrecision As Integer
Dim EvaluationMetricsRecall As Integer
Dim NumberOfTrainMentions As Integer
Dim DataAccessRoleArn As String = jResp.StringOf("EntityRecognizerProperties.DataAccessRoleArn")
Dim EndTime As Integer = jResp.IntOf("EntityRecognizerProperties.EndTime")
Dim EntityRecognizerArn As String = jResp.StringOf("EntityRecognizerProperties.EntityRecognizerArn")
Dim S3Uri As String = jResp.StringOf("EntityRecognizerProperties.InputDataConfig.Annotations.S3Uri")
Dim TestS3Uri As String = jResp.StringOf("EntityRecognizerProperties.InputDataConfig.Annotations.TestS3Uri")
Dim DataFormat As String = jResp.StringOf("EntityRecognizerProperties.InputDataConfig.DataFormat")
Dim InputFormat As String = jResp.StringOf("EntityRecognizerProperties.InputDataConfig.Documents.InputFormat")
Dim DocumentsS3Uri As String = jResp.StringOf("EntityRecognizerProperties.InputDataConfig.Documents.S3Uri")
Dim DocumentsTestS3Uri As String = jResp.StringOf("EntityRecognizerProperties.InputDataConfig.Documents.TestS3Uri")
Dim EntityListS3Uri As String = jResp.StringOf("EntityRecognizerProperties.InputDataConfig.EntityList.S3Uri")
Dim LanguageCode As String = jResp.StringOf("EntityRecognizerProperties.LanguageCode")
Dim Message As String = jResp.StringOf("EntityRecognizerProperties.Message")
Dim ModelKmsKeyId As String = jResp.StringOf("EntityRecognizerProperties.ModelKmsKeyId")
Dim F1Score As Integer = jResp.IntOf("EntityRecognizerProperties.RecognizerMetadata.EvaluationMetrics.F1Score")
Dim Precision As Integer = jResp.IntOf("EntityRecognizerProperties.RecognizerMetadata.EvaluationMetrics.Precision")
Dim Recall As Integer = jResp.IntOf("EntityRecognizerProperties.RecognizerMetadata.EvaluationMetrics.Recall")
Dim NumberOfTestDocuments As Integer = jResp.IntOf("EntityRecognizerProperties.RecognizerMetadata.NumberOfTestDocuments")
Dim NumberOfTrainedDocuments As Integer = jResp.IntOf("EntityRecognizerProperties.RecognizerMetadata.NumberOfTrainedDocuments")
Dim SourceModelArn As String = jResp.StringOf("EntityRecognizerProperties.SourceModelArn")
Dim Status As String = jResp.StringOf("EntityRecognizerProperties.Status")
Dim SubmitTime As Integer = jResp.IntOf("EntityRecognizerProperties.SubmitTime")
Dim TrainingEndTime As Integer = jResp.IntOf("EntityRecognizerProperties.TrainingEndTime")
Dim TrainingStartTime As Integer = jResp.IntOf("EntityRecognizerProperties.TrainingStartTime")
Dim VersionName As String = jResp.StringOf("EntityRecognizerProperties.VersionName")
Dim VolumeKmsKeyId As String = jResp.StringOf("EntityRecognizerProperties.VolumeKmsKeyId")
Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("EntityRecognizerProperties.InputDataConfig.AugmentedManifests")
While i < count_i
jResp.I = i
AnnotationDataS3Uri = jResp.StringOf("EntityRecognizerProperties.InputDataConfig.AugmentedManifests[i].AnnotationDataS3Uri")
DocumentType = jResp.StringOf("EntityRecognizerProperties.InputDataConfig.AugmentedManifests[i].DocumentType")
S3Uri = jResp.StringOf("EntityRecognizerProperties.InputDataConfig.AugmentedManifests[i].S3Uri")
SourceDocumentsS3Uri = jResp.StringOf("EntityRecognizerProperties.InputDataConfig.AugmentedManifests[i].SourceDocumentsS3Uri")
Split = jResp.StringOf("EntityRecognizerProperties.InputDataConfig.AugmentedManifests[i].Split")
j = 0
count_j = jResp.SizeOfArray("EntityRecognizerProperties.InputDataConfig.AugmentedManifests[i].AttributeNames")
While j < count_j
jResp.J = j
strVal = jResp.StringOf("EntityRecognizerProperties.InputDataConfig.AugmentedManifests[i].AttributeNames[j]")
j = j + 1
End While
i = i + 1
End While
i = 0
count_i = jResp.SizeOfArray("EntityRecognizerProperties.InputDataConfig.EntityTypes")
While i < count_i
jResp.I = i
v_Type = jResp.StringOf("EntityRecognizerProperties.InputDataConfig.EntityTypes[i].Type")
i = i + 1
End While
i = 0
count_i = jResp.SizeOfArray("EntityRecognizerProperties.RecognizerMetadata.EntityTypes")
While i < count_i
jResp.I = i
EvaluationMetricsF1Score = jResp.IntOf("EntityRecognizerProperties.RecognizerMetadata.EntityTypes[i].EvaluationMetrics.F1Score")
EvaluationMetricsPrecision = jResp.IntOf("EntityRecognizerProperties.RecognizerMetadata.EntityTypes[i].EvaluationMetrics.Precision")
EvaluationMetricsRecall = jResp.IntOf("EntityRecognizerProperties.RecognizerMetadata.EntityTypes[i].EvaluationMetrics.Recall")
NumberOfTrainMentions = jResp.IntOf("EntityRecognizerProperties.RecognizerMetadata.EntityTypes[i].NumberOfTrainMentions")
v_Type = jResp.StringOf("EntityRecognizerProperties.RecognizerMetadata.EntityTypes[i].Type")
i = i + 1
End While
i = 0
count_i = jResp.SizeOfArray("EntityRecognizerProperties.VpcConfig.SecurityGroupIds")
While i < count_i
jResp.I = i
strVal = jResp.StringOf("EntityRecognizerProperties.VpcConfig.SecurityGroupIds[i]")
i = i + 1
End While
i = 0
count_i = jResp.SizeOfArray("EntityRecognizerProperties.VpcConfig.Subnets")
While i < count_i
jResp.I = i
strVal = jResp.StringOf("EntityRecognizerProperties.VpcConfig.Subnets[i]")
i = i + 1
End While
' A sample JSON response body parsed by the above code:
' {
' "EntityRecognizerProperties": {
' "DataAccessRoleArn": "string",
' "EndTime": number,
' "EntityRecognizerArn": "string",
' "InputDataConfig": {
' "Annotations": {
' "S3Uri": "string",
' "TestS3Uri": "string"
' },
' "AugmentedManifests": [
' {
' "AnnotationDataS3Uri": "string",
' "AttributeNames": [
' "string"
' ],
' "DocumentType": "string",
' "S3Uri": "string",
' "SourceDocumentsS3Uri": "string",
' "Split": "string"
' }
' ],
' "DataFormat": "string",
' "Documents": {
' "InputFormat": "string",
' "S3Uri": "string",
' "TestS3Uri": "string"
' },
' "EntityList": {
' "S3Uri": "string"
' },
' "EntityTypes": [
' {
' "Type": "string"
' }
' ]
' },
' "LanguageCode": "string",
' "Message": "string",
' "ModelKmsKeyId": "string",
' "RecognizerMetadata": {
' "EntityTypes": [
' {
' "EvaluationMetrics": {
' "F1Score": number,
' "Precision": number,
' "Recall": number
' },
' "NumberOfTrainMentions": number,
' "Type": "string"
' }
' ],
' "EvaluationMetrics": {
' "F1Score": number,
' "Precision": number,
' "Recall": number
' },
' "NumberOfTestDocuments": number,
' "NumberOfTrainedDocuments": number
' },
' "SourceModelArn": "string",
' "Status": "string",
' "SubmitTime": number,
' "TrainingEndTime": number,
' "TrainingStartTime": number,
' "VersionName": "string",
' "VolumeKmsKeyId": "string",
' "VpcConfig": {
' "SecurityGroupIds": [
' "string"
' ],
' "Subnets": [
' "string"
' ]
' }
' }
' }
