https://github.com/interzoid/streetaddresssimkey-go
Generates a similarity key for a street address for matching inconsistent street addresses within a dataset(s)
https://github.com/interzoid/streetaddresssimkey-go
addresses ai dataquality go go-package golang
Last synced: 3 months ago
JSON representation
Generates a similarity key for a street address for matching inconsistent street addresses within a dataset(s)
- Host: GitHub
- URL: https://github.com/interzoid/streetaddresssimkey-go
- Owner: interzoid
- License: mit
- Created: 2023-02-03T23:58:43.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-09-17T20:08:08.000Z (over 2 years ago)
- Last Synced: 2024-06-20T14:29:46.499Z (almost 2 years ago)
- Topics: addresses, ai, dataquality, go, go-package, golang
- Language: Go
- Homepage: https://www.interzoid.com
- Size: 4.88 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## streetaddresssimkey-go
Go package for generating a similarity key from the input data used to match with other similar street address data. Use the generated similarity key, rather than the actual data itself, to match and/or sort street address data by similarity. This avoids the problems of data inconsistency, misspellings, and address element variations when matching within a single dataset, and can also help matching across datasets or for more advanced searching.
The key generation is based on a series of tests, algorithms, AI, and an ever-growing body of Machine Learning-based generated knowledge.
### Usage
To generate the similarity key, you will need the following information:
- an API License key, available at https://www.interzoid.com
- a street address to generate the similarity key for
Begin by retrieving the package:
go get "github.com/interzoid/streetaddresssimkey-go"
Import the package into your code:
import "github.com/interzoid/streetaddresssimkey-go"
Then, provide a street address into the GetSimKey() method:
simkey, code, credits, err := StreetAddressSimKey.GetSimKey("YOUR-API-KEY","107 E. Main St.")
The return values will be the generated similarity key, a code (success or failure), how many remaining credits on your API key, and any error messages. The similarity key can be used to search for other similar street addresses, to sort large datasets by similarity, and perhaps use additional attributes to identify duplicates/redundancy.
Examples:
100 E. Main St. Suite 101 -> fS9Xxx-9HoRD4ZGJA43meLBS3tAn5YjdCClGJyXtUrw
100 East Main St. #101 -> fS9Xxx-9HoRD4ZGJA43meLBS3tAn5YjdCClGJyXtUrw
Park Avenue #500 -> EP88bx0VFDaIh-cOt86c8pOJ6lNkb_TWiKFpmMKXakY
500 PARK AVE. -> EP88bx0VFDaIh-cOt86c8pOJ6lNkb_TWiKFpmMKXakY
See Also:
**Individual Name Similarity Keys**: https://github.com/interzoid/fullnamesimkey-go
**Individual Name Match Scoring**: https://github.com/interzoid/fullnamematchscore-go
**Company Name Similarity Keys**: https://github.com/interzoid/companynamesimkey-go