Skip to content

Commit

Permalink
Add algorithmic transparency record specialist document type
Browse files Browse the repository at this point in the history
This document type has been requested by the Department of Science, Innovation and Technology.
The records explain how and why public sector organisations use AI and algorithmic tools for decision making.
  • Loading branch information
lauraghiorghisor-tw committed Jan 18, 2024
1 parent 7cad8f3 commit 17e69d1
Show file tree
Hide file tree
Showing 13 changed files with 979 additions and 1 deletion.
1 change: 1 addition & 0 deletions content_schemas/allowed_document_types.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
- accessible_documents_policy
- access_and_opening
- ai_assurance_portfolio_technique
- algorithmic_transparency_record
- ambassador_role
- animal_disease_case
- answer
Expand Down
1 change: 1 addition & 0 deletions content_schemas/dist/formats/generic/frontend/schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
"accessible_documents_policy",
"access_and_opening",
"ai_assurance_portfolio_technique",
"algorithmic_transparency_record",
"ambassador_role",
"animal_disease_case",
"answer",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@
"accessible_documents_policy",
"access_and_opening",
"ai_assurance_portfolio_technique",
"algorithmic_transparency_record",
"ambassador_role",
"animal_disease_case",
"answer",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
"accessible_documents_policy",
"access_and_opening",
"ai_assurance_portfolio_technique",
"algorithmic_transparency_record",
"ambassador_role",
"animal_disease_case",
"answer",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
"accessible_documents_policy",
"access_and_opening",
"ai_assurance_portfolio_technique",
"algorithmic_transparency_record",
"ambassador_role",
"animal_disease_case",
"answer",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@
"accessible_documents_policy",
"access_and_opening",
"ai_assurance_portfolio_technique",
"algorithmic_transparency_record",
"ambassador_role",
"animal_disease_case",
"answer",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
"accessible_documents_policy",
"access_and_opening",
"ai_assurance_portfolio_technique",
"algorithmic_transparency_record",
"ambassador_role",
"animal_disease_case",
"answer",
Expand Down
120 changes: 120 additions & 0 deletions content_schemas/dist/formats/specialist_document/frontend/schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
"enum": [
"aaib_report",
"ai_assurance_portfolio_technique",
"algorithmic_transparency_record",
"animal_disease_case",
"asylum_support_decision",
"business_finance_support_scheme",
Expand Down Expand Up @@ -436,6 +437,122 @@
}
}
},
"algorithmic_transparency_record_metadata": {
"type": "object",
"additionalProperties": false,
"properties": {
"algorithmic_transparency_record_atrs_version": {
"type": "string"
},
"algorithmic_transparency_record_capability": {
"type": "array",
"items": {
"type": "string",
"enum": [
"computer-vision",
"computer-audition",
"computer-linguistics",
"robotics",
"forecasting",
"discovery",
"planning",
"creation",
"analysis",
"management",
"other"
]
}
},
"algorithmic_transparency_record_date_published": {
"type": "string",
"pattern": "^[1-9][0-9]{3}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[0-1])$"
},
"algorithmic_transparency_record_function": {
"type": "array",
"items": {
"type": "string",
"enum": [
"general-public-services",
"defence",
"public-order-and-safety",
"economic-affairs",
"environmental-protection",
"housing-and-community-amenities",
"health",
"recreation-culture-and-religion",
"education",
"social-protection",
"regulation"
]
}
},
"algorithmic_transparency_record_organisation": {
"type": "string",
"enum": [
"cabinet-office",
"ministry-of-justice",
"information-commissioners-office",
"department-for-health-and-social-care",
"food-standards-agency",
"hampshire-and-thames-valley-police",
"west-midlands-police",
"department-for-science-innovation-and-technology",
"department-for-education"
]
},
"algorithmic_transparency_record_organisation_type": {
"type": "array",
"items": {
"type": "string",
"enum": [
"ministerial-department",
"non-ministerial-department",
"agency-or-public-body",
"local-authority",
"devolved-administration",
"high-profile-group",
"public-corporation"
]
}
},
"algorithmic_transparency_record_other_tags": {
"type": "string"
},
"algorithmic_transparency_record_phase": {
"type": "string",
"enum": [
"pre-deployment",
"beta-pilot",
"production",
"retired"
]
},
"algorithmic_transparency_record_region": {
"type": "array",
"items": {
"type": "string",
"enum": [
"northern-ireland",
"scotland",
"wales",
"england",
"london",
"north-east",
"north-west",
"yorkshire-and-the-humber",
"east-midlands",
"west-midlands",
"south-east",
"east-of-england",
"south-west"
]
}
},
"algorithmic_transparency_record_task": {
"type": "string"
}
}
},
"analytics_identifier": {
"description": "A short identifier we send to Google Analytics for multi-valued fields. This means we avoid the truncated values we would get if we sent the path or slug of eg organisations.",
"anyOf": [
Expand Down Expand Up @@ -521,6 +638,9 @@
{
"$ref": "#/definitions/ai_assurance_portfolio_technique_metadata"
},
{
"$ref": "#/definitions/algorithmic_transparency_record_metadata"
},
{
"$ref": "#/definitions/animal_disease_case_metadata"
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@
"enum": [
"aaib_report",
"ai_assurance_portfolio_technique",
"algorithmic_transparency_record",
"animal_disease_case",
"asylum_support_decision",
"business_finance_support_scheme",
Expand Down Expand Up @@ -528,6 +529,122 @@
}
}
},
"algorithmic_transparency_record_metadata": {
"type": "object",
"additionalProperties": false,
"properties": {
"algorithmic_transparency_record_atrs_version": {
"type": "string"
},
"algorithmic_transparency_record_capability": {
"type": "array",
"items": {
"type": "string",
"enum": [
"computer-vision",
"computer-audition",
"computer-linguistics",
"robotics",
"forecasting",
"discovery",
"planning",
"creation",
"analysis",
"management",
"other"
]
}
},
"algorithmic_transparency_record_date_published": {
"type": "string",
"pattern": "^[1-9][0-9]{3}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[0-1])$"
},
"algorithmic_transparency_record_function": {
"type": "array",
"items": {
"type": "string",
"enum": [
"general-public-services",
"defence",
"public-order-and-safety",
"economic-affairs",
"environmental-protection",
"housing-and-community-amenities",
"health",
"recreation-culture-and-religion",
"education",
"social-protection",
"regulation"
]
}
},
"algorithmic_transparency_record_organisation": {
"type": "string",
"enum": [
"cabinet-office",
"ministry-of-justice",
"information-commissioners-office",
"department-for-health-and-social-care",
"food-standards-agency",
"hampshire-and-thames-valley-police",
"west-midlands-police",
"department-for-science-innovation-and-technology",
"department-for-education"
]
},
"algorithmic_transparency_record_organisation_type": {
"type": "array",
"items": {
"type": "string",
"enum": [
"ministerial-department",
"non-ministerial-department",
"agency-or-public-body",
"local-authority",
"devolved-administration",
"high-profile-group",
"public-corporation"
]
}
},
"algorithmic_transparency_record_other_tags": {
"type": "string"
},
"algorithmic_transparency_record_phase": {
"type": "string",
"enum": [
"pre-deployment",
"beta-pilot",
"production",
"retired"
]
},
"algorithmic_transparency_record_region": {
"type": "array",
"items": {
"type": "string",
"enum": [
"northern-ireland",
"scotland",
"wales",
"england",
"london",
"north-east",
"north-west",
"yorkshire-and-the-humber",
"east-midlands",
"west-midlands",
"south-east",
"east-of-england",
"south-west"
]
}
},
"algorithmic_transparency_record_task": {
"type": "string"
}
}
},
"analytics_identifier": {
"description": "A short identifier we send to Google Analytics for multi-valued fields. This means we avoid the truncated values we would get if we sent the path or slug of eg organisations.",
"anyOf": [
Expand Down Expand Up @@ -613,6 +730,9 @@
{
"$ref": "#/definitions/ai_assurance_portfolio_technique_metadata"
},
{
"$ref": "#/definitions/algorithmic_transparency_record_metadata"
},
{
"$ref": "#/definitions/animal_disease_case_metadata"
},
Expand Down
Loading

0 comments on commit 17e69d1

Please sign in to comment.