DescribeDocumentClassifier PureBasic Example
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,"DocumentClassifierArn","string")
; The JSON request body created by the above code:
; {
; "DocumentClassifierArn": "string"
; }
CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.1")
CkRest::ckAddHeader(rest,"X-Amz-Target","Comprehend_20171127.DescribeDocumentClassifier")
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
AnnotationDataS3Uri.s
DocumentType.s
SourceDocumentsS3Uri.s
Split.s
j.i
count_j.i
strVal.s
Accuracy.i = CkJsonObject::ckIntOf(jResp,"DocumentClassifierProperties.ClassifierMetadata.EvaluationMetrics.Accuracy")
F1Score.i = CkJsonObject::ckIntOf(jResp,"DocumentClassifierProperties.ClassifierMetadata.EvaluationMetrics.F1Score")
HammingLoss.i = CkJsonObject::ckIntOf(jResp,"DocumentClassifierProperties.ClassifierMetadata.EvaluationMetrics.HammingLoss")
MicroF1Score.i = CkJsonObject::ckIntOf(jResp,"DocumentClassifierProperties.ClassifierMetadata.EvaluationMetrics.MicroF1Score")
MicroPrecision.i = CkJsonObject::ckIntOf(jResp,"DocumentClassifierProperties.ClassifierMetadata.EvaluationMetrics.MicroPrecision")
MicroRecall.i = CkJsonObject::ckIntOf(jResp,"DocumentClassifierProperties.ClassifierMetadata.EvaluationMetrics.MicroRecall")
Precision.i = CkJsonObject::ckIntOf(jResp,"DocumentClassifierProperties.ClassifierMetadata.EvaluationMetrics.Precision")
Recall.i = CkJsonObject::ckIntOf(jResp,"DocumentClassifierProperties.ClassifierMetadata.EvaluationMetrics.Recall")
NumberOfLabels.i = CkJsonObject::ckIntOf(jResp,"DocumentClassifierProperties.ClassifierMetadata.NumberOfLabels")
NumberOfTestDocuments.i = CkJsonObject::ckIntOf(jResp,"DocumentClassifierProperties.ClassifierMetadata.NumberOfTestDocuments")
NumberOfTrainedDocuments.i = CkJsonObject::ckIntOf(jResp,"DocumentClassifierProperties.ClassifierMetadata.NumberOfTrainedDocuments")
DataAccessRoleArn.s = CkJsonObject::ckStringOf(jResp,"DocumentClassifierProperties.DataAccessRoleArn")
DocumentClassifierArn.s = CkJsonObject::ckStringOf(jResp,"DocumentClassifierProperties.DocumentClassifierArn")
EndTime.i = CkJsonObject::ckIntOf(jResp,"DocumentClassifierProperties.EndTime")
DataFormat.s = CkJsonObject::ckStringOf(jResp,"DocumentClassifierProperties.InputDataConfig.DataFormat")
LabelDelimiter.s = CkJsonObject::ckStringOf(jResp,"DocumentClassifierProperties.InputDataConfig.LabelDelimiter")
S3Uri.s = CkJsonObject::ckStringOf(jResp,"DocumentClassifierProperties.InputDataConfig.S3Uri")
TestS3Uri.s = CkJsonObject::ckStringOf(jResp,"DocumentClassifierProperties.InputDataConfig.TestS3Uri")
LanguageCode.s = CkJsonObject::ckStringOf(jResp,"DocumentClassifierProperties.LanguageCode")
Message.s = CkJsonObject::ckStringOf(jResp,"DocumentClassifierProperties.Message")
Mode.s = CkJsonObject::ckStringOf(jResp,"DocumentClassifierProperties.Mode")
ModelKmsKeyId.s = CkJsonObject::ckStringOf(jResp,"DocumentClassifierProperties.ModelKmsKeyId")
KmsKeyId.s = CkJsonObject::ckStringOf(jResp,"DocumentClassifierProperties.OutputDataConfig.KmsKeyId")
OutputDataConfigS3Uri.s = CkJsonObject::ckStringOf(jResp,"DocumentClassifierProperties.OutputDataConfig.S3Uri")
SourceModelArn.s = CkJsonObject::ckStringOf(jResp,"DocumentClassifierProperties.SourceModelArn")
Status.s = CkJsonObject::ckStringOf(jResp,"DocumentClassifierProperties.Status")
SubmitTime.i = CkJsonObject::ckIntOf(jResp,"DocumentClassifierProperties.SubmitTime")
TrainingEndTime.i = CkJsonObject::ckIntOf(jResp,"DocumentClassifierProperties.TrainingEndTime")
TrainingStartTime.i = CkJsonObject::ckIntOf(jResp,"DocumentClassifierProperties.TrainingStartTime")
VersionName.s = CkJsonObject::ckStringOf(jResp,"DocumentClassifierProperties.VersionName")
VolumeKmsKeyId.s = CkJsonObject::ckStringOf(jResp,"DocumentClassifierProperties.VolumeKmsKeyId")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"DocumentClassifierProperties.InputDataConfig.AugmentedManifests")
While i < count_i
CkJsonObject::setCkI(jResp, i)
AnnotationDataS3Uri = CkJsonObject::ckStringOf(jResp,"DocumentClassifierProperties.InputDataConfig.AugmentedManifests[i].AnnotationDataS3Uri")
DocumentType = CkJsonObject::ckStringOf(jResp,"DocumentClassifierProperties.InputDataConfig.AugmentedManifests[i].DocumentType")
S3Uri = CkJsonObject::ckStringOf(jResp,"DocumentClassifierProperties.InputDataConfig.AugmentedManifests[i].S3Uri")
SourceDocumentsS3Uri = CkJsonObject::ckStringOf(jResp,"DocumentClassifierProperties.InputDataConfig.AugmentedManifests[i].SourceDocumentsS3Uri")
Split = CkJsonObject::ckStringOf(jResp,"DocumentClassifierProperties.InputDataConfig.AugmentedManifests[i].Split")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"DocumentClassifierProperties.InputDataConfig.AugmentedManifests[i].AttributeNames")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"DocumentClassifierProperties.InputDataConfig.AugmentedManifests[i].AttributeNames[j]")
j = j + 1
Wend
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"DocumentClassifierProperties.VpcConfig.SecurityGroupIds")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"DocumentClassifierProperties.VpcConfig.SecurityGroupIds[i]")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"DocumentClassifierProperties.VpcConfig.Subnets")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"DocumentClassifierProperties.VpcConfig.Subnets[i]")
i = i + 1
Wend
; A sample JSON response body parsed by the above code:
; {
; "DocumentClassifierProperties": {
; "ClassifierMetadata": {
; "EvaluationMetrics": {
; "Accuracy": number,
; "F1Score": number,
; "HammingLoss": number,
; "MicroF1Score": number,
; "MicroPrecision": number,
; "MicroRecall": number,
; "Precision": number,
; "Recall": number
; },
; "NumberOfLabels": number,
; "NumberOfTestDocuments": number,
; "NumberOfTrainedDocuments": number
; },
; "DataAccessRoleArn": "string",
; "DocumentClassifierArn": "string",
; "EndTime": number,
; "InputDataConfig": {
; "AugmentedManifests": [
; {
; "AnnotationDataS3Uri": "string",
; "AttributeNames": [
; "string"
; ],
; "DocumentType": "string",
; "S3Uri": "string",
; "SourceDocumentsS3Uri": "string",
; "Split": "string"
; }
; ],
; "DataFormat": "string",
; "LabelDelimiter": "string",
; "S3Uri": "string",
; "TestS3Uri": "string"
; },
; "LanguageCode": "string",
; "Message": "string",
; "Mode": "string",
; "ModelKmsKeyId": "string",
; "OutputDataConfig": {
; "KmsKeyId": "string",
; "S3Uri": "string"
; },
; "SourceModelArn": "string",
; "Status": "string",
; "SubmitTime": number,
; "TrainingEndTime": number,
; "TrainingStartTime": number,
; "VersionName": "string",
; "VolumeKmsKeyId": "string",
; "VpcConfig": {
; "SecurityGroupIds": [
; "string"
; ],
; "Subnets": [
; "string"
; ]
; }
; }
; }
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
