DescribeEntityRecognizer Xojo 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
success = 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
System.DebugLog("ConnectFailReason: " + Str(rest.ConnectFailReason))
System.DebugLog(rest.LastErrorText)
Return
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
success = json.UpdateString("EntityRecognizerArn","string")
// The JSON request body created by the above code:
// {
// "EntityRecognizerArn": "string"
// }
success = rest.AddHeader("Content-Type","application/x-amz-json-1.1")
success = rest.AddHeader("X-Amz-Target","Comprehend_20171127.DescribeEntityRecognizer")
Dim sbRequestBody As New Chilkat.StringBuilder
success = json.EmitSb(sbRequestBody)
Dim sbResponseBody As New Chilkat.StringBuilder
success = rest.FullRequestSb("POST","/",sbRequestBody,sbResponseBody)
If (success <> True) Then
System.DebugLog(rest.LastErrorText)
Return
End If
Dim respStatusCode As Int32
respStatusCode = rest.ResponseStatusCode
System.DebugLog("response status code = " + Str(respStatusCode))
If (respStatusCode <> 200) Then
System.DebugLog("Response Header:")
System.DebugLog(rest.ResponseHeader)
System.DebugLog("Response Body:")
System.DebugLog(sbResponseBody.GetAsString())
Return
End If
Dim jResp As New Chilkat.JsonObject
success = 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 Int32
Dim count_j As Int32
Dim strVal As String
Dim v_Type As String
Dim EvaluationMetricsF1Score As Int32
Dim EvaluationMetricsPrecision As Int32
Dim EvaluationMetricsRecall As Int32
Dim NumberOfTrainMentions As Int32
Dim DataAccessRoleArn As String
DataAccessRoleArn = jResp.StringOf("EntityRecognizerProperties.DataAccessRoleArn")
Dim EndTime As Int32
EndTime = jResp.IntOf("EntityRecognizerProperties.EndTime")
Dim EntityRecognizerArn As String
EntityRecognizerArn = jResp.StringOf("EntityRecognizerProperties.EntityRecognizerArn")
Dim S3Uri As String
S3Uri = jResp.StringOf("EntityRecognizerProperties.InputDataConfig.Annotations.S3Uri")
Dim TestS3Uri As String
TestS3Uri = jResp.StringOf("EntityRecognizerProperties.InputDataConfig.Annotations.TestS3Uri")
Dim DataFormat As String
DataFormat = jResp.StringOf("EntityRecognizerProperties.InputDataConfig.DataFormat")
Dim InputFormat As String
InputFormat = jResp.StringOf("EntityRecognizerProperties.InputDataConfig.Documents.InputFormat")
Dim DocumentsS3Uri As String
DocumentsS3Uri = jResp.StringOf("EntityRecognizerProperties.InputDataConfig.Documents.S3Uri")
Dim DocumentsTestS3Uri As String
DocumentsTestS3Uri = jResp.StringOf("EntityRecognizerProperties.InputDataConfig.Documents.TestS3Uri")
Dim EntityListS3Uri As String
EntityListS3Uri = jResp.StringOf("EntityRecognizerProperties.InputDataConfig.EntityList.S3Uri")
Dim LanguageCode As String
LanguageCode = jResp.StringOf("EntityRecognizerProperties.LanguageCode")
Dim Message As String
Message = jResp.StringOf("EntityRecognizerProperties.Message")
Dim ModelKmsKeyId As String
ModelKmsKeyId = jResp.StringOf("EntityRecognizerProperties.ModelKmsKeyId")
Dim F1Score As Int32
F1Score = jResp.IntOf("EntityRecognizerProperties.RecognizerMetadata.EvaluationMetrics.F1Score")
Dim Precision As Int32
Precision = jResp.IntOf("EntityRecognizerProperties.RecognizerMetadata.EvaluationMetrics.Precision")
Dim Recall As Int32
Recall = jResp.IntOf("EntityRecognizerProperties.RecognizerMetadata.EvaluationMetrics.Recall")
Dim NumberOfTestDocuments As Int32
NumberOfTestDocuments = jResp.IntOf("EntityRecognizerProperties.RecognizerMetadata.NumberOfTestDocuments")
Dim NumberOfTrainedDocuments As Int32
NumberOfTrainedDocuments = jResp.IntOf("EntityRecognizerProperties.RecognizerMetadata.NumberOfTrainedDocuments")
Dim SourceModelArn As String
SourceModelArn = jResp.StringOf("EntityRecognizerProperties.SourceModelArn")
Dim Status As String
Status = jResp.StringOf("EntityRecognizerProperties.Status")
Dim SubmitTime As Int32
SubmitTime = jResp.IntOf("EntityRecognizerProperties.SubmitTime")
Dim TrainingEndTime As Int32
TrainingEndTime = jResp.IntOf("EntityRecognizerProperties.TrainingEndTime")
Dim TrainingStartTime As Int32
TrainingStartTime = jResp.IntOf("EntityRecognizerProperties.TrainingStartTime")
Dim VersionName As String
VersionName = jResp.StringOf("EntityRecognizerProperties.VersionName")
Dim VolumeKmsKeyId As String
VolumeKmsKeyId = jResp.StringOf("EntityRecognizerProperties.VolumeKmsKeyId")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = 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
Wend
i = i + 1
Wend
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
Wend
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
Wend
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
Wend
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
Wend
// 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"
// ]
// }
// }
// }
