language: fix docs

Author: stephenplusplus

README.md

@@ -305,43 +305,103 @@ var languageClient = language({
 
 // Get the entities from a sentence.
 languageClient.detectEntities('Stephen of Michigan!', function(err, entities) {
-  // entities = {
-  //   people: ['Stephen'],
-  //   places: ['Michigan']
-  // }
+  // entities = [
+  //   {
+  //     name: 'Stephen',
+  //     type: 'PERSON',
+  //     metadata: {
+  //       mid: '/m/05d8y4q'
+  //     },
+  //     salience: 0.7309288382530212,
+  //     mentions: [
+  //       {
+  //         text: {
+  //           content: 'Stephen',
+  //           beginOffset: -1
+  //         },
+  //         type: 'PROPER'
+  //       }
+  //     ]
+  //   },
+  //   // ...
+  // ]
 });
 
 // Create a document if you plan to run multiple detections.
 var document = languageClient.document('Contributions welcome!');
 
 // Analyze the sentiment of the document.
 document.detectSentiment(function(err, sentiment) {
-  // sentiment = 100 // Large numbers represent more positive sentiments.
+  // sentiment = {
+  //   magnitude: 0.5,
+  //   score: 0.5
+  // }
 });
 
 // Parse the syntax of the document.
-document.annotate(function(err, annotations) {
-  // annotations = {
+document.annotate(function(err, annotation) {
+  // annotation = {
   //   language: 'en',
-  //   sentiment: 100,
-  //   entities: {},
-  //   sentences: ['Contributions welcome!'],
-  //   tokens: [
+  //   sentiment: {
+  //     magnitude: 0.30000001192092896,
+  //     score: 0.30000001192092896
+  //   },
+  //   entities: [
   //     {
-  //       text: 'Contributions',
-  //       partOfSpeech: 'Noun (common and proper)',
-  //       partOfSpeechTag: 'NOUN'
-  //     },
-  //     {
-  //       text: 'welcome',
-  //       partOfSpeech: 'Verb (all tenses and modes)',
-  //       partOfSpeechTag: 'VERB'
-  //     },
+  //       name: 'Contributions',
+  //       type: 'OTHER',
+  //       metadata: {},
+  //       salience: 1,
+  //       mentions: [
+  //         {
+  //           text: {
+  //             content: 'Contributions',
+  //             beginOffset: -1
+  //           },
+  //           type: 'COMMON'
+  //         }
+  //       ]
+  //     }
+  //   ],
+  //   sentences: [
   //     {
-  //       text: '!',
-  //       partOfSpeech: 'Punctuation',
-  //       partOfSpeechTag: 'PUNCT'
+  //       text: {
+  //         content: 'Contributions welcome!',
+  //         beginOffset: -1
+  //       },
+  //       sentiment: {
+  //         magnitude: 0.30000001192092896,
+  //         score: 0.30000001192092896
+  //       }
   //     }
+  //   ],
+  //   tokens: [
+  //     {
+  //       text: {
+  //         content: 'Contributions',
+  //         beginOffset: -1
+  //       },
+  //       partOfSpeech: {
+  //         tag: 'NOUN',
+  //         aspect: 'ASPECT_UNKNOWN',
+  //         case: 'CASE_UNKNOWN',
+  //         form: 'FORM_UNKNOWN',
+  //         gender: 'GENDER_UNKNOWN',
+  //         mood: 'MOOD_UNKNOWN',
+  //         number: 'PLURAL',
+  //         person: 'PERSON_UNKNOWN',
+  //         proper: 'PROPER_UNKNOWN',
+  //         reciprocity: 'RECIPROCITY_UNKNOWN',
+  //         tense: 'TENSE_UNKNOWN',
+  //         voice: 'VOICE_UNKNOWN'
+  //       },
+  //       dependencyEdge: {
+  //         headTokenIndex: 1,
+  //         label: 'NSUBJ'
+  //       },
+  //       lemma: 'contribution'
+  //     },
+  //     // ...
   //   ]
   // }
 });

packages/language/README.md

@@ -36,24 +36,7 @@ language.detectEntities('Stephen of Michigan!', function(err, entities) {
   //       }
   //     ]
   //   },
-  //   {
-  //     name: 'Michigan',
-  //     type: 'LOCATION',
-  //     metadata: {
-  //       mid: '/m/04rrx',
-  //       wikipedia_url: 'http://en.wikipedia.org/wiki/Michigan'
-  //     },
-  //     salience: 0.26907116174697876,
-  //     mentions: [
-  //       {
-  //         text: {
-  //           content: 'Michigan',
-  //           beginOffset: -1
-  //         },
-  //         type: 'PROPER'
-  //       }
-  //     ]
-  //   }
+  //   // ...
   // ]
 });
 
@@ -69,8 +52,8 @@ document.detectSentiment(function(err, sentiment) {
 });
 
 // Parse the syntax of the document.
-document.annotate(function(err, annotations) {
-  // annotations = {
+document.annotate(function(err, annotation) {
+  // annotation = {
   //   language: 'en',
   //   sentiment: {
   //     magnitude: 0.30000001192092896,
@@ -131,56 +114,7 @@ document.annotate(function(err, annotations) {
   //       },
   //       lemma: 'contribution'
   //     },
-  //     {
-  //       text: {
-  //         content: 'welcome',
-  //         beginOffset: -1
-  //       },
-  //       partOfSpeech: {
-  //         tag: 'VERB',
-  //         aspect: 'ASPECT_UNKNOWN',
-  //         case: 'CASE_UNKNOWN',
-  //         form: 'FORM_UNKNOWN',
-  //         gender: 'GENDER_UNKNOWN',
-  //         mood: 'INDICATIVE',
-  //         number: 'NUMBER_UNKNOWN',
-  //         person: 'PERSON_UNKNOWN',
-  //         proper: 'PROPER_UNKNOWN',
-  //         reciprocity: 'RECIPROCITY_UNKNOWN',
-  //         tense: 'PRESENT',
-  //         voice: 'VOICE_UNKNOWN'
-  //       },
-  //       dependencyEdge: {
-  //         headTokenIndex: 1,
-  //         label: 'ROOT'
-  //       },
-  //       lemma: 'welcome'
-  //     },
-  //     {
-  //       text: {
-  //         content: '!',
-  //         beginOffset: -1
-  //       },
-  //       partOfSpeech: {
-  //         tag: 'PUNCT',
-  //         aspect: 'ASPECT_UNKNOWN',
-  //         case: 'CASE_UNKNOWN',
-  //         form: 'FORM_UNKNOWN',
-  //         gender: 'GENDER_UNKNOWN',
-  //         mood: 'MOOD_UNKNOWN',
-  //         number: 'NUMBER_UNKNOWN',
-  //         person: 'PERSON_UNKNOWN',
-  //         proper: 'PROPER_UNKNOWN',
-  //         reciprocity: 'RECIPROCITY_UNKNOWN',
-  //         tense: 'TENSE_UNKNOWN',
-  //         voice: 'VOICE_UNKNOWN'
-  //       },
-  //       dependencyEdge: {
-  //         headTokenIndex: 1,
-  //         label: 'P'
-  //       },
-  //       lemma: '!'
-  //     }
+  //     // ...
   //   ]
   // }
 });