Chilkat Tools

DescribeEntityRecognizer Powershell Example

Amazon Comprehend

Add-Type -Path "C:\chilkat\ChilkatDotNet47-9.5.0-x64\ChilkatDotNet47.dll"

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

$rest = New-Object Chilkat.Rest

$authAws = New-Object 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 -ne $true) {
    $("ConnectFailReason: " + $rest.ConnectFailReason)
    $($rest.LastErrorText)
    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 = New-Object 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")

$sbRequestBody = New-Object Chilkat.StringBuilder
$json.EmitSb($sbRequestBody)
$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $rest.FullRequestSb("POST","/",$sbRequestBody,$sbResponseBody)
if ($success -ne $true) {
    $($rest.LastErrorText)
    exit
}

$respStatusCode = $rest.ResponseStatusCode
$("response status code = " + $respStatusCode)
if ($respStatusCode -ne 200) {
    $("Response Header:")
    $($rest.ResponseHeader)
    $("Response Body:")
    $($sbResponseBody.GetAsString())
    exit
}

$jResp = New-Object 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

$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 -lt $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 -lt $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 -lt $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 -lt $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 -lt $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 -lt $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"
#       ]
#     }
#   }
# }
Chilkat Online Tools

DescribeEntityRecognizer Powershell Example

Amazon Comprehend
