Categorygithub.com/abadojack/whatlanggo
modulepackage
1.0.1
Repository: https://github.com/abadojack/whatlanggo.git
Documentation: pkg.go.dev

# README

Whatlanggo

Build Status Go Report Card GoDoc Coverage Status

Natural language detection for Go.

Features

  • Supports 84 languages
  • 100% written in Go
  • No external dependencies
  • Fast
  • Recognizes not only a language, but also a script (Latin, Cyrillic, etc)

Getting started

Installation:

    go get -u github.com/abadojack/whatlanggo

Simple usage example:

package main

import (
	"fmt"

	"github.com/abadojack/whatlanggo"
)

func main() {
	info := whatlanggo.Detect("Foje funkcias kaj foje ne funkcias")
	fmt.Println("Language:", info.Lang.String(), " Script:", whatlanggo.Scripts[info.Script], " Confidence: ", info.Confidence)
}

Blacklisting and whitelisting

package main

import (
	"fmt"

	"github.com/abadojack/whatlanggo"
)

func main() {
	//Blacklist
	options := whatlanggo.Options{
		Blacklist: map[whatlanggo.Lang]bool{
			whatlanggo.Ydd: true,
		},
	}

	info := whatlanggo.DetectWithOptions("האקדמיה ללשון העברית", options)

	fmt.Println("Language:", info.Lang.String(), "Script:", whatlanggo.Scripts[info.Script])

	//Whitelist
	options1 := whatlanggo.Options{
		Whitelist: map[whatlanggo.Lang]bool{
			whatlanggo.Epo: true,
			whatlanggo.Ukr: true,
		},
	}

	info = whatlanggo.DetectWithOptions("Mi ne scias", options1)
	fmt.Println("Language:", info.Lang.String(), " Script:", whatlanggo.Scripts[info.Script])
}

For more details, please check the documentation.

Requirements

Go 1.8 or higher

How does it work?

How does the language recognition work?

The algorithm is based on the trigram language models, which is a particular case of n-grams. To understand the idea, please check the original whitepaper Cavnar and Trenkle '94: N-Gram-Based Text Categorization'.

How IsReliable calculated?

It is based on the following factors:

  • How many unique trigrams are in the given text
  • How big is the difference between the first and the second(not returned) detected languages? This metric is called rate in the code base.

Therefore, it can be presented as 2d space with threshold functions, that splits it into "Reliable" and "Not reliable" areas. This function is a hyperbola and it looks like the following one:

Language recognition whatlang rust

For more details, please check a blog article Introduction to Rust Whatlang Library and Natural Language Identification Algorithms.

License

MIT

Derivation

whatlanggo is a derivative of Franc (JavaScript, MIT) by Titus Wormer.

Acknowledgements

Thanks to greyblake (Potapov Sergey) for creating whatlang-rs from where I got the idea and algorithms.

# Functions

CodeToLang gets enum by ISO 639-3 code as a string.
Detect language and script of the given text.
DetectLang detects only the language by a given text.
DetectLangWithOptions detects only the language of the given text with the provided options.
DetectScript returns only the script of the given text.
DetectWithOptions detects the language and script of the given text with the provided options.
LangToString converts enum into ISO 639-3 code as a string.
LangToStringShort converts enum into ISO 639-1 code as a string.

# Constants

Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
ReliableConfidenceThreshold is confidence rating that has to be succeeded for the language detection to be considered reliable.
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...
Aka ...

# Variables

Langs represents a map of Lang to language name.
Scripts is the set of Unicode script tables.

# Structs

Info represents a full outcome of language detection.
Options represents options that can be set when detecting a language or/and script such blacklisting languages to skip checking.

# Type aliases

Lang represents a language following ISO 639-3 standard.