Skip to content

Official JavaScript/TypeScript SDK for DeepCitation. Add citations with verifications to any LLM system.

License

Notifications You must be signed in to change notification settings

DeepCitation/deepcitation-js

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

182 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

@deepcitation/deepcitation-js

Verify AI citations against source documents. Visual proof for every claim.

npm version License: MIT Zero Dependencies

Documentation · Get API Key · Terms · Privacy · Examples · Agent Integration


Spot hallucinations instantly. Visual evidence for every AI citation:

Multiple display variants. From inline linter-style underlines to chips, badges, and superscripts:

View Component Showcase
DeepCitation Component Showcase

Install

npm install @deepcitation/deepcitation-js

Quick Start

import { DeepCitation, wrapCitationPrompt } from "@deepcitation/deepcitation-js";
import { CitationComponent } from "@deepcitation/deepcitation-js/react";

// 1. Upload sources
const deepcitation = new DeepCitation({ apiKey: process.env.DEEPCITATION_API_KEY });
const { deepTextPromptPortion } = await deepcitation.prepareFiles([{ file: pdfBuffer, filename: "report.pdf" }]);

// 2. Wrap prompts & call LLM
const { enhancedSystemPrompt, enhancedUserPrompt } = wrapCitationPrompt({
  systemPrompt: "You are a helpful assistant...",
  userPrompt: "Analyze this document",
  deepTextPromptPortion,
});

// 3. Verify citations
const { verifications } = await deepcitation.verify({ llmOutput: response.content });

// 4. Display with React
<CitationComponent citation={citation} verification={verifications[key]} />

React Components

Component Description
CitationComponent Inline citations with 6 variants: linter (default), chip, brackets, text, superscript, badge
UrlCitationComponent URL citations with favicon and status badges

Requires Tailwind CSS or import @deepcitation/deepcitation-js/styles.css

Supported Formats

PDF, DOCX, XLSX, PPTX, HTML, Images (JPG, PNG, TIFF, WebP, HEIC), URLs

Resources

License

MIT

Hosted API/service is subject to Terms. Patent pending. "DeepCitation" is a trademark.

About

Official JavaScript/TypeScript SDK for DeepCitation. Add citations with verifications to any LLM system.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages