Summarize documents

This API generates concise summaries for a list of input documents using a large language model (LLM), returning a corresponding list of summaries.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
path Parameters
projectName
required
string

The CDF project name, equal to the project variable in the server URL.

Example: publicdata
header Parameters
content-type
required
string (Content-Type)
cdf-version
string

cdf version header. Use this to specify the requested CDF release.

Example: alpha
Request Body schema: application/json
required
ignoreUnknownIds
boolean (Ignoreunknownids)
Default: false

If True, the API will not fail if any documents are missing, but summaries for the missing documents will be excluded from the response.

required
Array of DocumentInternalId (object) or DocumentExternalId (object) or DocumentInstanceId (object) (Items) = 1 items

List of documents to summarize

Responses
200

Successful Response

400

The response for a failed request.

post/api/v1/projects/{projectName}/ai/tools/documents/summarize
Request samples
application/json
{
  • "ignoreUnknownIds": false,
  • "items": [
    • {
      }
    ]
}
Response samples
application/json
{
  • "items": [
    • {
      }
    ]
}
➔ Next to Documents / Documents