curl --request POST \
--url https://platform.kodexa.ai/api/document-families/{id}/assess \
--header 'x-api-key: <api-key>'{
"addedFeatures": [
{
"featureId": "<string>",
"source": "<string>"
}
],
"applicableKnowledgeSets": [
{
"knowledgeSetId": "<string>",
"name": "<string>",
"setType": "<string>"
}
],
"appliedKnowledgeSets": [
{
"knowledgeSetId": "<string>",
"name": "<string>",
"setType": "<string>"
}
],
"totalApplicableKnowledgeSets": 123,
"totalAppliedKnowledgeSets": 123,
"totalExtractedFeatures": 123
}Evaluates the document family’s features against all active knowledge sets for the organization using CNF expression matching. Returns applicable and newly applied knowledge sets, along with any additional features inherited from matching sets.
curl --request POST \
--url https://platform.kodexa.ai/api/document-families/{id}/assess \
--header 'x-api-key: <api-key>'{
"addedFeatures": [
{
"featureId": "<string>",
"source": "<string>"
}
],
"applicableKnowledgeSets": [
{
"knowledgeSetId": "<string>",
"name": "<string>",
"setType": "<string>"
}
],
"appliedKnowledgeSets": [
{
"knowledgeSetId": "<string>",
"name": "<string>",
"setType": "<string>"
}
],
"totalApplicableKnowledgeSets": 123,
"totalAppliedKnowledgeSets": 123,
"totalExtractedFeatures": 123
}API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.
Unique identifier (UUID) of the resource.
Assessment results
Results of assessing a document family against active knowledge sets using CNF expression matching.
Features added to the document family from matching knowledge sets.
Show child attributes
Knowledge sets whose feature expressions match the document family.
Show child attributes
Knowledge sets that were newly applied during this assessment.
Show child attributes
Count of knowledge sets matching the document.
Count of knowledge sets newly applied.
Total number of features on the document family.