From c5a7bbb8301c80d1dc96661f60cf81a3a4ce496c Mon Sep 17 00:00:00 2001 From: Fabian Steeg Date: Thu, 14 Mar 2024 11:53:05 +0100 Subject: [PATCH 1/2] Add optional `standardizedScore` field in service manifest (#147) --- draft/examples/manifest/valid/wikidata.json | 3 ++- draft/index.html | 4 +++- draft/schemas/manifest.json | 4 ++++ 3 files changed, 9 insertions(+), 2 deletions(-) diff --git a/draft/examples/manifest/valid/wikidata.json b/draft/examples/manifest/valid/wikidata.json index 536c05b..75b297f 100644 --- a/draft/examples/manifest/valid/wikidata.json +++ b/draft/examples/manifest/valid/wikidata.json @@ -82,5 +82,6 @@ "type": true, "entity": true, "property": true - } + }, + "standardizedScore": true } diff --git a/draft/index.html b/draft/index.html index d94a8f7..b80bdf7 100644 --- a/draft/index.html +++ b/draft/index.html @@ -382,6 +382,8 @@

Service Manifest

An optional value for the default text-processing language used by this service.
dir
An optional value for the default text direction used by this service.
+
standardizedScore
+
An optional boolean indicating if the service returns values between 0 and 100 (inclusive) in the score field of reconciliation candidates. This enables clients to process and display candidates accordingly, e.g. with score percentages or visualizations.

For instance, a service could expose the following minimal service manifest: @@ -554,7 +556,7 @@

Reconciliation Query Responses

type
The types of the candidate entity;
score
-
An optional numeral indicating how well this candidate entity matches the query: a higher score indicates a better match. If candidates are scored, the reconciliation service SHOULD sort candidates in decreasing score order; +
An optional numeral indicating how well this candidate entity matches the query: a higher score indicates a better match. If candidates are scored, the reconciliation service SHOULD sort candidates in decreasing score order. If standardizedScore is set to true in the service manifest, this value MUST be between 0 and 100 (inclusive);
features
An optional array of matching features;
match
diff --git a/draft/schemas/manifest.json b/draft/schemas/manifest.json index 934410a..e500a9d 100644 --- a/draft/schemas/manifest.json +++ b/draft/schemas/manifest.json @@ -254,6 +254,10 @@ } } } + }, + "standardizedScore": { + "type": "boolean", + "description": "Whether the service returns values between 0 and 100 (inclusive) in the score field of reconciliation candidates" } }, "required": [ From 6c058d3850e8564618bff1a754fd2455baa26618 Mon Sep 17 00:00:00 2001 From: Fabian Steeg Date: Thu, 11 Apr 2024 17:29:24 +0200 Subject: [PATCH 2/2] Add standardizedScore change to "This Draft" section (#147) Remove camelCase entry, not merged yet, will add it back in #166 --- draft/index.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/draft/index.html b/draft/index.html index 09d8e0e..4f9f1b2 100644 --- a/draft/index.html +++ b/draft/index.html @@ -240,7 +240,7 @@

This Draft

  • Remove identifierSpace and schemaSpace and make view templates mandatory
  • Remove support for JSONP
  • Move the query field of reconciliation queries inside properties to allow for queries which do not provide entity names
    • -
  • Unify naming to camelCase convention
    • +
  • Add optional standardizedScore field to the manifest