Introduction

The search context and Document Summarizers (also referred to as "Auto Summarization") REST APIs allow your application to summarize text in a document.

A document summarizer resource represents an asynchronous document summarization process and yields a summarization when available.

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

Available URLs

POST /v2/documentSummarizers

Creates a new document summarizer for a search context, starting the process of summarization.

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

Request

Request Headers

Request Body

• input
  • contextId (String) Required. Identifies the search context which holds the full-text data to summarize.
• minSecondsAvailable (Integer) The minimum number of seconds this document summarizer 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 summarizer.

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

POST prizmdoc_server_base_url/v2/documentSummarizers
Content-Type: application/json
Accusoft-Affinity-Token: ejN9/kXEYOuken4Pb9ic9hqJK45XIad9LQNgCgQ+BkM=

{
  "input": {
    "contextId": "ElkNzWtrUJp4rXI5YnLUgw"
  },
  "minSecondsAvailable": 600
}

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

Response

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

{
  "input": {
    "contextId": "ElkNzWtrUJp4rXI5YnLUgw"
  },
  "processId": "pR5X6nPDgMwat6cxlmn0Q3",
  "state": "processing",
  "percentComplete": 0,
  "expirationDateTime": "2024-12-17T20:38:39.796Z"
}

GET /v2/documentSummarizers/{processId}

Gets a summarization of the document.

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

Request

URL Parameters

Successful Response

Response Body

JSON with the available document summarization.

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

Error Responses

Example

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

You would GET like so:

GET prizmdoc_server_base_url/v2/documentSummarizers/pR5X6nPDgMwat6cxlmn0Q3

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

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

{
  "summarization": "This document discusses the yearly migration of giraffes from Norway to New Zealand."
}