Upload README.md with huggingface_hub
Browse files
README.md
CHANGED
|
@@ -5,7 +5,7 @@ MuleSoft Documentation Embeddings for RAG Applications
|
|
| 5 |
## Dataset Information
|
| 6 |
|
| 7 |
- **Version**: 1.0.0
|
| 8 |
-
- **Created**: 2025-09-16T02:
|
| 9 |
- **Source**: Vector Database
|
| 10 |
- **License**: MIT
|
| 11 |
- **Language**: en
|
|
@@ -23,6 +23,45 @@ question-answering, retrieval, knowledge-base
|
|
| 23 |
- **Knowledge Sources**: mulesoft, user_defined_docs
|
| 24 |
- **Average Content Length**: 5079 characters
|
| 25 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 26 |
## Usage
|
| 27 |
|
| 28 |
This dataset can be used for:
|
|
@@ -44,10 +83,10 @@ This dataset can be used for:
|
|
| 44 |
If you use this dataset, please cite:
|
| 45 |
|
| 46 |
```bibtex
|
| 47 |
-
@dataset{{
|
| 48 |
-
title={{
|
| 49 |
-
author={{
|
| 50 |
year={{2025}},
|
| 51 |
-
url={{https://huggingface.co/datasets/
|
| 52 |
}}
|
| 53 |
```
|
|
|
|
| 5 |
## Dataset Information
|
| 6 |
|
| 7 |
- **Version**: 1.0.0
|
| 8 |
+
- **Created**: 2025-09-16T02:41:16.352809
|
| 9 |
- **Source**: Vector Database
|
| 10 |
- **License**: MIT
|
| 11 |
- **Language**: en
|
|
|
|
| 23 |
- **Knowledge Sources**: mulesoft, user_defined_docs
|
| 24 |
- **Average Content Length**: 5079 characters
|
| 25 |
|
| 26 |
+
## Dataset Schema
|
| 27 |
+
|
| 28 |
+
The dataset contains the original document properties with the following fields:
|
| 29 |
+
|
| 30 |
+
- `author`: Document author
|
| 31 |
+
- `chunk_id`: Unique chunk identifier
|
| 32 |
+
- `chunk_index`: Position of chunk in document
|
| 33 |
+
- `document_id`: Source document identifier
|
| 34 |
+
- `entities`: Extracted entities
|
| 35 |
+
- `keywords`: Document keywords
|
| 36 |
+
- `knowledge_source`: Source of knowledge (mulesoft, user_defined_docs)
|
| 37 |
+
- `page_content`: Main text content
|
| 38 |
+
- `relationships`: Entity relationships
|
| 39 |
+
- `source_url`: Original document URL
|
| 40 |
+
- `tags`: Document tags
|
| 41 |
+
- `title`: Document title
|
| 42 |
+
- `total_chunks`: Total number of chunks in document
|
| 43 |
+
- `vector`: Embedding vector (3072 dimensions from OpenAI text-embedding-3-large)
|
| 44 |
+
|
| 45 |
+
## RAG Configuration
|
| 46 |
+
|
| 47 |
+
This dataset was created using the following RAG (Retrieval-Augmented Generation) configuration:
|
| 48 |
+
|
| 49 |
+
### Embedding Model
|
| 50 |
+
- **Model Type**: OpenAI
|
| 51 |
+
- **Model ID**: text-embedding-3-large
|
| 52 |
+
- **Embedding Dimensions**: 3072
|
| 53 |
+
- **Provider**: OpenAI
|
| 54 |
+
|
| 55 |
+
### Chunking Configuration
|
| 56 |
+
- **Chunk Size**: 2048 characters
|
| 57 |
+
- **Chunk Overlap**: 256 characters
|
| 58 |
+
|
| 59 |
+
### Technical Details
|
| 60 |
+
- **Vector Database**: Vector Database
|
| 61 |
+
- **Collection**: SkillPilotDataSet_v11
|
| 62 |
+
- **Total Vectors**: 6430
|
| 63 |
+
- **Vector Distance**: Cosine similarity
|
| 64 |
+
|
| 65 |
## Usage
|
| 66 |
|
| 67 |
This dataset can be used for:
|
|
|
|
| 83 |
If you use this dataset, please cite:
|
| 84 |
|
| 85 |
```bibtex
|
| 86 |
+
@dataset{{mulesoft_documentation_embeddings,
|
| 87 |
+
title={{MuleSoft Documentation Embeddings}},
|
| 88 |
+
author={{Bassem Elsodany}},
|
| 89 |
year={{2025}},
|
| 90 |
+
url={{https://huggingface.co/datasets/BassemE/mulesoft-documentation-embeddings}}
|
| 91 |
}}
|
| 92 |
```
|