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

Add ElasticSearchRM Class to Retrieval Modules #308

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Donnie
Copy link

@Donnie Donnie commented Jan 18, 2025

This pull request introduces a new ElasticSearchRM class to the knowledge_storm/rm.py file. The ElasticSearchRM class allows for integration with Elasticsearch as a retrieval module, enabling the system to query and retrieve documents from an Elasticsearch index.

Changes

  • Imported the Elasticsearch class from the elasticsearch package.
  • Added the ElasticSearchRM class with the following features:
    • Initialization with Elasticsearch hosts and index name.
    • Method for retrieving usage statistics and resetting the counter.
    • forward method to handle search queries and return retrieved documents.

Purpose

The addition of the ElasticSearchRM class provides users with an alternative search module that leverages Elasticsearch, enhancing the flexibility and capability of the retrieval system within the STORM project.

Notes

  • Ensure the elasticsearch package is installed (pip install elasticsearch) to use this new class.

@Donnie Donnie changed the title Add ElasticSearchRM Add ElasticSearchRM Class to Retrieval Modules Jan 18, 2025
@Donnie Donnie marked this pull request as draft January 18, 2025 10:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant