| Name | tilores-sdk JSON |
| Version |
0.3.0
JSON |
| download |
| home_page | None |
| Summary | This is the offical SDK to develop with the Tilores entity resolution database. |
| upload_time | 2024-10-28 13:03:13 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2024 Tilo Tech GmbH Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
entity-resolution
tilores
graph-rag
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Tilores Python SDK
The `tilores-sdk` Python package is a small SDK to develop with the [Tilores entity resolution system](https://docs.tilotech.io/tilores/).
## What is entity resolution?
Entity resolution is the connecting of non-identitcal, related data from disparate sources to "entities".
Entities can be anything from people, to companies to financial transactions.
Tilores is a highly-scalable, “entity-resolution” technology that was originally developed to connect internal data together. The technology was developed because we found that no other technology on the market could deliver the speed, scalability or cost performance we demanded.
Common use cases of entity resolution are:
* Deduplication of records from different sources
* Matching of financial transaction records
* Data cleaning and transformation
* Frequency analysis of individual attributes
* Retrieval Augmented Generation
## Example usage
### Installation
```console
$ pip install tilores-sdk
```
### Usage
* Given you have a Tilores instance setup
* Given you have a set of Tilores instance API credentials.
Obtain your credentials from your Tilores instance in [Manage Instance > Integration > GraphQL API](https://app.tilores.io/).
* Given you have data loaded, and a schema configured that supports searching for the fields specified in this example.
```python
import os
from tilores import TiloresAPI
# Initialize the TiloresAPI (or use `TiloresAPI.from_environ()`)
tilores = TiloresAPI(
api_url=os.environ['TILORES_API_URL'],
token_url=os.environ['TILORES_TOKEN_URL'],
client_id=os.environ['TILORES_CLIENT_ID'],
client_secret=os.environ['TILORES_CLIENT_SECRET']
)
tilores.search({'name': 'Müller, Sophia'})
```
## Features
The Tilores SDK supports the following features of the Tilores API:
* Tilores instance authentication
* Tilores database schema and introspection
* Tilores database GraphQL queries
* Tilores entity resolution search
* Tilores golden record retrieval
In addition to that, it provides various convenience helpers to integrate with the Python ecosystem:
* Create pydantic base classes from the Tilores schema
Raw data
{
"_id": null,
"home_page": null,
"name": "tilores-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "entity-resolution, tilores, graph-rag",
"author": null,
"author_email": "Lukas Rieder <lukas@parlant.co>, Stefan Berkner <stefan.berkner@tilores.io>",
"download_url": "https://files.pythonhosted.org/packages/52/77/358ecc92f3cc938dc0409b2eada66ef396f07809028ea3ebc4f04c928ba0/tilores_sdk-0.3.0.tar.gz",
"platform": null,
"description": "# Tilores Python SDK\n\nThe `tilores-sdk` Python package is a small SDK to develop with the [Tilores entity resolution system](https://docs.tilotech.io/tilores/).\n\n## What is entity resolution?\n\nEntity resolution is the connecting of non-identitcal, related data from disparate sources to \"entities\".\nEntities can be anything from people, to companies to financial transactions.\n\nTilores is a highly-scalable, \u201centity-resolution\u201d technology that was originally developed to connect internal data together. The technology was developed because we found that no other technology on the market could deliver the speed, scalability or cost performance we demanded.\n\nCommon use cases of entity resolution are:\n\n* Deduplication of records from different sources\n* Matching of financial transaction records\n* Data cleaning and transformation\n* Frequency analysis of individual attributes\n* Retrieval Augmented Generation\n\n## Example usage\n\n### Installation\n\n```console\n$ pip install tilores-sdk\n```\n\n### Usage\n\n* Given you have a Tilores instance setup\n* Given you have a set of Tilores instance API credentials.\n\n Obtain your credentials from your Tilores instance in [Manage Instance > Integration > GraphQL API](https://app.tilores.io/).\n\n* Given you have data loaded, and a schema configured that supports searching for the fields specified in this example.\n\n```python\nimport os\nfrom tilores import TiloresAPI\n\n# Initialize the TiloresAPI (or use `TiloresAPI.from_environ()`)\ntilores = TiloresAPI(\n api_url=os.environ['TILORES_API_URL'],\n token_url=os.environ['TILORES_TOKEN_URL'],\n client_id=os.environ['TILORES_CLIENT_ID'],\n client_secret=os.environ['TILORES_CLIENT_SECRET']\n)\ntilores.search({'name': 'M\u00fcller, Sophia'})\n```\n\n## Features\n\nThe Tilores SDK supports the following features of the Tilores API:\n\n* Tilores instance authentication\n* Tilores database schema and introspection\n* Tilores database GraphQL queries\n* Tilores entity resolution search\n* Tilores golden record retrieval\n\nIn addition to that, it provides various convenience helpers to integrate with the Python ecosystem:\n\n* Create pydantic base classes from the Tilores schema\n\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Tilo Tech GmbH Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "This is the offical SDK to develop with the Tilores entity resolution database.",
"version": "0.3.0",
"project_urls": {
"Homepage": "https://github.com/tilotech/python-tilores-sdk",
"Issues": "https://github.com/tilotech/python-tilores-sdk/issues"
},
"split_keywords": [
"entity-resolution",
" tilores",
" graph-rag"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "21ce7358f7732b8d0b664873063db9061f7f510d86ef469919c5462e5a540283",
"md5": "d2a34d0d445714c3b9aa686cc1d6a4e3",
"sha256": "8da3072ed57901c612f10d03cbf9495ee583ad78671a76227421fcd61be49f39"
},
"downloads": -1,
"filename": "tilores_sdk-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d2a34d0d445714c3b9aa686cc1d6a4e3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 8010,
"upload_time": "2024-10-28T13:03:11",
"upload_time_iso_8601": "2024-10-28T13:03:11.844729Z",
"url": "https://files.pythonhosted.org/packages/21/ce/7358f7732b8d0b664873063db9061f7f510d86ef469919c5462e5a540283/tilores_sdk-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5277358ecc92f3cc938dc0409b2eada66ef396f07809028ea3ebc4f04c928ba0",
"md5": "cb9d9b61984de20ec4635bd7aadae623",
"sha256": "5f62f9cc77af5a168694de895187376a3584a6246d6f19cc4b7da96f635c424d"
},
"downloads": -1,
"filename": "tilores_sdk-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "cb9d9b61984de20ec4635bd7aadae623",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 8185,
"upload_time": "2024-10-28T13:03:13",
"upload_time_iso_8601": "2024-10-28T13:03:13.001512Z",
"url": "https://files.pythonhosted.org/packages/52/77/358ecc92f3cc938dc0409b2eada66ef396f07809028ea3ebc4f04c928ba0/tilores_sdk-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-28 13:03:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tilotech",
"github_project": "python-tilores-sdk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "tilores-sdk"
}
