Chilkat Online Tools

DescribeEntityRecognizer Perl Example

Amazon Comprehend

use chilkat();

# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

$rest = chilkat::CkRest->new();

$authAws = chilkat::CkAuthAws->new();
$authAws->put_AccessKey("AWS_ACCESS_KEY");
$authAws->put_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->put_Region("us-west-2");
$authAws->put_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,1,1);
if ($success != 1) {
    print "ConnectFailReason: " . $rest->get_ConnectFailReason() . "\r\n";
    print $rest->lastErrorText() . "\r\n";
    exit;
}

# 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

$json = chilkat::CkJsonObject->new();
$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");

$sbRequestBody = chilkat::CkStringBuilder->new();
$json->EmitSb($sbRequestBody);
$sbResponseBody = chilkat::CkStringBuilder->new();
$success = $rest->FullRequestSb("POST","/",$sbRequestBody,$sbResponseBody);
if ($success != 1) {
    print $rest->lastErrorText() . "\r\n";
    exit;
}

$respStatusCode = $rest->get_ResponseStatusCode();
print "response status code = " . $respStatusCode . "\r\n";
if ($respStatusCode != 200) {
    print "Response Header:" . "\r\n";
    print $rest->responseHeader() . "\r\n";
    print "Response Body:" . "\r\n";
    print $sbResponseBody->getAsString() . "\r\n";
    exit;
}

$jResp = chilkat::CkJsonObject->new();
$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

$DataAccessRoleArn = $jResp->stringOf("EntityRecognizerProperties.DataAccessRoleArn");
$EndTime = $jResp->IntOf("EntityRecognizerProperties.EndTime");
$EntityRecognizerArn = $jResp->stringOf("EntityRecognizerProperties.EntityRecognizerArn");
$S3Uri = $jResp->stringOf("EntityRecognizerProperties.InputDataConfig.Annotations.S3Uri");
$TestS3Uri = $jResp->stringOf("EntityRecognizerProperties.InputDataConfig.Annotations.TestS3Uri");
$DataFormat = $jResp->stringOf("EntityRecognizerProperties.InputDataConfig.DataFormat");
$InputFormat = $jResp->stringOf("EntityRecognizerProperties.InputDataConfig.Documents.InputFormat");
$DocumentsS3Uri = $jResp->stringOf("EntityRecognizerProperties.InputDataConfig.Documents.S3Uri");
$DocumentsTestS3Uri = $jResp->stringOf("EntityRecognizerProperties.InputDataConfig.Documents.TestS3Uri");
$EntityListS3Uri = $jResp->stringOf("EntityRecognizerProperties.InputDataConfig.EntityList.S3Uri");
$LanguageCode = $jResp->stringOf("EntityRecognizerProperties.LanguageCode");
$Message = $jResp->stringOf("EntityRecognizerProperties.Message");
$ModelKmsKeyId = $jResp->stringOf("EntityRecognizerProperties.ModelKmsKeyId");
$F1Score = $jResp->IntOf("EntityRecognizerProperties.RecognizerMetadata.EvaluationMetrics.F1Score");
$Precision = $jResp->IntOf("EntityRecognizerProperties.RecognizerMetadata.EvaluationMetrics.Precision");
$Recall = $jResp->IntOf("EntityRecognizerProperties.RecognizerMetadata.EvaluationMetrics.Recall");
$NumberOfTestDocuments = $jResp->IntOf("EntityRecognizerProperties.RecognizerMetadata.NumberOfTestDocuments");
$NumberOfTrainedDocuments = $jResp->IntOf("EntityRecognizerProperties.RecognizerMetadata.NumberOfTrainedDocuments");
$SourceModelArn = $jResp->stringOf("EntityRecognizerProperties.SourceModelArn");
$Status = $jResp->stringOf("EntityRecognizerProperties.Status");
$SubmitTime = $jResp->IntOf("EntityRecognizerProperties.SubmitTime");
$TrainingEndTime = $jResp->IntOf("EntityRecognizerProperties.TrainingEndTime");
$TrainingStartTime = $jResp->IntOf("EntityRecognizerProperties.TrainingStartTime");
$VersionName = $jResp->stringOf("EntityRecognizerProperties.VersionName");
$VolumeKmsKeyId = $jResp->stringOf("EntityRecognizerProperties.VolumeKmsKeyId");
$i = 0;
$count_i = $jResp->SizeOfArray("EntityRecognizerProperties.InputDataConfig.AugmentedManifests");
while ($i < $count_i) {
    $jResp->put_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->put_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->put_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->put_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->put_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->put_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"
#       ]
#     }
#   }
# }