noahsantacruz commited on
Commit
bac6ab4
1 Parent(s): d07423a

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +22 -0
README.md CHANGED
@@ -1,3 +1,25 @@
1
  ---
2
  license: gpl-3.0
3
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  license: gpl-3.0
3
  ---
4
+ # Description
5
+
6
+ Export of Sefaria's Hebrew library data. This data represents over version in the library marked as Hebrew.
7
+
8
+ ## Schema
9
+
10
+ | Field | Description |
11
+ | --- | --- |
12
+ | text | The text of a single segment in the library. A segment is the smallest chunk of test, usually representing a paragraph. |
13
+ | metadata | Dictionary of metadata. See below for schema. |
14
+
15
+ ### Metadata Schema
16
+
17
+ | Field | Description |
18
+ | --- | --- |
19
+ | url | URL to this segment in Sefaria |
20
+ | ref | Canonical Ref to this segment. Refs are a human readable ID that is unique independent of version. Different versions of a segment all share the same Ref. |
21
+ | versionTitle | Version title of the version this segment came from. |
22
+ | lang | two letter language code. |
23
+ | docCategory | Category for this segment. This corresponds to where the segment's book is located in Sefaria's table of contents. |
24
+ | dataQuality | Estimate of the quality of the text. This can be either "professional" or "user". |
25
+ | pagerank | Pagerank for this segment calculated using Sefaria's internal link graph. Higher values indicate the segment is more centrally cited by sources. |