Skip to content

Latest commit

 

History

History
51 lines (34 loc) · 2.21 KB

README.md

File metadata and controls

51 lines (34 loc) · 2.21 KB

GcNLP

Elixir wrapper for Google Cloud Natural Language API. See Cloud Natural Language API

Latest version 0.2.2 doc.

Installation

The package can be installed as:

  1. Add gc_nlp to your list of dependencies in mix.exs:
```elixir
def deps do
  [{:gc_nlp, "~> 0.2.2"}]
end
```
  1. Ensure gc_nlp is started before your application:
```elixir
def application do
  [applications: [:gc_nlp]]
end
```
  1. Put your Google Cloud credential json file in 'config/' or modify the appropriate Goth config. Refer to this guide to get your credential file. Default to expect "gcloud-secret.json" inside config directory.

Using GcNLP

  1. Sentiment Analysis

    iex> GcNLP.analyze_sentiment "There is a lot of new features coming in Elixir 1.4"
%{"documentSentiment" => %{"magnitude" => 0.1, "polarity" => 1}, "language" => "en"}

  2. Entity Analysis

    iex> GcNLP.analyze_entities "There is a lot of new features coming in Elixir 1.4"
%{"entities" => [%{"mentions" => [%{"text" => %{"beginOffset" => 41, "content" => "Elixir 1.4"}}], "metadata" => %{}, "name" => "Elixir 1.4", "salience" => 0.16144496, "type" => "OTHER"}], "language" => "en"}

  3. Syntactic Analysis

    iex> GcNLP.annotate_text "There is a lot of new features coming in Elixir 1.4"
%{"documentSentiment" => %{"magnitude" => 0.1, "polarity" => 1}, "entities" => [%{"mentions" => [%{"text" => %{"beginOffset" => 41, "content" => "Elixir 1.4"}}], "metadata" => %{}, "name" => "Elixir 1.4", "salience" => 0.16144496, "type" => "OTHER"}], "language" => "en", "sentences" => [%{"text" => %{"beginOffset" => 0, "content" => "There is a lot of new features coming in Elixir 1.4"}}], "tokens" => [%{"dependencyEdge" => %{"headTokenIndex" => 1, "label" => "EXPL"}, "lemma" => "There", "partOfSpeech" => %{"tag" => "DET"}, "text" => %{"beginOffset" => 0, "content" => "There"}}, %{"dependencyEdge" => %{"headTokenIndex" => 1, "label" => "ROOT"}, "lemma" => "be", "partOfSpeech" => %{"tag" => "VERB"}, "text" => %{"beginOffset" => 6, "content" => "is"}}, ...}