feat: add adapter-qdrant #2322

oxf71 · 2025-01-15T09:22:29Z

Relates to

Add qdrant adapter into Eliza system.

Risks

Low

Main implementation risk is that the Adapter doesn't work correctly.

Background

What does this PR do?

Add a new adapter for qdrant.

What kind of change is this?

Features (non-breaking change which adds functionality).

Documentation changes needed?

Testing

Where should a reviewer start?

Detailed testing steps

Configure the env value below

QDRANT_URL=
QDRANT_KEY=
QDRANT_PORT=443
QDRANT_VECTOR_SIZE=1536

field settings->ragKnowledge set true
set knowledge field

Discord username

j0771x
misasky

Summary by CodeRabbit

New Features
- Added Qdrant database adapter support
- Introduced new configuration parameters for Qdrant service
- Enhanced database initialization with Qdrant integration
Dependencies
- Added @elizaos/adapter-qdrant package
- Added @qdrant/js-client-rest dependency
Configuration
- Updated environment variables for Qdrant connection
- Added new package configuration for Qdrant adapter

github-actions

Hi @oxf71! Welcome to the elizaOS community. Thanks for submitting your first pull request; your efforts are helping us accelerate towards AGI. We'll review it shortly. You are now an elizaOS contributor!

wtfsayo · 2025-01-16T09:59:20Z

@coderabbitai review

coderabbitai · 2025-01-16T10:03:07Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The pull request introduces a new Qdrant database adapter for the project, expanding the database integration capabilities. Changes include adding configuration parameters for Qdrant in the .env.example file, creating a new @elizaos/adapter-qdrant package, and modifying the agent's database initialization logic to support Qdrant as a database option. The implementation provides a comprehensive set of methods for managing various data types like knowledge, memories, goals, and participants.

Changes

File	Change Summary
`.env.example`	Added Qdrant configuration variables: `QDRANT_URL`, `QDRANT_KEY`, `QDRANT_PORT`, `QDRANT_VECTOR_SIZE`
`agent/package.json`	Added `@elizaos/adapter-qdrant` dependency
`agent/src/index.ts`	Imported `QdrantDatabaseAdapter` and updated database initialization logic
`packages/adapter-qdrant/.npmignore`	Added `.npmignore` to specify files to ignore when publishing
`packages/adapter-qdrant/eslint.config.mjs`	Introduced ESLint configuration file extending global config
`packages/adapter-qdrant/package.json`	Created package configuration with name, version, dependencies, and scripts
`packages/adapter-qdrant/src/index.ts`	Added `QdrantDatabaseAdapter` class with methods for database operations
`packages/adapter-qdrant/tsconfig.json`	Added TypeScript configuration extending base config
`packages/adapter-qdrant/tsup.config.ts`	Introduced `tsup` configuration for building the package

Possibly related PRs

feat: support autonome platform #2121: Introduces new configuration parameters for the Qdrant service, similar to this PR.
feat: add birdeye plugin #1417: Adds a new dependency for the @elizaos/adapter-qdrant package, connecting to the integration with external services.
feat: add getMemoryByIds to database adapters #2293: Adds a method to retrieve memories by IDs across various database adapters, enhancing data retrieval capabilities.

Suggested labels

Needs Testing, Plugin_new

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 5

🧹 Nitpick comments (2)

packages/adapter-qdrant/src/index.ts (1)

143-179: Enhance caching strategy with invalidation and size limits.

An in-memory cache without eviction policy can lead to uncontrolled memory growth. Consider implementing cache invalidation and setting size limits.
.env.example (1)
554-559: Add documentation comments for Qdrant configuration.

While the variables and default values are appropriate, adding brief documentation comments would help users understand:

The expected format for QDRANT_URL

Whether QDRANT_KEY is optional

Why these specific default values were chosen
 # Qdrant
-QDRANT_URL=
-QDRANT_KEY=
-QDRANT_PORT=443
-QDRANT_VECTOR_SIZE=1536
+# URL of your Qdrant instance (e.g., https://your-instance.qdrant.tech)
+QDRANT_URL=
+# API key for authentication (optional for local instances)
+QDRANT_KEY=
+# Qdrant service port (default: 443 for cloud, typically 6333 for local)
+QDRANT_PORT=443
+# Vector size matching your embedding model (default: 1536 for OpenAI embeddings)
+QDRANT_VECTOR_SIZE=1536

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 30b1c69 and 2b65c93.

📒 Files selected for processing (9)

.env.example (1 hunks)
agent/package.json (1 hunks)
agent/src/index.ts (2 hunks)
packages/adapter-qdrant/.npmignore (1 hunks)
packages/adapter-qdrant/eslint.config.mjs (1 hunks)
packages/adapter-qdrant/package.json (1 hunks)
packages/adapter-qdrant/src/index.ts (1 hunks)
packages/adapter-qdrant/tsconfig.json (1 hunks)
packages/adapter-qdrant/tsup.config.ts (1 hunks)

✅ Files skipped from review due to trivial changes (4)

packages/adapter-qdrant/tsconfig.json
packages/adapter-qdrant/.npmignore
packages/adapter-qdrant/tsup.config.ts
packages/adapter-qdrant/eslint.config.mjs

🔇 Additional comments (2)

packages/adapter-qdrant/package.json (1)

1-30: LGTM!

The package.json is correctly configured with appropriate dependencies and scripts.

agent/package.json (1)

26-26: LGTM! Qdrant adapter dependency added correctly.

The dependency is properly added using workspace syntax and maintains alphabetical ordering.

packages/adapter-qdrant/src/index.ts

agent/src/index.ts

… feat-adapter-qdrant

wtfsayo · 2025-01-19T15:32:51Z

@coderabbitai review

coderabbitai · 2025-01-19T15:32:53Z

@wtfsayo i'll review the changes in this pr that adds a new qdrant adapter.

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

wtfsayo · 2025-01-19T15:34:41Z

@oxf71 can you share demo if possible;

Also please allow us to push updates to PR

coderabbitai

Actionable comments posted: 1

🧹 Nitpick comments (1)

packages/adapter-qdrant/src/index.ts (1)
41-58: Use descriptive variable name in preprocess method

Renaming the variable c to processedContent enhances code readability and clarity.

Apply this diff:
-        const c =  content
+        const processedContent = content
...
-        return c
+        return processedContent

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2b65c93 and 048931f.

📒 Files selected for processing (4)

.env.example (1 hunks)
agent/package.json (1 hunks)
agent/src/index.ts (2 hunks)
packages/adapter-qdrant/src/index.ts (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

agent/package.json
.env.example

🔇 Additional comments (2)

agent/src/index.ts (2)

3-3: Import statement is correct

The import of QdrantDatabaseAdapter is properly added.

574-587: Database initialization logic for Qdrant is accurate

The added conditional check for environment variables and initialization of QdrantDatabaseAdapter are correctly implemented.

packages/adapter-qdrant/src/index.ts

…qdrant # Conflicts: # agent/package.json

oxf71 · 2025-01-20T06:42:55Z

@oxf71 can you share demo if possible;

Also please allow us to push updates to PR

We are using the "trump character". The "knowledge" field needs to be changed to a path format. After testing, we found that there is a difference: the implemented knowledge method is only invoked when it is set to the path format.

pnpm run dev --characters="characters/trump.character.json"

"knowledge": [
    {
      "path": "trump.txt"
    }
  ],

…qdrant # Conflicts: # agent/package.json

wtfsayo · 2025-01-22T17:55:33Z

hey @oxf71 can you share a demo of it working? Personally superexcited for this

wtfsayo · 2025-01-22T17:57:07Z

also can't resolve conflict or/and push change to this branch myself

root added 3 commits January 14, 2025 14:49

adapter-qdrant

7da8f01

update

f7cd4e0

chore: add cache && env conf

34d36ef

github-actions bot reviewed Jan 15, 2025

View reviewed changes

144757737+oxf71@users.noreply.github.com and others added 3 commits January 15, 2025 17:35

Merge branch 'develop' into feat-adapter-qdrant

53701d8

chore: remove search limit

ee5aee0

Merge branch 'develop' into feat-adapter-qdrant

3a7f800

oxf71 marked this pull request as ready for review January 16, 2025 03:01

Merge branch 'develop' into feat-adapter-qdrant

2b65c93

wtfsayo enabled auto-merge (squash) January 16, 2025 10:00

coderabbitai bot reviewed Jan 16, 2025

View reviewed changes

oxf71 added 3 commits January 17, 2025 09:12

Merge branch 'develop' into feat-adapter-qdrant

d848426

chore: delete cache

2f6beb8

Merge branch 'feat-adapter-qdrant' of github.com:b2network/eliza into…

72a1aff

… feat-adapter-qdrant

auto-merge was automatically disabled January 17, 2025 01:22
Head branch was pushed to by a user without write access

oxf71 added 6 commits January 17, 2025 11:05

chore: add env check

95accf9

chore: create collection

654edf0

chore: add env annotation

d4ee82c

refactor: process the qdrant id

a157d45

Merge branch 'develop' into feat-adapter-qdrant

48ce6f4

Merge branch 'develop' into feat-adapter-qdrant

048931f

coderabbitai bot reviewed Jan 19, 2025

View reviewed changes

packages/adapter-qdrant/src/index.ts Outdated Show resolved Hide resolved

oxf71 added 3 commits January 20, 2025 14:04

chore: modify cache key && add log

667dbc8

Merge branch 'develop' of github.com:elizaOS/eliza into feat-adapter-…

4addabd

…qdrant # Conflicts: # agent/package.json

chore: format

844bc3b

wtfsayo enabled auto-merge (squash) January 20, 2025 06:42

chore: rename var name

f8bef0c

auto-merge was automatically disabled January 20, 2025 06:48
Head branch was pushed to by a user without write access

oxf71 added 2 commits January 22, 2025 09:33

Merge branch 'develop' of github.com:elizaOS/eliza into feat-adapter-…

7b8e61d

…qdrant # Conflicts: # agent/package.json

Merge branch 'develop' into feat-adapter-qdrant

08d6599

Merge branch 'develop' into feat-adapter-qdrant

8b21401

wtfsayo enabled auto-merge January 23, 2025 05:41

wtfsayo self-requested a review January 23, 2025 05:41

wtfsayo approved these changes Jan 23, 2025

View reviewed changes

wtfsayo added this pull request to the merge queue Jan 23, 2025

wtfsayo merged commit 805fc50 into elizaOS:develop Jan 23, 2025
6 of 7 checks passed

coderabbitai bot mentioned this pull request Jan 25, 2025

feat(new-adapter): mongo-db adaptor #1427

Merged

odilitime mentioned this pull request Feb 1, 2025

chore: dev => main 0.1.9 #2361

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add adapter-qdrant #2322

feat: add adapter-qdrant #2322

oxf71 commented Jan 15, 2025 •

edited by coderabbitai bot

Loading

github-actions bot left a comment

wtfsayo commented Jan 16, 2025

coderabbitai bot commented Jan 16, 2025 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

wtfsayo commented Jan 19, 2025

coderabbitai bot commented Jan 19, 2025

wtfsayo commented Jan 19, 2025

coderabbitai bot left a comment

oxf71 commented Jan 20, 2025

wtfsayo commented Jan 22, 2025 •

edited

Loading

wtfsayo commented Jan 22, 2025

feat: add adapter-qdrant #2322

feat: add adapter-qdrant #2322

Conversation

oxf71 commented Jan 15, 2025 • edited by coderabbitai bot Loading

Relates to

Risks

Background

What does this PR do?

What kind of change is this?

Documentation changes needed?

Testing

Where should a reviewer start?

Detailed testing steps

Discord username

Summary by CodeRabbit

github-actions bot left a comment

Choose a reason for hiding this comment

wtfsayo commented Jan 16, 2025

coderabbitai bot commented Jan 16, 2025 • edited Loading

Review skipped

Walkthrough

Changes

Possibly related PRs

Suggested labels

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

wtfsayo commented Jan 19, 2025

coderabbitai bot commented Jan 19, 2025

wtfsayo commented Jan 19, 2025

coderabbitai bot left a comment

Choose a reason for hiding this comment

oxf71 commented Jan 20, 2025

wtfsayo commented Jan 22, 2025 • edited Loading

wtfsayo commented Jan 22, 2025

oxf71 commented Jan 15, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 16, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

wtfsayo commented Jan 22, 2025 •

edited

Loading