https://github.com/qdrant/rivet-plugin-qdrant
https://github.com/qdrant/rivet-plugin-qdrant
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/qdrant/rivet-plugin-qdrant
- Owner: qdrant
- License: apache-2.0
- Created: 2024-04-29T05:09:49.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-21T16:37:03.000Z (almost 2 years ago)
- Last Synced: 2025-05-09T18:54:32.304Z (about 1 year ago)
- Language: TypeScript
- Size: 218 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Rivet Qdrant Plugin
A plugin to add support for using [Qdrant](https://qdrant.tech) in [Rivet](https://rivet.ironcladapp.com/).
> [!IMPORTANT]
> You must use the [Node Executor](https://rivet.ironcladapp.com/docs/user-guide/executors#node) with this plugin.
## Using the plugin
### In Rivet
To use this plugin in Rivet:
1. Open the plugins overlay at the top of the screen.
2. Search for "rivet-plugin-qdrant".
3. Click the "Install" button to install the plugin in your current project.
### In the SDK
1. Import the plugin and Rivet into your project:
```ts
import * as Rivet from "@ironclad/rivet";
import RivetPluginQdrant from "rivet-plugin-qdrant";
```
2. Initialize the plugin and register the nodes with the `globalRivetNodeRegistry`:
```ts
Rivet.globalRivetNodeRegistry.registerPlugin(RivetPluginQdrant(Rivet));
```
(You may also use your own node registry if you wish, instead of the global one.)
3. The nodes will now work when run with `runGraphInFile` or `createProcessor`.
## Configuration
### In Rivet
By default, the plugin will attempt to connect to a Qdrant instance at `http://localhost:6333`. To configure this value, you can open the Settings window, navigate to the Plugins area, and configure the `Database URL` value. There's also an option to set an optional API key.
### In the SDK
Using `createProcessor` or `runGraphInFile`, pass in via `pluginSettings` in `RunGraphOptions`:
```ts
await createProcessor(project, {
...etc,
pluginSettings: {
qdrant: {
qdrantUrl: "http://localhost:6333",
},
},
});
```