Getting Started

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

const dc = new DeepCitation({ apiKey: process.env.DEEPCITATION_API_KEY });

// 1. Upload your source document
const { attachmentId, deepTextPromptPortion } = await dc.uploadFile(pdfBuffer, {
  filename: "report.pdf"
});

// 2. Wrap your prompts with citation instructions
const systemPrompt = "You are a helpful assistant that cites sources.";

const { enhancedSystemPrompt, enhancedUserPrompt } = wrapCitationPrompt({
  systemPrompt,
  userPrompt,
  deepTextPromptPortion // Pass file content directly
});

// 3. Call your LLM
const response = await yourLLM.chat({
  messages: [
    { role: "system", content: enhancedSystemPrompt },
    { role: "user", content: enhancedUserPrompt },
  ]
});

// 4. Extract and verify citations
const citations = getAllCitationsFromLlmOutput(response.content);
const verified = await dc.verify(attachmentId, citations);

// 5. Use verification results
for (const [key, result] of Object.entries(verified.verifications)) {
  console.log(`Citation ${key}: ${result.searchState?.status}`);
  if (result.verificationImageBase64) {
    // Display visual proof to users
  }
}