Skip to content

Deep Search Toolkit

PyPI version PyPI - Python Version License MIT Code style: black Docs Downloads

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 features for several common document workflows such as conversion, graph creation, and querying, including semantic retrieval and RAG.

Deep Search Deep Search GitHub Examples

Getting Started

Install

pip install deepsearch-toolkit

pipx install deepsearch-toolkit

poetry add deepsearch-toolkit

Set up your Profile

After logging in to Deep Search, you can set up your profile as shown below:

  1. click on the Toolkit / API icon on the top-right corner
  2. from the Toolkit section, copy the command and run on your terminal
  3. when prompted for the API key, copy it from the HTTP section and complete the setup

Deep Search Authentication Info

To quickly check your profile setup, run the following — your projects should be displayed:

deepsearch cps projects list

import deepsearch as ds
api = ds.CpsApi.from_env()
print([p.name for p in api.projects.list()])

Multi-profile support

You can set up multiple profiles, e.g. for different deployments. For details on managing profiles, check Profiles.

Start Using the Toolkit

Check out Deep Search Examples for interactive notebooks showcasing various common usage scenarios and find inspiration on how to make the most out of your own documents.