YarShev commited on
Commit
9f4d47d
·
verified ·
1 Parent(s): 29f850b

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +47 -23
README.md CHANGED
@@ -1,25 +1,49 @@
1
  ---
2
- dataset_info:
3
- features:
4
- - name: source_link
5
- dtype: string
6
- - name: title
7
- dtype: string
8
- - name: chunk_index
9
- dtype: int32
10
- - name: chunk_text
11
- dtype: string
12
- - name: embedding
13
- list: float32
14
- splits:
15
- - name: train
16
- num_bytes: 93965817
17
- num_examples: 4269
18
- download_size: 78278965
19
- dataset_size: 93965817
20
- configs:
21
- - config_name: default
22
- data_files:
23
- - split: train
24
- path: data/train-*
25
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ license: apache-2.0
3
+ language:
4
+ - en
5
+ tags:
6
+ - clickhouse
7
+ - rag
8
+ - embeddings
9
+ - documentation
10
+ pretty_name: ClickHouse Documentation Embeddings
11
+ task_categories:
12
+ - feature-extraction
 
 
 
 
 
 
 
 
 
 
 
 
13
  ---
14
+
15
+ # ClickHouse Documentation Embeddings
16
+
17
+ Vector dataset used as the knowledge base for the ClickHouse RAG API. Contains chunked ClickHouse documentation with precomputed embeddings.
18
+
19
+ **Not intended for fine-tuning the embedding model.**
20
+
21
+ ## Purpose
22
+
23
+ This dataset backs the retrieval step of the ClickHouse RAG API. At query time, the API embeds an incoming question using the same model and performs
24
+ cosine distance search against the `embedding` column in ClickHouse to retrieve relevant documentation chunks.
25
+
26
+ ## Schema
27
+
28
+ | Column | Type | Description |
29
+ |---|---|---|
30
+ | `source_link` | `string` | URL of the source documentation page |
31
+ | `title` | `string` | Title of the documentation page |
32
+ | `chunk_index` | `int32` | Position of this chunk within the source page (0-based) |
33
+ | `chunk_text` | `string` | Text content of the chunk |
34
+ | `embedding` | `Sequence[float32]` | 4096-dimensional embedding vector |
35
+
36
+ ## Embedding Model
37
+
38
+ Embeddings were produced by `qwen3_embedding_8b` served via [Text Embeddings Inference (TEI)](https://github.com/huggingface/text-embeddings-inference).
39
+
40
+ - **Dimensions:** 4096
41
+ - **Dtype:** float32
42
+
43
+ To query this dataset, embed your query using the same model and configuration. Using a different model will produce incompatible vectors and degrade
44
+ retrieval quality.
45
+
46
+ ## Source
47
+
48
+ Sourced from the [ClickHouse documentation](https://clickhouse.com/docs).
49
+