Skip to content

Commit 54123d7

Browse files
Merge pull request #34 from DataSeer/update_score_documentation
docs: update the 'user documentation' (cumulated score)
2 parents 0ecd384 + 46d7868 commit 54123d7

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

USER_DOCUMENTATION.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,14 @@ fetch('https://snapshot.dataseer.ai/processPDF', {
134134

135135
#### Example Response
136136

137+
Here is an example of JSON data returned by the API.
138+
The ‘response’ key is an array of objects. Each item is structured as follows:
139+
- `name`: the name of the data (ex: das, non-functional_urls, cumulated_score)
140+
- `description`: the description of the data (ex: "Data availability statement" for "das")
141+
- `value`: the value of the data
142+
143+
***Note: the value of `cumulated_score` is between -10 and 32***
144+
137145
```json
138146
{
139147
"response": [
@@ -207,7 +215,7 @@ fetch('https://snapshot.dataseer.ai/processPDF', {
207215
{
208216
"name": "cumulated_score",
209217
"description": "Cumulated score from snapshot",
210-
"value": 0
218+
"value": 0 // The score is between -10 and 32
211219
}
212220
]
213221
}

0 commit comments

Comments
 (0)