Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation on search_ function queries #85

Closed
danibene opened this issue Feb 21, 2024 · 3 comments
Closed

Documentation on search_ function queries #85

danibene opened this issue Feb 21, 2024 · 3 comments

Comments

@danibene
Copy link
Contributor

Hi! Thank you so much for developing this package and making it public :)

I am wondering if you have any examples for what is expected for the query parameter in the search_ functions, e.g., search_semanticscholar(). Is there a way to specify multiple keywords and AND/OR operators?

@danibene
Copy link
Contributor Author

Ok, I believe I have figured it out: https://www.semanticscholar.org/product/api%2Ftutorial#using-search-query-operators

So one example could be: docs = litstudy.search_semanticscholar("((cloud computing) | virtualization) +security", limit=10, batch_size=5)

Maybe this reference could be added to the docstring?

@stijnh
Copy link
Member

stijnh commented Feb 21, 2024

Hi! Indeed, we send the query directly to the semanticscholar api without any processing, so you can just follow their guide.

Expanding the information in the docstring sounds like a good idea. If you make a pull request to add that reference to the docstring, we would be more than happy to merge your contribution!

Let us know if you run into any other problems (either in code or in the documentation).

@stijnh
Copy link
Member

stijnh commented Feb 21, 2024

This has been resolved by #86

Thanks for your contribution!

@stijnh stijnh closed this as completed Feb 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants