Skip to content

Feature delete mapping #458

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

Merged
gusmith merged 13 commits into from
Nov 4, 2019
Merged

Feature delete mapping #458

Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
1c00f74
Remove mention of the mapping output type from the swagger file.
gusmith Oct 30, 2019
78d7538
Remove the mapping from the mapping results database types.
gusmith Oct 31, 2019
dce2b0b
Remove some unused imports.
gusmith Oct 31, 2019
ce70e40
Remove the mapping output type from the library.
gusmith Oct 31, 2019
3239c5f
Remove mapping and add groups in the result type accessible only to t…
gusmith Oct 31, 2019
1c8ca4c
Update all the tests.
gusmith Oct 31, 2019
f64add7
Decrease waiting time in test.
gusmith Oct 31, 2019
6c05352
Correct documentation which was actually not really up-to-date.
gusmith Oct 31, 2019
19ea122
Update some documentation.
gusmith Nov 1, 2019
4cab4e6
Remove mapping from the tutorial
gusmith Nov 1, 2019
b6c3d2c
And some changelog
gusmith Nov 1, 2019
a583c0b
Rename an internal variable and correct documentation
gusmith Nov 4, 2019
f7601d1
Remove sleep in test utility method.
gusmith Nov 4, 2019
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
Next Next commit
Remove mention of the mapping output type from the swagger file.
  • Loading branch information
@gusmith
gusmith committed Oct 31, 2019
commit 1c00f74663d3db083ffb3874594389de10197725
27 changes: 6 additions & 21 deletions backend/entityservice/api_def/swagger.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,13 +75,12 @@ info:

The options are:

* `"mapping"` - Creates a lookup table of the form `indexA = indexB`.
* `"permutations"` - Creates random permutations and a mask.
* `"similarity_scores"` - Outputs a list of similarity scores of `[indexA, indexB, score]`, where `score`
represents the likelihood that `indexA = indexB`.
* `"groups"` - Outputs a list of groups of records, where each group represents one entity.

Only `"groups"` supports multi-party linkage. `"mapping"`, `"permutations"`, and `"similarity_scores"` only support linkage
Copy link
Collaborator

@wilko77 wilko77 Nov 4, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

line 43 and 71 mentioning four different output types. -> change to three.

Copy link
Contributor Author

@gusmith gusmith Nov 4, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

Only `"groups"` supports multi-party linkage. `"permutations"` and `"similarity_scores"` only support linkage
with two parties.


Expand Down Expand Up @@ -193,16 +192,16 @@ paths:
The parts of the computed linkage results that are accessable by the different tokens depends on the
`result_type`:

- `"mapping"`, `"similarity_scores"`, or `"groups"`\
If the `result_type` is `"mapping"`, `"similarity_scores"`, or `"groups"` then the results can be accessed with the
- `"similarity_scores"`, or `"groups"`\
If the `result_type` is `"similarity_scores"` or `"groups"` then the results can be accessed with the
`result_token``token`, which is provided when initially creating the mapping.

- `"permutations"`\
If the `result_type` is `permutations`, then the data providers can access their respective permutation with
their individual `receipt_token`, which they obtain when adding data to the mapping.
The mask can be accessed with the `result_token`.

Only `"groups"` supports multi-party linkage. If the result type is `"mapping"`, `"similarity_scores"`, or
Only `"groups"` supports multi-party linkage. If the result type is `"similarity_scores"` or
`"permutations"`, then the number of parties must be 2.

parameters:
Expand Down Expand Up @@ -508,19 +507,6 @@ paths:
Note if the result isn't ready, a `404` will be returned.


### result_type = "mapping"

The mapping of indices between parties. Data is returned as `json` object e.g,

{
"mapping":
{
"0": "5",
"2": "0"
}
}


### result_type = "similarity_scores"

The list of the indices of potential matches and their similarity score
Expand Down Expand Up @@ -718,10 +704,9 @@ definitions:
description: |
Defines the output type of the mapping. Multi-party linkage requires `"groups"` to be used.
enum:
- similarity_scores
- mapping
- permutations
- groups
- permutations
- similarity_scores

RunState:
type: string
Expand Down