Interact with the Deep Search platform for new knowledge explorations and discoveries
Project description
Deep Search Toolkit
Interact with the Deep Search platform for new knowledge explorations and discoveries
The Deep Search Toolkit is a Python SDK and CLI allowing users 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
To set up, just install deepsearch-toolkit
with your packaging tool.
With poetry
:
poetry add deepsearch-toolkit
With pip
:
pip install deepsearch-toolkit
Extras
Optional functionality can be installed as package "extras". To install all extras, use
deepsearch-toolkit[all]
with your packaging tool.
Install as toolkit developer
If you are a Deep Search Toolkit developer, set up as follows:
poetry install --all-extras
Requirements
Python 3.8+
Start using the toolkit
Set up a profile
For details, check Profiles.
deepsearch profile config
Convert a document
For details, check Document conversion.
deepsearch documents convert -p 1234567890abcdefghijklmnopqrstvwyz123456 -u https://arxiv.org/pdf/2206.00785.pdf
The output should look like:
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.26.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0854d612530e37213837fb3db94636a174df631eaf5af09c9c1cc366e24ebe4c |
|
MD5 | 13ff5fac3885c63610c394c154033c60 |
|
BLAKE2b-256 | f283584df067c45620672cf0ef00303cf38ac95403469aaa3b6187b33973f00c |
Hashes for deepsearch_toolkit-0.26.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 198669959c21722d274854d967027565f50e1cdbcd6add442017d316c00186f3 |
|
MD5 | 15c9b913948b4dbfe72c91d4b0c872af |
|
BLAKE2b-256 | c6337d002cac867d200ec91eeecf7c9ad0809bdb57e302513b71de23bf3b2a9e |