FORGEBOX Enterprise 🚀 - Take your ColdFusion (CFML) Development to Modern Times! Learn More...

aylien.cfc

v0.1.2 Public

ayliencfc

A CFML wrapper for the Aylien API. Access Aylien's Natural Language Processing (NLP) API to extract meaning and insight from textual content.

This is a very early stage API wrapper. Feel free to use the issue tracker to report bugs or suggest improvements!

Acknowledgements

This project borrows heavily from the API frameworks built by jcberquist, such as xero-cfml and aws-cfml. Because it draws on those projects, it is also licensed under the terms of the MIT license.

Table of Contents

Quick Start

Let's analyze some text! Here's how to extract entities:

aylien = new aylien.aylien( applicationId = 'xxx', applicationKey = 'xxx' );

entities = aylien.entities( url = 'http://bit.ly/intb2018' );

writeDump( entities );

Reference Manual

entities( string text = '', string url = '', string language )

Extracts named entities (people, organizations and locations) and values (URLs, emails, telephone numbers, currency amounts and percentages) from a document. You must provide either the text or url argument.

concepts( string text = '', string url = '', string language )

Extracts different types of notable entities mentioned in a document, disambiguates and cross link them to DBPedia and Linked Data entities, along with their semantic types (including DBPedia and schema.org). You must provide either the text or url argument.

sentiment( string text = '', string url = '', string language, string mode )

Determines the tone of a piece of text such as a tweet, a review or an article, and for short text, whether it is subjective or objective. You must provide either the text or url argument. Be sure to use the appropriate mode parameter based on your input text: tweet for short text such as social media updates and document for longer text such as a review or an article. The default mode is tweet.

Questions

For questions that aren't about bugs, feel free to hit me up on the CFML Slack Channel; I'm @mjclemente. You'll likely get a much faster response than creating an issue here.

Contributing

👍 🎉 First off, thanks for taking the time to contribute! 🎉 👍

Before putting the work into creating a PR, I'd appreciate it if you opened an issue. That way we can discuss the best way to implement changes/features, before work is done.

Changes should be submitted as Pull Requests on the develop branch.

Here are all the versions for this package. Please note that you can leverage CommandBox package versioning to install any package you like. Please refer to our managing package version guide for more information.

Version Created Last Update Published By Stable Actions
Current
0.1.2 Aug 20 2019 07:44 PM Aug 20 2019 07:44 PM
Version History
0.1.1 Apr 29 2019 08:20 PM Apr 29 2019 08:20 PM
0.1.0 Apr 29 2019 08:06 AM Apr 29 2019 08:06 AM

 

No collaborators yet.
   
  • Apr 29 2019 08:06 AM
  • Aug 20 2019 07:44 PM
  • 164
  • 0
  • 54