Chilkat Online Tools

ListEntityRecognizers PureBasic Example

Amazon Comprehend

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkRest.pb"
IncludeFile "CkAuthAws.pb"

Procedure ChilkatExample()

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

    rest.i = CkRest::ckCreate()
    If rest.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    authAws.i = CkAuthAws::ckCreate()
    If authAws.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkAuthAws::setCkAccessKey(authAws, "AWS_ACCESS_KEY")
    CkAuthAws::setCkSecretKey(authAws, "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.)
    CkAuthAws::setCkRegion(authAws, "us-west-2")
    CkAuthAws::setCkServiceName(authAws, "comprehend")
    ; SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
    CkRest::ckSetAuthAws(rest,authAws)

    ; URL: https://comprehend.us-west-2.amazonaws.com/
    ; Use the same region as specified above.
    success = CkRest::ckConnect(rest,"comprehend.us-west-2.amazonaws.com",443,1,1)
    If success <> 1
        Debug "ConnectFailReason: " + Str(CkRest::ckConnectFailReason(rest))
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        CkAuthAws::ckDispose(authAws)
        ProcedureReturn
    EndIf

    ; 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.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"Filter.RecognizerName","string")
    CkJsonObject::ckUpdateString(json,"Filter.Status","string")
    CkJsonObject::ckUpdateInt(json,"Filter.SubmitTimeAfter",123)
    CkJsonObject::ckUpdateInt(json,"Filter.SubmitTimeBefore",123)
    CkJsonObject::ckUpdateInt(json,"MaxResults",123)
    CkJsonObject::ckUpdateString(json,"NextToken","string")

    ; The JSON request body created by the above code:

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

    CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.1")
    CkRest::ckAddHeader(rest,"X-Amz-Target","Comprehend_20171127.ListEntityRecognizers")

    sbRequestBody.i = CkStringBuilder::ckCreate()
    If sbRequestBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckEmitSb(json,sbRequestBody)
    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkRest::ckFullRequestSb(rest,"POST","/",sbRequestBody,sbResponseBody)
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        CkAuthAws::ckDispose(authAws)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbRequestBody)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    respStatusCode.i = CkRest::ckResponseStatusCode(rest)
    Debug "response status code = " + Str(respStatusCode)
    If respStatusCode <> 200
        Debug "Response Header:"
        Debug CkRest::ckResponseHeader(rest)
        Debug "Response Body:"
        Debug CkStringBuilder::ckGetAsString(sbResponseBody)
        CkRest::ckDispose(rest)
        CkAuthAws::ckDispose(authAws)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbRequestBody)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jResp,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.s
    EndTime.i
    EntityRecognizerArn.s
    S3Uri.s
    TestS3Uri.s
    DataFormat.s
    InputFormat.s
    DocumentsS3Uri.s
    DocumentsTestS3Uri.s
    EntityListS3Uri.s
    LanguageCode.s
    Message.s
    ModelKmsKeyId.s
    F1Score.i
    Precision.i
    Recall.i
    NumberOfTestDocuments.i
    NumberOfTrainedDocuments.i
    SourceModelArn.s
    Status.s
    SubmitTime.i
    TrainingEndTime.i
    TrainingStartTime.i
    VersionName.s
    VolumeKmsKeyId.s
    j.i
    count_j.i
    AnnotationDataS3Uri.s
    DocumentType.s
    SourceDocumentsS3Uri.s
    Split.s
    k.i
    count_k.i
    strVal.s
    v_Type.s
    EvaluationMetricsF1Score.i
    EvaluationMetricsPrecision.i
    EvaluationMetricsRecall.i
    NumberOfTrainMentions.i

    NextToken.s = CkJsonObject::ckStringOf(jResp,"NextToken")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"EntityRecognizerPropertiesList")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        DataAccessRoleArn = CkJsonObject::ckStringOf(jResp,"EntityRecognizerPropertiesList[i].DataAccessRoleArn")
        EndTime = CkJsonObject::ckIntOf(jResp,"EntityRecognizerPropertiesList[i].EndTime")
        EntityRecognizerArn = CkJsonObject::ckStringOf(jResp,"EntityRecognizerPropertiesList[i].EntityRecognizerArn")
        S3Uri = CkJsonObject::ckStringOf(jResp,"EntityRecognizerPropertiesList[i].InputDataConfig.Annotations.S3Uri")
        TestS3Uri = CkJsonObject::ckStringOf(jResp,"EntityRecognizerPropertiesList[i].InputDataConfig.Annotations.TestS3Uri")
        DataFormat = CkJsonObject::ckStringOf(jResp,"EntityRecognizerPropertiesList[i].InputDataConfig.DataFormat")
        InputFormat = CkJsonObject::ckStringOf(jResp,"EntityRecognizerPropertiesList[i].InputDataConfig.Documents.InputFormat")
        DocumentsS3Uri = CkJsonObject::ckStringOf(jResp,"EntityRecognizerPropertiesList[i].InputDataConfig.Documents.S3Uri")
        DocumentsTestS3Uri = CkJsonObject::ckStringOf(jResp,"EntityRecognizerPropertiesList[i].InputDataConfig.Documents.TestS3Uri")
        EntityListS3Uri = CkJsonObject::ckStringOf(jResp,"EntityRecognizerPropertiesList[i].InputDataConfig.EntityList.S3Uri")
        LanguageCode = CkJsonObject::ckStringOf(jResp,"EntityRecognizerPropertiesList[i].LanguageCode")
        Message = CkJsonObject::ckStringOf(jResp,"EntityRecognizerPropertiesList[i].Message")
        ModelKmsKeyId = CkJsonObject::ckStringOf(jResp,"EntityRecognizerPropertiesList[i].ModelKmsKeyId")
        F1Score = CkJsonObject::ckIntOf(jResp,"EntityRecognizerPropertiesList[i].RecognizerMetadata.EvaluationMetrics.F1Score")
        Precision = CkJsonObject::ckIntOf(jResp,"EntityRecognizerPropertiesList[i].RecognizerMetadata.EvaluationMetrics.Precision")
        Recall = CkJsonObject::ckIntOf(jResp,"EntityRecognizerPropertiesList[i].RecognizerMetadata.EvaluationMetrics.Recall")
        NumberOfTestDocuments = CkJsonObject::ckIntOf(jResp,"EntityRecognizerPropertiesList[i].RecognizerMetadata.NumberOfTestDocuments")
        NumberOfTrainedDocuments = CkJsonObject::ckIntOf(jResp,"EntityRecognizerPropertiesList[i].RecognizerMetadata.NumberOfTrainedDocuments")
        SourceModelArn = CkJsonObject::ckStringOf(jResp,"EntityRecognizerPropertiesList[i].SourceModelArn")
        Status = CkJsonObject::ckStringOf(jResp,"EntityRecognizerPropertiesList[i].Status")
        SubmitTime = CkJsonObject::ckIntOf(jResp,"EntityRecognizerPropertiesList[i].SubmitTime")
        TrainingEndTime = CkJsonObject::ckIntOf(jResp,"EntityRecognizerPropertiesList[i].TrainingEndTime")
        TrainingStartTime = CkJsonObject::ckIntOf(jResp,"EntityRecognizerPropertiesList[i].TrainingStartTime")
        VersionName = CkJsonObject::ckStringOf(jResp,"EntityRecognizerPropertiesList[i].VersionName")
        VolumeKmsKeyId = CkJsonObject::ckStringOf(jResp,"EntityRecognizerPropertiesList[i].VolumeKmsKeyId")
        j = 0
        count_j = CkJsonObject::ckSizeOfArray(jResp,"EntityRecognizerPropertiesList[i].InputDataConfig.AugmentedManifests")
        While j < count_j
            CkJsonObject::setCkJ(jResp, j)
            AnnotationDataS3Uri = CkJsonObject::ckStringOf(jResp,"EntityRecognizerPropertiesList[i].InputDataConfig.AugmentedManifests[j].AnnotationDataS3Uri")
            DocumentType = CkJsonObject::ckStringOf(jResp,"EntityRecognizerPropertiesList[i].InputDataConfig.AugmentedManifests[j].DocumentType")
            S3Uri = CkJsonObject::ckStringOf(jResp,"EntityRecognizerPropertiesList[i].InputDataConfig.AugmentedManifests[j].S3Uri")
            SourceDocumentsS3Uri = CkJsonObject::ckStringOf(jResp,"EntityRecognizerPropertiesList[i].InputDataConfig.AugmentedManifests[j].SourceDocumentsS3Uri")
            Split = CkJsonObject::ckStringOf(jResp,"EntityRecognizerPropertiesList[i].InputDataConfig.AugmentedManifests[j].Split")
            k = 0
            count_k = CkJsonObject::ckSizeOfArray(jResp,"EntityRecognizerPropertiesList[i].InputDataConfig.AugmentedManifests[j].AttributeNames")
            While k < count_k
                CkJsonObject::setCkK(jResp, k)
                strVal = CkJsonObject::ckStringOf(jResp,"EntityRecognizerPropertiesList[i].InputDataConfig.AugmentedManifests[j].AttributeNames[k]")
                k = k + 1
            Wend
            j = j + 1
        Wend
        j = 0
        count_j = CkJsonObject::ckSizeOfArray(jResp,"EntityRecognizerPropertiesList[i].InputDataConfig.EntityTypes")
        While j < count_j
            CkJsonObject::setCkJ(jResp, j)
            v_Type = CkJsonObject::ckStringOf(jResp,"EntityRecognizerPropertiesList[i].InputDataConfig.EntityTypes[j].Type")
            j = j + 1
        Wend
        j = 0
        count_j = CkJsonObject::ckSizeOfArray(jResp,"EntityRecognizerPropertiesList[i].RecognizerMetadata.EntityTypes")
        While j < count_j
            CkJsonObject::setCkJ(jResp, j)
            EvaluationMetricsF1Score = CkJsonObject::ckIntOf(jResp,"EntityRecognizerPropertiesList[i].RecognizerMetadata.EntityTypes[j].EvaluationMetrics.F1Score")
            EvaluationMetricsPrecision = CkJsonObject::ckIntOf(jResp,"EntityRecognizerPropertiesList[i].RecognizerMetadata.EntityTypes[j].EvaluationMetrics.Precision")
            EvaluationMetricsRecall = CkJsonObject::ckIntOf(jResp,"EntityRecognizerPropertiesList[i].RecognizerMetadata.EntityTypes[j].EvaluationMetrics.Recall")
            NumberOfTrainMentions = CkJsonObject::ckIntOf(jResp,"EntityRecognizerPropertiesList[i].RecognizerMetadata.EntityTypes[j].NumberOfTrainMentions")
            v_Type = CkJsonObject::ckStringOf(jResp,"EntityRecognizerPropertiesList[i].RecognizerMetadata.EntityTypes[j].Type")
            j = j + 1
        Wend
        j = 0
        count_j = CkJsonObject::ckSizeOfArray(jResp,"EntityRecognizerPropertiesList[i].VpcConfig.SecurityGroupIds")
        While j < count_j
            CkJsonObject::setCkJ(jResp, j)
            strVal = CkJsonObject::ckStringOf(jResp,"EntityRecognizerPropertiesList[i].VpcConfig.SecurityGroupIds[j]")
            j = j + 1
        Wend
        j = 0
        count_j = CkJsonObject::ckSizeOfArray(jResp,"EntityRecognizerPropertiesList[i].VpcConfig.Subnets")
        While j < count_j
            CkJsonObject::setCkJ(jResp, j)
            strVal = CkJsonObject::ckStringOf(jResp,"EntityRecognizerPropertiesList[i].VpcConfig.Subnets[j]")
            j = j + 1
        Wend
        i = i + 1
    Wend

    ; 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"
    ; }


    CkRest::ckDispose(rest)
    CkAuthAws::ckDispose(authAws)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbRequestBody)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure