captide.js

Visit our website | Try our app | Documentation

Overview

Captide enables precise querying across over millions filings and earnings calls, offering best-in-class accuracy for financial analysis. It streamlines data extraction, investment research, and document review—accessible through a user-friendly interface at app.captide.co or directly via API.

About This Package

This npm package provides a document viewer designed to display source documents obtained via Captide's REST API. It is specifically developed to support source linking to answers given by Captide's AI agents that perform Q&A over financial disclosures. The viewer can display HTML, PDF, or XLSX documents and automatically scroll and highlight specific parts in these source documents that correspond to parts of the answer obtained through the API. This helps attribute the AI agent's outputs—such as specific sentences or metrics—directly to their original sources, rendering SEC filings, earnings call transcripts, and international disclosures with precise highlighting of relevant sections.

Yarn Usage

This project now uses Yarn as its package manager. Please use the following commands:

Install dependencies

``sh
yarn install
`

Run the development server

`sh
yarn start
`

Build for production

`sh
yarn build
`

Usage Examples

$3

`javascript
import { useDocumentViewer } from '@contexts/document-viewer-context';

const { loadDocument } = useDocumentViewer();

// Load a document by ID
await loadDocument('document-id-123');
`

$3

`javascript
import { useDocumentViewer } from '@contexts/document-viewer-context';

const { loadDocument } = useDocumentViewer();

// Load a document and highlight specific text
await loadDocument(
'document-id-123',
'element-id-456',
'Total net sales $95,359 $90,753 $219,659 $210,328'
);
`

The citation snippet feature provides intelligent text search that can handle:
- Table data with varying spacing (e.g., financial data in rows)
- Fuzzy matching when exact text isn't found
- Cross-page search if the text appears on different pages
- Visual highlighting with animated overlays

$3

`javascript
// Load document with specific element highlighting and citation
await loadDocument(
'https://api.captide.co/documents/123',
'highlight-element-789',
'Revenue increased 15% year-over-year to $2.5 billion'
);
`

PDF text selection / Ctrl+F alignment (PDF.js vs native viewer)

This package uses PDF.js to render PDFs. PDF.js renders the page visually to a canvas, and reconstructs a separate HTML "text layer" for selection and find/highlighting. Some PDFs (fonts/transforms/OCR quirks) can cause that reconstructed text layer to be offset from the canvas, leading to shifted selection boxes or Ctrl/Cmd+F highlights.

DocumentViewer supports choosing the renderer:

- renderMode="pdfjs": default, feature-rich (custom overlays, PDF.js find UI, etc.)
- renderMode="native": uses the browser's built-in PDF viewer (Safari uses PDFKit; best for accurate selection/highlights)
- renderMode="auto": uses native on Safari, PDF.js elsewhere

Note: embedding PDFs via