@sovant/sdk 1.0.2 → 1.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +84 -11
- package/dist/index.js +6 -6
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,30 +1,103 @@
|
|
|
1
1
|
# Sovant TypeScript SDK
|
|
2
|
+
|
|
3
|
+
**AI Infrastructure: Memory-as-a-Service for AI systems.**
|
|
4
|
+
The official TypeScript/JavaScript client for the Sovant Memory API.
|
|
5
|
+
|
|
2
6
|
[](https://www.npmjs.com/package/@sovant/sdk)
|
|
7
|
+
[](https://sovant.ai/docs)
|
|
8
|
+
[](https://github.com/sovant-ai/sovant)
|
|
9
|
+
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
## What is Sovant?
|
|
13
|
+
|
|
14
|
+
Sovant is an **AI infrastructure company** providing the **memory layer for AI systems**.
|
|
15
|
+
Our platform makes it simple to persist, search, and manage conversational and contextual data securely across sessions, channels, and applications.
|
|
16
|
+
|
|
17
|
+
- **Problem:** Most AI systems forget everything once a session ends. This causes compliance risks, knowledge loss, and poor user experience.
|
|
18
|
+
- **Solution:** Sovant provides a **Memory-as-a-Service API** — a single SDK and API key that lets you store, retrieve, and search memories with audit-ready controls.
|
|
19
|
+
- **Target audience:** Developers, startups, and enterprises building AI agents, copilots, or compliance-driven apps who need context persistence.
|
|
20
|
+
|
|
21
|
+
---
|
|
22
|
+
|
|
23
|
+
## Installation
|
|
3
24
|
|
|
4
|
-
## Install
|
|
5
25
|
```bash
|
|
6
|
-
npm
|
|
26
|
+
npm install @sovant/sdk
|
|
27
|
+
# or
|
|
28
|
+
yarn add @sovant/sdk
|
|
29
|
+
# or
|
|
30
|
+
pnpm add @sovant/sdk
|
|
7
31
|
```
|
|
8
32
|
|
|
9
|
-
##
|
|
33
|
+
## 60-Second Quickstart
|
|
34
|
+
|
|
10
35
|
```typescript
|
|
11
36
|
import { Sovant } from "@sovant/sdk";
|
|
12
37
|
|
|
13
38
|
const sv = new Sovant({ apiKey: process.env.SOVANT_API_KEY! });
|
|
14
39
|
|
|
40
|
+
// Create a memory
|
|
15
41
|
await sv.memory.create({
|
|
16
|
-
data: { note: "
|
|
17
|
-
type: "preference"
|
|
18
|
-
ttl: "30d"
|
|
42
|
+
data: { note: "User prefers morning meetings" },
|
|
43
|
+
type: "preference"
|
|
19
44
|
});
|
|
20
45
|
|
|
21
|
-
|
|
22
|
-
|
|
46
|
+
// Search memories
|
|
47
|
+
const results = await sv.memory.search({
|
|
48
|
+
query: "meeting preferences",
|
|
23
49
|
topK: 3
|
|
24
50
|
});
|
|
25
51
|
|
|
26
|
-
console.log(
|
|
52
|
+
console.log(results);
|
|
27
53
|
```
|
|
28
54
|
|
|
29
|
-
##
|
|
30
|
-
|
|
55
|
+
## Features
|
|
56
|
+
|
|
57
|
+
- **Memory CRUD** — create, retrieve, update, delete memories
|
|
58
|
+
- **Semantic Search** — query memories with filters and topK ranking
|
|
59
|
+
- **Threads** — link related memories via thread_id (REST API)
|
|
60
|
+
- **Batch Operations (Beta)** — atomic multi-operation support
|
|
61
|
+
- **Compliance-ready** — audit trails, PDPA/GDPR-friendly by design
|
|
62
|
+
- **SDKs** — official TypeScript and Python SDKs, with REST API reference
|
|
63
|
+
|
|
64
|
+
## SDKs and Documentation
|
|
65
|
+
|
|
66
|
+
- [TypeScript SDK Documentation](https://sovant.ai/docs/sdk/typescript)
|
|
67
|
+
- [Python SDK on PyPI](https://pypi.org/project/sovant/)
|
|
68
|
+
- [REST API Reference](https://sovant.ai/docs/api)
|
|
69
|
+
- [Full Documentation](https://sovant.ai/docs)
|
|
70
|
+
|
|
71
|
+
## API Overview
|
|
72
|
+
|
|
73
|
+
### Endpoints Summary
|
|
74
|
+
- `POST /api/v1/memory` — Create memory
|
|
75
|
+
- `GET /api/v1/memory` — List memories
|
|
76
|
+
- `GET /api/v1/memories/{id}` — Get memory by ID
|
|
77
|
+
- `PATCH|PUT /api/v1/memories/{id}` — Update memory
|
|
78
|
+
- `DELETE /api/v1/memories/{id}` — Delete memory
|
|
79
|
+
- `GET /api/v1/memory/search` — Search memories
|
|
80
|
+
- `POST /api/v1/memory/batch` — Batch operations (Beta)
|
|
81
|
+
|
|
82
|
+
## Field Mapping Note
|
|
83
|
+
|
|
84
|
+
- **SDK level:** accepts `data`
|
|
85
|
+
- **API level:** expects `content`
|
|
86
|
+
- SDK automatically converts `data` → `content`.
|
|
87
|
+
- `subject` is deprecated (ignored by API). Use `thread_id`, `tags`, or `metadata` for grouping.
|
|
88
|
+
|
|
89
|
+
## Status of Advanced Features
|
|
90
|
+
|
|
91
|
+
- **Batch API:** Available, marked Beta.
|
|
92
|
+
- **Threads:** Fully supported via REST API.
|
|
93
|
+
- **Webhooks, personalization, multi-channel sync:** Coming soon.
|
|
94
|
+
|
|
95
|
+
## Versioning & Changelog
|
|
96
|
+
|
|
97
|
+
- **Stable release:** 1.0.3
|
|
98
|
+
- Earlier build 1.0.0 was experimental and is deprecated.
|
|
99
|
+
- See [CHANGELOG.md](./CHANGELOG.md) for details.
|
|
100
|
+
|
|
101
|
+
## License
|
|
102
|
+
|
|
103
|
+
MIT © Sovant AI
|
package/dist/index.js
CHANGED
|
@@ -6,7 +6,7 @@ export class Sovant {
|
|
|
6
6
|
if (!opts?.apiKey)
|
|
7
7
|
throw new Error("Missing apiKey");
|
|
8
8
|
this.apiKey = opts.apiKey;
|
|
9
|
-
this.baseUrl = (opts.baseUrl ?? process.env.SOVANT_BASE_URL ?? "https://
|
|
9
|
+
this.baseUrl = (opts.baseUrl ?? process.env.SOVANT_BASE_URL ?? "https://sovant.ai").replace(/\/+$/, "");
|
|
10
10
|
this.timeout = opts.timeoutMs ?? 30000;
|
|
11
11
|
}
|
|
12
12
|
async req(path, init) {
|
|
@@ -42,7 +42,7 @@ export class Sovant {
|
|
|
42
42
|
}
|
|
43
43
|
}
|
|
44
44
|
memory = {
|
|
45
|
-
create: (input) => this.req("/v1/memory", {
|
|
45
|
+
create: (input) => this.req("/api/v1/memory", {
|
|
46
46
|
method: "POST",
|
|
47
47
|
body: JSON.stringify({
|
|
48
48
|
content: typeof input.data === 'string' ? input.data : JSON.stringify(input.data),
|
|
@@ -53,7 +53,7 @@ export class Sovant {
|
|
|
53
53
|
thread_id: input.thread_id
|
|
54
54
|
})
|
|
55
55
|
}),
|
|
56
|
-
get: (id) => this.req(`/v1/memories/${encodeURIComponent(id)}`, {
|
|
56
|
+
get: (id) => this.req(`/api/v1/memories/${encodeURIComponent(id)}`, {
|
|
57
57
|
method: "GET"
|
|
58
58
|
}),
|
|
59
59
|
search: (q) => {
|
|
@@ -72,11 +72,11 @@ export class Sovant {
|
|
|
72
72
|
params.append('from_date', q.from_date);
|
|
73
73
|
if (q.to_date)
|
|
74
74
|
params.append('to_date', q.to_date);
|
|
75
|
-
return this.req(`/v1/memory/search?${params.toString()}`, {
|
|
75
|
+
return this.req(`/api/v1/memory/search?${params.toString()}`, {
|
|
76
76
|
method: "GET"
|
|
77
77
|
});
|
|
78
78
|
},
|
|
79
|
-
update: (id, patch) => this.req(`/v1/memories/${encodeURIComponent(id)}`, {
|
|
79
|
+
update: (id, patch) => this.req(`/api/v1/memories/${encodeURIComponent(id)}`, {
|
|
80
80
|
method: "PATCH",
|
|
81
81
|
body: JSON.stringify({
|
|
82
82
|
content: patch.data ? (typeof patch.data === 'string' ? patch.data : JSON.stringify(patch.data)) : undefined,
|
|
@@ -86,7 +86,7 @@ export class Sovant {
|
|
|
86
86
|
metadata: patch.metadata
|
|
87
87
|
})
|
|
88
88
|
}),
|
|
89
|
-
delete: (id) => this.req(`/v1/memories/${encodeURIComponent(id)}`, {
|
|
89
|
+
delete: (id) => this.req(`/api/v1/memories/${encodeURIComponent(id)}`, {
|
|
90
90
|
method: "DELETE"
|
|
91
91
|
})
|
|
92
92
|
};
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAMA,MAAM,OAAO,MAAM;IACT,MAAM,CAAS;IACf,OAAO,CAAS;IAChB,OAAO,CAAS;IAExB,YAAY,IAAyB;QACnC,IAAI,CAAC,IAAI,EAAE,MAAM;YAAE,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;QACrD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC1B,IAAI,CAAC,OAAO,GAAG,CAAC,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,eAAe,IAAI,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAMA,MAAM,OAAO,MAAM;IACT,MAAM,CAAS;IACf,OAAO,CAAS;IAChB,OAAO,CAAS;IAExB,YAAY,IAAyB;QACnC,IAAI,CAAC,IAAI,EAAE,MAAM;YAAE,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;QACrD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC1B,IAAI,CAAC,OAAO,GAAG,CAAC,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,eAAe,IAAI,mBAAmB,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QACxG,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,SAAS,IAAI,KAAK,CAAC;IACzC,CAAC;IAEO,KAAK,CAAC,GAAG,CAAI,IAAY,EAAE,IAAiB;QAClD,MAAM,GAAG,GAAG,IAAI,eAAe,EAAE,CAAC;QAClC,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACvD,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,IAAI,CAAC,OAAO,GAAG,IAAI,EAAE,EAAE;gBAChD,GAAG,IAAI;gBACP,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;oBAClC,eAAe,EAAE,UAAU,IAAI,CAAC,MAAM,EAAE;oBACxC,GAAG,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;iBACxB;gBACD,MAAM,EAAE,GAAG,CAAC,MAAM;aACnB,CAAC,CAAC;YACH,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;YAC9B,IAAI,IAAS,CAAC;YACd,IAAI,CAAC;gBACH,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAC7C,CAAC;YAAC,MAAM,CAAC;gBACP,IAAI,GAAG,IAAI,CAAC;YACd,CAAC;YACD,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;gBACZ,MAAM,GAAG,GAAG,IAAI,EAAE,OAAO,IAAI,GAAG,CAAC,UAAU,CAAC;gBAC5C,MAAM,IAAI,GAAG,IAAI,EAAE,IAAI,IAAI,QAAQ,GAAG,CAAC,MAAM,EAAE,CAAC;gBAChD,MAAM,IAAI,WAAW,CAAC,GAAG,EAAE,IAAI,EAAE,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YACrD,CAAC;YACD,OAAO,IAAS,CAAC;QACnB,CAAC;gBAAS,CAAC;YACT,YAAY,CAAC,EAAE,CAAC,CAAC;QACnB,CAAC;IACH,CAAC;IAED,MAAM,GAAG;QACP,MAAM,EAAE,CAAU,KAOjB,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,gBAAgB,EAAE;YAC/B,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACnB,OAAO,EAAE,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC;gBACjF,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,SAAS;gBAC7B,GAAG,EAAE,KAAK,CAAC,GAAG;gBACd,IAAI,EAAE,KAAK,CAAC,IAAI;gBAChB,QAAQ,EAAE,KAAK,CAAC,QAAQ;gBACxB,SAAS,EAAE,KAAK,CAAC,SAAS;aAC3B,CAAC;SACH,CAAC;QAEF,GAAG,EAAE,CAAC,EAAU,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,oBAAoB,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAAE;YAC1E,MAAM,EAAE,KAAK;SACd,CAAC;QAEF,MAAM,EAAE,CAAC,CAQR,EAAE,EAAE;YACH,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;YACrC,IAAI,CAAC,CAAC,KAAK;gBAAE,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC;YAC7C,IAAI,CAAC,CAAC,IAAI;gBAAE,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;YAC1C,IAAI,CAAC,CAAC,IAAI;gBAAE,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;YACpD,IAAI,CAAC,CAAC,SAAS;gBAAE,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC;YACzD,IAAI,CAAC,CAAC,KAAK;gBAAE,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;YACxD,IAAI,CAAC,CAAC,SAAS;gBAAE,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC;YACzD,IAAI,CAAC,CAAC,OAAO;gBAAE,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC;YACnD,OAAO,IAAI,CAAC,GAAG,CAAC,yBAAyB,MAAM,CAAC,QAAQ,EAAE,EAAE,EAAE;gBAC5D,MAAM,EAAE,KAAK;aACd,CAAC,CAAC;QACL,CAAC;QAED,MAAM,EAAE,CAAU,EAAU,EAAE,KAM5B,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,oBAAoB,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAAE;YAC5D,MAAM,EAAE,OAAO;YACf,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACnB,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;gBAC5G,IAAI,EAAE,KAAK,CAAC,IAAI;gBAChB,GAAG,EAAE,KAAK,CAAC,GAAG;gBACd,IAAI,EAAE,KAAK,CAAC,IAAI;gBAChB,QAAQ,EAAE,KAAK,CAAC,QAAQ;aACzB,CAAC;SACH,CAAC;QAEF,MAAM,EAAE,CAAC,EAAU,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,oBAAoB,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAAE;YAC7E,MAAM,EAAE,QAAQ;SACjB,CAAC;KACH,CAAC;CACH;AAED,MAAM,OAAO,WAAY,SAAQ,KAAK;IACpC,IAAI,CAAS;IACb,MAAM,CAAU;IAChB,OAAO,CAAO;IAEd,YAAY,OAAe,EAAE,IAAY,EAAE,MAAe,EAAE,OAAa;QACvE,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,aAAa,CAAC;QAC1B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;CACF"}
|