Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(RAG): add BM25 Retriever. #1578

Merged
merged 2 commits into from
May 30, 2024
Merged

Conversation

Aries-ckt
Copy link
Collaborator

@Aries-ckt Aries-ckt commented May 28, 2024

Close #1577

Description

Add Elasticsearch BM25Retriever.
https://www.elastic.co/guide/en/elasticsearch/reference/8.13/index-modules-similarity.html

How Has This Been Tested?

  1. install Elasticsearch refer https://www.elastic.co/guide/en/elasticsearch/reference/8.13/setup.html
  2. update Elasticsearch config
def _create_es_config():
    """create Elasticsearch config."""
    return ElasticsearchVectorConfig(
        name="bm25_es_dbgpt",
        uri="localhost",
        port="9200",
        user="elastic",
        password="dbgpt",
    )
  1. run example
 python examples/rag/bm25_retriever_example.py

Snapshots:

Include snapshots for easier review.

Checklist:

  • My code follows the style guidelines of this project
  • I have already rebased the commits and make the commit message conform to the project standard.
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • Any dependent changes have been merged and published in downstream modules

@github-actions github-actions bot added the enhancement New feature or request label May 28, 2024
Copy link
Collaborator

@csunny csunny left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

r+

Copy link
Collaborator

@fangyinc fangyinc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@fangyinc fangyinc merged commit 47b0630 into eosphoros-ai:main May 30, 2024
6 checks passed
Hopshine pushed a commit to Hopshine/DB-GPT that referenced this pull request Sep 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature][RAG] add BM25 Retriever for ChatKnowledge
3 participants