Document Summaries

List all document summaries

client.DocumentSummaries.List(ctx, query) (*CursorPagination[DocumentSummary], error)

get/document-summaries

Get a document summary by ID

client.DocumentSummaries.Get(ctx, id) (*DocumentSummary, error)

get/document-summaries/{id}

Update a document summary

client.DocumentSummaries.Update(ctx, id, body) (*DocumentSummary, error)

put/document-summaries/{id}

Download document summary as PDF

client.DocumentSummaries.Download(ctx, id, query) (*Response, error)

get/document-summaries/{id}/download

ModelsExpand Collapse

type DocumentSummary struct{…}

ID string

Unique identifier for the document summary

CreatedAt Time

Timestamp when the summary was created

formatdate-time

DisplayName string

Display name for the summary

DocumentID string

ID of the document this summary belongs to

HouseholdID string

ID of the household this summary belongs to

Summary string

The summary text content

UpdatedAt Time

Timestamp when the summary was last updated

formatdate-time

EntryMode DocumentSummaryEntryModeoptional

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

Accepts one of the following:

const DocumentSummaryEntryModeAIAuto DocumentSummaryEntryMode = "AI_AUTO"

const DocumentSummaryEntryModeUser DocumentSummaryEntryMode = "USER"

SummaryFormat DocumentSummaryFormatoptional

Format of the summary content

Accepts one of the following:

const DocumentSummaryFormatMarkdown DocumentSummaryFormat = "MARKDOWN"

const DocumentSummaryFormatPlainText DocumentSummaryFormat = "PLAIN_TEXT"

type DocumentSummaryEntryMode string

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

Accepts one of the following:

const DocumentSummaryEntryModeAIAuto DocumentSummaryEntryMode = "AI_AUTO"

const DocumentSummaryEntryModeUser DocumentSummaryEntryMode = "USER"

type DocumentSummaryFormat string

Format of the summary content

Accepts one of the following:

const DocumentSummaryFormatMarkdown DocumentSummaryFormat = "MARKDOWN"

const DocumentSummaryFormatPlainText DocumentSummaryFormat = "PLAIN_TEXT"

type PageInfo struct{…}

HasNextPage bool

When paginating forwards, are there more items?

HasPreviousPage bool

When paginating backwards, are there more items?

EndCursor stringoptional

Cursor pointing to the last item in the current page

StartCursor stringoptional

Cursor pointing to the first item in the current page