pdfvector/dist/types.d.ts

Official TypeScript/JavaScript SDK for PDF Vector API - Parse PDFs to markdown and search academic publications across multiple databases

export type AcademicSearchProvider = "pubmed" | "semantic-scholar" | "google-scholar" | "arxiv" | "eric";
export declare const AcademicSearchProviderValues: readonly AcademicSearchProvider[];
export interface AcademicSearchAuthor {
    name: string;
    url?: string;
}
export interface AcademicSearchBasePublication {
    doi?: string;
    title?: string;
    url?: string;
    providerURL?: string;
    authors?: AcademicSearchAuthor[];
    date?: string;
    year?: number;
    totalCitations?: number;
    totalReferences?: number;
    abstract?: string;
    pdfURL?: string;
    provider?: AcademicSearchProvider;
}
export interface AcademicSearchSemanticScholarData {
    paperId: string;
    venue?: string;
    publicationTypes?: string[];
    influentialCitationCount?: number;
    fieldsOfStudy?: string[];
    s2FieldsOfStudy?: {
        category: string;
        source: string;
    }[];
    openAccessPdfStatus?: "GREEN" | "GOLD" | "HYBRID" | "BRONZE" | "CLOSED" | null;
    externalIds?: {
        CorpusId?: number;
        PubMed?: string;
        ArXiv?: string;
        MAG?: string;
        ACL?: string;
        PubMedCentral?: string;
        DBLP?: string;
    };
    isOpenAccess?: boolean;
    citationVelocity?: number;
    publicationVenue?: {
        id?: string;
        name?: string;
        type?: string;
        url?: string;
        alternate_names?: string[];
        issn?: string;
    };
}
export interface AcademicSearchGoogleScholarData {
    scholarId: string;
    displayedLink: string;
    snippet?: string;
    citedByLink?: string;
    citedByCount?: string;
    versionsLink?: string;
    versionsCount?: string;
    relatedPagesLink?: string;
    resources?: {
        title: string;
        type: string;
        link: string;
    }[];
}
export interface AcademicSearchPubMedData {
    pmid: string;
    pmcid?: string;
    journal?: string;
    journalAbbreviation?: string;
    volume?: string;
    issue?: string;
    pages?: string;
    meshTerms?: string[];
    keywords?: string[];
    publicationTypes?: string[];
    authorAffiliations?: {
        author: string;
        affiliation: string;
    }[];
    publicationStatus?: string;
    language?: string;
    grantNumbers?: string[];
    conflictOfInterest?: string;
    chemicalList?: string[];
    dataAvailability?: string;
    history?: {
        received?: string;
        accepted?: string;
        revised?: string;
    };
}
export interface AcademicSearchArxivData {
    arxivId: string;
    version?: string;
    categories?: string[];
    comment?: string;
    journalRef?: string;
    primaryCategory?: string;
    submittedDate?: string;
    updatedDate?: string;
    license?: string;
    announceType?: "new" | "replace" | "cross-list";
}
export interface AcademicSearchEricData {
    ericId: string;
    source?: string;
    publicationType?: string;
    educationLevel?: string[];
    audience?: string[];
    institution?: string;
    sponsor?: string;
    isbn?: string;
    issn?: string;
    descriptors?: string[];
    publisher?: string;
    peerReviewed?: boolean;
    fullTextAvailable?: boolean;
}
export type AcademicSearchProviderData = AcademicSearchSemanticScholarData | AcademicSearchGoogleScholarData | AcademicSearchPubMedData | AcademicSearchArxivData | AcademicSearchEricData;
export interface AcademicSearchPublication extends AcademicSearchBasePublication {
    providerData?: AcademicSearchProviderData;
}
export type AcademicSearchPublicationField = "doi" | "title" | "url" | "providerURL" | "authors" | "date" | "year" | "totalCitations" | "totalReferences" | "abstract" | "pdfURL" | "provider" | "providerData";
export declare const AcademicSearchPublicationFieldValues: readonly AcademicSearchPublicationField[];
export interface AcademicSearchProviderError {
    provider: string;
    message: string;
    code?: string;
    details?: Record<string, unknown>;
}
export interface AcademicSearchResponse {
    estimatedTotalResults: number;
    results: Partial<AcademicSearchPublication>[];
    errors?: AcademicSearchProviderError[];
}
export interface AcademicFetchResult extends AcademicSearchPublication {
    /** The ID that was used to fetch this publication */
    id: string;
    /** The provider that was detected/queried */
    detectedProvider: AcademicSearchProvider;
}
export interface AcademicFetchError {
    /** The ID that failed to fetch */
    id: string;
    /** Error message */
    error: string;
    /** Optional error code */
    code?: string;
}
export interface AcademicFetchResponse {
    /** Successfully fetched publications */
    results: AcademicFetchResult[];
    /** Errors for IDs that couldn't be fetched */
    errors?: AcademicFetchError[];
}
export interface ParseResponse {
    markdown: string;
    pageCount: number;
    creditCount: number;
    usedLLM: boolean;
}
export interface AskResponse {
    markdown: string;
    pageCount: number;
    creditCount: number;
}
export interface ExtractResponse {
    data: Record<string, unknown>;
    pageCount: number;
    creditCount: number;
}
export interface TemporaryUploadResponse {
    key: string;
    url: string;
    exp: number;
}
//# sourceMappingURL=types.d.ts.map