Introduce Natural Language API #1440

stephenplusplus · 2016-07-18T20:00:38Z

Upstream API docs:

https://cloud.google.com/natural-language/docs/getting-started

Docs preview:

To Dos

stephenplusplus · 2016-07-19T16:28:22Z

@callmehiphop let me know what you think of the usability. Ready to start on tests after.

callmehiphop · 2016-07-20T18:08:46Z

Could you throw up a gist or something of more code examples? Or is the README example all there is to it?

stephenplusplus · 2016-07-20T18:17:12Z

README + system tests is all for now. It's not a very big API, just 3 methods. I did fail to mention there's a verbose mode for each method call.

The two primary ways of calling are

// inline
language.detectEntities('a sentence', function(err, entities) {});

// with a document
var document = language.detectEntities('a sentence');
document.detectEntities(function(err, entities) {});

The verbose mode just makes less simplifications. These tests show what the general responses look like in simple/verbose mode for each annotation type (annotation, entities, sentiment): https://github.com/stephenplusplus/gcloud-node/blob/spp--language/system-test/language.js#L314

LMKIYHAQ

callmehiphop · 2016-07-25T17:17:44Z

I see, is there a reason we only provide convenience methods for entities and sentiment? Where as your readme example shows tokens, language and sentences as well.

stephenplusplus · 2016-07-25T17:19:47Z

There are only 3 API endpoints, see https://cloud.google.com/natural-language/reference/rest/v1beta1/documents:

analyzeEntities (detectEntities)
analyzeSentiment (detectSentiment)
annotateText (annotate)

stephenplusplus · 2016-07-25T17:22:43Z

We can add things like detectSentences() and detectTokens(), it would just be plucking out only part of the annotate() response. It might end up with users thinking they have to run both functions to get both types of annotations. WDYT?

callmehiphop · 2016-07-25T17:30:36Z

We can add things like detectSentences() and detectTokens(), it would just be plucking out only part of the annotate() response.

We took this exact approach with the vision api, did we not? Granted the vision annotate() response has more data in it, convenience methods sorta seem like one of the big reasons why gcloud-node exists, no?

It might end up with users thinking they have to run both functions to get both types of annotations.

Can't this be prevented with documentation? Stating that it's a convenience method for annotate()?

stephenplusplus · 2016-07-25T17:36:00Z

We took this exact approach with the vision api, did we not?

No, the Vision API has one API method that returns a response that matches the type of request you send. So we have detectFaces, which makes a request that asks for facial detection, so the response only includes facial detections.

convenience methods sorta seem like one of the big reasons why gcloud-node exists, no?

What we're talking about here is making a request that includes a lot of info, but only returning a part of it. I can see both sides here, however this is new territory for us. I feel conflicted because we would essentially be throwing away information. Docs can help, but a user simply seeing methods called detectTokens and detectSentences will make them think these each have to be called to get those types of detections.

callmehiphop · 2016-07-25T17:38:52Z

No, the Vision API has one API method that returns a response that matches the type of request you send. So we have detectFaces, which makes a request that asks for facial detection, so the response only includes facial detections.

Ah, my mistake. Fair enough then, feel free to ignore!

README.md

