@pdfvector/instance-client 0.0.27 → 0.0.29

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @pdfvector/instance-client
 
+## 0.0.29
+### Patch Changes
+
+
+
+- [#151](https://github.com/phuctm97/pdfvector/pull/151) [`0deb0b8`](https://github.com/phuctm97/pdfvector/commit/0deb0b8d0219a55a75ab5698a2190bb7e6c6d422) Thanks [@khanhduyvt0101](https://github.com/khanhduyvt0101)! - Update instance-client README with grant search, paper graph, similar papers, and crossref provider
+
+## 0.0.28
+### Patch Changes
+
+- Updated dependencies [[`aaf8ba1`](https://github.com/phuctm97/pdfvector/commit/aaf8ba1a73c4076cc63c17fcd47e463b05d7db2a)]:
+  - @pdfvector/instance-contract@0.0.30
+
 ## 0.0.27
 ### Patch Changes
 

package/README.md

@@ -1,6 +1,6 @@
 # PDFVector TypeScript/JavaScript SDK
 
-The official TypeScript/JavaScript SDK for the [PDFVector](https://www.pdfvector.com) API: Parse PDF, Word, Image, and Excel documents to clean, structured markdown format, ask questions about documents using AI, extract structured data from documents with JSON Schema, search across multiple academic databases with a unified API, fetch specific publications by DOI, PubMed ID, ArXiv ID, and more, and find relevant academic citations for paragraphs of text.
+The official TypeScript/JavaScript SDK for the [PDFVector](https://www.pdfvector.com) API: Parse PDF, Word, Image, and Excel documents to clean, structured markdown format, ask questions about documents using AI, extract structured data from documents with JSON Schema, search across multiple academic databases with a unified API, fetch specific publications by DOI, PubMed ID, ArXiv ID, and more, find relevant academic citations for paragraphs of text, explore paper citation graphs, find similar papers, and search for research grants across US, EU, and UK funding databases.
 
 ## Installation
 
@@ -337,12 +337,13 @@ result.results.forEach((publication) => {
 **Supported Providers:**
 
 - `"semantic-scholar"` (default) - [Semantic Scholar](https://www.semanticscholar.org/)
-- `"arxiv"` - [ArXiv](https://arxiv.org/)
 - `"pubmed"` - [PubMed](https://pubmed.ncbi.nlm.nih.gov/)
+- `"arxiv"` - [ArXiv](https://arxiv.org/)
 - `"google-scholar"` - [Google Scholar](https://scholar.google.com/)
 - `"eric"` - [ERIC](https://eric.ed.gov/)
 - `"europe-pmc"` - [Europe PMC](https://europepmc.org/)
 - `"openalex"` - [OpenAlex](https://openalex.org/)
+- `"crossref"` - [Crossref](https://www.crossref.org/)
 
 **Search Parameters:**
 
@@ -402,6 +403,115 @@ for (const item of result.results) {
 }
 ```
 
+### Paper Citation Graph
+
+Retrieve a paper's citing papers and referenced papers with pagination support. Costs 2+ credits per request (scales with result count).
+
+```typescript
+const result = await client.academic.paperGraph({
+  id: "10.1038/nature12373", // DOI, ArXiv ID, Semantic Scholar ID, OpenAlex ID, or URL
+  citationsLimit: 20,
+  referencesLimit: 20,
+  citationsOffset: 0,
+  referencesOffset: 0,
+  fields: ["title", "authors", "year", "doi"],
+});
+
+console.log(`Paper: ${result.paper.title}`);
+console.log(`Total Citations: ${result.totalCitations}`);
+console.log(`Total References: ${result.totalReferences}`);
+
+for (const citation of result.citations) {
+  console.log(`  Cited by: ${citation.title} (${citation.year})`);
+}
+```
+
+**Parameters:**
+
+- `id` (required): Paper identifier (DOI, ArXiv ID, Semantic Scholar ID, OpenAlex ID, or URL)
+- `citationsLimit`: Max citing papers to return, 0-1000 (default: 100)
+- `referencesLimit`: Max referenced papers to return, 0-1000 (default: 100)
+- `citationsOffset` / `referencesOffset`: Pagination offsets (default: 0)
+- `fields`: Specific fields to return
+
+### Find Similar Papers
+
+Find papers similar to a seed paper using citation network analysis. Costs 3 credits per request.
+
+```typescript
+const result = await client.academic.similarPapers({
+  id: "10.1038/nature12373",
+  limit: 10,
+  includeEdges: true, // include citation graph edges for visualization
+  fields: ["title", "year", "doi"],
+});
+
+console.log(`Seed: ${result.seed.title}`);
+
+for (const item of result.results) {
+  console.log(`  [Similarity: ${item.similarity.toFixed(2)}] ${item.publication.title}`);
+  if (item.citingIds) {
+    console.log(`    Citing: ${item.citingIds.length} papers in result set`);
+  }
+}
+```
+
+**Parameters:**
+
+- `id` (required): Seed paper identifier
+- `limit`: Max similar papers, 1-100 (default: 30)
+- `includeEdges`: Include `citingIds`/`citedByIds` for graph construction (default: false)
+- `fields`: Specific fields to return
+
+### Search Grants
+
+Search for research grants and funding opportunities across multiple databases with a unified API. Costs 2 credits per request.
+
+```typescript
+const result = await client.academic.searchGrants({
+  query: "machine learning healthcare",
+  providers: ["grants-gov", "nih-reporter", "cordis", "ukri"],
+  limit: 10,
+  fundingMin: 100000,
+  fundingMax: 1000000,
+  deadlineFrom: "2026-01-01",
+  deadlineTo: "2026-12-31",
+});
+
+console.log(`Found ${result.estimatedTotalResults} grants`);
+
+for (const grant of result.results) {
+  console.log(`Title: ${grant.title}`);
+  console.log(`Agency: ${grant.agency} (${grant.region})`);
+  console.log(`Funding: ${grant.currency} ${grant.fundingAmountMin}-${grant.fundingAmountMax}`);
+  console.log(`Deadline: ${grant.deadlineDate ?? grant.closeDate ?? "N/A"}`);
+  console.log(`URL: ${grant.url}`);
+  console.log("---");
+}
+
+// Partial provider failures are reported in errors array
+result.errors?.forEach((error) => {
+  console.log(`Provider ${error.provider} failed: ${error.message}`);
+});
+```
+
+**Supported Grant Providers:**
+
+- `"grants-gov"` - [Grants.gov](https://www.grants.gov/) (US federal grants — NIH, NSF, DOE, DOD, etc.)
+- `"nih-reporter"` - [NIH RePORTER](https://reporter.nih.gov/) (NIH-funded research projects)
+- `"cordis"` - [CORDIS](https://cordis.europa.eu/) (EU-funded projects — Horizon Europe, ERC, etc.)
+- `"ukri"` - [UKRI](https://www.ukri.org/) (UK-funded projects — EPSRC, BBSRC, MRC, etc.)
+
+**Search Parameters:**
+
+- `query` (required): 1-400 characters
+- `providers`: Array of grant provider names (default: all 4 providers)
+- `offset`: Pagination offset (default: 0)
+- `limit`: Results per provider, 1-50 (default: 10)
+- `fundingMin` / `fundingMax`: Filter by funding amount
+- `deadlineFrom` / `deadlineTo`: Filter by deadline date (ISO format, e.g. `"2026-01-01"`)
+- `fields`: Specific fields to return (`"sourceId"`, `"title"`, `"url"`, `"agency"`, `"program"`, `"description"`, `"eligibility"`, `"fundingAmountMin"`, `"fundingAmountMax"`, `"currency"`, `"deadlineDate"`, `"openDate"`, `"closeDate"`, `"grantType"`, `"region"`, `"keywords"`, `"piName"`, `"organizationName"`, `"provider"`, `"providerData"`)
+
 ## Document ID Tracking
 
 Pass a `documentId` per request to track API usage. The ID is sent as a header and returned in responses for document, identity, invoice, and bank statement endpoints. Academic endpoints do not use `documentId`.
@@ -464,6 +574,9 @@ console.log(resultB.documentId); // "doc-b"
 | Academic Search | 2 | 2 | 2 | 2 | /request |
 | Academic Fetch | 2 | 2 | 2 | 2 | /request |
 | Academic Find Citations | 2 | 2 | 2 | 2 | /sentence |
+| Academic Paper Graph | 2+ | 2+ | 2+ | 2+ | /request |
+| Academic Similar Papers | 3 | 3 | 3 | 3 | /request |
+| Grant Search | 2 | 2 | 2 | 2 | /request |
 
 ## Error Handling
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pdfvector/instance-client",
-  "version": "0.0.27",
+  "version": "0.0.29",
   "type": "module",
   "description": "Official TypeScript/JavaScript SDK for PDFVector API - Parse PDF/Word/Image/Excel documents to clean, structured markdown format and search academic publications across multiple databases",
   "license": "MIT",