Merge pull request #32 from impresso/ocrqa

Schema for OCR-QA

README.md

@@ -22,6 +22,8 @@ We define schemas for:
       - [Language Identification](docs/language_identification.md) (draft 06)
   - Entities
     - [Entities](docs/entities.md) (2020-12)
+  - [OCR Quality Assessment](docs/ocr_qa.md) (OCR-QA)
+
 
 #### Processes
   - Data processing manifests (todo)

docs/ocr_qa-properties-ci_ref.md

@@ -0,0 +1,3 @@
+## ci\_ref Type
+
+`string`

docs/ocr_qa-properties-ocrqa.md

@@ -0,0 +1,3 @@
+## ocrqa Type
+
+`number`

docs/ocr_qa.md

@@ -0,0 +1,46 @@
+## OCR-QA JSON Schema Type
+
+`object` ([OCR-QA JSON Schema](ocr_qa.md))
+
+# OCR-QA JSON Schema Properties
+
+| Property           | Type     | Required | Nullable       | Defined by                                                                                                                                        |
+| :----------------- | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------ |
+| [ci\_ref](#ci_ref) | `string` | Required | cannot be null | [OCR-QA JSON Schema](ocr_qa-properties-ci_ref.md "https://impresso.github.io/impresso-schemas/json/ocr_qa/ocr_qa.schema.json#/properties/ci_ref") |
+| [ocrqa](#ocrqa)    | `number` | Required | cannot be null | [OCR-QA JSON Schema](ocr_qa-properties-ocrqa.md "https://impresso.github.io/impresso-schemas/json/ocr_qa/ocr_qa.schema.json#/properties/ocrqa")   |
+
+## ci\_ref
+
+Reference to canonical content item id, typically an article
+
+`ci_ref`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [OCR-QA JSON Schema](ocr_qa-properties-ci_ref.md "https://impresso.github.io/impresso-schemas/json/ocr_qa/ocr_qa.schema.json#/properties/ci_ref")
+
+### ci\_ref Type
+
+`string`
+
+## ocrqa
+
+The estimated OCR quality, between 0 and 1
+
+`ocrqa`
+
+* is required
+
+* Type: `number`
+
+* cannot be null
+
+* defined in: [OCR-QA JSON Schema](ocr_qa-properties-ocrqa.md "https://impresso.github.io/impresso-schemas/json/ocr_qa/ocr_qa.schema.json#/properties/ocrqa")
+
+### ocrqa Type
+
+`number`

examples/ocr_qa/ocr_qa_example.json

@@ -0,0 +1,4 @@
+{
+  "ci_ref": "actionfem-1939-05-15-a-i0022",
+  "ocrqa": 0.86
+}

json/ocr_qa/ocr_qa.schema.json

@@ -0,0 +1,21 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://impresso.github.io/impresso-schemas/json/ocr_qa/ocr_qa.schema.json",
+  "title": "OCR-QA JSON Schema",
+  "description": "A representation for the assessment of OCR quality of content items.",
+  "type": "object",
+  "properties": {
+    "ci_ref": {
+      "type": "string",
+      "description": "Reference to canonical content item id, typically an article"
+    },
+    "ocrqa": {
+      "type": "number",
+      "description": "The estimated OCR quality, between 0 and 1"
+    }
+  },
+  "required": [
+    "ocrqa",
+    "ci_ref"
+  ]
+}