DataSourcePassage

Type

One passage as passages() returns it: its text, the entities it carries, and a citation.

One passage from passages or allPassages. It holds the passage text, prefixed with its heading path; the entity ids the passage carries (its document's, plus any its text names from the dictionary); and a citation back to its source.

DataSourcePassage.ts

interface DataSourcePassage {
  text: string
  entities: string[]
  citation: Citation
}

Fields

text

string

The chunk, prefixed with its heading path for context.

entities

string[]

Its document's ids, and those its text names from the dictionary.

citation

Citation

Where the passage came from.

Read a page

const { passages } = await Manuals.passages({ filter: { phrase: 'lockout procedure' } });
passages[0].entities; // [1]