Text Similarity API
============
Text Similarity is a simple tool for checking the similarity between two texts. It returns the similarity score.
This is a Python API Wrapper for the [Text Similarity API](https://apiverve.com/marketplace/api/textsimilarity)
---
## Installation
pip install apiverve-textsimilarity
---
## Configuration
Before using the textsimilarity API client, you have to setup your account and obtain your API Key.
You can get it by signing up at [https://apiverve.com](https://apiverve.com)
---
## Usage
The Text Similarity API documentation is found here: [https://docs.apiverve.com/api/textsimilarity](https://docs.apiverve.com/api/textsimilarity).
You can find parameters, example responses, and status codes documented here.
### Setup
```
# Import the client module
from apiverve_textsimilarity.apiClient import TextsimilarityAPIClient
# Initialize the client with your APIVerve API key
api = TextsimilarityAPIClient("[YOUR_API_KEY]")
```
---
### Perform Request
Using the API client, you can perform requests to the API.
###### Define Query
```
query = { "text1": "I'm so excited that tomorrow is going to be sunny! Can't wait!", "text2": "We're pretty excited about the weather tomorrow. It's going to be sunny!" }
```
###### Simple Request
```
# Make a request to the API
result = api.execute(query)
# Print the result
print(result)
```
###### Example Response
```
{
"status": "ok",
"error": null,
"data": {
"simiarity": 45.83,
"similarityCaseSensitive": 47.22,
"difference": {
"count": 7,
"percentage": 58.33
}
},
"code": 200
}
```
---
## Customer Support
Need any assistance? [Get in touch with Customer Support](https://apiverve.com/contact).
---
## Updates
Stay up to date by following [@apiverveHQ](https://twitter.com/apiverveHQ) on Twitter.
---
## Legal
All usage of the APIVerve website, API, and services is subject to the [APIVerve Terms of Service](https://apiverve.com/terms) and all legal documents and agreements.
---
## License
Licensed under the The MIT License (MIT)
Copyright (©) 2024 APIVerve, and Evlar LLC
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.
Raw data
{
"_id": null,
"home_page": null,
"name": "apiverve-textsimilarity",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "text similarity, text similarity checker, text similarity api, text similarity tool, text similarity software",
"author": null,
"author_email": "APIVerve <hello@apiverve.com>",
"download_url": "https://files.pythonhosted.org/packages/8a/4f/2856d357200d22c47d03d3d009b7a1385ccfd0fc5926e7f5f6647f9c2229/apiverve_textsimilarity-1.1.5.tar.gz",
"platform": null,
"description": "Text Similarity API\r\n============\r\n\r\nText Similarity is a simple tool for checking the similarity between two texts. It returns the similarity score.\r\n\r\n\r\n\r\n\r\n\r\nThis is a Python API Wrapper for the [Text Similarity API](https://apiverve.com/marketplace/api/textsimilarity)\r\n\r\n---\r\n\r\n## Installation\r\n\tpip install apiverve-textsimilarity\r\n\r\n---\r\n\r\n## Configuration\r\n\r\nBefore using the textsimilarity API client, you have to setup your account and obtain your API Key. \r\nYou can get it by signing up at [https://apiverve.com](https://apiverve.com)\r\n\r\n---\r\n\r\n## Usage\r\n\r\nThe Text Similarity API documentation is found here: [https://docs.apiverve.com/api/textsimilarity](https://docs.apiverve.com/api/textsimilarity). \r\nYou can find parameters, example responses, and status codes documented here.\r\n\r\n### Setup\r\n\r\n```\r\n# Import the client module\r\nfrom apiverve_textsimilarity.apiClient import TextsimilarityAPIClient\r\n\r\n# Initialize the client with your APIVerve API key\r\napi = TextsimilarityAPIClient(\"[YOUR_API_KEY]\")\r\n```\r\n\r\n---\r\n\r\n\r\n### Perform Request\r\nUsing the API client, you can perform requests to the API.\r\n\r\n###### Define Query\r\n\r\n```\r\nquery = { \"text1\": \"I'm so excited that tomorrow is going to be sunny! Can't wait!\", \"text2\": \"We're pretty excited about the weather tomorrow. It's going to be sunny!\" }\r\n```\r\n\r\n###### Simple Request\r\n\r\n```\r\n# Make a request to the API\r\nresult = api.execute(query)\r\n\r\n# Print the result\r\nprint(result)\r\n```\r\n\r\n###### Example Response\r\n\r\n```\r\n{\r\n \"status\": \"ok\",\r\n \"error\": null,\r\n \"data\": {\r\n \"simiarity\": 45.83,\r\n \"similarityCaseSensitive\": 47.22,\r\n \"difference\": {\r\n \"count\": 7,\r\n \"percentage\": 58.33\r\n }\r\n },\r\n \"code\": 200\r\n}\r\n```\r\n\r\n---\r\n\r\n## Customer Support\r\n\r\nNeed any assistance? [Get in touch with Customer Support](https://apiverve.com/contact).\r\n\r\n---\r\n\r\n## Updates\r\nStay up to date by following [@apiverveHQ](https://twitter.com/apiverveHQ) on Twitter.\r\n\r\n---\r\n\r\n## Legal\r\n\r\nAll usage of the APIVerve website, API, and services is subject to the [APIVerve Terms of Service](https://apiverve.com/terms) and all legal documents and agreements.\r\n\r\n---\r\n\r\n## License\r\nLicensed under the The MIT License (MIT)\r\n\r\nCopyright (©) 2024 APIVerve, and Evlar LLC\r\n\r\nPermission 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:\r\n\r\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\r\n\r\nTHE 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.\r\n",
"bugtrack_url": null,
"license": null,
"summary": "Text Similarity is a simple tool for checking the similarity between two texts. It returns the similarity score.",
"version": "1.1.5",
"project_urls": {
"Documentation": "https://docs.apiverve.com/api/textsimilarity?utm_source=pypi",
"Homepage": "https://apiverve.com?utm_source=pypi",
"Repository": "https://github.com/apiverve/textsimilarity.Python-API",
"Twitter": "https://twitter.com/apivervehq"
},
"split_keywords": [
"text similarity",
" text similarity checker",
" text similarity api",
" text similarity tool",
" text similarity software"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e1a7c6bff039f77b47a23ca9bea5ce7f94335870da0e97e0c3270ccc56e4f7d6",
"md5": "c42e0949723e43d5d033363981b4b2b5",
"sha256": "ada765f009f0eae8ea32c15bf3c0c0a93212aa1fb06957dbc8a9492db4c506c9"
},
"downloads": -1,
"filename": "apiverve_textsimilarity-1.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c42e0949723e43d5d033363981b4b2b5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 7385,
"upload_time": "2024-09-21T07:04:19",
"upload_time_iso_8601": "2024-09-21T07:04:19.939089Z",
"url": "https://files.pythonhosted.org/packages/e1/a7/c6bff039f77b47a23ca9bea5ce7f94335870da0e97e0c3270ccc56e4f7d6/apiverve_textsimilarity-1.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8a4f2856d357200d22c47d03d3d009b7a1385ccfd0fc5926e7f5f6647f9c2229",
"md5": "7e8a5948f1632b7addbf3ad67ec01b4e",
"sha256": "9bee1527754fbc6362b81140d5d7a56713fa3fee4a9a0090849b26bc2f3b182a"
},
"downloads": -1,
"filename": "apiverve_textsimilarity-1.1.5.tar.gz",
"has_sig": false,
"md5_digest": "7e8a5948f1632b7addbf3ad67ec01b4e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 7095,
"upload_time": "2024-09-21T07:04:21",
"upload_time_iso_8601": "2024-09-21T07:04:21.354446Z",
"url": "https://files.pythonhosted.org/packages/8a/4f/2856d357200d22c47d03d3d009b7a1385ccfd0fc5926e7f5f6647f9c2229/apiverve_textsimilarity-1.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-21 07:04:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "apiverve",
"github_project": "textsimilarity.Python-API",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "apiverve-textsimilarity"
}
JSON
