Documentation
¶
Overview ¶
Copyright 2025 National Technology and Engineering Solutions of Sandia SPDX-License-Identifier: BSD-3-Clause
Copyright 2025 National Technology and Engineering Solutions of Sandia SPDX-License-Identifier: BSD-3-Clause
Copyright 2025 National Technology and Engineering Solutions of Sandia SPDX-License-Identifier: BSD-3-Clause
Copyright 2025 National Technology and Engineering Solutions of Sandia SPDX-License-Identifier: BSD-3-Clause
Copyright 2025 National Technology and Engineering Solutions of Sandia SPDX-License-Identifier: BSD-3-Clause
Copyright 2025 National Technology and Engineering Solutions of Sandia SPDX-License-Identifier: BSD-3-Clause
Index ¶
- Constants
- func CheckDOI(id string) (bool, error)
- func Encode(path string) (string, error)
- func GetArxivMetadata(id, rawEntry string) (*arxiv.Entry, error)
- func GetOSTIRecord(id, rawEntry string) (*osti.Record, error)
- type ArxivResult
- type CrossrefResult
- type DOIOrgResult
- type ElsevierResult
- type EntryConfig
- type OSTIResult
- type OnlineResult
- type Result
- func Entry(text string, mode string, class entries.Classifier, ...) (*Result, error)
- func EntryFromBase64(encoded string, id int, mode string, class entries.Classifier, ...) (*Result, error)
- func EntryFromBibliography(b *documents.Bibliography, id int, mode string, class entries.Classifier, ...) (*Result, error)
- type Search
- type SummarizeResult
Constants ¶
const ( SearchStatusNotAttempted string = "" SearchStatusDone string = "done" )
const (
CrossrefMatchThreshold float64 = 99 // determined empirically
)
Variables ¶
This section is empty.
Functions ¶
func GetArxivMetadata ¶
returns nil if not found
Types ¶
type ArxivResult ¶
type CrossrefResult ¶
type CrossrefResult struct {
Status string
Work *crossref.CrossrefWork
Comment string
Error error
}
type ElsevierResult ¶
type ElsevierResult struct {
Status string
Result *elsevier.SearchResult
Error error
}
type EntryConfig ¶
type OSTIResult ¶
type OnlineResult ¶
type Result ¶
type Result struct {
Text string
Arxiv ArxivResult
Crossref CrossrefResult
DOIOrg DOIOrgResult
Elsevier ElsevierResult
OSTI OSTIResult
Online OnlineResult
Web Search
Summary SummarizeResult
}
func Entry ¶
func Entry(text string, mode string, class entries.Classifier, extract documents.MetaExtractor, entryParser entries.Parser, cfg *EntryConfig, ) (*Result, error)
analyze bib entry `text`
func EntryFromBase64 ¶
func EntryFromBase64(encoded string, id int, mode string, class entries.Classifier, docExtract documents.EntryFromRawExtractor, docMeta documents.MetaExtractor, entryParser entries.Parser, cfg *EntryConfig, ) (*Result, error)
analyze entry `id` from base-64 encoded pdf file `encoded`
func EntryFromBibliography ¶ added in v0.3.0
func EntryFromBibliography(b *documents.Bibliography, id int, mode string, class entries.Classifier, docExtract documents.EntryFromBibliographyExtractor, docMeta documents.MetaExtractor, entryParser entries.Parser, cfg *EntryConfig, ) (*Result, error)
analyze entry `id` from a prepared bibliography artifact.
Source Files