From b9ae1f2d205d617d7d5240a6081d36a4d033ef43 Mon Sep 17 00:00:00 2001
From: Sean MacAvaney <sean.macavaney@gmail.com>
Date: Fri, 8 Nov 2024 10:57:37 +0000
Subject: [PATCH] added missing default_text for BEIR (#274)

* added missing default_text for BEIR
fixes #273

* bump version
---
 ir_datasets/__init__.py      |  2 +-
 ir_datasets/datasets/beir.py | 25 +++++++++++++++++++++++++
 setup.py                     |  2 +-
 3 files changed, 27 insertions(+), 2 deletions(-)

diff --git a/ir_datasets/__init__.py b/ir_datasets/__init__.py
index 441d7139..70a4097e 100644
--- a/ir_datasets/__init__.py
+++ b/ir_datasets/__init__.py
@@ -101,4 +101,4 @@ def main_cli():
     import sys
     main(sys.argv[1:])
 
-__version__ = "0.5.8" # NOTE: keep this in sync with setup.py
+__version__ = "0.5.9" # NOTE: keep this in sync with setup.py
diff --git a/ir_datasets/datasets/beir.py b/ir_datasets/datasets/beir.py
index d31e4936..54d4e884 100644
--- a/ir_datasets/datasets/beir.py
+++ b/ir_datasets/datasets/beir.py
@@ -54,6 +54,11 @@ class BeirSciDoc(NamedTuple):
     year: int
     cited_by: List[str]
     references: List[str]
+    def default_text(self):
+        """
+        title text
+        """
+        return f'{self.title} {self.text}'
 
 class BeirCordDoc(NamedTuple):
     doc_id: str
@@ -73,6 +78,11 @@ class BeirToucheDoc(NamedTuple):
     title: str
     stance: str
     url: str
+    def default_text(self):
+        """
+        title text
+        """
+        return f'{self.title} {self.text}'
 
 class BeirCqaDoc(NamedTuple):
     doc_id: str
@@ -89,6 +99,11 @@ class BeirUrlQuery(NamedTuple):
     query_id: str
     text: str
     url: str
+    def default_text(self):
+        """
+        text
+        """
+        return self.text
 
 class BeirSciQuery(NamedTuple):
     query_id: str
@@ -97,12 +112,22 @@ class BeirSciQuery(NamedTuple):
     year: int
     cited_by: List[str]
     references: List[str]
+    def default_text(self):
+        """
+        text
+        """
+        return self.text
 
 class BeirToucheQuery(NamedTuple):
     query_id: str
     text: str
     description: str
     narrative: str
+    def default_text(self):
+        """
+        text
+        """
+        return self.text
 
 class BeirCovidQuery(NamedTuple):
     query_id: str
diff --git a/setup.py b/setup.py
index 15f3bcc8..70041050 100644
--- a/setup.py
+++ b/setup.py
@@ -6,7 +6,7 @@
 
 setuptools.setup(
     name="ir_datasets",
-    version="0.5.8", # NOTE: keep this in sync with ir_datasets/__init__.py
+    version="0.5.9", # NOTE: keep this in sync with ir_datasets/__init__.py
     author="Sean MacAvaney",
     author_email="sean.macavaney@glasgow.ac.uk",
     description="provides a common interface to many IR ad-hoc ranking benchmarks, training datasets, etc.",