Skip to main content

API wrapper for the language detection as a service Linguin AI.

Project description

PyPI version build

Linguin AI Python wrapper

This is a Python wrapper for the Linguin AI API (see API docs) providing Language Detection as a Service.

Linguin AI is free for up to 100 detections per day. You can get your API key here.

Installation

pip3 install linguin

Usage

Get started with just a few lines of code:

from linguin import Linguin

# go to https://linguin.ai to get your key
linguin = Linguin("YOUR_API_TOKEN")

response = linguin.detect_language("test")

response.is_success
# >> True

response.result
# >> {'results': [{ 'lang': 'en', confidence: 1.0 }, ...]}

response = linguin.detect_profanity("you moron")

response.is_success
# >> True

response.result
# >> {'score':  0.9981}

If anything goes wrong for example: empty query string:

response = linguin.detect_language(" ")
    
response.is_success
# >> False
   
print(response.error)
# >> Error code: 400. The language of an empty text is more of a philosophical question.

response.error.status
# >> 400

response.error.message
# >> The language of an empty text is more of a philosophical question.

If you prefer to handle exceptions instead:

response = linguin.detect_language(" ", raise_on_error=True)
# >> raises LinguinInputError

See the list of all exceptions here.

Bulk detection

To detect the language of multiple texts with one API call, you can pass them as an array to the bulk_detect_language method. The results will be returned in the same order as the texts. All texts have to not be empty.

response = linguin.bulk_detect_language(["test", "Bahnhof", "고마워요"])

response.is_success
# >> True

response.result
# >> {'results': [[{'lang': 'en', 'confidence': 1.0}, ...], [{...}], ...]}

To check multiple texts for profanity with one API call, you can pass them as an array to the bulk_detect_profanity method. The results will be returned in the same order as the texts. All texts have to not be empty.

response = linguin.bulk_detect_profanity(["a test", "you are a moron"])

response.is_success
# >> True

response.result
# >> {'scores': [0.0124, 0.9981]}

Account status

You can fetch the status of your account:

response = linguin.status()

response.result
# >> {'daily_limit': 50000, 'detections_today': 4500, 'remaining_today': 45500}
# for unlimited usage we return -1

Language list

You can fetch the list of supported languages:

from linguin import Linguin

languages = Linguin.languages()
# >> { 'de': ["German", "Deutsch"], ... }

Development

After checking out the repo, run pip3 install -r requirements.txt to install dependencies. Run tests with python3 -m unittest

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/LinguinAI/linguin-python. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Linguin project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

linguin-2.0.0.tar.gz (6.6 kB view hashes)

Uploaded source

Built Distribution

linguin-2.0.0-py3-none-any.whl (6.1 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page