Introduction

The search context and Document Classifiers REST API (which is part of the "Auto Tagging and Classification" feature) is used by our Viewer to determine a classification for a document which is currently being viewed.

IMPORTANT: This REST API is designed primarily for our Viewer. If your application needs to perform document classification without a viewer involved, we recommend you use PrizmDoc Server’s search context and document classifiers REST APIs directly.

IMPORTANT: This API will continue to evolve as we refine these features and extend our cloud service offerings.

Available URLs

POST /v2/viewingSessions/{viewingSessionId}/documentClassifiers

Creates a new document classifier for a viewing session’s source document, starting the process of document classification.

After a successful POST to create the document classifier, we immediately begin a background process to start a document classification for you to GET. Once the full text of the document has been searched and classified, the document classifier state will change from "processing" to "complete".

Request

Request Headers

Request Body

• input
  • classifications (Array of strings) Required. A list of classifications from which to select a classification for the document.
• minSecondsAvailable (Integer) The minimum number of seconds this document classifier will remain available. The actual lifetime may be longer. The default lifetime is defined by the processIds.lifetime central configuration parameter.

Successful Response

Response Body

JSON with metadata about the created document classifier.

• input (Object) Input we accepted to create the document classifier.
• processId (String) Unique id for this document classifier.
• affinityToken (String) Affinity token for this document classifier. Present when clustering is enabled.
• state (String) State of document classification.
  • "processing" - The classification is still being executed.
  • "complete" - The classification is complete.
  • "error" - There was a problem performing the classification.
• percentComplete (Integer) Percentage of document classification which has completed (from 0 to 100).
• expirationDateTime (String) Currently planned date and time when the document classifier resource will expire and no longer be available for use. Format is RFC 3339 Internet Date/Time profile of ISO 8601, e.g. "2024-11-05T08:15:30.494Z".

Error Responses

Example

Request

This POST begins document classification:

POST pas_base_url/v2/viewingSessions/XYZ.../documentClassifiers
Content-Type: application/json

{
  "input": {
    "classifications": ["geography", "health", "history", "mathematics", "nature", "philosophy", "technology"]
  },
  "minSecondsAvailable": 600
}

NOTE: See the Base URL for PAS topic for more information.

Response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "input": {
    "classifications": ["geography", "health", "history", "mathematics", "nature", "philosophy", "technology"]
  },
  "processId": "pR5X6nPDgMwat6cxlmn0Q3",
  "state": "processing",
  "percentComplete": 0,
  "expirationDateTime": "2024-12-17T20:38:39.796Z"
}

GET /v2/documentClassifiers/{processId}

Gets a classification of the document.

This URL is designed to give you the document classification when it becomes available.

Request

URL Parameters

Successful Response

Response Body

JSON with the available document classification.

• classification (String) Always present. String containing the document classification. If no classification is available, this string will be empty.

Error Responses

Example

Here is an example request and response illustrating how you would acquire the classification from the document classifier.

You would GET like so:

GET pas_base_url/v2/documentClassifiers/pR5X6nPDgMwat6cxlmn0Q3

NOTE: See the Base URL for PAS topic for more information.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "classification": "technology"
}