README.md

metadata

license: mit

Dataset Structure Overview

M-BEIR dataset comprises two main components: Query Data and Candidate Pool. Each of these sections consists of structured entries in JSONL format (JSON Lines), meaning each line is a valid JSON object. Below is a detailed breakdown of the components and their respective fields:

Query Data (JSONL File) Each line in the Query Data file represents a unique query, formatted as a JSON object with the following fields:

• Query ID (qid): A unique identifier formatted as {dataset_id}:{query_id}.
• Query Text (query_txt): The text component of the query.
• Query Image Path (query_img_path): The file path to the associated query image.
• Query Modality (query_modality): The modality type of the query (text, image or text,image)
• Query Source Content (query_src_content): Additional content from the original dataset, presented as a string by json.dumps().
• Positive Candidates List (pos_cand_list): A list of positive candidate documents, where each entry includes:
  • Document ID (did): A unique identifier formatted as {dataset_id}:{doc_id}.
• Negative Candidates List (neg_cand_list): A list of negative candidate documents, where each entry includes:
  • Document ID (did): A unique identifier formatted as {dataset_id}:{doc_id}.

Candidate Pool (JSONL File) The Candidate Pool contains potential matching documents for the queries. Each line in this file is a JSON object representing a candidate document with these fields:

• Document ID (did): A unique identifier for the document, formatted as {dataset_id}:{doc_id}.
• Candidate Text (txt): The text content of the candidate document.
• Candidate Image Path (img_path): The file path to the candidate document's image.
• Candidate Modality (modality): The modality type of the candidate (e.g., text, image or text,image).
• Source Content (src_content): Additional content from the original dataset, presented as a string by json.dumps().