From 17e69d1cd729e86450eb22f3d600d7412b6c09a3 Mon Sep 17 00:00:00 2001 From: Laura Ghiorghisor Date: Tue, 9 Jan 2024 16:03:31 +0000 Subject: [PATCH] Add algorithmic transparency record specialist document type 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. --- content_schemas/allowed_document_types.yml | 1 + .../dist/formats/generic/frontend/schema.json | 1 + .../formats/generic/notification/schema.json | 1 + .../formats/generic/publisher_v2/schema.json | 1 + .../frontend/schema.json | 1 + .../notification/schema.json | 1 + .../publisher_v2/schema.json | 1 + .../specialist_document/frontend/schema.json | 120 +++++ .../notification/schema.json | 120 +++++ .../publisher_v2/schema.json | 120 +++++ .../algorithmic-transparency-record.json | 491 ++++++++++++++++++ .../definitions/_specialist_document.jsonnet | 121 ++++- .../formats/specialist_document.jsonnet | 1 + 13 files changed, 979 insertions(+), 1 deletion(-) create mode 100644 content_schemas/examples/specialist_document/frontend/algorithmic-transparency-record.json diff --git a/content_schemas/allowed_document_types.yml b/content_schemas/allowed_document_types.yml index 01598a668..55c4d97d2 100644 --- a/content_schemas/allowed_document_types.yml +++ b/content_schemas/allowed_document_types.yml @@ -4,6 +4,7 @@ - accessible_documents_policy - access_and_opening - ai_assurance_portfolio_technique +- algorithmic_transparency_record - ambassador_role - animal_disease_case - answer diff --git a/content_schemas/dist/formats/generic/frontend/schema.json b/content_schemas/dist/formats/generic/frontend/schema.json index a4399e612..65b4b019a 100644 --- a/content_schemas/dist/formats/generic/frontend/schema.json +++ b/content_schemas/dist/formats/generic/frontend/schema.json @@ -40,6 +40,7 @@ "accessible_documents_policy", "access_and_opening", "ai_assurance_portfolio_technique", + "algorithmic_transparency_record", "ambassador_role", "animal_disease_case", "answer", diff --git a/content_schemas/dist/formats/generic/notification/schema.json b/content_schemas/dist/formats/generic/notification/schema.json index e992d6738..b9c48bb36 100644 --- a/content_schemas/dist/formats/generic/notification/schema.json +++ b/content_schemas/dist/formats/generic/notification/schema.json @@ -64,6 +64,7 @@ "accessible_documents_policy", "access_and_opening", "ai_assurance_portfolio_technique", + "algorithmic_transparency_record", "ambassador_role", "animal_disease_case", "answer", diff --git a/content_schemas/dist/formats/generic/publisher_v2/schema.json b/content_schemas/dist/formats/generic/publisher_v2/schema.json index 1302c1383..1c0deb23a 100644 --- a/content_schemas/dist/formats/generic/publisher_v2/schema.json +++ b/content_schemas/dist/formats/generic/publisher_v2/schema.json @@ -50,6 +50,7 @@ "accessible_documents_policy", "access_and_opening", "ai_assurance_portfolio_technique", + "algorithmic_transparency_record", "ambassador_role", "animal_disease_case", "answer", diff --git a/content_schemas/dist/formats/generic_with_external_related_links/frontend/schema.json b/content_schemas/dist/formats/generic_with_external_related_links/frontend/schema.json index 1464a5bf9..c732fe1a2 100644 --- a/content_schemas/dist/formats/generic_with_external_related_links/frontend/schema.json +++ b/content_schemas/dist/formats/generic_with_external_related_links/frontend/schema.json @@ -40,6 +40,7 @@ "accessible_documents_policy", "access_and_opening", "ai_assurance_portfolio_technique", + "algorithmic_transparency_record", "ambassador_role", "animal_disease_case", "answer", diff --git a/content_schemas/dist/formats/generic_with_external_related_links/notification/schema.json b/content_schemas/dist/formats/generic_with_external_related_links/notification/schema.json index 21124c5bb..c2c98b0fb 100644 --- a/content_schemas/dist/formats/generic_with_external_related_links/notification/schema.json +++ b/content_schemas/dist/formats/generic_with_external_related_links/notification/schema.json @@ -64,6 +64,7 @@ "accessible_documents_policy", "access_and_opening", "ai_assurance_portfolio_technique", + "algorithmic_transparency_record", "ambassador_role", "animal_disease_case", "answer", diff --git a/content_schemas/dist/formats/generic_with_external_related_links/publisher_v2/schema.json b/content_schemas/dist/formats/generic_with_external_related_links/publisher_v2/schema.json index 2daad2238..3a35db2b6 100644 --- a/content_schemas/dist/formats/generic_with_external_related_links/publisher_v2/schema.json +++ b/content_schemas/dist/formats/generic_with_external_related_links/publisher_v2/schema.json @@ -50,6 +50,7 @@ "accessible_documents_policy", "access_and_opening", "ai_assurance_portfolio_technique", + "algorithmic_transparency_record", "ambassador_role", "animal_disease_case", "answer", diff --git a/content_schemas/dist/formats/specialist_document/frontend/schema.json b/content_schemas/dist/formats/specialist_document/frontend/schema.json index 21aac9fc1..0e2b7c2f0 100644 --- a/content_schemas/dist/formats/specialist_document/frontend/schema.json +++ b/content_schemas/dist/formats/specialist_document/frontend/schema.json @@ -36,6 +36,7 @@ "enum": [ "aaib_report", "ai_assurance_portfolio_technique", + "algorithmic_transparency_record", "animal_disease_case", "asylum_support_decision", "business_finance_support_scheme", @@ -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": [ @@ -521,6 +638,9 @@ { "$ref": "#/definitions/ai_assurance_portfolio_technique_metadata" }, + { + "$ref": "#/definitions/algorithmic_transparency_record_metadata" + }, { "$ref": "#/definitions/animal_disease_case_metadata" }, diff --git a/content_schemas/dist/formats/specialist_document/notification/schema.json b/content_schemas/dist/formats/specialist_document/notification/schema.json index fb0d39702..ab297fa8f 100644 --- a/content_schemas/dist/formats/specialist_document/notification/schema.json +++ b/content_schemas/dist/formats/specialist_document/notification/schema.json @@ -60,6 +60,7 @@ "enum": [ "aaib_report", "ai_assurance_portfolio_technique", + "algorithmic_transparency_record", "animal_disease_case", "asylum_support_decision", "business_finance_support_scheme", @@ -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": [ @@ -613,6 +730,9 @@ { "$ref": "#/definitions/ai_assurance_portfolio_technique_metadata" }, + { + "$ref": "#/definitions/algorithmic_transparency_record_metadata" + }, { "$ref": "#/definitions/animal_disease_case_metadata" }, diff --git a/content_schemas/dist/formats/specialist_document/publisher_v2/schema.json b/content_schemas/dist/formats/specialist_document/publisher_v2/schema.json index ae2c3f937..fd1141ccf 100644 --- a/content_schemas/dist/formats/specialist_document/publisher_v2/schema.json +++ b/content_schemas/dist/formats/specialist_document/publisher_v2/schema.json @@ -46,6 +46,7 @@ "enum": [ "aaib_report", "ai_assurance_portfolio_technique", + "algorithmic_transparency_record", "animal_disease_case", "asylum_support_decision", "business_finance_support_scheme", @@ -352,6 +353,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": [ @@ -437,6 +554,9 @@ { "$ref": "#/definitions/ai_assurance_portfolio_technique_metadata" }, + { + "$ref": "#/definitions/algorithmic_transparency_record_metadata" + }, { "$ref": "#/definitions/animal_disease_case_metadata" }, diff --git a/content_schemas/examples/specialist_document/frontend/algorithmic-transparency-record.json b/content_schemas/examples/specialist_document/frontend/algorithmic-transparency-record.json new file mode 100644 index 000000000..2a9100f21 --- /dev/null +++ b/content_schemas/examples/specialist_document/frontend/algorithmic-transparency-record.json @@ -0,0 +1,491 @@ +{ + "content_id": "77fefe76-b7fb-4a8c-b90b-e1e3516c0af7", + "locale": "en", + "base_path": "/algorithmic-transparency-records/govuk-data-labs-cabinet-office-related-links", + "title": "GOV.UK Data Labs (Cabinet Office): Related Links", + "description": "The GOV.UK Data Labs team piloted the standard for their Related Links tool; a recommendation engine built to aid navigation of GOV.UK.", + "details": { + "body": "Related Links is a recommendation engine built to aid navigation of GOV.UK by providing relevant onward journeys from a content page.\n\nThe tool uses an algorithm called node2vec to train a model on the last three weeks of user movement data (web analytics data). Three weeks of data was used as our experience with user movement data on the site indicated it was sufficient to capture medium and long term trends while ignoring short-lived spikes in user behaviour. The model is used to predict related links for every page. These new related links are published to GOV.UK.\n\nThe tool is used to help users find useful information and content, aiding navigation.\n\nGOV.UK has approximately 600,000 pieces of content. Previously, related links were created manually, with only approximately 2,000 pieces of content having related links. The tool expanded that to nearly the entirety of the GOV.UK content.", + "attachments": [], + "metadata": { + "algorithmic_transparency_record_organisation": "department-for-science-innovation-and-technology", + "algorithmic_transparency_record_organisation_type": ["ministerial-department"], + "algorithmic_transparency_record_function": ["general-public-services"], + "algorithmic_transparency_record_capability": ["discovery"], + "algorithmic_transparency_record_task": "Task", + "algorithmic_transparency_record_phase": "beta-pilot", + "algorithmic_transparency_record_region": [ + "england", + "london" + ], + "algorithmic_transparency_record_date_published": "2015-12-31", + "algorithmic_transparency_record_atrs_version": "v2.1", + "algorithmic_transparency_record_other_tags": "Example tag" + }, + "max_cache_time": 10, + "change_history": [ + { + "note": "First published.", + "public_timestamp": "2015-07-10T13:09:46+00:00" + } + ], + "headers": [ + { + "text": "Statutory timetable", + "level": 2, + "id": "statutory-timetable" + }, + { + "text": "Phase 1", + "level": 2, + "id": "phase-1", + "headers": [ + { + "text": "Invitation to comment: closes 24 July 2015", + "level": 3, + "id": "invitation-to-comment-closes-24-july-2015" + }, + { + "text": "Launch of CMA merger inquiry", + "level": 3, + "id": "launch-of-cma-merger-inquiry" + }, + { + "text": "Contact", + "level": 3, + "id": "contact" + } + ] + } + ] + }, + "public_updated_at": "2015-07-10T13:09:46+00:00", + "schema_name": "specialist_document", + "document_type": "algorithmic_transparency_record", + "links": { + "organisations": [ + { + "analytics_identifier": "OT1280", + "api_path": "/api/content/government/organisations/centre-for-data-ethics-and-innovation", + "base_path": "/government/organisations/centre-for-data-ethics-and-innovation", + "content_id": "1405edcb-943d-42d2-8ec8-c51cd58335a5", + "description": "The CDEI is a government expert body enabling the trustworthy use of data and AI. CDEI is part of the Department for Science, Innovation and Technology.", + "document_type": "organisation", + "locale": "en", + "public_updated_at": "2015-03-10T16:23:14Z", + "schema_name": "organisation", + "title": "Centre for Data Ethics and Innovation", + "withdrawn": false, + "details": { + "brand": "cabinet-office", + "logo": { + "formatted_title": "Centre for
Data Ethics
and Innovation", + "crest": null + } + }, + "links": {}, + "api_url": "https://www.gov.uk/api/content/government/organisations/centre-for-data-ethics-and-innovation", + "web_url": "https://www.gov.uk/government/organisations/centre-for-data-ethics-and-innovation" + }, + { + "analytics_identifier": "D1381", + "api_path": "/api/content/government/organisations/department-for-science-innovation-and-technology", + "base_path": "/government/organisations/department-for-science-innovation-and-technology", + "content_id": "c352c234-8083-47ec-8a4b-0edd45c31263", + "description": "Driving innovation that will deliver improved public services, create new better-paid jobs and grow the economy. DSIT is a ministerial department, supported by 14 agencies and public bodies.", + "document_type": "organisation", + "locale": "en", + "public_updated_at": "2015-03-10T16:23:14Z", + "schema_name": "organisation", + "title": "Department for Science, Innovation and Technology", + "withdrawn": false, + "details": { + "brand": "department-for-science-innovation-and-technology", + "logo": { + "formatted_title": "Department for
Science, Innovation
& Technology", + "crest": null + } + }, + "links": {}, + "api_url": "https://www.gov.uk/api/content/government/organisations/department-for-science-innovation-and-technology", + "web_url": "https://www.gov.uk/government/organisations/department-for-science-innovation-and-technology" + }, + { + "analytics_identifier": "OT1329", + "api_path": "/api/content/government/organisations/central-digital-and-data-office", + "base_path": "/government/organisations/central-digital-and-data-office", + "content_id": "2fb482e7-3c4d-496f-887d-f8a55a15e89a", + "description": "The Central Digital and Data Office is part of the Cabinet Office. We lead the Government Digital and Data function for government. CDDO is part of the Cabinet Office .", + "document_type": "organisation", + "locale": "en", + "public_updated_at": "2015-03-10T16:23:14Z", + "schema_name": "organisation", + "title": "Central Digital and Data Office", + "withdrawn": false, + "details": { + "brand": "cabinet-office", + "logo": { + "formatted_title": "Central Digital
& Data Office", + "crest": "single-identity" + } + }, + "links": {}, + "api_url": "https://www.gov.uk/api/content/government/organisations/central-digital-and-data-office", + "web_url": "https://www.gov.uk/government/organisations/central-digital-and-data-office" + } + ], + "finder": [ + { + "analytics_identifier": null, + "api_path": "/api/content/algorithmic-transparency-records", + "base_path": "/algorithmic-transparency-records", + "content_id": "dc6dc59b-af0b-4849-a3f1-aa7b96635fac", + "description": "Find out how and why public sector organisations use AI and algorithmic tools for decision making.", + "document_type": "finder", + "locale": "en", + "public_updated_at": "2017-03-15T14:44:21Z", + "schema_name": "finder", + "title": "Find out how algorithmic tools are used in public organisations", + "withdrawn": false, + "details": { + "facets": [ + { + "key": "algorithmic_transparency_record_organisation", + "name": "Organisation", + "type": "text", + "preposition": "Organisation", + "display_as_result_metadata": true, + "filterable": true, + "allowed_values": [ + { + "label": "Cabinet Office", + "value": "cabinet-office" + }, + { + "label": "Ministry of Justice", + "value": "ministry-of-justice" + }, + { + "label": "Information Commissioner’s Office", + "value": "information-commissioners-office" + }, + { + "label": "Department for Health and Social Care ", + "value": "department-for-health-and-social-care" + }, + { + "label": "Food Standards Agency", + "value": "food-standards-agency" + }, + { + "label": "Hampshire and Thames Valley Police", + "value": "hampshire-and-thames-valley-police" + }, + { + "label": "West Midlands Police", + "value": "west-midlands-police" + }, + { + "label": "Department for Science Innovation and Technology", + "value": "department-for-science-innovation-and-technology" + }, + { + "label": "Department for Education", + "value": "department-for-education" + } + ] + }, + { + "key": "algorithmic_transparency_record_organisation_type", + "name": "Organisation type", + "type": "text", + "preposition": "Organisation type", + "display_as_result_metadata": true, + "filterable": true, + "allowed_values": [ + { + "label": "Ministerial department", + "value": "ministerial-department" + }, + { + "label": "Non-ministerial department", + "value": "non-ministerial-department" + }, + { + "label": "Agency or public body", + "value": "agency-or-public-body" + }, + { + "label": "Local authority", + "value": "local-authority" + }, + { + "label": "Devolved administration", + "value": "devolved-administration" + }, + { + "label": "High profile group", + "value": "high-profile-group" + }, + { + "label": "Public corporation", + "value": "public-corporation" + } + ] + }, + { + "key": "algorithmic_transparency_record_function", + "name": "Function", + "type": "text", + "preposition": "Function", + "display_as_result_metadata": true, + "filterable": true, + "allowed_values": [ + { + "label": "General public services", + "value": "general-public-services" + }, + { + "label": "Defence", + "value": "defence" + }, + { + "label": "Public order and safety", + "value": "public-order-and-safety" + }, + { + "label": "Economic affairs", + "value": "economic-affairs" + }, + { + "label": "Environmental protection", + "value": "environmental-protection" + }, + { + "label": "Housing and community amenities", + "value": "housing-and-community-amenities" + }, + { + "label": "Health", + "value": "health" + }, + { + "label": "Recreation culture and religion", + "value": "recreation-culture-and-religion" + }, + { + "label": "Education", + "value": "education" + }, + { + "label": "Social protection", + "value": "social-protection" + }, + { + "label": "Regulation", + "value": "regulation" + } + ] + }, + { + "key": "algorithmic_transparency_record_capability", + "name": "Capability", + "type": "text", + "preposition": "Capability", + "display_as_result_metadata": false, + "filterable": true, + "allowed_values": [ + { + "label": "Computer vision", + "value": "computer-vision" + }, + { + "label": "Computer audition", + "value": "computer-audition" + }, + { + "label": "Computer linguistics", + "value": "computer-linguistics" + }, + { + "label": "Robotics", + "value": "robotics" + }, + { + "label": "Forecasting", + "value": "forecasting" + }, + { + "label": "Discovery", + "value": "discovery" + }, + { + "label": "Planning", + "value": "planning" + }, + { + "label": "Creation", + "value": "creation" + }, + { + "label": "Analysis", + "value": "analysis" + }, + { + "label": "Management", + "value": "management" + }, + { + "label": "Other", + "value": "other" + } + ] + }, + { + "key": "algorithmic_transparency_record_task", + "name": "Task", + "type": "text", + "preposition": "Task", + "display_as_result_metadata": false, + "filterable": true + }, + { + "key": "algorithmic_transparency_record_phase", + "name": "Phase", + "type": "text", + "preposition": "Phase", + "display_as_result_metadata": true, + "filterable": true, + "allowed_values": [ + { + "label": "Pre-deployment", + "value": "pre-deployment" + }, + { + "label": "Beta/Pilot", + "value": "beta-pilot" + }, + { + "label": "Production", + "value": "production" + }, + { + "label": "Retired", + "value": "retired" + } + ] + }, + { + "key": "algorithmic_transparency_record_region", + "name": "Region", + "type": "text", + "preposition": "Region", + "display_as_result_metadata": true, + "filterable": true, + "allowed_values": [ + { + "label": "Northern Ireland", + "value": "northern-ireland" + }, + { + "label": "Scotland", + "value": "scotland" + }, + { + "label": "Wales", + "value": "wales" + }, + { + "label": "England", + "value": "england" + }, + { + "label": "London", + "value": "london" + }, + { + "label": "North East", + "value": "north-east" + }, + { + "label": "North West", + "value": "north-west" + }, + { + "label": "Yorkshire and the Humber", + "value": "yorkshire-and-the-humber" + }, + { + "label": "East Midlands", + "value": "east-midlands" + }, + { + "label": "West Midlands", + "value": "west-midlands" + }, + { + "label": "South East", + "value": "south-east" + }, + { + "label": "East of England", + "value": "east-of-england" + }, + { + "label": "South West", + "value": "south-west" + } + ] + }, + { + "key": "algorithmic_transparency_record_date_published", + "name": "Date published", + "type": "date", + "preposition": "Date published", + "display_as_result_metadata": true, + "filterable": true + }, + { + "key": "algorithmic_transparency_record_atrs_version", + "name": "ATRS version", + "type": "text", + "preposition": "ATRS version", + "display_as_result_metadata": true, + "filterable": false + }, + { + "key": "algorithmic_transparency_record_other_tags", + "name": "Other tags", + "type": "text", + "preposition": "Other tags", + "display_as_result_metadata": false, + "filterable": true + } + ] + }, + "links": {}, + "api_url": "https://www.gov.uk/api/content/algorithmic-transparency-records", + "web_url": "https://www.gov.uk/algorithmic-transparency-records" + } + ], + "available_translations": [ + { + "analytics_identifier": null, + "content_id": "77fefe76-b7fb-4a8c-b90b-e1e3516c0af7", + "description": "The GOV.UK Data Labs team piloted the standard for their Related Links tool; a recommendation engine built to aid navigation of GOV.UK.", + "document_type": "algorithmic_transparency_record", + "public_updated_at": "2015-10-01T11:00:38Z", + "schema_name": "specialist_document", + "title": "GOV.UK Data Labs (Cabinet Office): Related Links", + "base_path": "/algorithmic-transparency-records/govuk-data-labs-cabinet-office-related-links", + "locale": "en", + "api_path": "/api/content/algorithmic-transparency-records/govuk-data-labs-cabinet-office-related-links", + "withdrawn": false, + "api_url": "https://www.gov.uk/api/content/algorithmic-transparency-records/govuk-data-labs-cabinet-office-related-links", + "web_url": "https://www.gov.uk/algorithmic-transparency-records/govuk-data-labs-cabinet-office-related-links", + "links": {} + } + ] + }, + "updated_at": "2017-06-30T15:44:11.073Z" +} diff --git a/content_schemas/formats/shared/definitions/_specialist_document.jsonnet b/content_schemas/formats/shared/definitions/_specialist_document.jsonnet index ced16adca..0c0edccc1 100644 --- a/content_schemas/formats/shared/definitions/_specialist_document.jsonnet +++ b/content_schemas/formats/shared/definitions/_specialist_document.jsonnet @@ -8,6 +8,9 @@ { "$ref": "#/definitions/ai_assurance_portfolio_technique_metadata", }, + { + "$ref": "#/definitions/algorithmic_transparency_record_metadata", + }, { "$ref": "#/definitions/animal_disease_case_metadata", }, @@ -287,7 +290,123 @@ }, }, }, - }, + }, + algorithmic_transparency_record_metadata: { + type: "object", + additionalProperties: false, + properties: { + 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_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_capability: { + type: "array", + items: { + type: "string", + enum: [ + "computer-vision", + "computer-audition", + "computer-linguistics", + "robotics", + "forecasting", + "discovery", + "planning", + "creation", + "analysis", + "management", + "other", + ], + }, + }, + algorithmic_transparency_record_task: { + 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_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_atrs_version: { + type: "string", + }, + algorithmic_transparency_record_other_tags: { + type: "string", + }, + }, + }, animal_disease_case_metadata: { type: "object", additionalProperties: false, diff --git a/content_schemas/formats/specialist_document.jsonnet b/content_schemas/formats/specialist_document.jsonnet index 67ddf00d4..7c1843b1a 100644 --- a/content_schemas/formats/specialist_document.jsonnet +++ b/content_schemas/formats/specialist_document.jsonnet @@ -2,6 +2,7 @@ document_type: [ "aaib_report", "ai_assurance_portfolio_technique", + "algorithmic_transparency_record", "animal_disease_case", "asylum_support_decision", "business_finance_support_scheme",