6 releases

new 0.2.2 Dec 15, 2024
0.2.1 Dec 15, 2024
0.1.2 Dec 14, 2024

#462 in Web programming

Download history 495/week @ 2024-12-09

495 downloads per month

MIT license

47KB
1K SLoC

CircleCI Crates.io Version

Rust Semantic Scholar API Tools

Tools for Semantic Scholar API.

LOGO

Quick Start

Installation

To start using ss-tools, just add it to your project's dependencies in the Cargo.toml.

> cargo add ss-tools

API Key

If you have an API key, set it as an environmental value in a .env file

SEMANTIC_SCHOLAR_API_KEY = xxxxxxxxxxxxxxxxxxxxxxxx

Then, import it in your program;

use ss_tools::SemanticScholar;

Usage

Search by paper title

Pass any keywords or title of a paper. The original API returns multiple papers that could be related to the query_text. For now, ss-tools returns the first paper from the response.

In the future, we plan to improve the library to output the paper most relevant to the query_text based on similarity metrics.

let query_text = "attention is all you need";

let mut ss = SemanticScholar::new();
let paper_id = ss.query_paper_id(query_text.to_string(), &mut 5, 10).await; // paperId, max_retry_count, wait_time(sec)
assert_eq!(paper_id, "204e3073870fae3d05bcbc2f6a8e263d9b72e776");

Get details about a paper

Pass the paper_id that you want to know its details, and a list of SsField.

The returned SsResponse object has all the available fields.

let paper_id = "204e3073870fae3d05bcbc2f6a8e263d9b72e776";

let mut ss = SemanticScholar::new();
let fields = vec![
    SsField::Title,
    SsField::Abstract,
    SsField::Authors(vec![
        SsAuthorField::Name,
        SsAuthorField::Affiliations,
        SsAuthorField::HIndex,
    ]),
    SsField::CitationCount,
    SsField::ReferenceCount,
    SsField::Year,
    SsField::IsOpenAccess,
    SsField::PublicationDate,
    SsField::Venue,
    SsField::FieldsOfStudy,
    SsField::Citations(vec![SsField::Title, SsField::Year, SsField::CitationCount]),
    SsField::References(vec![SsField::Title, SsField::Year, SsField::CitationCount]),
    SsField::Journal,
    SsField::PublicationVenue,
    SsField::OpenAccessPdf,
    SsField::S2FieldsOfStudy,
    SsField::PublicationTypes,
    SsField::CitationStyles,
    SsField::Embedding,
];

let paper_details: SsResponse = ss.query_paper_details(paper_id.to_string(), fields, &mut 5, 10).await; // paper_id ,fields, max_retry_count, wait_time(sec)
assert_eq!(
    paper_details.clone().title.unwrap().to_lowercase(),
    "attention is all you need".to_string()
);

For detials about SsResponse, see the document Struct SsResponse.

Get references of a paper

let paper_id = "204e3073870fae3d05bcbc2f6a8e263d9b72e776";

let mut ss = SemanticScholar::new();
let fields = vec![
    SsField::Title,
    SsField::Year,
    SsField::Contexts,
    SsField::Intents,
    SsField::IsInfluential,
    SsField::ContextsWithIntent,
];

let paper_citations: SsResponsePapers = ss
    .query_paper_citations(paper_id.to_string(), fields, &mut 5, 10) // paper_id, fields, max_retry_count, wait_time(sec)
    .await
    .unwrap();

// SsResponsePapers.data: Vec<SsResponse>
assert!(paper_citations.data.len() > 10);

Get citations of a paper

let paper_id = "204e3073870fae3d05bcbc2f6a8e263d9b72e776";

let mut ss = SemanticScholar::new();
let fields = vec![
    SsField::Title,
    SsField::Year,
    SsField::Contexts,
    SsField::Intents,
    SsField::IsInfluential,
    SsField::ContextsWithIntent,
];

let paper_citations: SsResponsePapers = ss
    .query_paper_references(paper_id.to_string(), fields, &mut 5, 10) // paperId, fields, max_retry_count, wait_time(sec)
    .await
    .unwrap();

// SsResponsePapers.data: Vec<SsResponse>
assert!(paper_citations.data.len() > 10);

Get details about a author

COMMING SOON!

Updates

0.2.2
  • Fixed README.md
    • added the Semantic Scholar instruction about API key.
0.2.1
  • Fixed README.md
0.2.0
  • apply the Levenshtein algorithm to extract the correct title.
  • added retry loop when the Semantic Scholar API fails.
  • added new API to get citations of a paper
  • added new API to get references of a paper

Dependencies

~10–21MB
~288K SLoC