Cognite Data Fusion API

Summarize documents.

Generates concise summaries for a list of input documents using a language model.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code

Request

content-type

required

string (Content-Type)

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 A list of documents to summarize.
language	string (DocumentsLanguage) Default: "English" The language in which the answer should be provided. Enum: "Chinese" "Dutch" "English" "French" "German" "Italian" "Japanese" "Korean" "Latvian" "Norwegian" "Portuguese" "Spanish" "Swedish"

Responses

200

Successful Response

400

The response for a failed request.

post/ai/tools/documents/summarize

Request samples

application/json

{"ignoreUnknownIds": false,
"items": [{"id": 0
}
],
"language": "Chinese"
}

Response samples

application/json

{"items": [{"id": 0,
"summary": "string"
}
]
}