SemanticScholarClient

Struct SemanticScholarClient 

Source
pub struct SemanticScholarClient { /* private fields */ }
Expand description

Client for Semantic Scholar API

Provides methods to search for academic papers, retrieve citations and references, filter by fields of study, and convert results to SemanticVector format for RuVector analysis.

§Rate Limiting

The client automatically enforces rate limits:

  • Without API key: 100 requests per 5 minutes (3 seconds between requests)
  • With API key: Higher limits (200ms between requests)

§API Key

Set the SEMANTIC_SCHOLAR_API_KEY environment variable to use authenticated requests.

Implementations§

Source§

impl SemanticScholarClient

Source

pub fn new(api_key: Option<String>) -> Self

Create a new Semantic Scholar API client

§Arguments
  • api_key - Optional API key. If None, checks SEMANTIC_SCHOLAR_API_KEY env var
§Example
// Without API key
let client = SemanticScholarClient::new(None);

// With API key
let client = SemanticScholarClient::new(Some("your-api-key".to_string()));
Source

pub fn with_embedding_dim(api_key: Option<String>, embedding_dim: usize) -> Self

Create a new client with custom embedding dimension

§Arguments
  • api_key - Optional API key
  • embedding_dim - Dimension for text embeddings (default: 384)
Source

pub async fn search_papers( &self, query: &str, limit: usize, ) -> Result<Vec<SemanticVector>>

Search papers by keywords

§Arguments
  • query - Search query (keywords, title, etc.)
  • limit - Maximum number of results to return (max 100 per request)
§Example
let vectors = client.search_papers("deep learning transformers", 50).await?;
Source

pub async fn get_paper(&self, paper_id: &str) -> Result<Option<SemanticVector>>

Get a single paper by Semantic Scholar paper ID

§Arguments
  • paper_id - Semantic Scholar paper ID (e.g., “649def34f8be52c8b66281af98ae884c09aef38b”)
§Example
let paper = client.get_paper("649def34f8be52c8b66281af98ae884c09aef38b").await?;
Source

pub async fn get_citations( &self, paper_id: &str, limit: usize, ) -> Result<Vec<SemanticVector>>

Get papers that cite this paper

§Arguments
  • paper_id - Semantic Scholar paper ID
  • limit - Maximum number of citations to return (max 1000)
§Example
let citations = client.get_citations("649def34f8be52c8b66281af98ae884c09aef38b", 50).await?;
Source

pub async fn get_references( &self, paper_id: &str, limit: usize, ) -> Result<Vec<SemanticVector>>

Get papers this paper references

§Arguments
  • paper_id - Semantic Scholar paper ID
  • limit - Maximum number of references to return (max 1000)
§Example
let references = client.get_references("649def34f8be52c8b66281af98ae884c09aef38b", 50).await?;
Source

pub async fn search_by_field( &self, field_of_study: &str, limit: usize, ) -> Result<Vec<SemanticVector>>

Search papers by field of study

§Arguments
  • field_of_study - Field name (e.g., “Computer Science”, “Medicine”, “Biology”, “Physics”, “Economics”)
  • limit - Maximum number of results to return
§Example
let cs_papers = client.search_by_field("Computer Science", 100).await?;
let medical_papers = client.search_by_field("Medicine", 50).await?;
Source

pub async fn get_author(&self, author_id: &str) -> Result<Vec<SemanticVector>>

Get author details and their papers

§Arguments
  • author_id - Semantic Scholar author ID
§Example
let author_papers = client.get_author("1741101").await?;
Source

pub async fn search_recent( &self, query: &str, year_min: i32, ) -> Result<Vec<SemanticVector>>

Search recent papers published after a minimum year

§Arguments
  • query - Search query
  • year_min - Minimum publication year (e.g., 2020)
§Example
// Get papers about "climate change" published since 2020
let recent = client.search_recent("climate change", 2020).await?;
Source

pub async fn build_citation_graph( &self, paper_id: &str, max_citations: usize, max_references: usize, ) -> Result<(Option<SemanticVector>, Vec<SemanticVector>, Vec<SemanticVector>)>

Build citation graph for a paper

Returns a tuple of (paper, citations, references) as SemanticVectors

§Arguments
  • paper_id - Semantic Scholar paper ID
  • max_citations - Maximum citations to retrieve
  • max_references - Maximum references to retrieve
§Example
let (paper, citations, references) = client.build_citation_graph(
    "649def34f8be52c8b66281af98ae884c09aef38b",
    50,
    50
).await?;

Trait Implementations§

Source§

impl Default for SemanticScholarClient

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more