Textgain v0.1.1 Textgain

This module provides access to the various text analytics services provided by Textgain.

Each service is implemented as a function in this module, with both the tuple and “!” versions provided.

Summary

Functions

Executes a query against the Textgain age service, returning one of two tuples

Executes a query against the Textgain age service, returning a valid struct or raising an exception

Executes a query against the Textgain concepts service, returning one of two tuples

Executes a query against the Textgain concepts service, returning a valid struct or raising an exception

Executes a query against the Textgain education service, returning one of two tuples

Executes a query against the Textgain education service, returning a valid struct or raising an exception

Executes a query against the Textgain gender service, returning one of two tuples

Executes a query against the Textgain gender service, returning a valid struct or raising an exception

Executes a query against the Textgain genre service, returning one of two tuples

Executes a query against the Textgain genre service, returning a valid struct or raising an exception

Executes a query against the Textgain language service, returning one of two tuples

Executes a query against the Textgain language service, returning a valid struct or raising an exception

Executes a query against the Textgain personality service, returning one of two tuples

Executes a query against the Textgain personality service, returning a valid struct or raising an exception

Executes a query against the Textgain sentiment service, returning one of two tuples

Executes a query against the Textgain sentiment service, returning a valid struct or raising an exception

Executes a query against the Textgain tag service, returning one of two tuples

Executes a query against the Textgain tag service, returning a valid struct or raising an exception

Functions

age(text, options \\ [])
age(text :: binary, options :: keyword) :: tuple

Executes a query against the Textgain age service, returning one of two tuples:

{ :ok, %Elixir.Textgain.Age{} }
{ :error, msg }

See the Textgain API services page for details on returned analytics.

age!(text, options \\ [])
age!(text :: binary, options :: keyword) :: %Textgain.Age{age: term, confidence: term}

Executes a query against the Textgain age service, returning a valid struct or raising an exception.

See the Textgain API services page for details on returned analytics.

concepts(text, options \\ [])
concepts(text :: binary, options :: keyword) :: tuple

Executes a query against the Textgain concepts service, returning one of two tuples:

{ :ok, %Elixir.Textgain.Concepts{} }
{ :error, msg }

See the Textgain API services page for details on returned analytics.

concepts!(text, options \\ [])
concepts!(text :: binary, options :: keyword) :: %Textgain.Concepts{concepts: term}

Executes a query against the Textgain concepts service, returning a valid struct or raising an exception.

See the Textgain API services page for details on returned analytics.

education(text, options \\ [])
education(text :: binary, options :: keyword) :: tuple

Executes a query against the Textgain education service, returning one of two tuples:

{ :ok, %Elixir.Textgain.Education{} }
{ :error, msg }

See the Textgain API services page for details on returned analytics.

education!(text, options \\ [])
education!(text :: binary, options :: keyword) :: %Textgain.Education{confidence: term, education: term}

Executes a query against the Textgain education service, returning a valid struct or raising an exception.

See the Textgain API services page for details on returned analytics.

gender(text, options \\ [])
gender(text :: binary, options :: keyword) :: tuple

Executes a query against the Textgain gender service, returning one of two tuples:

{ :ok, %Elixir.Textgain.Gender{} }
{ :error, msg }

See the Textgain API services page for details on returned analytics.

gender!(text, options \\ [])
gender!(text :: binary, options :: keyword) :: %Textgain.Gender{confidence: term, gender: term}

Executes a query against the Textgain gender service, returning a valid struct or raising an exception.

See the Textgain API services page for details on returned analytics.

genre(text, options \\ [])
genre(text :: binary, options :: keyword) :: tuple

Executes a query against the Textgain genre service, returning one of two tuples:

{ :ok, %Elixir.Textgain.Genre{} }
{ :error, msg }

See the Textgain API services page for details on returned analytics.

genre!(text, options \\ [])
genre!(text :: binary, options :: keyword) :: %Textgain.Genre{confidence: term, genre: term, review: term}

Executes a query against the Textgain genre service, returning a valid struct or raising an exception.

See the Textgain API services page for details on returned analytics.

language(text, options \\ [])
language(text :: binary, options :: keyword) :: tuple

Executes a query against the Textgain language service, returning one of two tuples:

{ :ok, %Elixir.Textgain.Language{} }
{ :error, msg }

See the Textgain API services page for details on returned analytics.

language!(text, options \\ [])
language!(text :: binary, options :: keyword) :: %Textgain.Language{confidence: term, language: term}

Executes a query against the Textgain language service, returning a valid struct or raising an exception.

See the Textgain API services page for details on returned analytics.

personality(text, options \\ [])
personality(text :: binary, options :: keyword) :: tuple

Executes a query against the Textgain personality service, returning one of two tuples:

{ :ok, %Elixir.Textgain.Personality{} }
{ :error, msg }

See the Textgain API services page for details on returned analytics.

personality!(text, options \\ [])
personality!(text :: binary, options :: keyword) :: %Textgain.Personality{confidence: term, personality: term}

Executes a query against the Textgain personality service, returning a valid struct or raising an exception.

See the Textgain API services page for details on returned analytics.

sentiment(text, options \\ [])
sentiment(text :: binary, options :: keyword) :: tuple

Executes a query against the Textgain sentiment service, returning one of two tuples:

{ :ok, %Elixir.Textgain.Sentiment{} }
{ :error, msg }

See the Textgain API services page for details on returned analytics.

sentiment!(text, options \\ [])
sentiment!(text :: binary, options :: keyword) :: %Textgain.Sentiment{confidence: term, polarity: term}

Executes a query against the Textgain sentiment service, returning a valid struct or raising an exception.

See the Textgain API services page for details on returned analytics.

tag(text, options \\ [])
tag(text :: binary, options :: keyword) :: tuple

Executes a query against the Textgain tag service, returning one of two tuples:

{ :ok, %Elixir.Textgain.Tag{} }
{ :error, msg }

See the Textgain API services page for details on returned analytics.

tag!(text, options \\ [])
tag!(text :: binary, options :: keyword) :: %Textgain.Tag{confidence: term, text: term}

Executes a query against the Textgain tag service, returning a valid struct or raising an exception.

See the Textgain API services page for details on returned analytics.