run-llama / llama_index

LlamaIndex is a data framework for your LLM applications
https://docs.llamaindex.ai
MIT License
35.26k stars 4.96k forks source link

[Documentation]: Qdrant Vector Store - Metadata Filter Cosmetic Error #14192

Open pavanjava opened 2 months ago

pavanjava commented 2 months ago

Documentation Issue Description

Multiple places in the Qdrant Vector Store - Metadata Filter page, documentation quotes Pinecone but the page is refering to Qdrant. please find the attached image for reference.

Screenshot 2024-06-17 at 5 07 25 PM

I have a fix ready for this, how can I contribute back ?

Documentation Link

https://docs.llamaindex.ai/en/stable/examples/vector_stores/Qdrant_metadata_filter/

dosubot[bot] commented 2 months ago

To contribute back to the documentation and fix the issue where multiple places incorrectly refer to Pinecone instead of Qdrant on the "Qdrant Vector Store - Metadata Filter" page, you can follow these steps:

  1. Fork the Repository: Go to the LlamaIndex GitHub repository and fork it to your own GitHub account.

  2. Clone the Repository: Clone your forked repository to your local machine.

    git clone https://github.com/<your-username>/llama_index.git
    cd llama_index
  3. Create a New Branch: Create a new branch for your changes.

    git checkout -b fix-qdrant-documentation
  4. Edit the Documentation: Open the file docs/docs/examples/vector_stores/Qdrant_metadata_filter.ipynb and replace all incorrect references to Pinecone with Qdrant.

    For example, change:

    Build a Pinecone Index and connect to it

    to:

    Build a Qdrant Index and connect to it

    And change:

    Build the PineconeVectorStore and VectorStoreIndex

    to:

    Build the QdrantVectorStore and VectorStoreIndex

    Also, change:

    Use keyword arguments specific to pinecone

    to:

    Use keyword arguments specific to Qdrant
  5. Commit Your Changes: Commit your changes with a descriptive message.

    git add docs/docs/examples/vector_stores/Qdrant_metadata_filter.ipynb
    git commit -m "Fix incorrect references to Pinecone in Qdrant documentation"
  6. Push Your Changes: Push your changes to your forked repository.

    git push origin fix-qdrant-documentation
  7. Create a Pull Request: Go to the original LlamaIndex repository and create a pull request from your forked repository. Provide a clear description of the changes you made and why they are necessary.

By following these steps, you can contribute back to the documentation and correct the references from Pinecone to Qdrant [1].

To continue talking to Dosu, mention @dosu.

schiaro98 commented 2 months ago

Opened pull request to correct this https://github.com/run-llama/llama_index/pull/14446