Assess document for knowledge

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.

POST /api/document-families/{id}/assess

Assess document for knowledge

cURL

curl --request POST \
  --url https://platform.kodexa.ai/api/document-families/{id}/assess \
  --header 'x-api-key: <api-key>'

200

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

Authorizations

x-api-keybearerAuth

x-api-key · string · header · required

API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.

Path Parameters

id · string<uuid> · required

Unique identifier (UUID) of the resource.

Response

200

application/json

Assessment results

Results of assessing a document family against active knowledge sets using CNF expression matching.

addedFeatures · object[]

Features added to the document family from matching knowledge sets.

Show child attributes

applicableKnowledgeSets · object[]

Knowledge sets whose feature expressions match the document family.

Show child attributes

appliedKnowledgeSets · object[]

Knowledge sets that were newly applied during this assessment.

Show child attributes

totalApplicableKnowledgeSets · integer

Count of knowledge sets matching the document.

totalAppliedKnowledgeSets · integer

Count of knowledge sets newly applied.

totalExtractedFeatures · integer

Total number of features on the document family.