Skip to content

Commit 402b494

Browse files
author
Kathy Czeck
committed
Removed old parts
1 parent d5b0945 commit 402b494

File tree

1 file changed

+0
-93
lines changed

1 file changed

+0
-93
lines changed

README.md

Lines changed: 0 additions & 93 deletions
Original file line numberDiff line numberDiff line change
@@ -39,96 +39,3 @@ in the [examples](https://github.com/rosette-api/nodejs/tree/develop/examples) d
3939

4040
## Binding Developer Information
4141
If you are modifying the binding code, please refer to the [developer README](https://github.com/rosette-api/nodejs/tree/develop/DEVELOPER.md) file.
42-
43-
44-
45-
46-
47-
48-
49-
50-
51-
52-
53-
54-
# rosette-api
55-
56-
This is the Rosette API client binding for node.js.
57-
58-
## Getting Started
59-
Install the module with: `npm install rosette-api`
60-
61-
If the version you are using is not [the latest from npm](https://www.npmjs.com/package/rosette-api) (or `npm show rosette-api@* version`),
62-
please check for its [**compatibilty with api.rosette.com**](https://developer.rosette.com/features-and-functions?javascript).
63-
If you have an on-premise version of Rosette API server, please contact support for
64-
binding compatibility with your installation.
65-
66-
To check your installed version:
67-
68-
- `npm list rosette-api` for local installation
69-
- `npm list -g rosette-api` for global installation
70-
71-
https://www.npmjs.com/package/rosette-api
72-
73-
## Docker ##
74-
A Docker image for running the examples against the compiled source library is available on Docker Hub.
75-
76-
Command: `docker run -e API_KEY=api-key -v "<binding root directory>:/source" rosetteapi/docker-nodejs`
77-
78-
Additional environment settings:
79-
`-e ALT_URL=<alternative URL>`
80-
`-e FILENAME=<single filename>`
81-
82-
83-
## Example using the Rosette API language detection endpoint
84-
```javascript
85-
var Api = require('rosette-api');
86-
87-
var api = new Api(API_KEY);
88-
var endpoint = "language";
89-
var content = "Por favor Señorita, says the man.";
90-
api.parameters.content = content;
91-
92-
api.rosette(endpoint, function(err, res){
93-
if(err){
94-
console.log(err);
95-
} else {
96-
console.log(JSON.stringify(res, null, 2));
97-
}
98-
});
99-
```
100-
## API Parameters
101-
| Parameter | Endpoint | Required
102-
| ------------- |------------- |-------------
103-
| content | categories, entities, language, morphology, relationships, sentences, sentiment, tokens, topics, transliteration | Either content or contentUri required, transliteration requires content only |
104-
| contentUri | categories, entities, language, morphology, relationships, sentences, sentiment, tokens, topics | Either content or contentUri required |
105-
| language | categories, entities, language, morphology, relationships, sentences, sentiment, tokens, topics, name similarity | No |
106-
| documentFile | categories, entities, language, morphology, relationships, sentences, sentiment, tokens, topics | No |
107-
| name1 | name similarity | Yes |
108-
| name2 | name similarity| Yes |
109-
| name | name translation | Yes |
110-
| names | name deduplication | Yes |
111-
| targetLanguage | name translation, transliteration (No) | Yes |
112-
| entityType | name translation | No |
113-
| sourceLanguageOfOrigin | name translation | No |
114-
| sourceLanguageOfUse | name translation | No |
115-
| sourceLanguage | transliteration | No |
116-
| sourceScript | name translation, transliteration | No |
117-
| targetScript | name translation, transliteration | No |
118-
| targetScheme | name translation | No |
119-
| options | relationships | No |
120-
| accuracyMode | relationships | Yes |
121-
| explain | sentiment | No |
122-
| morphology | morphology | Yes |
123-
124-
## Additional Examples
125-
See [examples](examples).
126-
127-
## API Documentation
128-
See [documentation](http://rosette-api.github.io/nodejs)
129-
130-
## Release Notes
131-
See [wiki](https://github.com/rosette-api/nodejs/wiki/Release-Notes)
132-
133-
## Additional Information
134-
See [Rosette API site](https://developer.rosette.com/)

0 commit comments

Comments
 (0)