Introduction

DEPRECATION NOTICE: The following URLs have been deprecated and will be removed from the public API in a future release. Please use the newer Queriers API instead.

Deprecated URLs

URL	Description
POST /v2/viewingSessions/{viewingSessionId}/documentQueriers	Creates a new document querier for a viewing session’s source document, starting the process of document querying.
GET /v2/documentQueriers/{processId}	Gets available query response.

POST /v2/viewingSessions/{viewingSessionId}/documentQueriers (Deprecated)

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

Name	Description
`Content-Type`	Must be `application/json`

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.
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

Status Code	JSON `errorCode`	Description
`404`	-	No viewing session with the provided `{viewingSessionId}` could be found.
`480`	`"DocumentNotProvidedYet"`	The viewing session does not yet have a source document attached.
`480`	`"ServerContentDisabled"`	The source document satisfies the client-side viewing formats configured for the viewing session and the server content is disabled.
`480`	`"InvalidInput"`	An invalid input value was used. See `errorDetails` in the response body.
`480`	`"FeatureNotLicensed"`	You are not licensed to use the document querying feature.
`580`	`"InternalError"`	The server encountered an internal error when handling the request.

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",
  "expirationDateTime": "2024-12-17T20:38:39.796Z"
}

GET /v2/documentQueriers/{processId} (Deprecated)

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

Parameter	Description
`{processId}`	The `processId` which identifies the document querier.

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

Status Code	JSON `errorCode`	Description
`404`	-	No document querier with the provided `{processId}` could be found.
`400`	`"MissingInput"`	Can occur when clustering is enabled and an `Accusoft-Affinity-Token` request header was not provided.
`480`	`"InvalidInput"`	An invalid input value was used. See `errorDetails` in the response body.
`480`	`"ResourceNotUsable"`	Can occur when the document querier is in a `state` of `"error"`.
`580`	`"InternalError"`	The server encountered an internal error when handling the request.

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