DescribeEntityRecognizer Node.js Example
var os = require('os');
if (os.platform() == 'win32') {
if (os.arch() == 'ia32') {
var chilkat = require('@chilkat/ck-node17-win-ia32');
} else {
var chilkat = require('@chilkat/ck-node17-win64');
}
} else if (os.platform() == 'linux') {
if (os.arch() == 'arm') {
var chilkat = require('@chilkat/ck-node17-arm');
} else if (os.arch() == 'x86') {
var chilkat = require('@chilkat/ck-node17-linux32');
} else {
var chilkat = require('@chilkat/ck-node17-linux64');
}
} else if (os.platform() == 'darwin') {
var chilkat = require('@chilkat/ck-node17-macosx');
}
function chilkatExample() {
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
var rest = new chilkat.Rest();
var success;
var authAws = 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) {
console.log("ConnectFailReason: " + rest.ConnectFailReason);
console.log(rest.LastErrorText);
return;
}
// 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
var json = 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");
var sbRequestBody = new chilkat.StringBuilder();
json.EmitSb(sbRequestBody);
var sbResponseBody = new chilkat.StringBuilder();
success = rest.FullRequestSb("POST","/",sbRequestBody,sbResponseBody);
if (success !== true) {
console.log(rest.LastErrorText);
return;
}
var respStatusCode = rest.ResponseStatusCode;
console.log("response status code = " + respStatusCode);
if (respStatusCode !== 200) {
console.log("Response Header:");
console.log(rest.ResponseHeader);
console.log("Response Body:");
console.log(sbResponseBody.GetAsString());
return;
}
var jResp = 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
var AnnotationDataS3Uri;
var DocumentType;
var SourceDocumentsS3Uri;
var Split;
var j;
var count_j;
var strVal;
var v_Type;
var EvaluationMetricsF1Score;
var EvaluationMetricsPrecision;
var EvaluationMetricsRecall;
var NumberOfTrainMentions;
var DataAccessRoleArn = jResp.StringOf("EntityRecognizerProperties.DataAccessRoleArn");
var EndTime = jResp.IntOf("EntityRecognizerProperties.EndTime");
var EntityRecognizerArn = jResp.StringOf("EntityRecognizerProperties.EntityRecognizerArn");
var S3Uri = jResp.StringOf("EntityRecognizerProperties.InputDataConfig.Annotations.S3Uri");
var TestS3Uri = jResp.StringOf("EntityRecognizerProperties.InputDataConfig.Annotations.TestS3Uri");
var DataFormat = jResp.StringOf("EntityRecognizerProperties.InputDataConfig.DataFormat");
var InputFormat = jResp.StringOf("EntityRecognizerProperties.InputDataConfig.Documents.InputFormat");
var DocumentsS3Uri = jResp.StringOf("EntityRecognizerProperties.InputDataConfig.Documents.S3Uri");
var DocumentsTestS3Uri = jResp.StringOf("EntityRecognizerProperties.InputDataConfig.Documents.TestS3Uri");
var EntityListS3Uri = jResp.StringOf("EntityRecognizerProperties.InputDataConfig.EntityList.S3Uri");
var LanguageCode = jResp.StringOf("EntityRecognizerProperties.LanguageCode");
var Message = jResp.StringOf("EntityRecognizerProperties.Message");
var ModelKmsKeyId = jResp.StringOf("EntityRecognizerProperties.ModelKmsKeyId");
var F1Score = jResp.IntOf("EntityRecognizerProperties.RecognizerMetadata.EvaluationMetrics.F1Score");
var Precision = jResp.IntOf("EntityRecognizerProperties.RecognizerMetadata.EvaluationMetrics.Precision");
var Recall = jResp.IntOf("EntityRecognizerProperties.RecognizerMetadata.EvaluationMetrics.Recall");
var NumberOfTestDocuments = jResp.IntOf("EntityRecognizerProperties.RecognizerMetadata.NumberOfTestDocuments");
var NumberOfTrainedDocuments = jResp.IntOf("EntityRecognizerProperties.RecognizerMetadata.NumberOfTrainedDocuments");
var SourceModelArn = jResp.StringOf("EntityRecognizerProperties.SourceModelArn");
var Status = jResp.StringOf("EntityRecognizerProperties.Status");
var SubmitTime = jResp.IntOf("EntityRecognizerProperties.SubmitTime");
var TrainingEndTime = jResp.IntOf("EntityRecognizerProperties.TrainingEndTime");
var TrainingStartTime = jResp.IntOf("EntityRecognizerProperties.TrainingStartTime");
var VersionName = jResp.StringOf("EntityRecognizerProperties.VersionName");
var VolumeKmsKeyId = jResp.StringOf("EntityRecognizerProperties.VolumeKmsKeyId");
var i = 0;
var 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;
}
i = i+1;
}
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;
}
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;
}
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;
}
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;
}
// 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"
// ]
// }
// }
// }
}
chilkatExample();
