Chilkat Online Tools

ListEntityRecognizers 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("Filter.RecognizerName","string");
$json->UpdateString("Filter.Status","string");
$json->UpdateInt("Filter.SubmitTimeAfter",123);
$json->UpdateInt("Filter.SubmitTimeBefore",123);
$json->UpdateInt("MaxResults",123);
$json->UpdateString("NextToken","string");

# The JSON request body created by the above code:

# {
#   "Filter": {
#     "RecognizerName": "string",
#     "Status": "string",
#     "SubmitTimeAfter": number,
#     "SubmitTimeBefore": number
#   },
#   "MaxResults": number,
#   "NextToken": "string"
# }

$rest->AddHeader("Content-Type","application/x-amz-json-1.1");
$rest->AddHeader("X-Amz-Target","Comprehend_20171127.ListEntityRecognizers");

$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

$NextToken = $jResp->stringOf("NextToken");
$i = 0;
$count_i = $jResp->SizeOfArray("EntityRecognizerPropertiesList");
while ($i < $count_i) {
    $jResp->put_I($i);
    $DataAccessRoleArn = $jResp->stringOf("EntityRecognizerPropertiesList[i].DataAccessRoleArn");
    $EndTime = $jResp->IntOf("EntityRecognizerPropertiesList[i].EndTime");
    $EntityRecognizerArn = $jResp->stringOf("EntityRecognizerPropertiesList[i].EntityRecognizerArn");
    $S3Uri = $jResp->stringOf("EntityRecognizerPropertiesList[i].InputDataConfig.Annotations.S3Uri");
    $TestS3Uri = $jResp->stringOf("EntityRecognizerPropertiesList[i].InputDataConfig.Annotations.TestS3Uri");
    $DataFormat = $jResp->stringOf("EntityRecognizerPropertiesList[i].InputDataConfig.DataFormat");
    $InputFormat = $jResp->stringOf("EntityRecognizerPropertiesList[i].InputDataConfig.Documents.InputFormat");
    $DocumentsS3Uri = $jResp->stringOf("EntityRecognizerPropertiesList[i].InputDataConfig.Documents.S3Uri");
    $DocumentsTestS3Uri = $jResp->stringOf("EntityRecognizerPropertiesList[i].InputDataConfig.Documents.TestS3Uri");
    $EntityListS3Uri = $jResp->stringOf("EntityRecognizerPropertiesList[i].InputDataConfig.EntityList.S3Uri");
    $LanguageCode = $jResp->stringOf("EntityRecognizerPropertiesList[i].LanguageCode");
    $Message = $jResp->stringOf("EntityRecognizerPropertiesList[i].Message");
    $ModelKmsKeyId = $jResp->stringOf("EntityRecognizerPropertiesList[i].ModelKmsKeyId");
    $F1Score = $jResp->IntOf("EntityRecognizerPropertiesList[i].RecognizerMetadata.EvaluationMetrics.F1Score");
    $Precision = $jResp->IntOf("EntityRecognizerPropertiesList[i].RecognizerMetadata.EvaluationMetrics.Precision");
    $Recall = $jResp->IntOf("EntityRecognizerPropertiesList[i].RecognizerMetadata.EvaluationMetrics.Recall");
    $NumberOfTestDocuments = $jResp->IntOf("EntityRecognizerPropertiesList[i].RecognizerMetadata.NumberOfTestDocuments");
    $NumberOfTrainedDocuments = $jResp->IntOf("EntityRecognizerPropertiesList[i].RecognizerMetadata.NumberOfTrainedDocuments");
    $SourceModelArn = $jResp->stringOf("EntityRecognizerPropertiesList[i].SourceModelArn");
    $Status = $jResp->stringOf("EntityRecognizerPropertiesList[i].Status");
    $SubmitTime = $jResp->IntOf("EntityRecognizerPropertiesList[i].SubmitTime");
    $TrainingEndTime = $jResp->IntOf("EntityRecognizerPropertiesList[i].TrainingEndTime");
    $TrainingStartTime = $jResp->IntOf("EntityRecognizerPropertiesList[i].TrainingStartTime");
    $VersionName = $jResp->stringOf("EntityRecognizerPropertiesList[i].VersionName");
    $VolumeKmsKeyId = $jResp->stringOf("EntityRecognizerPropertiesList[i].VolumeKmsKeyId");
    $j = 0;
    $count_j = $jResp->SizeOfArray("EntityRecognizerPropertiesList[i].InputDataConfig.AugmentedManifests");
    while ($j < $count_j) {
        $jResp->put_J($j);
        $AnnotationDataS3Uri = $jResp->stringOf("EntityRecognizerPropertiesList[i].InputDataConfig.AugmentedManifests[j].AnnotationDataS3Uri");
        $DocumentType = $jResp->stringOf("EntityRecognizerPropertiesList[i].InputDataConfig.AugmentedManifests[j].DocumentType");
        $S3Uri = $jResp->stringOf("EntityRecognizerPropertiesList[i].InputDataConfig.AugmentedManifests[j].S3Uri");
        $SourceDocumentsS3Uri = $jResp->stringOf("EntityRecognizerPropertiesList[i].InputDataConfig.AugmentedManifests[j].SourceDocumentsS3Uri");
        $Split = $jResp->stringOf("EntityRecognizerPropertiesList[i].InputDataConfig.AugmentedManifests[j].Split");
        $k = 0;
        $count_k = $jResp->SizeOfArray("EntityRecognizerPropertiesList[i].InputDataConfig.AugmentedManifests[j].AttributeNames");
        while ($k < $count_k) {
            $jResp->put_K($k);
            $strVal = $jResp->stringOf("EntityRecognizerPropertiesList[i].InputDataConfig.AugmentedManifests[j].AttributeNames[k]");
            $k = $k + 1;
        }

        $j = $j + 1;
    }

    $j = 0;
    $count_j = $jResp->SizeOfArray("EntityRecognizerPropertiesList[i].InputDataConfig.EntityTypes");
    while ($j < $count_j) {
        $jResp->put_J($j);
        $v_Type = $jResp->stringOf("EntityRecognizerPropertiesList[i].InputDataConfig.EntityTypes[j].Type");
        $j = $j + 1;
    }

    $j = 0;
    $count_j = $jResp->SizeOfArray("EntityRecognizerPropertiesList[i].RecognizerMetadata.EntityTypes");
    while ($j < $count_j) {
        $jResp->put_J($j);
        $EvaluationMetricsF1Score = $jResp->IntOf("EntityRecognizerPropertiesList[i].RecognizerMetadata.EntityTypes[j].EvaluationMetrics.F1Score");
        $EvaluationMetricsPrecision = $jResp->IntOf("EntityRecognizerPropertiesList[i].RecognizerMetadata.EntityTypes[j].EvaluationMetrics.Precision");
        $EvaluationMetricsRecall = $jResp->IntOf("EntityRecognizerPropertiesList[i].RecognizerMetadata.EntityTypes[j].EvaluationMetrics.Recall");
        $NumberOfTrainMentions = $jResp->IntOf("EntityRecognizerPropertiesList[i].RecognizerMetadata.EntityTypes[j].NumberOfTrainMentions");
        $v_Type = $jResp->stringOf("EntityRecognizerPropertiesList[i].RecognizerMetadata.EntityTypes[j].Type");
        $j = $j + 1;
    }

    $j = 0;
    $count_j = $jResp->SizeOfArray("EntityRecognizerPropertiesList[i].VpcConfig.SecurityGroupIds");
    while ($j < $count_j) {
        $jResp->put_J($j);
        $strVal = $jResp->stringOf("EntityRecognizerPropertiesList[i].VpcConfig.SecurityGroupIds[j]");
        $j = $j + 1;
    }

    $j = 0;
    $count_j = $jResp->SizeOfArray("EntityRecognizerPropertiesList[i].VpcConfig.Subnets");
    while ($j < $count_j) {
        $jResp->put_J($j);
        $strVal = $jResp->stringOf("EntityRecognizerPropertiesList[i].VpcConfig.Subnets[j]");
        $j = $j + 1;
    }

    $i = $i + 1;
}

# A sample JSON response body parsed by the above code:

# {
#   "EntityRecognizerPropertiesList": [
#     {
#       "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"
#         ]
#       }
#     }
#   ],
#   "NextToken": "string"
# }