curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/ai/tools/documents/summarize \
--header 'Authorization: Bearer <token>' \
--header 'content-type: <content-type>' \
--data '
{
"items": [
{
"id": 123
}
],
"ignoreUnknownIds": false,
"language": "English"
}
'{
"items": [
{
"id": 123,
"summary": "<string>"
}
]
}Generates concise summaries for a list of input documents using a language model.
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/ai/tools/documents/summarize \
--header 'Authorization: Bearer <token>' \
--header 'content-type: <content-type>' \
--data '
{
"items": [
{
"id": 123
}
],
"ignoreUnknownIds": false,
"language": "English"
}
'{
"items": [
{
"id": 123,
"summary": "<string>"
}
]
}Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.
A list of documents to summarize.
1 elementShow child attributes
If true, the API will not fail if any documents are missing, but summaries for the missing documents will be excluded from the response.
The language in which the answer should be provided.
Chinese, Dutch, English, French, German, Italian, Japanese, Korean, Latvian, Norwegian, Portuguese, Spanish, Swedish Successful Response
A list of documents with summaries.
Show child attributes
Was this page helpful?