-
Notifications
You must be signed in to change notification settings - Fork 105
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
11 changed files
with
883 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,130 @@ | ||
# Logs | ||
logs | ||
*.log | ||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* | ||
lerna-debug.log* | ||
.pnpm-debug.log* | ||
|
||
# Diagnostic reports (https://nodejs.org/api/report.html) | ||
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json | ||
|
||
# Runtime data | ||
pids | ||
*.pid | ||
*.seed | ||
*.pid.lock | ||
|
||
# Directory for instrumented libs generated by jscoverage/JSCover | ||
lib-cov | ||
|
||
# Coverage directory used by tools like istanbul | ||
coverage | ||
*.lcov | ||
|
||
# nyc test coverage | ||
.nyc_output | ||
|
||
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) | ||
.grunt | ||
|
||
# Bower dependency directory (https://bower.io/) | ||
bower_components | ||
|
||
# node-waf configuration | ||
.lock-wscript | ||
|
||
# Compiled binary addons (https://nodejs.org/api/addons.html) | ||
build/Release | ||
|
||
# Dependency directories | ||
node_modules/ | ||
jspm_packages/ | ||
|
||
# Snowpack dependency directory (https://snowpack.dev/) | ||
web_modules/ | ||
|
||
# TypeScript cache | ||
*.tsbuildinfo | ||
|
||
# Optional npm cache directory | ||
.npm | ||
|
||
# Optional eslint cache | ||
.eslintcache | ||
|
||
# Optional stylelint cache | ||
.stylelintcache | ||
|
||
# Microbundle cache | ||
.rpt2_cache/ | ||
.rts2_cache_cjs/ | ||
.rts2_cache_es/ | ||
.rts2_cache_umd/ | ||
|
||
# Optional REPL history | ||
.node_repl_history | ||
|
||
# Output of 'npm pack' | ||
*.tgz | ||
|
||
# Yarn Integrity file | ||
.yarn-integrity | ||
|
||
# dotenv environment variable files | ||
.env | ||
.env.development.local | ||
.env.test.local | ||
.env.production.local | ||
.env.local | ||
|
||
# parcel-bundler cache (https://parceljs.org/) | ||
.cache | ||
.parcel-cache | ||
|
||
# Next.js build output | ||
.next | ||
out | ||
|
||
# Nuxt.js build / generate output | ||
.nuxt | ||
dist | ||
|
||
# Gatsby files | ||
.cache/ | ||
# Comment in the public line in if your project uses Gatsby and not Next.js | ||
# https://nextjs.org/blog/next-9-1#public-directory-support | ||
# public | ||
|
||
# vuepress build output | ||
.vuepress/dist | ||
|
||
# vuepress v2.x temp and cache directory | ||
.temp | ||
.cache | ||
|
||
# Docusaurus cache and generated files | ||
.docusaurus | ||
|
||
# Serverless directories | ||
.serverless/ | ||
|
||
# FuseBox cache | ||
.fusebox/ | ||
|
||
# DynamoDB Local files | ||
.dynamodb/ | ||
|
||
# TernJS port file | ||
.tern-port | ||
|
||
# Stores VSCode versions used for testing VSCode extensions | ||
.vscode-test | ||
|
||
# yarn v2 | ||
.yarn/cache | ||
.yarn/unplugged | ||
.yarn/build-state.yml | ||
.yarn/install-state.gz | ||
.pnp.* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
{ | ||
"trailingComma": "es5", | ||
"tabWidth": 2, | ||
"semi": true, | ||
"singleQuote": true | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,100 @@ | ||
# ⚡ Node.js Sync with Qdrant Function | ||
|
||
Syncs documents in an Appwrite database collection to a [Qdrant](https://qdrant.tech/) collection. | ||
|
||
## 🧰 Usage | ||
|
||
### GET / | ||
|
||
Returns an HTML page where a search can be performed to test the sync of the documents. | ||
|
||
### POST / | ||
|
||
Triggers sync of the Appwrite database collection to Qdrant. | ||
|
||
## ⚙️ Configuration | ||
|
||
| Setting | Value | | ||
| ----------------- | ------------- | | ||
| Runtime | Node (18.0) | | ||
| Entrypoint | `src/main.js` | | ||
| Build Commands | `npm install` | | ||
| Permissions | `any` | | ||
| Timeout (Seconds) | 15 | | ||
|
||
## 🔒 Environment Variables | ||
|
||
### APPWRITE_API_KEY | ||
|
||
API Key to talk to Appwrite backend APIs. | ||
|
||
| Question | Answer | | ||
| ------------- | -------------------------------------------------------------------------------------------------- | | ||
| Required | Yes | | ||
| Sample Value | `d1efb...aec35` | | ||
| Documentation | [Appwrite: Getting Started for Server](https://appwrite.io/docs/getting-started-for-server#apiKey) | | ||
|
||
### APPWRITE_DATABASE_ID | ||
|
||
The ID of the Appwrite database that contains the collection to sync. | ||
|
||
| Question | Answer | | ||
| ------------- | --------------------------------------------------------- | | ||
| Required | Yes | | ||
| Sample Value | `612a3...5b6c9` | | ||
| Documentation | [Appwrite: Databases](https://appwrite.io/docs/databases) | | ||
|
||
### APPWRITE_COLLECTION_ID | ||
|
||
The ID of the collection in the Appwrite database to sync. | ||
|
||
| Question | Answer | | ||
| ------------- | ---------------------------------------------------------------------- | | ||
| Required | Yes | | ||
| Sample Value | `7c3e8...2a9f1` | | ||
| Documentation | [Appwrite: Collections](https://appwrite.io/docs/databases#collection) | | ||
|
||
### APPWRITE_ENDPOINT | ||
|
||
The URL endpoint of the Appwrite server. If not provided, it defaults to the Appwrite Cloud server: `https://cloud.appwrite.io/v1`. | ||
|
||
| Question | Answer | | ||
| ------------ | ------------------------------ | | ||
| Required | No | | ||
| Sample Value | `https://cloud.appwrite.io/v1` | | ||
|
||
### QDRANT_URL | ||
|
||
The URL of the Qdrant server. | ||
|
||
| Question | Answer | | ||
| ------------- | -------------------------------------------------------------------------------------------------- | | ||
| Required | Yes | | ||
| Documentation | [Qdrant Cloud](https://qdrant.tech/documentation/cloud/#getting-started-with-qdrant-managed-cloud) | | ||
|
||
### QDRANT_API_KEY | ||
|
||
The API key to authenticate requests to Qdrant cloud. | ||
|
||
| Question | Answer | | ||
| ------------- | -------------------------------------------------------------------------- | | ||
| Required | Yes | | ||
| Documentation | [Qdrant: API Keys](https://qdrant.tech/documentation/cloud/authentication) | | ||
|
||
### QDRANT_COLLECTION_NAME | ||
|
||
The name of the Qdrant collection to sync the documents to. | ||
|
||
| Question | Answer | | ||
| ------------- | ---------------------------------------------------------------------- | | ||
| Required | Yes | | ||
| Documentation | [Collections](https://qdrant.tech/documentation/concepts/collections/) | | ||
|
||
### OPENAI_API_KEY | ||
|
||
API Key for OpenAI API. Used to generate the embeddings for the documents. | ||
|
||
| Question | Answer | | ||
| ------------- | -------------------------------------------------------- | | ||
| Required | Yes | | ||
| Documentation | [OpenAI: API Keys](https://platform.openai.com/api-keys) | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
declare global { | ||
namespace NodeJS { | ||
interface ProcessEnv { | ||
APPWRITE_ENDPOINT?: string; | ||
APPWRITE_API_KEY: string; | ||
APPWRITE_FUNCTION_PROJECT_ID: string; | ||
APPWRITE_DATABASE_ID: string; | ||
APPWRITE_COLLECTION_ID: string; | ||
QDRANT_API_KEY: string; | ||
QDRANT_COLLECTION_NAME: string; | ||
QDRANT_URL: string; | ||
OPENAI_API_KEY: string; | ||
} | ||
} | ||
} | ||
|
||
export {}; |
Oops, something went wrong.