Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 0 additions & 7 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,6 @@
"modus/app-manifest",
"modus/data-fetching",
"modus/model-invoking",
"modus/search",
"modus/api-generation",
"modus/authentication",
"modus/error-handling",
Expand All @@ -107,7 +106,6 @@
"group": "AssemblyScript SDK",
"pages": [
"modus/sdk/assemblyscript/overview",
"modus/sdk/assemblyscript/collections",
"modus/sdk/assemblyscript/console",
"modus/sdk/assemblyscript/dgraph",
"modus/sdk/assemblyscript/graphql",
Expand All @@ -123,7 +121,6 @@
"group": "Go SDK",
"pages": [
"modus/sdk/go/overview",
"modus/sdk/go/collections",
"modus/sdk/go/console",
"modus/sdk/go/dgraph",
"modus/sdk/go/graphql",
Expand Down Expand Up @@ -503,10 +500,6 @@
"destination": "/introduction",
"permanent": true
},
{
"source": "/modus/sdk/collections",
"destination": "/modus/sdk/assemblyscript/collections"
},
{
"source": "/modus/sdk/console",
"destination": "/modus/sdk/assemblyscript/console"
Expand Down
4 changes: 0 additions & 4 deletions getting-started-with-hyper-commerce.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -120,10 +120,6 @@ In the Hypermode console, you’ll see several key components of your project:
- **[Functions](/modus/overview):** These are serverless functions written in
AssemblyScript (a TypeScript-like language) that are automatically exposed as
GraphQL APIs. Once deployed, you can query these functions within your app.
- **[Collections](/modus/sdk/assemblyscript/collections):** Hypermode offers
built-in key-value storage, known as collections, with support for vector
embeddings. This allows you to store and retrieve data efficiently, without
requiring a database for basic use cases.
- **[Models](/modus/sdk/assemblyscript/models):** This section represents the AI
models defined for your project. These models handle tasks like embedding text
into vectors for search. Hypermode provides open source shared and dedicated
Expand Down
46 changes: 0 additions & 46 deletions modus/app-manifest.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,6 @@ resources for your functions at runtime. You define the manifest in the
<Card title="Models" icon="cube" href="#models">
Define inference services for use in your functions
</Card>
<Card title="Collections" icon="table" href="#collections">
Define sets of text data to enable natural language search
</Card>
</CardGroup>

### Base manifest
Expand Down Expand Up @@ -516,46 +513,3 @@ dedicated instance of the model. Your project's functions securely access the
hosted model, with no further configuration required.

</Tip>

## Collections

Collections simplify the usage of vector embeddings to build natural language
search features. The `collections` object allows you to define indexed data
types that are automatically embedded and searchable based on the search method
you define.

Each collection requires a unique name, specified as a key, containing only
alphanumeric characters and hyphens.

For more detail on implementing Collections, see [Search](/modus/search).

```json modus.json
{
"collections": {
"myProducts": {
"searchMethods": {
"searchMethod": {
"embedder": "myEmbedder",
"index": {
"type": "sequential"
}
}
}
}
}
}
```

<ResponseField name="searchMethods" type="object" required>
Search methods define a pair of an embedder and index to make available for
searching the data in your collection.
</ResponseField>

<ResponseField name="embedder" type="string" required>
The function name to embed text added to the collection.
</ResponseField>

<ResponseField name="index" type="string">
If provided, describes the index mechanism used by the search method. `type`:
specifies the type of the index. For example, `sequential` (default).
</ResponseField>
3 changes: 1 addition & 2 deletions modus/model-invoking.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -256,5 +256,4 @@ export function classifyText(text: string, threshold: f32): string {

Modus supports invoking embedding models for text, images, and other data types.
You use the outputs of these models for implementing search, recommendation, and
similarity functions in your app. Refer to [Search](/modus/search) for more
information on how to use embeddings in your app.
similarity functions in your app.
1 change: 0 additions & 1 deletion modus/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,5 @@ A few of the core Modus features include:
| [Multi-Language](/modus/project-structure) | Write functions in Go and AssemblyScript, with additional language support in development |
| [Auto-Generated API](/modus/api-generation) | A secure API is automatically generated from your function signatures |
| [Model Integration](/modus/model-invoking) | Connect and invoke AI models from different providers, without learning a new SDK |
| [Search](/modus/search) | Add natural language search and recommendations with integrated vector embeddings |
| [Authentication](/modus/authentication) | Secure your API endpoints with minimal configuration |
| **WebAssembly Runtime** | Small and portable execution engine for deployment across server, edge, and desktop computes |
6 changes: 3 additions & 3 deletions modus/project-structure.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,9 @@ configuration separated from your source code.

The `modus.json` [app manifest](/modus/app-manifest) is the central
configuration file for your Modus app. It defines the endpoints, connections,
models, and collections that your code has available to it during runtime.
Because Modus is a secure-by-default framework, only the resources defined in
this file are accessible to your app.
and models that your code has available to it during runtime. Because Modus is a
secure-by-default framework, only the resources defined in this file are
accessible to your app.

## Initializing your app

Expand Down
8 changes: 0 additions & 8 deletions modus/run-locally.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -98,11 +98,3 @@ hyp login

After logging in, your app automatically connects to Hypermode's
[Model Router](/model-router) when running locally.

## Working with Collections

Collections requires a PostgreSQL instance for local development. While
Hypermode manages this database in production, you'll need to set up PostgreSQL
locally when developing outside the Hypermode platform. For detailed setup
instructions, see
[Develop locally with Collections](/modus/search#develop-locally-with-collections).
Loading