Update README.md

README.md

@@ -1,3 +1,82 @@
----
-license: apache-2.0
----
+---
+task_categories:
+- text-retrieval
+- text-ranking
+language:
+- en
+tags:
+- search
+- reranking
+---
+
+# DevRev Search Dataset
+
+## Summary
+
+The **DevRev Search Dataset** contains transformed and anonymized user queries on DevRev's public articles, paired with relevant article chunks that answer them. It is designed to benchmark enterprise search and reranking systems. The dataset also includes test queries along with the underlying article chunks used for retrieval.
+
+---
+
+## Dataset Details
+
+- **Curated by:** Research@DevRev  
+- **Language:** English
+- **Intended Use:** Evaluation of search, retrieval, and reranking models in enterprise support contexts  
+
+---
+
+## Dataset Structure
+
+- **`annotated_queries.parquet`** — Queries paired with annotated (golden) article chunks  
+- **`knowledge_base.parquet`** — Article chunks created from DevRev’s customer-facing support documentation  
+- **`test_queries.parquet`** — Held-out queries used for evaluation  
+
+---
+
+## Dataset Creation
+
+### Curation Rationale
+There is a lack of publicly available datasets representing enterprise support search. This dataset addresses that gap, enabling fair and consistent evaluation of enterprise-focused search and reranking systems.
+
+### Source Data
+
+- **Queries:** Transformed and anonymized versions of real user queries on DevRev's public articles.  
+- **Knowledge Base Articles:** Segmented (chunked) excerpts from DevRev’s customer-facing support documentation.
+
+---
+
+## Annotations
+
+- **Annotation Process:** An automated proprietary pipeline identifies the most relevant article chunks for each query.  
+- **Annotators:** Fully automated system; no human annotators were used.  
+- **Validation:** Internal validation was conducted by selecting a representative sample of the automatically generated annotations, which were then manually reviewed by human evaluators to verify their correctness and ensure they meet the desired quality standards.
+
+---
+
+## Personal and Sensitive Information
+All user queries were anonymized and stripped of any identifying or sensitive data. No personal information is included.
+
+---
+
+## Uses
+
+- **Primary Use:** Training and evaluation of enterprise search, retrieval, and reranking models.  
+- **Example Tasks:**  
+  - [Query-to-document retrieval](https://huggingface.co/tasks/text-ranking)  
+  - Reranking evaluation
+
+---
+
+## Citation
+
+If you use this dataset, please cite:
+
+**BibTeX:**
+```bibtex
+@dataset{devrev_search_2025,
+  title={DevRev Search Dataset},
+  author={Research@DevRev},
+  year={2025},
+  url={https://huggingface.co/datasets/devrev/search},
+  license={Apache-2.0}
+}