@memnexus-ai/typescript-sdk 1.1.1
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/LICENSE +21 -0
- package/README.md +197 -0
- package/dist/index.d.ts +4821 -0
- package/dist/index.js +5581 -0
- package/dist/index.mjs +5521 -0
- package/package.json +50 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,197 @@
|
|
|
1
|
+
# Memnexus TypeScript SDK 1.0.0
|
|
2
|
+
|
|
3
|
+
Welcome to the Memnexus SDK documentation. This guide will help you get started with integrating and using the Memnexus SDK in your project.
|
|
4
|
+
|
|
5
|
+
[](https://liblab.com/?utm_source=readme)
|
|
6
|
+
|
|
7
|
+
## Versions
|
|
8
|
+
|
|
9
|
+
- API version: `1.0.0`
|
|
10
|
+
- SDK version: `1.0.0`
|
|
11
|
+
|
|
12
|
+
## About the API
|
|
13
|
+
|
|
14
|
+
Core API service for MemNexus - single service boundary for all data access
|
|
15
|
+
|
|
16
|
+
## Table of Contents
|
|
17
|
+
|
|
18
|
+
- [Setup & Configuration](#setup--configuration)
|
|
19
|
+
- [Supported Language Versions](#supported-language-versions)
|
|
20
|
+
- [Installation](#installation)
|
|
21
|
+
- [Setting a Custom Timeout](#setting-a-custom-timeout)
|
|
22
|
+
- [Sample Usage](#sample-usage)
|
|
23
|
+
- [Services](#services)
|
|
24
|
+
- [Models](#models)
|
|
25
|
+
- [License](#license)
|
|
26
|
+
|
|
27
|
+
# Setup & Configuration
|
|
28
|
+
|
|
29
|
+
## Supported Language Versions
|
|
30
|
+
|
|
31
|
+
This SDK is compatible with the following versions: `TypeScript >= 4.8.4`
|
|
32
|
+
|
|
33
|
+
## Installation
|
|
34
|
+
|
|
35
|
+
To get started with the SDK, we recommend installing using `npm` or `yarn`:
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
npm install memnexus
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
or
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
yarn add memnexus
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
## Setting a Custom Timeout
|
|
48
|
+
|
|
49
|
+
You can set a custom timeout for the SDK's HTTP requests as follows:
|
|
50
|
+
|
|
51
|
+
```ts
|
|
52
|
+
const memnexus = new Memnexus({ timeout: 10000 });
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
# Sample Usage
|
|
56
|
+
|
|
57
|
+
Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:
|
|
58
|
+
|
|
59
|
+
```ts
|
|
60
|
+
import { Memnexus } from 'memnexus';
|
|
61
|
+
|
|
62
|
+
(async () => {
|
|
63
|
+
const memnexus = new Memnexus({});
|
|
64
|
+
|
|
65
|
+
const { data } = await memnexus.apiKeys.debugUser();
|
|
66
|
+
|
|
67
|
+
console.log(data);
|
|
68
|
+
})();
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
## Services
|
|
72
|
+
|
|
73
|
+
The SDK provides various services to interact with the API.
|
|
74
|
+
|
|
75
|
+
<details>
|
|
76
|
+
<summary>Below is a list of all available services with links to their detailed documentation:</summary>
|
|
77
|
+
|
|
78
|
+
| Name |
|
|
79
|
+
| :--------------------------------------------------------------------- |
|
|
80
|
+
| [ApiKeysService](documentation/services/ApiKeysService.md) |
|
|
81
|
+
| [ArtifactsService](documentation/services/ArtifactsService.md) |
|
|
82
|
+
| [ConversationsService](documentation/services/ConversationsService.md) |
|
|
83
|
+
| [FactsService](documentation/services/FactsService.md) |
|
|
84
|
+
| [GraphRagService](documentation/services/GraphRagService.md) |
|
|
85
|
+
| [HealthService](documentation/services/HealthService.md) |
|
|
86
|
+
| [MemoriesService](documentation/services/MemoriesService.md) |
|
|
87
|
+
| [SystemService](documentation/services/SystemService.md) |
|
|
88
|
+
| [PatternsService](documentation/services/PatternsService.md) |
|
|
89
|
+
| [BehaviorService](documentation/services/BehaviorService.md) |
|
|
90
|
+
| [TopicsService](documentation/services/TopicsService.md) |
|
|
91
|
+
| [CommunitiesService](documentation/services/CommunitiesService.md) |
|
|
92
|
+
|
|
93
|
+
</details>
|
|
94
|
+
|
|
95
|
+
## Models
|
|
96
|
+
|
|
97
|
+
The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.
|
|
98
|
+
|
|
99
|
+
<details>
|
|
100
|
+
<summary>Below is a list of all available models with links to their detailed documentation:</summary>
|
|
101
|
+
|
|
102
|
+
| Name | Description |
|
|
103
|
+
| :----------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------- |
|
|
104
|
+
| [ListApiKeysOkResponse](documentation/models/ListApiKeysOkResponse.md) | |
|
|
105
|
+
| [ApiKey](documentation/models/ApiKey.md) | |
|
|
106
|
+
| [Error](documentation/models/Error.md) | |
|
|
107
|
+
| [CreateApiKeyRequest](documentation/models/CreateApiKeyRequest.md) | |
|
|
108
|
+
| [CreateApiKeyCreatedResponse](documentation/models/CreateApiKeyCreatedResponse.md) | |
|
|
109
|
+
| [ListArtifactsOkResponse](documentation/models/ListArtifactsOkResponse.md) | |
|
|
110
|
+
| [Artifact](documentation/models/Artifact.md) | |
|
|
111
|
+
| [CreateArtifactRequest](documentation/models/CreateArtifactRequest.md) | |
|
|
112
|
+
| [CreateArtifactCreatedResponse](documentation/models/CreateArtifactCreatedResponse.md) | |
|
|
113
|
+
| [GetArtifactByIdOkResponse](documentation/models/GetArtifactByIdOkResponse.md) | |
|
|
114
|
+
| [UpdateArtifactRequest](documentation/models/UpdateArtifactRequest.md) | |
|
|
115
|
+
| [UpdateArtifactOkResponse](documentation/models/UpdateArtifactOkResponse.md) | |
|
|
116
|
+
| [ListConversationsOkResponse](documentation/models/ListConversationsOkResponse.md) | |
|
|
117
|
+
| [Conversation](documentation/models/Conversation.md) | |
|
|
118
|
+
| [Error](documentation/models/Error.md) | |
|
|
119
|
+
| [CreateConversationRequest](documentation/models/CreateConversationRequest.md) | |
|
|
120
|
+
| [CreateConversationCreatedResponse](documentation/models/CreateConversationCreatedResponse.md) | |
|
|
121
|
+
| [GetConversationSummaryOkResponse](documentation/models/GetConversationSummaryOkResponse.md) | |
|
|
122
|
+
| [GetConversationTimelineOkResponse](documentation/models/GetConversationTimelineOkResponse.md) | |
|
|
123
|
+
| [Memory](documentation/models/Memory.md) | |
|
|
124
|
+
| [SearchConversationsRequest](documentation/models/SearchConversationsRequest.md) | |
|
|
125
|
+
| [SearchConversationsOkResponse](documentation/models/SearchConversationsOkResponse.md) | |
|
|
126
|
+
| [FindConversationsByTopicRequest](documentation/models/FindConversationsByTopicRequest.md) | |
|
|
127
|
+
| [FindConversationsByTopicOkResponse](documentation/models/FindConversationsByTopicOkResponse.md) | |
|
|
128
|
+
| [ListFactsOkResponse](documentation/models/ListFactsOkResponse.md) | |
|
|
129
|
+
| [Fact](documentation/models/Fact.md) | |
|
|
130
|
+
| [CreateFactRequest](documentation/models/CreateFactRequest.md) | |
|
|
131
|
+
| [CreateFactCreatedResponse](documentation/models/CreateFactCreatedResponse.md) | |
|
|
132
|
+
| [GetFactByIdOkResponse](documentation/models/GetFactByIdOkResponse.md) | |
|
|
133
|
+
| [UpdateFactRequest](documentation/models/UpdateFactRequest.md) | |
|
|
134
|
+
| [UpdateFactOkResponse](documentation/models/UpdateFactOkResponse.md) | |
|
|
135
|
+
| [FactSearchRequest](documentation/models/FactSearchRequest.md) | |
|
|
136
|
+
| [SearchFactsOkResponse](documentation/models/SearchFactsOkResponse.md) | |
|
|
137
|
+
| [QueryCommunitiesRequest](documentation/models/QueryCommunitiesRequest.md) | |
|
|
138
|
+
| [GraphRagQueryRequest](documentation/models/GraphRagQueryRequest.md) | |
|
|
139
|
+
| [ExecuteGraphRagQueryOkResponse](documentation/models/ExecuteGraphRagQueryOkResponse.md) | |
|
|
140
|
+
| [GraphRagQueryResponse](documentation/models/GraphRagQueryResponse.md) | |
|
|
141
|
+
| [Memory](documentation/models/Memory.md) | |
|
|
142
|
+
| [Error](documentation/models/Error.md) | |
|
|
143
|
+
| [HealthCheck](documentation/models/HealthCheck.md) | |
|
|
144
|
+
| [ServiceCheck](documentation/models/ServiceCheck.md) | |
|
|
145
|
+
| [UpdateMemoryRequest](documentation/models/UpdateMemoryRequest.md) | |
|
|
146
|
+
| [UpdateMemoryOkResponse](documentation/models/UpdateMemoryOkResponse.md) | |
|
|
147
|
+
| [Memory](documentation/models/Memory.md) | |
|
|
148
|
+
| [Error](documentation/models/Error.md) | |
|
|
149
|
+
| [ListMemoriesOkResponse](documentation/models/ListMemoriesOkResponse.md) | |
|
|
150
|
+
| [Pagination](documentation/models/Pagination.md) | |
|
|
151
|
+
| [CreateMemoryRequest](documentation/models/CreateMemoryRequest.md) | |
|
|
152
|
+
| [CreateMemoryResponse](documentation/models/CreateMemoryResponse.md) | Response from creating a memory, includes the memory and session/conversation metadata |
|
|
153
|
+
| [CreateMemoryResponseMeta](documentation/models/CreateMemoryResponseMeta.md) | |
|
|
154
|
+
| [SearchRequest](documentation/models/SearchRequest.md) | |
|
|
155
|
+
| [SearchResponse](documentation/models/SearchResponse.md) | |
|
|
156
|
+
| [NoCache](documentation/models/NoCache.md) | |
|
|
157
|
+
| [Error](documentation/models/Error.md) | |
|
|
158
|
+
| [EvaluateFeatureFlagRequest](documentation/models/EvaluateFeatureFlagRequest.md) | |
|
|
159
|
+
| [AnalyzeMemoryQualityOkResponse](documentation/models/AnalyzeMemoryQualityOkResponse.md) | |
|
|
160
|
+
| [PruneMemoriesRequest](documentation/models/PruneMemoriesRequest.md) | |
|
|
161
|
+
| [PruneMemoriesOkResponse](documentation/models/PruneMemoriesOkResponse.md) | |
|
|
162
|
+
| [ListPatternsOkResponse](documentation/models/ListPatternsOkResponse.md) | |
|
|
163
|
+
| [Pattern](documentation/models/Pattern.md) | |
|
|
164
|
+
| [Error](documentation/models/Error.md) | |
|
|
165
|
+
| [CompilePatternsRequest](documentation/models/CompilePatternsRequest.md) | |
|
|
166
|
+
| [DetectPatternsRequest](documentation/models/DetectPatternsRequest.md) | |
|
|
167
|
+
| [AnalyzePatternsRequest](documentation/models/AnalyzePatternsRequest.md) | |
|
|
168
|
+
| [UpdatePatternRequest](documentation/models/UpdatePatternRequest.md) | |
|
|
169
|
+
| [RecordPatternFeedbackRequest](documentation/models/RecordPatternFeedbackRequest.md) | |
|
|
170
|
+
| [UpdateBehavioralStateRequest](documentation/models/UpdateBehavioralStateRequest.md) | |
|
|
171
|
+
| [ListTopicsOkResponse](documentation/models/ListTopicsOkResponse.md) | |
|
|
172
|
+
| [Topic](documentation/models/Topic.md) | |
|
|
173
|
+
| [Error](documentation/models/Error.md) | |
|
|
174
|
+
| [GetTopicByIdOkResponse](documentation/models/GetTopicByIdOkResponse.md) | |
|
|
175
|
+
| [MergeTopicsRequest](documentation/models/MergeTopicsRequest.md) | |
|
|
176
|
+
| [DiscoverRelatedTopicsRequest](documentation/models/DiscoverRelatedTopicsRequest.md) | |
|
|
177
|
+
| [CalculateTopicSimilarityRequest](documentation/models/CalculateTopicSimilarityRequest.md) | |
|
|
178
|
+
| [FindSimilarTopicsRequest](documentation/models/FindSimilarTopicsRequest.md) | |
|
|
179
|
+
| [ClusterTopicsRequest](documentation/models/ClusterTopicsRequest.md) | |
|
|
180
|
+
| [DetectCommunitiesRequest](documentation/models/DetectCommunitiesRequest.md) | |
|
|
181
|
+
| [SearchTopicsRequest](documentation/models/SearchTopicsRequest.md) | |
|
|
182
|
+
| [SearchTopicsOkResponse](documentation/models/SearchTopicsOkResponse.md) | |
|
|
183
|
+
| [ListCommunitiesOkResponse](documentation/models/ListCommunitiesOkResponse.md) | |
|
|
184
|
+
| [Community](documentation/models/Community.md) | |
|
|
185
|
+
| [GetCommunityByIdOkResponse](documentation/models/GetCommunityByIdOkResponse.md) | |
|
|
186
|
+
| [MergeCommunitiesRequest](documentation/models/MergeCommunitiesRequest.md) | |
|
|
187
|
+
| [MergeCommunitiesOkResponse](documentation/models/MergeCommunitiesOkResponse.md) | |
|
|
188
|
+
|
|
189
|
+
</details>
|
|
190
|
+
|
|
191
|
+
## License
|
|
192
|
+
|
|
193
|
+
This SDK is licensed under the MIT License.
|
|
194
|
+
|
|
195
|
+
See the [LICENSE](LICENSE) file for more details.
|
|
196
|
+
|
|
197
|
+
<!-- This file was generated by liblab | https://liblab.com/ -->
|