@@ -701,6 +702,71 @@ vision.detectFaces('./image.jpg', function(err, faces) {
 ```


+## Google Cloud Natural Language (Alpha)
+
+> **This is an Alpha release of Google Cloud Resource Manager.** This feature is not covered by any SLA or deprecation policy and may be subject to backward-incompatible changes.


stephenplusplus · 2016-08-01T17:07:24Z

Docs preview: http://stephenplusplus.github.io/gcloud-node/#/docs/master/language

stephenplusplus · 2016-08-02T17:34:20Z

All tested and doc'd @callmehiphop. PTAL when you can.

stephenplusplus · 2016-08-02T19:06:07Z

@jmuk -- I rebased this PR against @jmdobry's modularization PR. That is still in development, but it will hopefully merge soon. You can use the new structure to get started with #1464. If the changes you make can be limited to just creating files, as opposed to amending the files in packages/language, that should make it pretty safe in regards to avoiding conflicts.

You will need to run these commands when setting up the repo:

$ ./scripts/link.sh
$ cd packages/language
$ npm install

# good to go-- helpful development commands:
$ npm run lint
$ npm run test
$ npm run system-test

@callmehiphop sorry for the huge PR now... all of the language changes for review are here: https://github.com/stephenplusplus/gcloud-node/tree/spp--language/packages/language

stephenplusplus · 2016-08-04T01:13:01Z

@jmuk @callmehiphop -- I rebased this off of master now.

README.md

+// Authorizing on a per-API-basis. You don't need to do this if you auth on a
+// global basis (see Authorization section above).
+
+var languageClient = language({


coveralls · 2016-08-05T23:25:55Z

Coverage remained the same at 100.0% when pulling ecfbeda on stephenplusplus:spp--language into 143f120 on GoogleCloudPlatform:master.

stephenplusplus · 2016-08-07T20:23:01Z

@callmehiphop anything left for me to do here?

packages/language/test/document.js

+        Document.formatTokens_ = util.noop;
+      });
+
+      it('should return the language and syntax by default', function(done) {


callmehiphop · 2016-08-08T17:25:28Z

@stephenplusplus I had a couple small comments, but nothing really important. I think overall it looks good, my only real complaint is that the system tests were a little tricky to work through.

…ation

stephenplusplus · 2016-08-08T17:33:24Z

Yeah, the system tests have a unique style for sure. If it gets to be impossible to deal with when adding new features/debugging, we can look into changing that.

PTAL!

packages/language/test/document.js

+        });
+      });
+
+      it('should return the syntax by default', function(done) {


coveralls · 2016-08-08T17:39:43Z

Coverage remained the same at 100.0% when pulling 3be25bc on stephenplusplus:spp--language into b6433a1 on GoogleCloudPlatform:master.

packages/language/test/document.js

@@ -287,7 +287,7 @@ describe('Document', function() {
        Document.formatTokens_ = util.noop;
      });

-      it('should return the language by default', function(done) {
+      it('should return language if no features are requested', function(done) {


coveralls · 2016-08-08T18:00:04Z

Coverage remained the same at 100.0% when pulling f007c7e on stephenplusplus:spp--language into b6433a1 on GoogleCloudPlatform:master.

coveralls · 2016-08-08T18:19:21Z

Coverage remained the same at 100.0% when pulling f007c7e on stephenplusplus:spp--language into b6433a1 on GoogleCloudPlatform:master.

* language: implement API

stephenplusplus added the don't merge label Jul 18, 2016

googlebot added the cla: yes This human has signed the Contributor License Agreement. label Jul 18, 2016

dhermes reviewed Jul 26, 2016
View reviewed changes

stephenplusplus force-pushed the spp--language branch from 33bfcdb to 2c8a839 Compare July 26, 2016 17:54

stephenplusplus assigned callmehiphop Aug 2, 2016

stephenplusplus force-pushed the spp--language branch from 86fbe99 to 8cd0ac3 Compare August 2, 2016 18:56

googlebot added cla: no This human has *not* signed the Contributor License Agreement. and removed cla: yes This human has signed the Contributor License Agreement. labels Aug 2, 2016

stephenplusplus added api: language Issues related to the Cloud Natural Language API API. and removed don't merge labels Aug 2, 2016

stephenplusplus force-pushed the spp--language branch from 2a64114 to a59a816 Compare August 4, 2016 01:11

googlebot added cla: yes This human has signed the Contributor License Agreement. and removed cla: no This human has *not* signed the Contributor License Agreement. labels Aug 4, 2016

stephenplusplus force-pushed the spp--language branch 2 times, most recently from 41fd353 to 84d255c Compare August 4, 2016 20:15

callmehiphop reviewed Aug 5, 2016
View reviewed changes

callmehiphop reviewed Aug 8, 2016
View reviewed changes

stephenplusplus and others added 9 commits August 8, 2016 13:30

language: implement API

b5c4856

readme: remove double gcloud decl & update authorization -> authentic…

b485b4b

…ation

mark service object ID as optional

a9ad534

add missing param

f65fe35

fix & elaborate docs

603a839

sentiments are numbers

cb74e11

mutability

15e1846

add arrify as depenency

09e68dc

split test

a3bfc96

stephenplusplus force-pushed the spp--language branch from ecfbeda to a3bfc96 Compare August 8, 2016 17:33

callmehiphop reviewed Aug 8, 2016
View reviewed changes

packages/language/test/document.js

});

});

it('should return the syntax by default', function(done) {

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

test words

3be25bc

callmehiphop reviewed Aug 8, 2016
View reviewed changes

docs

f007c7e

callmehiphop merged commit 00957c3 into googleapis:master Aug 8, 2016

stephenplusplus added a commit to stephenplusplus/gcloud-node that referenced this pull request Aug 23, 2016

Introduce Natural Language API (googleapis#1440)

9360f13

* language: implement API

snyk-bot mentioned this pull request Sep 15, 2021

[Snyk] Fix for 1 vulnerabilities mikolajroszak/google-cloud-node#1

Open

sofisl pushed a commit that referenced this pull request Oct 11, 2022

Introduce Natural Language API (#1440)

9d7af29

* language: implement API

sofisl mentioned this pull request Oct 11, 2022

migrate code from googleapis/nodejs-language #3395

Merged

4 tasks

sofisl pushed a commit that referenced this pull request Oct 13, 2022

Introduce Natural Language API (#1440)

cccb21e

* language: implement API

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduce Natural Language API #1440

Introduce Natural Language API #1440

stephenplusplus commented Jul 18, 2016 •

edited

Loading

stephenplusplus commented Jul 19, 2016

callmehiphop commented Jul 20, 2016

stephenplusplus commented Jul 20, 2016

callmehiphop commented Jul 25, 2016

stephenplusplus commented Jul 25, 2016

stephenplusplus commented Jul 25, 2016

callmehiphop commented Jul 25, 2016

stephenplusplus commented Jul 25, 2016

callmehiphop commented Jul 25, 2016

This comment was marked as spam.

stephenplusplus commented Aug 1, 2016

stephenplusplus commented Aug 2, 2016

stephenplusplus commented Aug 2, 2016

stephenplusplus commented Aug 4, 2016

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

coveralls commented Aug 5, 2016 •

edited

Loading

stephenplusplus commented Aug 7, 2016

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

callmehiphop commented Aug 8, 2016

stephenplusplus commented Aug 8, 2016

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

coveralls commented Aug 8, 2016 •

edited

Loading

This comment was marked as spam.

This comment was marked as spam.

coveralls commented Aug 8, 2016 •

edited

Loading

coveralls commented Aug 8, 2016 •

edited

Loading

Introduce Natural Language API #1440

Introduce Natural Language API #1440

Conversation

stephenplusplus commented Jul 18, 2016 • edited Loading

To Dos

stephenplusplus commented Jul 19, 2016

callmehiphop commented Jul 20, 2016

stephenplusplus commented Jul 20, 2016

callmehiphop commented Jul 25, 2016

stephenplusplus commented Jul 25, 2016

stephenplusplus commented Jul 25, 2016

callmehiphop commented Jul 25, 2016

stephenplusplus commented Jul 25, 2016

callmehiphop commented Jul 25, 2016

This comment was marked as spam.

stephenplusplus commented Aug 1, 2016

stephenplusplus commented Aug 2, 2016

stephenplusplus commented Aug 2, 2016

stephenplusplus commented Aug 4, 2016

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

coveralls commented Aug 5, 2016 • edited Loading

stephenplusplus commented Aug 7, 2016

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

callmehiphop commented Aug 8, 2016

stephenplusplus commented Aug 8, 2016

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

coveralls commented Aug 8, 2016 • edited Loading

This comment was marked as spam.

This comment was marked as spam.

coveralls commented Aug 8, 2016 • edited Loading

coveralls commented Aug 8, 2016 • edited Loading

stephenplusplus commented Jul 18, 2016 •

edited

Loading

coveralls commented Aug 5, 2016 •

edited

Loading

coveralls commented Aug 8, 2016 •

edited

Loading

coveralls commented Aug 8, 2016 •

edited

Loading

coveralls commented Aug 8, 2016 •

edited

Loading