Chilkat Online Tools

DescribeEntityRecognizer C Example

Amazon Comprehend

#include <C_CkRest.h>
#include <C_CkAuthAws.h>
#include <C_CkJsonObject.h>
#include <C_CkStringBuilder.h>

void ChilkatSample(void)
    {
    HCkRest rest;
    BOOL success;
    HCkAuthAws authAws;
    HCkJsonObject json;
    HCkStringBuilder sbRequestBody;
    HCkStringBuilder sbResponseBody;
    int respStatusCode;
    HCkJsonObject jResp;
    const char *AnnotationDataS3Uri;
    const char *DocumentType;
    const char *SourceDocumentsS3Uri;
    const char *Split;
    int j;
    int count_j;
    const char *strVal;
    const char *v_Type;
    int EvaluationMetricsF1Score;
    int EvaluationMetricsPrecision;
    int EvaluationMetricsRecall;
    int NumberOfTrainMentions;
    const char *DataAccessRoleArn;
    int EndTime;
    const char *EntityRecognizerArn;
    const char *S3Uri;
    const char *TestS3Uri;
    const char *DataFormat;
    const char *InputFormat;
    const char *DocumentsS3Uri;
    const char *DocumentsTestS3Uri;
    const char *EntityListS3Uri;
    const char *LanguageCode;
    const char *Message;
    const char *ModelKmsKeyId;
    int F1Score;
    int Precision;
    int Recall;
    int NumberOfTestDocuments;
    int NumberOfTrainedDocuments;
    const char *SourceModelArn;
    const char *Status;
    int SubmitTime;
    int TrainingEndTime;
    int TrainingStartTime;
    const char *VersionName;
    const char *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 = CkRest_Create();

    authAws = CkAuthAws_Create();
    CkAuthAws_putAccessKey(authAws,"AWS_ACCESS_KEY");
    CkAuthAws_putSecretKey(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_putRegion(authAws,"us-west-2");
    CkAuthAws_putServiceName(authAws,"comprehend");
    // SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
    CkRest_SetAuthAws(rest,authAws);

    // URL: https://comprehend.us-west-2.amazonaws.com/
    // Use the same region as specified above.
    success = CkRest_Connect(rest,"comprehend.us-west-2.amazonaws.com",443,TRUE,TRUE);
    if (success != TRUE) {
        printf("ConnectFailReason: %d\n",CkRest_getConnectFailReason(rest));
        printf("%s\n",CkRest_lastErrorText(rest));
        CkRest_Dispose(rest);
        CkAuthAws_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 = CkJsonObject_Create();
    CkJsonObject_UpdateString(json,"EntityRecognizerArn","string");

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

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

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

    sbRequestBody = CkStringBuilder_Create();
    CkJsonObject_EmitSb(json,sbRequestBody);
    sbResponseBody = CkStringBuilder_Create();
    success = CkRest_FullRequestSb(rest,"POST","/",sbRequestBody,sbResponseBody);
    if (success != TRUE) {
        printf("%s\n",CkRest_lastErrorText(rest));
        CkRest_Dispose(rest);
        CkAuthAws_Dispose(authAws);
        CkJsonObject_Dispose(json);
        CkStringBuilder_Dispose(sbRequestBody);
        CkStringBuilder_Dispose(sbResponseBody);
        return;
    }

    respStatusCode = CkRest_getResponseStatusCode(rest);
    printf("response status code = %d\n",respStatusCode);
    if (respStatusCode != 200) {
        printf("Response Header:\n");
        printf("%s\n",CkRest_responseHeader(rest));
        printf("Response Body:\n");
        printf("%s\n",CkStringBuilder_getAsString(sbResponseBody));
        CkRest_Dispose(rest);
        CkAuthAws_Dispose(authAws);
        CkJsonObject_Dispose(json);
        CkStringBuilder_Dispose(sbRequestBody);
        CkStringBuilder_Dispose(sbResponseBody);
        return;
    }

    jResp = CkJsonObject_Create();
    CkJsonObject_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 = CkJsonObject_stringOf(jResp,"EntityRecognizerProperties.DataAccessRoleArn");
    EndTime = CkJsonObject_IntOf(jResp,"EntityRecognizerProperties.EndTime");
    EntityRecognizerArn = CkJsonObject_stringOf(jResp,"EntityRecognizerProperties.EntityRecognizerArn");
    S3Uri = CkJsonObject_stringOf(jResp,"EntityRecognizerProperties.InputDataConfig.Annotations.S3Uri");
    TestS3Uri = CkJsonObject_stringOf(jResp,"EntityRecognizerProperties.InputDataConfig.Annotations.TestS3Uri");
    DataFormat = CkJsonObject_stringOf(jResp,"EntityRecognizerProperties.InputDataConfig.DataFormat");
    InputFormat = CkJsonObject_stringOf(jResp,"EntityRecognizerProperties.InputDataConfig.Documents.InputFormat");
    DocumentsS3Uri = CkJsonObject_stringOf(jResp,"EntityRecognizerProperties.InputDataConfig.Documents.S3Uri");
    DocumentsTestS3Uri = CkJsonObject_stringOf(jResp,"EntityRecognizerProperties.InputDataConfig.Documents.TestS3Uri");
    EntityListS3Uri = CkJsonObject_stringOf(jResp,"EntityRecognizerProperties.InputDataConfig.EntityList.S3Uri");
    LanguageCode = CkJsonObject_stringOf(jResp,"EntityRecognizerProperties.LanguageCode");
    Message = CkJsonObject_stringOf(jResp,"EntityRecognizerProperties.Message");
    ModelKmsKeyId = CkJsonObject_stringOf(jResp,"EntityRecognizerProperties.ModelKmsKeyId");
    F1Score = CkJsonObject_IntOf(jResp,"EntityRecognizerProperties.RecognizerMetadata.EvaluationMetrics.F1Score");
    Precision = CkJsonObject_IntOf(jResp,"EntityRecognizerProperties.RecognizerMetadata.EvaluationMetrics.Precision");
    Recall = CkJsonObject_IntOf(jResp,"EntityRecognizerProperties.RecognizerMetadata.EvaluationMetrics.Recall");
    NumberOfTestDocuments = CkJsonObject_IntOf(jResp,"EntityRecognizerProperties.RecognizerMetadata.NumberOfTestDocuments");
    NumberOfTrainedDocuments = CkJsonObject_IntOf(jResp,"EntityRecognizerProperties.RecognizerMetadata.NumberOfTrainedDocuments");
    SourceModelArn = CkJsonObject_stringOf(jResp,"EntityRecognizerProperties.SourceModelArn");
    Status = CkJsonObject_stringOf(jResp,"EntityRecognizerProperties.Status");
    SubmitTime = CkJsonObject_IntOf(jResp,"EntityRecognizerProperties.SubmitTime");
    TrainingEndTime = CkJsonObject_IntOf(jResp,"EntityRecognizerProperties.TrainingEndTime");
    TrainingStartTime = CkJsonObject_IntOf(jResp,"EntityRecognizerProperties.TrainingStartTime");
    VersionName = CkJsonObject_stringOf(jResp,"EntityRecognizerProperties.VersionName");
    VolumeKmsKeyId = CkJsonObject_stringOf(jResp,"EntityRecognizerProperties.VolumeKmsKeyId");
    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"EntityRecognizerProperties.InputDataConfig.AugmentedManifests");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        AnnotationDataS3Uri = CkJsonObject_stringOf(jResp,"EntityRecognizerProperties.InputDataConfig.AugmentedManifests[i].AnnotationDataS3Uri");
        DocumentType = CkJsonObject_stringOf(jResp,"EntityRecognizerProperties.InputDataConfig.AugmentedManifests[i].DocumentType");
        S3Uri = CkJsonObject_stringOf(jResp,"EntityRecognizerProperties.InputDataConfig.AugmentedManifests[i].S3Uri");
        SourceDocumentsS3Uri = CkJsonObject_stringOf(jResp,"EntityRecognizerProperties.InputDataConfig.AugmentedManifests[i].SourceDocumentsS3Uri");
        Split = CkJsonObject_stringOf(jResp,"EntityRecognizerProperties.InputDataConfig.AugmentedManifests[i].Split");
        j = 0;
        count_j = CkJsonObject_SizeOfArray(jResp,"EntityRecognizerProperties.InputDataConfig.AugmentedManifests[i].AttributeNames");
        while (j < count_j) {
            CkJsonObject_putJ(jResp,j);
            strVal = CkJsonObject_stringOf(jResp,"EntityRecognizerProperties.InputDataConfig.AugmentedManifests[i].AttributeNames[j]");
            j = j + 1;
        }

        i = i + 1;
    }

    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"EntityRecognizerProperties.InputDataConfig.EntityTypes");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        v_Type = CkJsonObject_stringOf(jResp,"EntityRecognizerProperties.InputDataConfig.EntityTypes[i].Type");
        i = i + 1;
    }

    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"EntityRecognizerProperties.RecognizerMetadata.EntityTypes");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        EvaluationMetricsF1Score = CkJsonObject_IntOf(jResp,"EntityRecognizerProperties.RecognizerMetadata.EntityTypes[i].EvaluationMetrics.F1Score");
        EvaluationMetricsPrecision = CkJsonObject_IntOf(jResp,"EntityRecognizerProperties.RecognizerMetadata.EntityTypes[i].EvaluationMetrics.Precision");
        EvaluationMetricsRecall = CkJsonObject_IntOf(jResp,"EntityRecognizerProperties.RecognizerMetadata.EntityTypes[i].EvaluationMetrics.Recall");
        NumberOfTrainMentions = CkJsonObject_IntOf(jResp,"EntityRecognizerProperties.RecognizerMetadata.EntityTypes[i].NumberOfTrainMentions");
        v_Type = CkJsonObject_stringOf(jResp,"EntityRecognizerProperties.RecognizerMetadata.EntityTypes[i].Type");
        i = i + 1;
    }

    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"EntityRecognizerProperties.VpcConfig.SecurityGroupIds");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        strVal = CkJsonObject_stringOf(jResp,"EntityRecognizerProperties.VpcConfig.SecurityGroupIds[i]");
        i = i + 1;
    }

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


    CkRest_Dispose(rest);
    CkAuthAws_Dispose(authAws);
    CkJsonObject_Dispose(json);
    CkStringBuilder_Dispose(sbRequestBody);
    CkStringBuilder_Dispose(sbResponseBody);
    CkJsonObject_Dispose(jResp);

    }