Document Summarization

async AsyncCogniteClient.ai.tools.documents.summarize(
id: int | None = None,
external_id: str | None = None,
instance_id: NodeId | None = None,
) → Summary

Summarize a document using a Large Language Model.

Note

Currently only supports summarizing a single document at a time, but this may be extended in the future.

Parameters:

  • id (int | None) – The ID of the document

  • external_id (str | None) – The external ID of the document

  • instance_id (NodeId | None) – The instance ID of the document

Returns:

A summary of the document.

Return type:

Summary

Examples

Summarize a single document using ID:

>>> from cognite.client import CogniteClient, AsyncCogniteClient
>>> client = CogniteClient()
>>> # async_client = AsyncCogniteClient()  # another option
>>> client.ai.tools.documents.summarize(id=123)

You can also use external ID or instance ID:

>>> from cognite.client.data_classes.data_modeling import NodeId
>>> client.ai.tools.documents.summarize(instance_id=NodeId("my-space", "my-xid"))