Textgain

v0.1.4

Textgain v0.1.4 Textgain View Source

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.

Link to this section Summary

Functions

age(text, options \\ [])

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

age!(text, options \\ [])

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

concepts(text, options \\ [])

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

concepts!(text, options \\ [])

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

education(text, options \\ [])

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

education!(text, options \\ [])

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

gender(text, options \\ [])

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

gender!(text, options \\ [])

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

genre(text, options \\ [])

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

genre!(text, options \\ [])

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

language(text, options \\ [])

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

language!(text, options \\ [])

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

personality(text, options \\ [])

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

personality!(text, options \\ [])

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

sentiment(text, options \\ [])

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

sentiment!(text, options \\ [])

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

tag(text, options \\ [])

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

tag!(text, options \\ [])

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

Link to this section Functions

Link to this function

age(text, options \\ []) View Source 
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.

Link to this function

age!(text, options \\ []) View Source 
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.

Link to this function

concepts(text, options \\ []) View Source 
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.

Link to this function

concepts!(text, options \\ []) View Source 
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.

Link to this function

education(text, options \\ []) View Source 
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.

Link to this function

education!(text, options \\ []) View Source 
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.

Link to this function

gender(text, options \\ []) View Source 
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.

Link to this function

gender!(text, options \\ []) View Source 
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.

Link to this function

genre(text, options \\ []) View Source 
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.

Link to this function

genre!(text, options \\ []) View Source 
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.

Link to this function

language(text, options \\ []) View Source 
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.

Link to this function

language!(text, options \\ []) View Source 
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.

Link to this function

personality(text, options \\ []) View Source 
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.

Link to this function

personality!(text, options \\ []) View Source 
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.

Link to this function

sentiment(text, options \\ []) View Source 
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.

Link to this function

sentiment!(text, options \\ []) View Source 
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.

Link to this function

tag(text, options \\ []) View Source 
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.

Link to this function

tag!(text, options \\ []) View Source 
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.