# opencalais-tagging

> Tag content using Opencalais

Latest version **2.2.0** (published 2022-04-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install opencalais-tagging
pnpm add opencalais-tagging
yarn add opencalais-tagging
bun add opencalais-tagging
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.2.0 |
| Published | 2022-04-03 |
| First published | 2018-01-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 27.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Author | Akash Dathan |
| Maintainers | akashdathan |
| Keywords | opencalais, tag, content, tagging, language, topics, detect |

## Links

- npm: https://www.npmjs.com/package/opencalais-tagging
- Repository: https://github.com/akashdathan/opencalais-tagging
- Homepage: https://github.com/akashdathan/opencalais-tagging#readme
- Issues: https://github.com/akashdathan/opencalais-tagging/issues
- npm.io page: https://npm.io/package/opencalais-tagging

## Alternatives

- [@lexical/table](https://npm.io/package/@lexical/table.md) — 3.0M weekly downloads
- [mantine-datatable](https://npm.io/package/mantine-datatable.md) — 98.2K weekly downloads
- [react-native-collapsible-tab-view](https://npm.io/package/react-native-collapsible-tab-view.md) — 70.6K weekly downloads
- [@handsontable/vue3](https://npm.io/package/@handsontable/vue3.md) — 16.1K weekly downloads
- [vuewordcloud](https://npm.io/package/vuewordcloud.md) — 7.2K weekly downloads

## Recent versions

- 2.2.0 (latest) — 2022-04-03
- 2.0.0 — 2018-02-03
- 1.0.1 — 2018-01-11
- 1.0.0 — 2018-01-11

## README

# Opencalais Tagging

[![GitHub stars](https://img.shields.io/github/stars/akashdathan/opencalais-tagging.svg?style=social&label=Star)](https://github.com/akashdathan/opencalais-tagging/stargazers) [![GitHub watchers](https://img.shields.io/github/watchers/akashdathan/opencalais-tagging.svg?style=social&label=Watch)](https://github.com/akashdathan/opencalais-tagging/subscription)

[npm-url]: https://npmjs.org/package/opencalais-tagging

>Open Calais attaches intelligent metadata-tags to your unstructured content, enabling powerful text analytics. The Open Calais natural language processing engine automatically analyzes and tags your input files in such a way that your consuming application can both easily pinpoint relevant data, and effectively leverage the invaluable intelligence and insights contained within the text. Please refer to the complete documentation [here](http://www.opencalais.com/wp-content/uploads/folder/ThomsonReutersOpenCalaisAPIUserGuide020316R93.pdf).

## Installation

```bash
$ npm install opencalais-tagging
```

## Usage

* Get your free opencalais key from [here](http://www.opencalais.com/opencalais-api/).


>A promise is returned if a callback function is not provided.

```js
const calais  = require('opencalais-tagging'),
      options = {
        content     : 'The content to tag',
        accessToken : 'opencalais-key'
      }
	
const response = await calais.tag(options)

console.log('Response : ', response)

```

>An optional callbck function can also be provided.

```js
const calais  = require('opencalais-tagging'),
      options = {
        content     : 'The content to tag',
        accessToken : 'opencalais-key'
      }
	  
calais.tag(options, (error, data) => {
  console.log('Response : ', data)
})
```

## Options
> ####The following query parameters can be provided.

| Options | Description | Values | Default Value |
|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------|------------------|
| content (MANDATORY) | Content to be tagged. | string | none |
| accessToken (MANDATORY) | Obtained access token | string | none |
| Content-Type | Indicates the input mime type. | text/html, text/xml, text/raw, application/pdf | text/raw |
| omitOutputtingOriginalText | Excludes the original text from the output.  Highly recommended for large input files. | boolean | true |
| outputFormat | Defines the output format. | xml/rdf, application/json, text/n3 | application/json |
| x-calais-contentClass | Specifies the genre of the input document.  Highly recommended for optimal extraction  when input files are news stories or research  reports. | news, research | none |
| x-calais-language | Indicates the language of the input text. | English, French, Spanish | none |
| x-calais-selectiveTags | Lets you specify a custom set of metadata tag  types to be included in the output. | additionalcontactdetails, company, country, deal, company, industry, person, socialtags, topic | none |

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details

---
_Source: https://npm.io/package/opencalais-tagging · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._