Skip to content

Commit 813b9eb

Browse files
loks0nloks0n
authored
Merge pull request #290 from Anush008/feat-287-sync-with-qdrant-ts
feat: sync-with-qdrant template-typescript
2 parents b8070bf + bb1d591 commit 813b9eb

File tree

11 files changed

+889
-0
lines changed

11 files changed

+889
-0
lines changed

‎node-typescript/sync-with-qdrant/.gitignore

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
# Logs
2+
logs
3+
*.log
4+
npm-debug.log*
5+
yarn-debug.log*
6+
yarn-error.log*
7+
lerna-debug.log*
8+
.pnpm-debug.log*
9+
10+
# Diagnostic reports (https://nodejs.org/api/report.html)
11+
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
12+
13+
# Runtime data
14+
pids
15+
*.pid
16+
*.seed
17+
*.pid.lock
18+
19+
# Directory for instrumented libs generated by jscoverage/JSCover
20+
lib-cov
21+
22+
# Coverage directory used by tools like istanbul
23+
coverage
24+
*.lcov
25+
26+
# nyc test coverage
27+
.nyc_output
28+
29+
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
30+
.grunt
31+
32+
# Bower dependency directory (https://bower.io/)
33+
bower_components
34+
35+
# node-waf configuration
36+
.lock-wscript
37+
38+
# Compiled binary addons (https://nodejs.org/api/addons.html)
39+
build/Release
40+
41+
# Dependency directories
42+
node_modules/
43+
jspm_packages/
44+
45+
# Snowpack dependency directory (https://snowpack.dev/)
46+
web_modules/
47+
48+
# TypeScript cache
49+
*.tsbuildinfo
50+
51+
# Optional npm cache directory
52+
.npm
53+
54+
# Optional eslint cache
55+
.eslintcache
56+
57+
# Optional stylelint cache
58+
.stylelintcache
59+
60+
# Microbundle cache
61+
.rpt2_cache/
62+
.rts2_cache_cjs/
63+
.rts2_cache_es/
64+
.rts2_cache_umd/
65+
66+
# Optional REPL history
67+
.node_repl_history
68+
69+
# Output of 'npm pack'
70+
*.tgz
71+
72+
# Yarn Integrity file
73+
.yarn-integrity
74+
75+
# dotenv environment variable files
76+
.env
77+
.env.development.local
78+
.env.test.local
79+
.env.production.local
80+
.env.local
81+
82+
# parcel-bundler cache (https://parceljs.org/)
83+
.cache
84+
.parcel-cache
85+
86+
# Next.js build output
87+
.next
88+
out
89+
90+
# Nuxt.js build / generate output
91+
.nuxt
92+
dist
93+
94+
# Gatsby files
95+
.cache/
96+
# Comment in the public line in if your project uses Gatsby and not Next.js
97+
# https://nextjs.org/blog/next-9-1#public-directory-support
98+
# public
99+
100+
# vuepress build output
101+
.vuepress/dist
102+
103+
# vuepress v2.x temp and cache directory
104+
.temp
105+
.cache
106+
107+
# Docusaurus cache and generated files
108+
.docusaurus
109+
110+
# Serverless directories
111+
.serverless/
112+
113+
# FuseBox cache
114+
.fusebox/
115+
116+
# DynamoDB Local files
117+
.dynamodb/
118+
119+
# TernJS port file
120+
.tern-port
121+
122+
# Stores VSCode versions used for testing VSCode extensions
123+
.vscode-test
124+
125+
# yarn v2
126+
.yarn/cache
127+
.yarn/unplugged
128+
.yarn/build-state.yml
129+
.yarn/install-state.gz
130+
.pnp.*

‎node-typescript/sync-with-qdrant/.prettierrc.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"trailingComma": "es5",
3+
"tabWidth": 2,
4+
"semi": true,
5+
"singleQuote": true
6+
}

