Get summaries for a document

documents.get_summaries() -> DocumentGetSummariesResponse

get/documents/{id}/document-summaries

Retrieve all summaries associated with a specific document

ParametersExpand Collapse

id: str

ReturnsExpand Collapse

class DocumentGetSummariesResponse: …

data: List[DocumentSummary]

id: str

Unique identifier for the document summary

created_at: datetime

Timestamp when the summary was created

formatdate-time

display_name: str

Display name for the summary

document_id: str

ID of the document this summary belongs to

household_id: str

ID of the household this summary belongs to

summary: str

The summary text content

updated_at: datetime

Timestamp when the summary was last updated

formatdate-time

entry_mode: Optional[DocumentSummaryEntryMode]

Indicates if the summary was AI-generated or user-entered

Accepts one of the following:

"AI_AUTO"

"USER"

summary_format: Optional[DocumentSummaryFormat]

Format of the summary content

Accepts one of the following:

"MARKDOWN"

"PLAIN_TEXT"

Get summaries for a document

from withluminary import Luminary

client = Luminary()
response = client.documents.get_summaries(
    "id",
)
print(response.data)

{
  "data": [
    {
      "id": "document_summary_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "created_at": "2019-12-27T18:11:19.117Z",
      "display_name": "Default summary",
      "document_id": "document_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "household_id": "household_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "summary": "summary",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "entry_mode": "AI_AUTO",
      "summary_format": "MARKDOWN"
    }
  ]
}

Returns Examples

{
  "data": [
    {
      "id": "document_summary_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "created_at": "2019-12-27T18:11:19.117Z",
      "display_name": "Default summary",
      "document_id": "document_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "household_id": "household_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "summary": "summary",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "entry_mode": "AI_AUTO",
      "summary_format": "MARKDOWN"
    }
  ]
}