Core Concepts

​

Users

Hyperspell is a multi-tenant platform, and you can have multiple users in your app. You don’t have to explicitly create users in Hyperspell — you simply pass the user id from your own database or authentication provider to Hyperspell. As we’ll learn in the authentication section, Hyperspell lets you generate user tokens that are specific to a user and can be used to query data from Hyperspell for that user only. However, you can also use an app token and not associate data with a specific user.

​

Documents

When we say documents, we really mean any data that you want to index and query. This can be anything from a single text file, an email, a slack channel, a CSV file, an image, or even a PDF.

There are two ways of getting documents into Hyperspell:

​

Collections

A collection is a group of documents. When you add data to Hyperspell, it is added to a collection. Depending on on your use case, you can use collections for different purposes.

1. Personal Collections: Most commonly, a collection is used to store documents for a single user.
2. Topical Collections: These are collections that are relevant to a specific topic or only include a certain type of document, such as marketing materials, or legal documents.
3. Special purpose collections: These are collections that are used for a specific purpose, for example, only documents relevant to a specific chat session.