1.0.1 • Published 4 months ago

@shoprag/rag-universe v1.0.1

Weekly downloads
-
License
MIT
Repository
-
Last release
4 months ago

@shoprag/rag-universe

A RAG plugin for ShopRAG that manages files within a Universe server, leveraging its vector embedding capabilities.

Installation

npm install @shoprag/rag-universe

Configuration

Add the following to the RAGs array in your shoprag.json:

{
  "to": "universe",
  "config": {
    "serverUrl": "http://your-universe-server.com",
    "universe": "your-universe-name"
  }
}
  • serverUrl: The URL of the Universe server (required).
  • universe: The name of the universe to manage files in (required).

Credentials

This plugin requires a bearer token for authentication with the Universe server.

Usage

The plugin integrates with ShopRAG to:

  • Add Files: Stores new files with fileId as the ID and content as text.
  • Update Files: Overwrites existing files using the same fileId.
  • Delete Files: Removes files by fileId.
  • Delete All Files: Clears all files in the specified universe.

Run shoprag to execute the pipeline, ensuring the Universe server is running and accessible.

Prerequisites

  • A running Universe server.
  • Node.js with fetch support (v18+ recommended).

License

This project is licensed under the MIT License.

1.0.1

4 months ago

1.0.0

4 months ago