‎node-typescript/sync-with-qdrant/README.md

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
# ⚡ Node.js (Typescript) Sync with Qdrant Function
2+
3+
Syncs documents in an Appwrite database collection to a [Qdrant](https://qdrant.tech/) collection.
4+
5+
## 🧰 Usage
6+
7+
### GET /
8+
9+
Returns an HTML page where a search can be performed to test the sync of the documents.
10+
11+
### POST /
12+
13+
Triggers sync of the Appwrite database collection to Qdrant.
14+
15+
## ⚙️ Configuration
16+
17+
| Setting | Value |
18+
| ----------------- | ------------- |
19+
| Runtime | Node (18.0) |
20+
| Entrypoint | `src/main.js` |
21+
| Build Commands | `npm install` |
22+
| Permissions | `any` |
23+
| Timeout (Seconds) | 15 |
24+
25+
## 🔒 Environment Variables
26+
27+
### APPWRITE_API_KEY
28+
29+
API Key to talk to Appwrite backend APIs.
30+
31+
| Question | Answer |
32+
| ------------- | -------------------------------------------------------------------------------------------------- |
33+
| Required | Yes |
34+
| Sample Value | `d1efb...aec35` |
35+
| Documentation | [Appwrite: Getting Started for Server](https://appwrite.io/docs/getting-started-for-server#apiKey) |
36+
37+
### APPWRITE_DATABASE_ID
38+
39+
The ID of the Appwrite database that contains the collection to sync.
40+
41+
| Question | Answer |
42+
| ------------- | --------------------------------------------------------- |
43+
| Required | Yes |
44+
| Sample Value | `612a3...5b6c9` |
45+
| Documentation | [Appwrite: Databases](https://appwrite.io/docs/databases) |
46+
47+
### APPWRITE_COLLECTION_ID
48+
49+
The ID of the collection in the Appwrite database to sync.
50+
51+
| Question | Answer |
52+
| ------------- | ---------------------------------------------------------------------- |
53+
| Required | Yes |
54+
| Sample Value | `7c3e8...2a9f1` |
55+
| Documentation | [Appwrite: Collections](https://appwrite.io/docs/databases#collection) |
56+
57+
### APPWRITE_ENDPOINT
58+
59+
The URL endpoint of the Appwrite server. If not provided, it defaults to the Appwrite Cloud server: `https://cloud.appwrite.io/v1`.
60+
61+
| Question | Answer |
62+
| ------------ | ------------------------------ |
63+
| Required | No |
64+
| Sample Value | `https://cloud.appwrite.io/v1` |
65+
66+
### QDRANT_URL
67+
68+
The URL of the Qdrant server.
69+
70+
| Question | Answer |
71+
| ------------- | -------------------------------------------------------------------------------------------------- |
72+
| Required | Yes |
73+
| Documentation | [Qdrant Cloud](https://qdrant.tech/documentation/cloud/#getting-started-with-qdrant-managed-cloud) |
74+
75+
### QDRANT_API_KEY
76+
77+
The API key to authenticate requests to Qdrant cloud.
78+
79+
| Question | Answer |
80+
| ------------- | -------------------------------------------------------------------------- |
81+
| Required | Yes |
82+
| Documentation | [Qdrant: API Keys](https://qdrant.tech/documentation/cloud/authentication) |
83+
84+
### QDRANT_COLLECTION_NAME
85+
86+
The name of the Qdrant collection to sync the documents to.
87+
88+
| Question | Answer |
89+
| ------------- | ---------------------------------------------------------------------- |
90+
| Required | Yes |
91+
| Documentation | [Collections](https://qdrant.tech/documentation/concepts/collections/) |
92+
93+
### OPENAI_API_KEY
94+
95+
API Key for OpenAI API. Used to generate the embeddings for the documents.
96+
97+
| Question | Answer |
98+
| ------------- | -------------------------------------------------------- |
99+
| Required | Yes |
100+
| Documentation | [OpenAI: API Keys](https://platform.openai.com/api-keys) |

‎node-typescript/sync-with-qdrant/env.d.ts

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
declare global {
2+
namespace NodeJS {
3+
interface ProcessEnv {
4+
APPWRITE_ENDPOINT?: string;
5+
APPWRITE_API_KEY: string;
6+
APPWRITE_FUNCTION_PROJECT_ID: string;
7+
APPWRITE_DATABASE_ID: string;
8+
APPWRITE_COLLECTION_ID: string;
9+
QDRANT_API_KEY: string;
10+
QDRANT_COLLECTION_NAME: string;
11+
QDRANT_URL: string;
12+
OPENAI_API_KEY: string;
13+
}
14+
}
15+
}
16+
17+
export {};

0 commit comments

Comments
 (0)