noahsantacruz commited on
Commit
6413d0d
·
1 Parent(s): d6a281f

Update README.md

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