Skip to content
Luminary Luminary Luminary
Get started
API Reference
Document Summaries

Update a document summary

document_summaries.update(strid, DocumentSummaryUpdateParams**kwargs) -> DocumentSummary
PUT/document-summaries/{id}

Update an existing document summary

ParametersExpand Collapse
id: str
display_name: Optional[str]

Display name for the summary

minLength1
entry_mode: Optional[DocumentSummaryEntryMode]

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

One of the following:
"AI_AUTO"
"USER"
summary: Optional[str]

The summary text content

summary_format: Optional[DocumentSummaryFormat]

Format of the summary content

One of the following:
"MARKDOWN"
"PLAIN_TEXT"
ReturnsExpand Collapse
class 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

One of the following:
"AI_AUTO"
"USER"
summary_format: Optional[DocumentSummaryFormat]

Format of the summary content

One of the following:
"MARKDOWN"
"PLAIN_TEXT"

Update a document summary

from withluminary import Luminary

client = Luminary()
document_summary = client.document_summaries.update(
    id="id",
)
print(document_summary.id)
{
  "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
{
  "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"
}