Update README.md

Create dataset card.

README.md

@@ -1,3 +1,183 @@
----
-license: apache-2.0
----
+---
+license: cdla-sharing-1.0
+task_categories:
+- question-answering
+- table-question-answering
+language:
+- en
+tags:
+- question-answering
+- llm
+- chatbot
+- banking
+- conversational-ai
+- generative-ai
+- natural-language-understanding
+- fine-tuning
+- retail-banking
+pretty_name: >-
+  Bitext - Retail Banking Tagged Training Dataset for LLM-based Virtual Assistants
+size_categories:
+- 10K<n<100K
+---
+# Bitext - Retail Banking Tagged Training Dataset for LLM-based Virtual Assistants
+
+## Overview
+
+This dataset is designed to train Large Language Models such as GPT, Llama3, and Mistral, aimed at both Fine Tuning and Domain Adaptation specific to the Retail Banking sector.
+
+The dataset has the following specifications:
+
+- Use Case: Intent Detection
+- Vertical: Retail Banking
+- 26 intents assigned to 9 categories
+- 25545 question/answer pairs, with approximately 1000 per intent
+- 1224 entity/slot types
+- 12 different types of language generation tags
+
+The categories and intents are derived from Bitext's extensive experience across various industry-specific datasets, ensuring the relevance and applicability across diverse banking contexts.
+
+## Dataset Token Count
+
+The dataset contains a total of 4.98 million tokens across 'instruction' and 'response' columns. This extensive corpus is crucial for training sophisticated LLMs that can perform a variety of functions including conversational AI, question answering, and virtual assistant tasks in the banking domain.
+
+## Fields of the Dataset
+
+Each entry in the dataset comprises the following fields:
+
+- flags: tags
+- instruction: a user request from the Retail Banking domain
+- category: the high-level semantic category for the intent
+- intent: the specific intent corresponding to the user instruction
+- response: an example of an expected response from the virtual assistant
+
+## Categories and Intents
+
+The dataset covers a wide range of banking-related categories and intents, which are:
+
+- **ACCOUNT**: check_recent_transactions, close_account, create_account
+- **ATM**: dispute_ATM_withdrawal, recover_swallowed_card
+- **CARD**: activate_card, activate_card_international_usage, block_card, cancel_card, check_card_annual_fee, check_current_balance_on_card
+- **CONTACT**: customer_service, human_agent
+- **FEES**: check_fees
+- **FIND**: find_ATM, find_branch
+- **LOAN**: apply_for_loan, apply_for_mortgage, cancel_loan, cancel_mortgage, check_loan_payments, check_mortgage_payments
+- **PASSWORD**: get_password, set_up_password
+- **TRANSFER**: cancel_transfer, make_transfer
+
+## Entities
+
+The entities covered by the dataset include:
+
+- **{{Full Name}}**, typically present in intents such as apply_for_loan, apply_for_mortgage.
+- **{{Banking App}}**, featured in intents like activate_card, check_loan_payments.
+- **{{Account Number}}**, relevant to intents such as activate_card_international_usage, block_card.
+- **{{Customer Support Working Hours}}**, associated with intents like customer_service, human_agent.
+- **{{Customer Support Team}}**, important for intents including cancel_card, make_transfer.
+- **{{Company Website URL}}**, typically present in intents such as activate_card, apply_for_loan.
+- **{{Customer Support}}**, featured in intents like activate_card, block_card.
+- **{{Customer Support Email}}**, relevant to intents such as activate_card_international_usage, apply_for_loan.
+- **{{Mortgage Account Number}}**, associated with intents like cancel_mortgage, check_mortgage_payments.
+- **{{Mortgage Account}}**, important for intents including check_loan_payments, check_mortgage_payments.
+- **{{Billing}}**, typically present in intents such as check_fees, check_mortgage_payments.
+- **{{Username}}**, featured in intents like activate_card, block_card.
+- **{{Customer Support Phone Number}}**, relevant to intents such as activate_card, apply_for_loan.
+- **{{Live Chat}}**, associated with intents like activate_card_international_usage, apply_for_mortgage.
+- **{{Company Website}}**, important for intents including activate_card, apply_for_loan.
+- **{{Mortgage Department}}**, typically present in intents such as apply_for_mortgage, cancel_mortgage.
+- **{{Account}}**, featured in intents like activate_card, block_card.
+- **{{Name}}**, relevant to intents such as activate_card, apply_for_loan.
+- **{{Bank Name}}**, associated with intents like activate_card, apply_for_loan.
+- **{{Password}}**, important for intents including activate_card, block_card.
+- **{{Customer Support Email Address}}**, typically present in intents such as activate_card, apply_for_loan.
+- **{{Customer Service Email Address}}**, featured in intents like activate_card_international_usage, cancel_card.
+- **{{Email Address}}**, relevant to intents such as activate_card, apply_for_loan.
+- **{{Profile}}**, associated with intents like cancel_card, check_fees.
+- **{{Customer Service Working Hours}}**, important for intents including activate_card, apply_for_loan.
+- **{{Credit Card}}**, typically present in intents such as activate_card, block_card.
+- **{{Bank App}}**, featured in intents like activate_card, block_card.
+- **{{Loan Account Number}}**, relevant to intents such as cancel_loan, check_loan_payments.
+- **{{Account Settings}}**, associated with intents like activate_card, block_card.
+
+This comprehensive list of entities ensures that the dataset is well-equipped to train models that are highly adept at understanding and processing a wide range of banking-related queries and tasks.
+
+## Language Generation Tags
+
+The dataset includes tags indicative of various language variations and styles adapted for Retail Banking, enhancing the robustness and versatility of models trained on this data. These tags categorize the utterances into different registers such as colloquial, formal, or containing specific banking jargon, ensuring that the trained models can understand and generate a range of conversational styles appropriate for different customer interactions in the retail banking sector.
+
+## Language Generation Tags
+
+The dataset includes tags that reflect various language variations and styles, crucial for creating adaptable and responsive conversational AI models within the banking sector. These tags help in understanding and generating appropriate responses based on the linguistic context and user interaction style.
+
+### Tags for Lexical variation
+
+- **M - Morphological variation**: Adjusts for inflectional and derivational forms in banking terminology.
+  - Example: "is my account active", "is my account activated"
+- **L - Semantic variations**: Handles synonyms, use of hyphens, compounding common in banking communications.
+  - Example: “what's my balance date", “what's my billing date”
+
+### Tags for Syntactic structure variation
+
+- **B - Basic syntactic structure**: Simple, direct commands or statements.
+  - Example: "activate my card", "I need to check my balance"
+- **I - Interrogative structure**: Structuring sentences in the form of questions.
+  - Example: “can you show my balance?”, “how do I transfer money?”
+- **C - Coordinated syntactic structure**: Complex sentences coordinating multiple ideas or tasks.
+  - Example: “I want to transfer money and check my balance, what should I do?”
+- **N - Negation**: Expressing denial or contradiction.
+  - Example: "I do not wish to proceed with this transaction, how can I stop it?"
+
+### Tags for language register variations
+
+- **P - Politeness variation**: Polite forms often used in customer service.
+  - Example: “could you please help me check my account balance?”
+- **Q - Colloquial variation**: Informal language that might be used in casual customer interactions.
+  - Example: "can u tell me my balance?"
+- **W - Offensive language**: Handling potentially offensive language which might occasionally appear in frustrated customer interactions.
+  - Example: “I’m upset with these charges, this is ridiculous!”
+
+### Tags for stylistic variations
+
+- **K - Keyword mode**: Responses focused on keywords relevant to banking tasks.
+  - Example: "balance check", "account status"
+- **E - Use of abbreviations**: Common abbreviations in the context of banking.
+  - Example: “acct for account”, “trans for transaction”
+- **Z - Errors and Typos**: Includes common misspellings or typographical errors found in customer inputs.
+  - Example: “how can I chek my balance”
+
+### Other tags not in use in this Dataset
+
+- **D - Indirect speech**: Expressing commands or requests indirectly.
+  - Example: “I was wondering if you could show me my last transaction.”
+- **G - Regional variations**: Adjustments for regional language differences.
+  - Example: American vs British English: "checking account" vs "current account"
+- **R - Respect structures - Language-dependent variations**: Formality levels appropriate in different languages.
+  - Example: Using “vous” in French for formal addressing instead of “tu.”
+- **Y - Code switching**: Switching between languages or dialects within the same conversation.
+  - Example: “Can you help me with my cuenta, please?”
+
+These tags not only aid in training models for a wide range of customer interactions but also ensure that the models are culturally and linguistically sensitive, enhancing the customer experience in retail banking environments.
+
+## License
+
+The `Bitext-retail-banking-llm-chatbot-training-dataset` is released under the **Community Data License Agreement (CDLA) Sharing 1.0**. This license facilitates broad sharing and collaboration while ensuring that the freedom to use, share, modify, and utilize the data remains intact for all users.
+
+### Key Aspects of CDLA-Sharing 1.0
+
+- **Attribution and ShareAlike**: Users must attribute the dataset and continue to share derivatives under the same license.
+- **Non-Exclusivity**: The license is non-exclusive, allowing multiple users to utilize the data simultaneously.
+- **Irrevocability**: Except in cases of material non-compliance, rights under this license are irrevocable.
+- **No Warranty**: The dataset is provided without warranties regarding its accuracy, completeness, or fitness for a particular purpose.
+- **Limitation of Liability**: Both users and data providers limit their liability for damages arising from the use of the dataset.
+
+### Usage Under CDLA-Sharing 1.0
+
+By using the `Bitext-retail-banking-llm-chatbot-training-dataset`, you agree to adhere to the terms set forth in the CDLA-Sharing 1.0. It is essential to ensure that any publications or distributions of the data, or derivatives thereof, maintain attribution to the original data providers and are distributed under the same or compatible terms of this agreement.
+
+For a detailed understanding of the license, refer to the [official CDLA-Sharing 1.0 documentation](https://cdla.dev/sharing-1-0/).
+
+This license supports the open sharing and collaborative improvement of datasets within the AI and data science community, making it particularly suited for projects aimed at developing and enhancing AI technologies in the retail banking sector.
+
+---
+
+(c) Bitext Innovations, 2024