Getting Started

Hyperspace engine uses native Python syntax and can be seamlessly integrated into an existing Python project or be used as a stand-alone code. Using HyperSpace requires setting local client, which provides a convenient interface to manage data and access run vector and similarity search queries. The main steps for integration:

Set Hyperspace environment
(Optional) Ingest data
Build and run queries
Install Hyperspace API client

Installing Hyperspace Client

The client can be installed using a standard shell command:

pip install python-client-search-master-master.zip

Setting the Hyperspace Environment

Set the environment:

import search_master

Set the local host:

conf = search_master.configuration.Configuration()
conf.host = 'address provided by HyperSpace'
api_client = search_master.api_client.ApiClient(configuration=conf)

Create a local instance

api_instance = search_master.SearchMasterApi(api_client=api_client)

login_response = api_instance.login({"username":””,
                                    "password": “”})
api_client = search_master.api_client.ApiClient(              configuration=conf, header_name='Authorization',
             header_value="Bearer " + login_response.token)