npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

nucleus_api

v4.0.11

Published

Nucleus_text_analytics_APIs_from_SumUp_Analytics__Example_and_documentation_httpswww_sumup_aiapisnucleus_documentation

Downloads

80

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Maintainers

licneplicnepjimw567jimw567

Keywords

Readme

nucleus_api

NucleusApi - JavaScript client for nucleus_api Nucleus text analytics APIs from SumUp Analytics. Example and documentation: https://www.sumup.ai/apis/#nucleus-documentation

  • API version: v4.0.11
  • Package version: v4.0.11 For more information, please visit https://www.sumup.ai

Installation

For Node.js

npm

Run the following command to install the latest version of the sdk:

npm install nucleus_api@latest --save --force

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var NucleusApi = require('nucleus_api');

var my_instance = new NucleusApi.ApiClient("http://localhost:5000", "YOUR_API_KEY")
var api = new NucleusApi.NucleusApi(my_instance)


api.postExampleJob("purple", 5, function (error, data, response) {
    if (error) {console.log(error);return;}
    console.log(data);
}, function(prog) {
    console.log("Progress:", prog);
})

The legacy api's can be called using callLegacyApi, as follows:

api.callLegacyApi("topic_spot_metrics_api.topic_spot_metrics_api",{dataset:"my_dataset"}, function (error, data, response) {
    if (error) {console.log(error);return;}
    console.log(data);
}, function(prog) {
    console.log("Progress:", prog);
})

Documentation for API Endpoints

All URIs are relative to https://localhost:5000

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- NucleusApi.NucleusApi | getJob | GET /jobs | NucleusApi.NucleusApi | getListDatasets | GET /datasets | NucleusApi.NucleusApi | getListFilters | GET /filters | NucleusApi.NucleusApi | getListForensics | GET /forensics | NucleusApi.NucleusApi | getUser | GET /users | NucleusApi.NucleusApi | postAdminAddUser | POST /admin/add_user | NucleusApi.NucleusApi | postAdminDeleteUser | POST /admin/delete_user | NucleusApi.NucleusApi | postAdminList | POST /admin/list | NucleusApi.NucleusApi | postAdminManageDataset | POST /admin/manage_dataset | NucleusApi.NucleusApi | postAdminUpdateUser | POST /admin/update_user | NucleusApi.NucleusApi | postAppendJsonToDataset | POST /datasets/append_json_to_dataset | NucleusApi.NucleusApi | postAuthorConnectivityApi | POST /topics/author_connectivity | NucleusApi.NucleusApi | postAvailableSecFilings | POST /feeds/available_sec_filings | NucleusApi.NucleusApi | postBulkInsertJson | POST /datasets/bulk_insert_json | NucleusApi.NucleusApi | postCreateDatasetFromSecFilings | POST /feeds/create_dataset_from_sec_filings | NucleusApi.NucleusApi | postCustomTrackerApi | POST /dashboard/custom_tracker | NucleusApi.NucleusApi | postDatasetInfo | POST /datasets/dataset_info | NucleusApi.NucleusApi | postDatasetTagging | POST /datasets/dataset_tagging | NucleusApi.NucleusApi | postDeleteDataset | POST /datasets/delete_dataset | NucleusApi.NucleusApi | postDeleteDocument | POST /datasets/delete_document | NucleusApi.NucleusApi | postDeleteFilter | POST /filters/delete_filter | NucleusApi.NucleusApi | postDeleteForensic | POST /forensics/delete_forensic | NucleusApi.NucleusApi | postDocClassifyApi | POST /documents/document_classify | NucleusApi.NucleusApi | postDocDisplay | POST /documents/document_display | NucleusApi.NucleusApi | postDocInfo | POST /documents/document_info | NucleusApi.NucleusApi | postDocNewWordsApi | POST /documents/document_new_words | NucleusApi.NucleusApi | postDocNoveltyApi | POST /documents/document_novelty | NucleusApi.NucleusApi | postDocRecommendApi | POST /documents/document_recommend | NucleusApi.NucleusApi | postDocSentimentApi | POST /documents/document_sentiment | NucleusApi.NucleusApi | postDocSummaryApi | POST /documents/document_summary | NucleusApi.NucleusApi | postDocumentContrastSummaryApi | POST /documents/document_contrasted_summary | NucleusApi.NucleusApi | postExampleJob | POST /jobs/start_example_job | NucleusApi.NucleusApi | postKeyAuthorsApi | POST /dashboard/key_authors | NucleusApi.NucleusApi | postLegacy | POST /legacy | NucleusApi.NucleusApi | postMetadataAutocomplete | POST /datasets/metadata_autocomplete | NucleusApi.NucleusApi | postMetadataHistogram | POST /datasets/metadata_histogram | NucleusApi.NucleusApi | postRenameDataset | POST /datasets/rename_dataset | NucleusApi.NucleusApi | postSaveFilter | POST /filters/save_filter | NucleusApi.NucleusApi | postSaveForensic | POST /forensics/save_forensic | NucleusApi.NucleusApi | postSetupConnector | POST /connectors/setup_connector | NucleusApi.NucleusApi | postSmartAlertsApi | POST /dashboard/smart_alerts | NucleusApi.NucleusApi | postTopicApi | POST /topics/topics | NucleusApi.NucleusApi | postTopicConsensusApi | POST /topics/topic_consensus | NucleusApi.NucleusApi | postTopicConsensusTransferApi | POST /topics/topic_consensus_transfer | NucleusApi.NucleusApi | postTopicContrastApi | POST /topics/topic_contrast | NucleusApi.NucleusApi | postTopicDeltaApi | POST /topics/topic_delta | NucleusApi.NucleusApi | postTopicHistoricalAnalysisApi | POST /topics/topic_historical | NucleusApi.NucleusApi | postTopicSentimentApi | POST /topics/topic_sentiment | NucleusApi.NucleusApi | postTopicSentimentTransferApi | POST /topics/topic_sentiment_transfer | NucleusApi.NucleusApi | postTopicSummaryApi | POST /topics/topic_summary | NucleusApi.NucleusApi | postTopicTransferApi | POST /topics/topic_transfer | NucleusApi.NucleusApi | postUpdateDatasetMetadata | POST /datasets/update_dataset_metadata | NucleusApi.NucleusApi | postUpdateForensic | POST /forensics/update_forensic | NucleusApi.NucleusApi | postUploadFile | POST /datasets/upload_file | NucleusApi.NucleusApi | postUploadUrl | POST /datasets/upload_url |

Documentation for Models

Documentation for Authorization

apikey

  • Type: API key
  • API key parameter name: x-api-key
  • Location: HTTP header

Copyright 2019 SumUp Analytics, Inc