Get summaries for a document

client.documents.getSummaries(, ?): DocumentGetSummariesResponse { data }

get/documents/{id}/document-summaries

Retrieve all summaries associated with a specific document

ParametersExpand Collapse

id: string

ReturnsExpand Collapse

DocumentGetSummariesResponse { data }

data: Array<DocumentSummary { id, created_at, display_name, 6 more } >

id: string

Unique identifier for the document summary

created_at: string

Timestamp when the summary was created

formatdate-time

display_name: string

Display name for the summary

document_id: string

ID of the document this summary belongs to

household_id: string

ID of the household this summary belongs to

summary: string

The summary text content

updated_at: string

Timestamp when the summary was last updated

formatdate-time

entry_mode?: DocumentSummaryEntryMode

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

Accepts one of the following:

"AI_AUTO"

"USER"

summary_format?: DocumentSummaryFormat

Format of the summary content

Accepts one of the following:

"MARKDOWN"

"PLAIN_TEXT"

Get summaries for a document

import Luminary from 'withluminary';

const client = new Luminary();

const response = await client.documents.getSummaries('id');

console.log(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"
    }
  ]
}