Chilkat Online Tools

DescribeEntityRecognizer Unicode C Example

Amazon Comprehend

#include <C_CkRestW.h>
#include <C_CkAuthAwsW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkStringBuilderW.h>

void ChilkatSample(void)
    {
    HCkRestW rest;
    BOOL success;
    HCkAuthAwsW authAws;
    HCkJsonObjectW json;
    HCkStringBuilderW sbRequestBody;
    HCkStringBuilderW sbResponseBody;
    int respStatusCode;
    HCkJsonObjectW jResp;
    const wchar_t *AnnotationDataS3Uri;
    const wchar_t *DocumentType;
    const wchar_t *SourceDocumentsS3Uri;
    const wchar_t *Split;
    int j;
    int count_j;
    const wchar_t *strVal;
    const wchar_t *v_Type;
    int EvaluationMetricsF1Score;
    int EvaluationMetricsPrecision;
    int EvaluationMetricsRecall;
    int NumberOfTrainMentions;
    const wchar_t *DataAccessRoleArn;
    int EndTime;
    const wchar_t *EntityRecognizerArn;
    const wchar_t *S3Uri;
    const wchar_t *TestS3Uri;
    const wchar_t *DataFormat;
    const wchar_t *InputFormat;
    const wchar_t *DocumentsS3Uri;
    const wchar_t *DocumentsTestS3Uri;
    const wchar_t *EntityListS3Uri;
    const wchar_t *LanguageCode;
    const wchar_t *Message;
    const wchar_t *ModelKmsKeyId;
    int F1Score;
    int Precision;
    int Recall;
    int NumberOfTestDocuments;
    int NumberOfTrainedDocuments;
    const wchar_t *SourceModelArn;
    const wchar_t *Status;
    int SubmitTime;
    int TrainingEndTime;
    int TrainingStartTime;
    const wchar_t *VersionName;
    const wchar_t *VolumeKmsKeyId;
    int i;
    int count_i;

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

    rest = CkRestW_Create();

    authAws = CkAuthAwsW_Create();
    CkAuthAwsW_putAccessKey(authAws,L"AWS_ACCESS_KEY");
    CkAuthAwsW_putSecretKey(authAws,L"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.)
    CkAuthAwsW_putRegion(authAws,L"us-west-2");
    CkAuthAwsW_putServiceName(authAws,L"comprehend");
    // SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
    CkRestW_SetAuthAws(rest,authAws);

    // URL: https://comprehend.us-west-2.amazonaws.com/
    // Use the same region as specified above.
    success = CkRestW_Connect(rest,L"comprehend.us-west-2.amazonaws.com",443,TRUE,TRUE);
    if (success != TRUE) {
        wprintf(L"ConnectFailReason: %d\n",CkRestW_getConnectFailReason(rest));
        wprintf(L"%s\n",CkRestW_lastErrorText(rest));
        CkRestW_Dispose(rest);
        CkAuthAwsW_Dispose(authAws);
        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

    json = CkJsonObjectW_Create();
    CkJsonObjectW_UpdateString(json,L"EntityRecognizerArn",L"string");

    // The JSON request body created by the above code:

    // {
    //   "EntityRecognizerArn": "string"
    // }

    CkRestW_AddHeader(rest,L"Content-Type",L"application/x-amz-json-1.1");
    CkRestW_AddHeader(rest,L"X-Amz-Target",L"Comprehend_20171127.DescribeEntityRecognizer");

    sbRequestBody = CkStringBuilderW_Create();
    CkJsonObjectW_EmitSb(json,sbRequestBody);
    sbResponseBody = CkStringBuilderW_Create();
    success = CkRestW_FullRequestSb(rest,L"POST",L"/",sbRequestBody,sbResponseBody);
    if (success != TRUE) {
        wprintf(L"%s\n",CkRestW_lastErrorText(rest));
        CkRestW_Dispose(rest);
        CkAuthAwsW_Dispose(authAws);
        CkJsonObjectW_Dispose(json);
        CkStringBuilderW_Dispose(sbRequestBody);
        CkStringBuilderW_Dispose(sbResponseBody);
        return;
    }

    respStatusCode = CkRestW_getResponseStatusCode(rest);
    wprintf(L"response status code = %d\n",respStatusCode);
    if (respStatusCode != 200) {
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",CkRestW_responseHeader(rest));
        wprintf(L"Response Body:\n");
        wprintf(L"%s\n",CkStringBuilderW_getAsString(sbResponseBody));
        CkRestW_Dispose(rest);
        CkAuthAwsW_Dispose(authAws);
        CkJsonObjectW_Dispose(json);
        CkStringBuilderW_Dispose(sbRequestBody);
        CkStringBuilderW_Dispose(sbResponseBody);
        return;
    }

    jResp = CkJsonObjectW_Create();
    CkJsonObjectW_LoadSb(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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
    // See this example explaining how this memory should be used: const char * functions.

    DataAccessRoleArn = CkJsonObjectW_stringOf(jResp,L"EntityRecognizerProperties.DataAccessRoleArn");
    EndTime = CkJsonObjectW_IntOf(jResp,L"EntityRecognizerProperties.EndTime");
    EntityRecognizerArn = CkJsonObjectW_stringOf(jResp,L"EntityRecognizerProperties.EntityRecognizerArn");
    S3Uri = CkJsonObjectW_stringOf(jResp,L"EntityRecognizerProperties.InputDataConfig.Annotations.S3Uri");
    TestS3Uri = CkJsonObjectW_stringOf(jResp,L"EntityRecognizerProperties.InputDataConfig.Annotations.TestS3Uri");
    DataFormat = CkJsonObjectW_stringOf(jResp,L"EntityRecognizerProperties.InputDataConfig.DataFormat");
    InputFormat = CkJsonObjectW_stringOf(jResp,L"EntityRecognizerProperties.InputDataConfig.Documents.InputFormat");
    DocumentsS3Uri = CkJsonObjectW_stringOf(jResp,L"EntityRecognizerProperties.InputDataConfig.Documents.S3Uri");
    DocumentsTestS3Uri = CkJsonObjectW_stringOf(jResp,L"EntityRecognizerProperties.InputDataConfig.Documents.TestS3Uri");
    EntityListS3Uri = CkJsonObjectW_stringOf(jResp,L"EntityRecognizerProperties.InputDataConfig.EntityList.S3Uri");
    LanguageCode = CkJsonObjectW_stringOf(jResp,L"EntityRecognizerProperties.LanguageCode");
    Message = CkJsonObjectW_stringOf(jResp,L"EntityRecognizerProperties.Message");
    ModelKmsKeyId = CkJsonObjectW_stringOf(jResp,L"EntityRecognizerProperties.ModelKmsKeyId");
    F1Score = CkJsonObjectW_IntOf(jResp,L"EntityRecognizerProperties.RecognizerMetadata.EvaluationMetrics.F1Score");
    Precision = CkJsonObjectW_IntOf(jResp,L"EntityRecognizerProperties.RecognizerMetadata.EvaluationMetrics.Precision");
    Recall = CkJsonObjectW_IntOf(jResp,L"EntityRecognizerProperties.RecognizerMetadata.EvaluationMetrics.Recall");
    NumberOfTestDocuments = CkJsonObjectW_IntOf(jResp,L"EntityRecognizerProperties.RecognizerMetadata.NumberOfTestDocuments");
    NumberOfTrainedDocuments = CkJsonObjectW_IntOf(jResp,L"EntityRecognizerProperties.RecognizerMetadata.NumberOfTrainedDocuments");
    SourceModelArn = CkJsonObjectW_stringOf(jResp,L"EntityRecognizerProperties.SourceModelArn");
    Status = CkJsonObjectW_stringOf(jResp,L"EntityRecognizerProperties.Status");
    SubmitTime = CkJsonObjectW_IntOf(jResp,L"EntityRecognizerProperties.SubmitTime");
    TrainingEndTime = CkJsonObjectW_IntOf(jResp,L"EntityRecognizerProperties.TrainingEndTime");
    TrainingStartTime = CkJsonObjectW_IntOf(jResp,L"EntityRecognizerProperties.TrainingStartTime");
    VersionName = CkJsonObjectW_stringOf(jResp,L"EntityRecognizerProperties.VersionName");
    VolumeKmsKeyId = CkJsonObjectW_stringOf(jResp,L"EntityRecognizerProperties.VolumeKmsKeyId");
    i = 0;
    count_i = CkJsonObjectW_SizeOfArray(jResp,L"EntityRecognizerProperties.InputDataConfig.AugmentedManifests");
    while (i < count_i) {
        CkJsonObjectW_putI(jResp,i);
        AnnotationDataS3Uri = CkJsonObjectW_stringOf(jResp,L"EntityRecognizerProperties.InputDataConfig.AugmentedManifests[i].AnnotationDataS3Uri");
        DocumentType = CkJsonObjectW_stringOf(jResp,L"EntityRecognizerProperties.InputDataConfig.AugmentedManifests[i].DocumentType");
        S3Uri = CkJsonObjectW_stringOf(jResp,L"EntityRecognizerProperties.InputDataConfig.AugmentedManifests[i].S3Uri");
        SourceDocumentsS3Uri = CkJsonObjectW_stringOf(jResp,L"EntityRecognizerProperties.InputDataConfig.AugmentedManifests[i].SourceDocumentsS3Uri");
        Split = CkJsonObjectW_stringOf(jResp,L"EntityRecognizerProperties.InputDataConfig.AugmentedManifests[i].Split");
        j = 0;
        count_j = CkJsonObjectW_SizeOfArray(jResp,L"EntityRecognizerProperties.InputDataConfig.AugmentedManifests[i].AttributeNames");
        while (j < count_j) {
            CkJsonObjectW_putJ(jResp,j);
            strVal = CkJsonObjectW_stringOf(jResp,L"EntityRecognizerProperties.InputDataConfig.AugmentedManifests[i].AttributeNames[j]");
            j = j + 1;
        }

        i = i + 1;
    }

    i = 0;
    count_i = CkJsonObjectW_SizeOfArray(jResp,L"EntityRecognizerProperties.InputDataConfig.EntityTypes");
    while (i < count_i) {
        CkJsonObjectW_putI(jResp,i);
        v_Type = CkJsonObjectW_stringOf(jResp,L"EntityRecognizerProperties.InputDataConfig.EntityTypes[i].Type");
        i = i + 1;
    }

    i = 0;
    count_i = CkJsonObjectW_SizeOfArray(jResp,L"EntityRecognizerProperties.RecognizerMetadata.EntityTypes");
    while (i < count_i) {
        CkJsonObjectW_putI(jResp,i);
        EvaluationMetricsF1Score = CkJsonObjectW_IntOf(jResp,L"EntityRecognizerProperties.RecognizerMetadata.EntityTypes[i].EvaluationMetrics.F1Score");
        EvaluationMetricsPrecision = CkJsonObjectW_IntOf(jResp,L"EntityRecognizerProperties.RecognizerMetadata.EntityTypes[i].EvaluationMetrics.Precision");
        EvaluationMetricsRecall = CkJsonObjectW_IntOf(jResp,L"EntityRecognizerProperties.RecognizerMetadata.EntityTypes[i].EvaluationMetrics.Recall");
        NumberOfTrainMentions = CkJsonObjectW_IntOf(jResp,L"EntityRecognizerProperties.RecognizerMetadata.EntityTypes[i].NumberOfTrainMentions");
        v_Type = CkJsonObjectW_stringOf(jResp,L"EntityRecognizerProperties.RecognizerMetadata.EntityTypes[i].Type");
        i = i + 1;
    }

    i = 0;
    count_i = CkJsonObjectW_SizeOfArray(jResp,L"EntityRecognizerProperties.VpcConfig.SecurityGroupIds");
    while (i < count_i) {
        CkJsonObjectW_putI(jResp,i);
        strVal = CkJsonObjectW_stringOf(jResp,L"EntityRecognizerProperties.VpcConfig.SecurityGroupIds[i]");
        i = i + 1;
    }

    i = 0;
    count_i = CkJsonObjectW_SizeOfArray(jResp,L"EntityRecognizerProperties.VpcConfig.Subnets");
    while (i < count_i) {
        CkJsonObjectW_putI(jResp,i);
        strVal = CkJsonObjectW_stringOf(jResp,L"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"
    //       ]
    //     }
    //   }
    // }


    CkRestW_Dispose(rest);
    CkAuthAwsW_Dispose(authAws);
    CkJsonObjectW_Dispose(json);
    CkStringBuilderW_Dispose(sbRequestBody);
    CkStringBuilderW_Dispose(sbResponseBody);
    CkJsonObjectW_Dispose(jResp);

    }