Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add optional standardizedScore field in service manifest (#147) #156

Merged
merged 3 commits into from
Apr 11, 2024
Merged

Add optional standardizedScore field in service manifest (#147) #156

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c5a7bbb
Add optional `standardizedScore` field in service manifest (#147)
fsteeg Mar 14, 2024
bd6d7ec
Merge remote-tracking branch 'origin/master' into 147-standardizedScore
fsteeg Apr 11, 2024
6c058d3
Add standardizedScore change to "This Draft" section (#147)
fsteeg Apr 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion draft/examples/manifest/valid/wikidata.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,5 +82,6 @@
"type": true,
"entity": true,
"property": true
}
},
"standardizedScore": true
}
4 changes: 3 additions & 1 deletion draft/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -382,6 +382,8 @@ <h3>Service Manifest</h3>
<dd>An optional value for the default <a href="#text-processing-language">text-processing language</a> used by this service.</dd>
<dt><code>dir</code></dt>
<dd>An optional value for the default <a href="#text-direction">text direction</a> used by this service.</dd>
<dt><code>standardizedScore</code></dt>
<dd>An optional boolean indicating if the service returns values between 0 and 100 (inclusive) in the <code>score</code> field of <a>reconciliation candidates</a>. This enables clients to process and display candidates accordingly, e.g. with score percentages or visualizations.</dd>
</dl>
</p>
<p>For instance, a service could expose the following minimal service manifest:
Expand Down Expand Up @@ -554,7 +556,7 @@ <h3>Reconciliation Query Responses</h3>
<dt><code>type</code></dt>
<dd>The types of the candidate entity;</dd>
<dt><code>score</code></dt>
<dd>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;</dt>
<dd>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 <code>standardizedScore</code> is set to <code>true</code> in the <a>service manifest</a>, this value MUST be between 0 and 100 (inclusive);</dt>
<dt><code>features</code></dt>
<dd>An optional array of <a>matching features</a>;</dd>
<dt><code>match</code></dt>
Expand Down
4 changes: 4 additions & 0 deletions draft/schemas/manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
Expand Down
Loading