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.

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

ADR 22: Preferred identifier algorithm #184

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Changes from all commits
Commits
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
39 changes: 39 additions & 0 deletions doc/adr/0022-preferred-identifier-algorithm.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# 23. Preferred Identifier Algorithm

Date: 2024-11-28

## Status

Draft

## Context

When moving to a model where multiple documents have multiple identifiers, we need to understand how we choose which one to display for human identification purposes.

## Decision

Scores for individual components are multiplied together; IDs scoring 0 are never routinely considered preferred. (Scores for a component are 1 unless otherwise specified)

#### Deprecation

Identifier is deprecated: 0
Document is deprecated: 0

#### Schema

Default: 0.5?
NCN: 1
BAILII: 0.8
FCL SQID: 0.01

#### Recentness

Take the most recent (which measure of recentness? on publication? identifier?) if all other choices are even.

### Other options

We probably want to be able to limit to "only public documents" (for the PUI), "only human friendly identifiers", which can also add a 0 modifier to an identifier/document pair.

## Consequences

We have a modular system for determining the best identifier/document to return in multiple scenarios.