Interact with the Deep Search platform for new knowledge explorations and discoveries
Project description
DeepSearch Toolkit
Interact with the Deep Search platform for new knowledge explorations and discoveries
The Deep Search Toolkit is a Python SDK allowing a user to interact with the Deep Search platform. The Toolkit provides easy-to-use functionalities for several common processes such as document conversion, graph creation and querying.
Quick links
Install
Using poetry
in your project? Add the toolkit with:
$ poetry add deepsearch-toolkit
New to poetry
? Visit https://python-poetry.org/ or our CONTRIBUTING.md section.
Using pip
:
$ pip install deepsearch-toolkit
Requirements
Python 3.8+
Start using the toolkit
// Login to Deep Search,
// see https://ds4sd.github.io/deepsearch-toolkit/getting_started/#authentication
$ deepsearch login
...
// Convert a document
// for more details, see https://ds4sd.github.io/deepsearch-toolkit/guide/convert_doc/
$ deepsearch documents convert -p 1234567890abcdefghijklmnopqrstvwyz123456 -u https://arxiv.org/pdf/2206.00785.pdf
Submitting input: : 100%|██████████████████████████████| 1/1 [00:01<00:00, 1.52s/it]
Converting input: : 100%|██████████████████████████████| 1/1 [00:33<00:00, 33.80s/it]
Downloading result: : 100%|██████████████████████████████| 1/1 [00:01<00:00, 1.11s/it]
Total online documents 1
Successfully converted documents 1
Get help and support
Please feel free to connect with us using the discussion section.
Contributing
Please read Contributing to Deep Search Toolkit for details.
References
If you use Deep Search
in your projects, please consider citing the following:
@software{Deep Search Toolkit,
author = {Deep Search Team},
month = {6},
title = {{Deep Search Toolkit}},
url = {https://github.com/DS4SD/deepsearch-toolkit},
version = {main},
year = {2022}
}
License
The Deep Search Toolkit
codebase is under MIT license.
For individual model usage, please refer to the model licenses found in the original packages.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for deepsearch_toolkit-0.13.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 902b7d4ff17b2915af4504cbdf44fc60f58ab1f5bf36ea723d763edefdcf9e1e |
|
MD5 | 93585ac64e544e0fd6c012c4cdee24b0 |
|
BLAKE2b-256 | 718a2a550adf655c2ec71fac044171bcdb31cf02bed139460d909b0503b6334e |
Hashes for deepsearch_toolkit-0.13.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 87305e55d112bc639f34befb5a1fc4dfe33a558424753109e6163e4d1c336b3a |
|
MD5 | d5f4495fb9f2ac78731df3030dfbd2a9 |
|
BLAKE2b-256 | cbe3a28cbd126fc17fd32e9e25db057fa9d783e655440279f9ba13723e15a829 |