Skip to content

Commit f1724ab

Browse files
mattjohnsonpintmattjohnsonpint
committed
Create overview pages for each SDK
1 parent 377b8c6 commit f1724ab

File tree

4 files changed

+141
-0
lines changed

4 files changed

+141
-0
lines changed

‎modus/sdk/assemblyscript/overview.mdx‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,62 @@ sidebarTitle: "Overview"
44
description: "Learn how to use the Modus AssemblyScript SDK"
55
icon: "circle-info"
66
---
7+
8+
import SdkOverviewIntro from "/snippets/sdk-overview-intro.mdx"
9+
10+
<SdkOverviewIntro language="AssemblyScript" />
11+
12+
## Importing the APIs
13+
14+
The Modus AssemblyScript SDK organizes its APIs into namespaces based on their
15+
purpose. In your AssemblyScript code, you can import each namespace you'd like
16+
to use like this:
17+
18+
```ts
19+
import { <namespace> } from "@hypermode/modus-sdk-as"
20+
```
21+
22+
## Available APIs
23+
24+
import SdkTip from "/snippets/sdk-tip.mdx"
25+
26+
<SdkTip />
27+
28+
The following namespaces are available. They're grouped into categories below
29+
for your convenience. Click on a namespace to view more information about its
30+
APIs.
31+
32+
### Client APIs
33+
34+
| Namespace | Purpose |
35+
| :--------------------- | :--------------------------------------------------------------------------------- |
36+
| [`http`](./http) | Provides access to external HTTP endpoints, including REST APIs and other services |
37+
| [`graphql`](./graphql) | Allows you to securely call and fetch data from any GraphQL endpoint |
38+
39+
### Database APIs
40+
41+
| Namespace | Purpose |
42+
| :--------------------------- | :---------------------------------------------- |
43+
| [`dgraph`](./dgraph) | Access and modify data in a Dgraph database |
44+
| [`mysql`](./mysql) | Access and modify data in a MySQL database |
45+
| [`neo4j`](./neo4j) | Access and modify data in a Neo4j database |
46+
| [`postgresql`](./postgresql) | Access and modify data in a PostgreSQL database |
47+
48+
### Inference APIs
49+
50+
| Namespace | Purpose |
51+
| :------------------- | :--------------------------------------------------------------------------------------------- |
52+
| [`models`](./models) | Invoke AI models, including large language models, embedding models, and classification models |
53+
54+
### Storage APIs
55+
56+
| Namespace | Purpose |
57+
| :----------------------------- | :--------------------------------------------------------- |
58+
| [`collections`](./collections) | Provides integrated storage and vector search capabilities |
59+
60+
### System APIs
61+
62+
| Namespace | Purpose |
63+
| :------------------------- | :------------------------------------------------------- |
64+
| [`console`](./console) | Provides logging, assertion, and timing functions |
65+
| [`localtime`](./localtime) | Allows you to access the user's local time and time zone |

‎modus/sdk/go/overview.mdx‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,60 @@ sidebarTitle: "Overview"
44
description: "Learn how to use the Modus Go SDK"
55
icon: "circle-info"
66
---
7+
8+
import SdkOverviewIntro from "/snippets/sdk-overview-intro.mdx"
9+
10+
<SdkOverviewIntro language="Go" />
11+
12+
## Importing the APIs
13+
14+
The Modus Go SDK organizes its APIs into packages based on their purpose. In
15+
your Go code, you can import each package you'd like to use like this:
16+
17+
```go
18+
import "github.com/hypermodeinc/modus/sdk/go/pkg/<package>"
19+
```
20+
21+
## Available APIs
22+
23+
import SdkTip from "/snippets/sdk-tip.mdx"
24+
25+
<SdkTip />
26+
27+
The following packages are available. They're grouped into categories below for
28+
your convenience. Click on a package to view more information about its APIs.
29+
30+
### Client APIs
31+
32+
| Package | Purpose |
33+
| :--------------------- | :--------------------------------------------------------------------------------- |
34+
| [`http`](./http) | Provides access to external HTTP endpoints, including REST APIs and other services |
35+
| [`graphql`](./graphql) | Allows you to securely call and fetch data from any GraphQL endpoint |
36+
37+
### Database APIs
38+
39+
| Package | Purpose |
40+
| :--------------------------- | :---------------------------------------------- |
41+
| [`dgraph`](./dgraph) | Access and modify data in a Dgraph database |
42+
| [`mysql`](./mysql) | Access and modify data in a MySQL database |
43+
| [`neo4j`](./neo4j) | Access and modify data in a Neo4j database |
44+
| [`postgresql`](./postgresql) | Access and modify data in a PostgreSQL database |
45+
46+
### Inference APIs
47+
48+
| Package | Purpose |
49+
| :------------------- | :--------------------------------------------------------------------------------------------- |
50+
| [`models`](./models) | Invoke AI models, including large language models, embedding models, and classification models |
51+
52+
### Storage APIs
53+
54+
| Package | Purpose |
55+
| :----------------------------- | :--------------------------------------------------------- |
56+
| [`collections`](./collections) | Provides integrated storage and vector search capabilities |
57+
58+
### System APIs
59+
60+
| Package | Purpose |
61+
| :------------------------- | :------------------------------------------------------- |
62+
| [`console`](./console) | Provides logging, assertion, and timing functions |
63+
| [`localtime`](./localtime) | Allows you to access the user's local time and time zone |

‎snippets/sdk-overview-intro.mdx‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
The Modus {language} SDK provides a set of APIs that allow you to interact
2+
with various databases and services in Modus apps written in {language}.
3+
It's designed to work seamlessly with the Modus platform, enabling you to build
4+
powerful applications with ease.
5+
6+
<Info>
7+
8+
The Modus SDKs come in multiple languages, each following the conventions for
9+
that language, including its capabilities and limitations. While each SDK
10+
provides similar features, the APIs may differ slightly between languages. Be
11+
sure to refer to the documentation for the specific SDK you're using.
12+
13+
Wherever possible, we've tried to keep the APIs consistent across languages.
14+
However, you may find differences in the APIs due to language-specific
15+
constraints.
16+
17+
If you have any questions or need help, please reach out to us via the `#modus`
18+
channel on the [Hypermode Discord server](https://discord.hypermode.com/).
19+
20+
</Info>

‎snippets/sdk-tip.mdx‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<Tip>
2+
We're constantly introducing new APIs through ongoing development with early users.
3+
Please [open an issue](https://github.com/hypermodeinc/modus/issues)
4+
if you have ideas on what would make Modus even more powerful for your next app!
5+
</Tip>

0 commit comments

Comments
 (0)