Introduction

The search context and Document Queriers REST API (which is part of the "Document Q&A" feature) is used by our Viewer to query a document which is currently being viewed.

IMPORTANT: This REST API is designed primarily for our Viewer. If your application needs to perform document querying without a viewer involved, we recommend you use PrizmDoc Server’s search context and document queriers 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}/documentQueriers

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

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

Request

Request Headers

Request Body

• input
  • query (String) Required. A question for querying the document.
• minSecondsAvailable (Integer) The minimum number of seconds this document querier 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 querier.

• input (Object) Input we accepted to create the document querier.
• processId (String) Unique id for this document querier.
• affinityToken (String) Affinity token for this document querier. Present when clustering is enabled.
• state (String) State of document querying.
  • "processing" - The querying is still being executed.
  • "complete" - The querying is complete.
  • "error" - There was a problem performing the querying.
• percentComplete (Integer) Percentage of document querying which has completed (from 0 to 100).
• expirationDateTime (String) Currently planned date and time when the document querier 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 querying:

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

{
  "input": {
    "query": "What does the acronym EMT refer to?"
  },
  "minSecondsAvailable": 600
}

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

Response

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

{
  "input": {
    "query": "What does the acronym EMT refer to?"
  },
  "processId": "pR5X6nPDgMwat6cxlmn0Q3",
  "state": "processing",
  "percentComplete": 0,
  "expirationDateTime": "2024-12-17T20:38:39.796Z"
}

GET /v2/documentQueriers/{processId}

Gets a response from a document query.

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

Request

URL Parameters

Successful Response

Response Body

JSON with the available document query response.

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

Error Responses

Example

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

You would GET like so:

GET pas_base_url/v2/documentQueriers/pR5X6nPDgMwat6cxlmn0Q3

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

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

{
  "response": "EMT stands for Emergency Medical Technician. An Emergency Medical Technician is a trained medical professional."
}