Memnexus TypeScript SDK 1.0.0

Welcome to the Memnexus SDK documentation. This guide will help you get started with integrating and using the Memnexus SDK in your project.

Versions

• API version: 1.0.0
• SDK version: 1.0.0

About the API

Core API service for MemNexus - single service boundary for all data access

Table of Contents

• Setup & Configuration
  • Supported Language Versions
  • Installation
• Setting a Custom Timeout
• Sample Usage
• Services
• Models
• License

Setup & Configuration

Supported Language Versions

This SDK is compatible with the following versions: TypeScript >= 4.8.4

Installation

To get started with the SDK, we recommend installing using npm or yarn:

npm install memnexus

or

yarn add memnexus

Setting a Custom Timeout

You can set a custom timeout for the SDK's HTTP requests as follows:

const memnexus = new Memnexus({ timeout: 10000 });

Sample Usage

Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:

import { Memnexus } from 'memnexus';

(async () => {
  const memnexus = new Memnexus({});

  const { data } = await memnexus.apiKeys.debugUser();

  console.log(data);
})();

Services

The SDK provides various services to interact with the API.

| Name | | :--------------------------------------------------------------------- | | ApiKeysService | | ArtifactsService | | ConversationsService | | FactsService | | GraphRagService | | HealthService | | MemoriesService | | SystemService | | PatternsService | | BehaviorService | | TopicsService | | CommunitiesService |

Models

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.

| Name | Description | | :----------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------- | | ListApiKeysOkResponse | | | ApiKey | | | Error | | | CreateApiKeyRequest | | | CreateApiKeyCreatedResponse | | | ListArtifactsOkResponse | | | Artifact | | | CreateArtifactRequest | | | CreateArtifactCreatedResponse | | | GetArtifactByIdOkResponse | | | UpdateArtifactRequest | | | UpdateArtifactOkResponse | | | ListConversationsOkResponse | | | Conversation | | | Error | | | CreateConversationRequest | | | CreateConversationCreatedResponse | | | GetConversationSummaryOkResponse | | | GetConversationTimelineOkResponse | | | Memory | | | SearchConversationsRequest | | | SearchConversationsOkResponse | | | FindConversationsByTopicRequest | | | FindConversationsByTopicOkResponse | | | ListFactsOkResponse | | | Fact | | | CreateFactRequest | | | CreateFactCreatedResponse | | | GetFactByIdOkResponse | | | UpdateFactRequest | | | UpdateFactOkResponse | | | FactSearchRequest | | | SearchFactsOkResponse | | | QueryCommunitiesRequest | | | GraphRagQueryRequest | | | ExecuteGraphRagQueryOkResponse | | | GraphRagQueryResponse | | | Memory | | | Error | | | HealthCheck | | | ServiceCheck | | | UpdateMemoryRequest | | | UpdateMemoryOkResponse | | | Memory | | | Error | | | ListMemoriesOkResponse | | | Pagination | | | CreateMemoryRequest | | | CreateMemoryResponse | Response from creating a memory, includes the memory and session/conversation metadata | | CreateMemoryResponseMeta | | | SearchRequest | | | SearchResponse | | | NoCache | | | Error | | | EvaluateFeatureFlagRequest | | | AnalyzeMemoryQualityOkResponse | | | PruneMemoriesRequest | | | PruneMemoriesOkResponse | | | ListPatternsOkResponse | | | Pattern | | | Error | | | CompilePatternsRequest | | | DetectPatternsRequest | | | AnalyzePatternsRequest | | | UpdatePatternRequest | | | RecordPatternFeedbackRequest | | | UpdateBehavioralStateRequest | | | ListTopicsOkResponse | | | Topic | | | Error | | | GetTopicByIdOkResponse | | | MergeTopicsRequest | | | DiscoverRelatedTopicsRequest | | | CalculateTopicSimilarityRequest | | | FindSimilarTopicsRequest | | | ClusterTopicsRequest | | | DetectCommunitiesRequest | | | SearchTopicsRequest | | | SearchTopicsOkResponse | | | ListCommunitiesOkResponse | | | Community | | | GetCommunityByIdOkResponse | | | MergeCommunitiesRequest | | | MergeCommunitiesOkResponse | |

License

This SDK is licensed under the MIT License.

See the LICENSE file for more details.