-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathalchemyapi.js
743 lines (647 loc) · 24.5 KB
/
alchemyapi.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
var request = require('request');
var fs = require('fs');
var ENDPOINTS = {};
var BASE_URL = 'http://access.alchemyapi.com/calls';
var API_KEY = '';
/**
* Checks if file is called directly, and then writes the API key to api_key.txt if it's included in the args
*
* Note: if you don't have an API key, register for one at: http://www.alchemyapi.com/api/register.html
*
* INPUT:
* Your API Key (sent as a command line argument)
*
* OUTPUT:
* none
*/
if (require.main === module) {
//file was called directly from command line to set the key
if (process.argv[2]) {
console.log('Args: ' + process.argv[2]);
fs.writeFile(__dirname + '/api_key.txt',process.argv[2], function(err) {
if (err) {
console.log('Error, unable to write key file: ' + err);
process.exit(1);
} else {
console.log('AlchemyAPI key: ' + process.argv[2] + ' successfully written to api_key.txt');
process.exit(0);
}
});
} else {
console.log('Are you trying to set the key? Make sure to use: node alchemyapi.js YOUR_KEY_HERE');
process.exit(1);
}
}
/**
* Initializes the SDK so it can send requests to AlchemyAPI for analysis.
* It loads the API key from api_key.txt and configures the endpoints.
* This function will be called automatically from the endpoint wrappers when needed.
*
* Note: if you don't have an API key, register for one at: http://www.alchemyapi.com/api/register.html
*
* INPUT:
* none
*
* OUTPUT:
* none
*/
function init() {
//Setup the endpoints
ENDPOINTS['sentiment'] = {};
ENDPOINTS['sentiment']['url'] = '/url/URLGetTextSentiment';
ENDPOINTS['sentiment']['text'] = '/text/TextGetTextSentiment';
ENDPOINTS['sentiment']['html'] = '/html/HTMLGetTextSentiment';
ENDPOINTS['sentiment_targeted'] = {};
ENDPOINTS['sentiment_targeted']['url'] = '/url/URLGetTargetedSentiment';
ENDPOINTS['sentiment_targeted']['text'] = '/text/TextGetTargetedSentiment';
ENDPOINTS['sentiment_targeted']['html'] = '/html/HTMLGetTargetedSentiment';
ENDPOINTS['author'] = {};
ENDPOINTS['author']['url'] = '/url/URLGetAuthor';
ENDPOINTS['author']['html'] = '/html/HTMLGetAuthor';
ENDPOINTS['keywords'] = {};
ENDPOINTS['keywords']['url'] = '/url/URLGetRankedKeywords';
ENDPOINTS['keywords']['text'] = '/text/TextGetRankedKeywords';
ENDPOINTS['keywords']['html'] = '/html/HTMLGetRankedKeywords';
ENDPOINTS['concepts'] = {};
ENDPOINTS['concepts']['url'] = '/url/URLGetRankedConcepts';
ENDPOINTS['concepts']['text'] = '/text/TextGetRankedConcepts';
ENDPOINTS['concepts']['html'] = '/html/HTMLGetRankedConcepts';
ENDPOINTS['entities'] = {};
ENDPOINTS['entities']['url'] = '/url/URLGetRankedNamedEntities';
ENDPOINTS['entities']['text'] = '/text/TextGetRankedNamedEntities';
ENDPOINTS['entities']['html'] = '/html/HTMLGetRankedNamedEntities';
ENDPOINTS['category'] = {};
ENDPOINTS['category']['url'] = '/url/URLGetCategory';
ENDPOINTS['category']['text'] = '/text/TextGetCategory';
ENDPOINTS['category']['html'] = '/html/HTMLGetCategory';
ENDPOINTS['relations'] = {};
ENDPOINTS['relations']['url'] = '/url/URLGetRelations';
ENDPOINTS['relations']['text'] = '/text/TextGetRelations';
ENDPOINTS['relations']['html'] = '/html/HTMLGetRelations';
ENDPOINTS['language'] = {};
ENDPOINTS['language']['url'] = '/url/URLGetLanguage';
ENDPOINTS['language']['text'] = '/text/TextGetLanguage';
ENDPOINTS['language']['html'] = '/html/HTMLGetLanguage';
ENDPOINTS['text_clean'] = {};
ENDPOINTS['text_clean']['url'] = '/url/URLGetText';
ENDPOINTS['text_clean']['html'] = '/html/HTMLGetText';
ENDPOINTS['text_raw'] = {};
ENDPOINTS['text_raw']['url'] = '/url/URLGetRawText';
ENDPOINTS['text_raw']['html'] = '/html/HTMLGetRawText';
ENDPOINTS['text_title'] = {};
ENDPOINTS['text_title']['url'] = '/url/URLGetTitle';
ENDPOINTS['text_title']['html'] = '/html/HTMLGetTitle';
ENDPOINTS['feeds'] = {};
ENDPOINTS['feeds']['url'] = '/url/URLGetFeedLinks';
ENDPOINTS['feeds']['html'] = '/html/HTMLGetFeedLinks';
ENDPOINTS['microformats'] = {};
ENDPOINTS['microformats']['url'] = '/url/URLGetMicroformatData';
ENDPOINTS['microformats']['html'] = '/html/HTMLGetMicroformatData';
//Load the key from api_key.txt
try {
key = fs.readFileSync(__dirname + '/api_key.txt').toString().trim();
}
catch(err) {
//Create the file
fs.openSync(__dirname + '/api_key.txt', 'w');
console.log('API key not detected in api_key.txt, please copy/paste your key into this file.');
console.log('If you do not have a key, register for one at: http://www.alchemyapi.com/api/register.html');
process.exit(1);
}
//Make sure the key formating looks good
if (key.length != 40) {
console.log('The API key in api_key.txt does not appear to be valid. Make sure to copy/paste the key correctly into api_key.txt, and that the file only contains the key.');
console.log('If you do not have a key, register for one at: http://www.alchemyapi.com/api/register.html');
process.exit(1);
}
//Set the key
API_KEY = key;
}
/**
* Calculates the sentiment for text, a URL or HTML.
* For an overview, please refer to: http://www.alchemyapi.com/products/features/sentiment-analysis/
* For the docs, please refer to: http://www.alchemyapi.com/api/sentiment-analysis/
*
* INPUT:
* flavor -> which version of the call, i.e. text, url or html.
* data -> the data to analyze, either the text, the url or html code.
* options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.
*
* Available Options:
* showSourceText -> 0: disabled (default), 1: enabled
*
* OUTPUT:
* The response, already converted from JSON to a Python object.
*/
exports.sentiment = function(flavor, data, options, callback) {
options = options || {}
if (API_KEY == '') {
init();
}
if (!(flavor in ENDPOINTS['sentiment'])) {
callback({ status:'ERROR', statusInfo:'Sentiment analysis is not available for ' + flavor });
} else {
var url = BASE_URL +
ENDPOINTS['sentiment'][flavor] +
'?apikey=' + API_KEY +
'&' + flavor + '=' + encodeURIComponent(data) +
'&outputMode=json';
for (var key in options) {
url += '&' + key + '=' + options[key].toString();
}
analyze(url, callback);
}
};
/**
* Calculates the targeted sentiment for text, a URL or HTML.
* For an overview, please refer to: http://www.alchemyapi.com/products/features/sentiment-analysis/
* For the docs, please refer to: http://www.alchemyapi.com/api/sentiment-analysis/
*
* INPUT:
* flavor -> which version of the call, i.e. text, url or html.
* data -> the data to analyze, either the text, the url or html code.
* target -> the word or phrase to run sentiment analysis on.
* options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.
*
* Available Options:
* showSourceText -> 0: disabled, 1: enabled
*
* OUTPUT:
* The response, already converted from JSON to a Python object.
*/
exports.sentiment_targeted = function(flavor, data, target, options, callback) {
options = options || {}
if (API_KEY == '') {
init();
}
if (!(flavor in ENDPOINTS['sentiment_targeted'])) {
callback({ status:'ERROR', statusInfo:'Sentiment analysis is not available for ' + flavor });
} else if (!target) {
callback({ status:'ERROR', statusInfo:'target must not be null' });
} else {
var url = BASE_URL +
ENDPOINTS['sentiment_targeted'][flavor] +
'?apikey=' + API_KEY +
'&' + flavor + '=' + encodeURIComponent(data) +
'&outputMode=json';
for (var key in options) {
url += '&' + key + '=' + options[key].toString();
}
analyze(url, callback);
}
};
/**
* Extracts the entities for text, a URL or HTML.
* For an overview, please refer to: http://www.alchemyapi.com/products/features/entity-extraction/
* For the docs, please refer to: http://www.alchemyapi.com/api/entity-extraction/
*
* INPUT:
* flavor -> which version of the call, i.e. text, url or html.
* data -> the data to analyze, either the text, the url or html code.
* options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.
*
* Available Options:
* disambiguate -> disambiguate entities (i.e. Apple the company vs. apple the fruit). 0: disabled, 1: enabled (default)
* linkedData -> include linked data on disambiguated entities. 0: disabled, 1: enabled (default)
* coreference -> resolve coreferences (i.e. the pronouns that correspond to named entities). 0: disabled, 1: enabled (default)
* quotations -> extract quotations by entities. 0: disabled (default), 1: enabled.
* sentiment -> analyze sentiment for each entity. 0: disabled (default), 1: enabled. Requires 1 additional API transction if enabled.
* showSourceText -> 0: disabled (default), 1: enabled
* maxRetrieve -> the maximum number of entities to retrieve (default: 50)
*
* OUTPUT:
* The response, already converted from JSON to a Python object.
*/
exports.entities = function(flavor, data, options, callback) {
options = options || {}
if (API_KEY == '') {
init();
}
if (!(flavor in ENDPOINTS['entities'])) {
callback({ status:'ERROR', statusInfo:'Entity extraction is not available for ' + flavor });
} else {
var url = BASE_URL +
ENDPOINTS['entities'][flavor] +
'?apikey=' + API_KEY +
'&' + flavor + '=' + encodeURIComponent(data) +
'&outputMode=json';
for (var key in options) {
url += '&' + key + '=' + options[key].toString();
}
analyze(url, callback);
}
};
/**
* Extracts the keywords from text, a URL or HTML.
* For an overview, please refer to: http://www.alchemyapi.com/products/features/keyword-extraction/
* For the docs, please refer to: http://www.alchemyapi.com/api/keyword-extraction/
*
* INPUT:
* flavor -> which version of the call, i.e. text, url or html.
* data -> the data to analyze, either the text, the url or html code.
* options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.
*
* Available Options:
* keywordExtractMode -> normal (default), strict
* sentiment -> analyze sentiment for each keyword. 0: disabled (default), 1: enabled. Requires 1 additional API transaction if enabled.
* showSourceText -> 0: disabled (default), 1: enabled.
* maxRetrieve -> the max number of keywords returned (default: 50)
*
* OUTPUT:
* The response, already converted from JSON to a Python object.
*/
exports.keywords = function(flavor, data, options, callback) {
options = options || {}
if (API_KEY == '') {
init();
}
if (!(flavor in ENDPOINTS['keywords'])) {
callback({ status:'ERROR', statusInfo:'Keyword extraction is not available for ' + flavor });
} else {
var url = BASE_URL +
ENDPOINTS['keywords'][flavor] +
'?apikey=' + API_KEY +
'&' + flavor + '=' + encodeURIComponent(data) +
'&outputMode=json';
for (var key in options) {
url += '&' + key + '=' + options[key].toString();
}
analyze(url, callback);
}
};
/**
* Tags the concepts for text, a URL or HTML.
* For an overview, please refer to: http://www.alchemyapi.com/products/features/concept-tagging/
* For the docs, please refer to: http://www.alchemyapi.com/api/concept-tagging/
*
* Available Options:
* maxRetrieve -> the maximum number of concepts to retrieve (default: 8)
* linkedData -> include linked data, 0: disabled, 1: enabled (default)
* showSourceText -> 0:disabled (default), 1: enabled
*
* OUTPUT:
* The response, already converted from JSON to a Python object.
*/
exports.concepts = function(flavor, data, options, callback) {
options = options || {}
if (API_KEY == '') {
init();
}
if (!(flavor in ENDPOINTS['concepts'])) {
callback({ status:'ERROR', statusInfo:'Concept tagging is not available for ' + flavor });
} else {
var url = BASE_URL +
ENDPOINTS['concepts'][flavor] +
'?apikey=' + API_KEY +
'&' + flavor + '=' + encodeURIComponent(data) +
'&outputMode=json';
for (var key in options) {
url += '&' + key + '=' + options[key].toString();
}
analyze(url, callback);
}
};
/**
* Extracts the author from a URL or HTML.
* For an overview, please refer to: http://www.alchemyapi.com/products/features/author-extraction/
* For the docs, please refer to: http://www.alchemyapi.com/api/author-extraction/
*
* INPUT:
* flavor -> which version of the call, i.e. text, url or html.
* data -> the data to analyze, either the text, the url or html code.
* options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.
*
* Availble Options:
* none
*
* OUTPUT:
* The response, already converted from JSON to a Python object.
*/
exports.author = function(flavor, data, options, callback) {
options = options || {}
if (API_KEY == '') {
init();
}
if (!(flavor in ENDPOINTS['author'])) {
callback({ status:'ERROR', statusInfo:'Author extraction is not available for ' + flavor });
} else {
var url = BASE_URL +
ENDPOINTS['author'][flavor] +
'?apikey=' + API_KEY +
'&' + flavor + '=' + encodeURIComponent(data) +
'&outputMode=json';
for (var key in options) {
url += '&' + key + '=' + options[key].toString();
}
analyze(url, callback);
}
};
/**
* Categorizes the text for text, a URL or HTML.
* For an overview, please refer to: http://www.alchemyapi.com/products/features/text-categorization/
* For the docs, please refer to: http://www.alchemyapi.com/api/text-categorization/
*
* INPUT:
* flavor -> which version of the call, i.e. text, url or html.
* data -> the data to analyze, either the text, the url or html code.
* options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.
*
* Available Options:
* showSourceText -> 0: disabled (default), 1: enabled
*
* OUTPUT:
* The response, already converted from JSON to a Python object.
*/
exports.category = function(flavor, data, options, callback) {
options = options || {}
if (API_KEY == '') {
init();
}
if (!(flavor in ENDPOINTS['category'])) {
callback({ status:'ERROR', statusInfo:'Text categorization is not available for ' + flavor });
} else {
var url = BASE_URL +
ENDPOINTS['category'][flavor] +
'?apikey=' + API_KEY +
'&' + flavor + '=' + encodeURIComponent(data) +
'&outputMode=json';
for (var key in options) {
url += '&' + key + '=' + options[key].toString();
}
analyze(url, callback);
}
};
/**
* Extracts the relations for text, a URL or HTML.
* For an overview, please refer to: http://www.alchemyapi.com/products/features/relation-extraction/
* For the docs, please refer to: http://www.alchemyapi.com/api/relation-extraction/
*
* INPUT:
* flavor -> which version of the call, i.e. text, url or html.
* data -> the data to analyze, either the text, the url or html code.
* options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.
*
* Available Options:
* sentiment -> 0: disabled (default), 1: enabled. Requires one additional API transaction if enabled.
* keywords -> extract keywords from the subject and object. 0: disabled (default), 1: enabled. Requires one additional API transaction if enabled.
* entities -> extract entities from the subject and object. 0: disabled (default), 1: enabled. Requires one additional API transaction if enabled.
* requireEntities -> only extract relations that have entities. 0: disabled (default), 1: enabled.
* sentimentExcludeEntities -> exclude full entity name in sentiment analysis. 0: disabled, 1: enabled (default)
* disambiguate -> disambiguate entities (i.e. Apple the company vs. apple the fruit). 0: disabled, 1: enabled (default)
* linkedData -> include linked data with disambiguated entities. 0: disabled, 1: enabled (default).
* coreference -> resolve entity coreferences. 0: disabled, 1: enabled (default)
* showSourceText -> 0: disabled (default), 1: enabled.
* maxRetrieve -> the maximum number of relations to extract (default: 50, max: 100)
*
* OUTPUT:
* The response, already converted from JSON to a Python object.
*/
exports.relations = function(flavor, data, options, callback) {
options = options || {}
if (API_KEY == '') {
init();
}
if (!(flavor in ENDPOINTS['relations'])) {
callback({ status:'ERROR', statusInfo:'Relation extraction is not available for ' + flavor });
} else {
var url = BASE_URL +
ENDPOINTS['relations'][flavor] +
'?apikey=' + API_KEY +
'&' + flavor + '=' + encodeURIComponent(data) +
'&outputMode=json';
for (var key in options) {
url += '&' + key + '=' + options[key].toString();
}
analyze(url, callback);
}
};
/**
* Detects the language for text, a URL or HTML.
* For an overview, please refer to: http://www.alchemyapi.com/api/language-detection/
* For the docs, please refer to: http://www.alchemyapi.com/products/features/language-detection/
*
* INPUT:
* flavor -> which version of the call, i.e. text, url or html.
* data -> the data to analyze, either the text, the url or html code.
* options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.
*
* Available Options:
* none
*
* OUTPUT:
* The response, already converted from JSON to a Python object.
*/
exports.language = function(flavor, data, options,callback) {
options = options || {}
if (API_KEY == '') {
init();
}
if (!(flavor in ENDPOINTS['language'])) {
callback({ status:'ERROR', statusInfo:'Language detection is not available for ' + flavor });
} else {
var url = BASE_URL +
ENDPOINTS['language'][flavor] +
'?apikey=' + API_KEY +
'&' + flavor + '=' + encodeURIComponent(data) +
'&outputMode=json';
for (var key in options) {
url += '&' + key + '=' + options[key].toString();
}
analyze(url, callback);
}
};
/**
* Extracts the cleaned text (removes ads, navigation, etc.) for text, a URL or HTML.
* For an overview, please refer to: http://www.alchemyapi.com/products/features/text-extraction/
* For the docs, please refer to: http://www.alchemyapi.com/api/text-extraction/
*
* INPUT:
* flavor -> which version of the call, i.e. text, url or html.
* data -> the data to analyze, either the text, the url or html code.
* options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.
*
* Available Options:
* useMetadata -> utilize meta description data, 0: disabled, 1: enabled (default)
* extractLinks -> include links, 0: disabled (default), 1: enabled.
*
* OUTPUT:
* The response, already converted from JSON to a Python object.
*/
exports.text_clean = function(flavor, data, options, callback) {
options = options || {}
if (API_KEY == '') {
init();
}
if (!(flavor in ENDPOINTS['text_clean'])) {
callback({ status:'ERROR', statusInfo:'Text extraction is not available for ' + flavor });
} else {
var url = BASE_URL +
ENDPOINTS['text_clean'][flavor] +
'?apikey=' + API_KEY +
'&' + flavor + '=' + encodeURIComponent(data) +
'&outputMode=json';
for (var key in options) {
url += '&' + key + '=' + options[key].toString();
}
analyze(url, callback);
}
};
/**
* Extracts the raw text (includes ads, navigation, etc.) for a URL or HTML.
* For an overview, please refer to: http://www.alchemyapi.com/products/features/text-extraction/
* For the docs, please refer to: http://www.alchemyapi.com/api/text-extraction/
*
* INPUT:
* flavor -> which version of the call, i.e. text, url or html.
* data -> the data to analyze, either the text, the url or html code.
* options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.
*
* Available Options:
* none
*
* OUTPUT:
* The response, already converted from JSON to a Python object.
*/
exports.text_raw = function(flavor, data, options, callback) {
options = options || {}
if (API_KEY == '') {
init();
}
if (!(flavor in ENDPOINTS['text_raw'])) {
callback({ status:'ERROR', statusInfo:'Text extraction is not available for ' + flavor });
} else {
var url = BASE_URL +
ENDPOINTS['text_raw'][flavor] +
'?apikey=' + API_KEY +
'&' + flavor + '=' + encodeURIComponent(data) +
'&outputMode=json';
for (var key in options) {
url += '&' + key + '=' + options[key].toString();
}
analyze(url, callback);
}
};
/**
* Extracts the title for a URL or HTML.
* For an overview, please refer to: http://www.alchemyapi.com/products/features/text-extraction/
* For the docs, please refer to: http://www.alchemyapi.com/api/text-extraction/
*
* INPUT:
* flavor -> which version of the call, i.e. text, url or html.
* data -> the data to analyze, either the text, the url or html code.
* options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.
*
* Available Options:
* useMetadata -> utilize title info embedded in meta data, 0: disabled, 1: enabled (default)
*
* OUTPUT:
* The response, already converted from JSON to a Python object.
*/
exports.text_title = function(flavor, data, options, callback) {
options = options || {}
if (API_KEY == '') {
init();
}
if (!(flavor in ENDPOINTS['text_title'])) {
callback({ status:'ERROR', statusInfo:'Text extraction is not available for ' + flavor });
} else {
var url = BASE_URL +
ENDPOINTS['text_title'][flavor] +
'?apikey=' + API_KEY +
'&' + flavor + '=' + encodeURIComponent(data) +
'&outputMode=json';
for (var key in options) {
url += '&' + key + '=' + options[key].toString();
}
analyze(url, callback);
}
};
/**
* Parses the microformats for a URL or HTML.
* For an overview, please refer to: http://www.alchemyapi.com/products/features/microformats-parsing/
* For the docs, please refer to: http://www.alchemyapi.com/api/microformats-parsing/
*
* INPUT:
* flavor -> which version of the call, i.e. url or html.
* data -> the data to analyze, either the the url or html code.
* options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.
*
* Available Options:
* none
*
* OUTPUT:
* The response, already converted from JSON to a Python object.
*/
exports.microformats = function(flavor, data, options, callback) {
options = options || {}
if (API_KEY == '') {
init();
}
if (!(flavor in ENDPOINTS['microformats'])) {
callback({ status:'ERROR', statusInfo:'Microformats parsing is not available for ' + flavor });
} else {
var url = BASE_URL +
ENDPOINTS['microformats'][flavor] +
'?apikey=' + API_KEY +
'&' + flavor + '=' + encodeURIComponent(data) +
'&outputMode=json';
for (var key in options) {
url += '&' + key + '=' + options[key].toString();
}
analyze(url, callback);
}
};
/**
* Detects the RSS/ATOM feeds for a URL or HTML.
* For an overview, please refer to: http://www.alchemyapi.com/products/features/feed-detection/
* For the docs, please refer to: http://www.alchemyapi.com/api/feed-detection/
*
* INPUT:
* flavor -> which version of the call, i.e. url or html.
* data -> the data to analyze, either the the url or html code.
* options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.
*
* Available Options:
* none
*
* OUTPUT:
* The response, already converted from JSON to a Python object.
*/
exports.feeds = function(flavor, data, options, callback) {
options = options || {}
if (API_KEY == '') {
init();
}
if (!(flavor in ENDPOINTS['feeds'])) {
callback({ status:'ERROR', statusInfo:'Feed detection is not available for ' + flavor });
} else {
var url = BASE_URL +
ENDPOINTS['feeds'][flavor] +
'?apikey=' + API_KEY +
'&' + flavor + '=' + encodeURIComponent(data) +
'&outputMode=json';
for (var key in options) {
url += '&' + key + '=' + options[key].toString();
}
analyze(url, callback);
}
};
/**
* HTTP Request wrapper that is called by the endpoint functions. This function is not intended to be called through an external interface.
* It makes the call, then converts the returned JSON string into a Python object.
*
* INPUT:
* url -> the full URI encoded url
*
* OUTPUT:
* The response, already converted from JSON to a Python object.
*/
function analyze(url, callback) {
request.post({ url:url }, function(error, response, body) {
if (!error && response.statusCode == 200) {
callback(error,JSON.parse(body));
} else {
callback(error,{ status:'ERROR', statusInfo:'invalid server response' });
}
});
}