yeshenshuijiao / edenai-javascript

The best AI engines in one API: vision, text, speech, translation, OCR, machine learning, etc. SDK and examples for JavaScript developers.

eden_ai_api_documentation

• API version: v1
• Package version: v1
• Build package: io.swagger.codegen.languages.JavascriptClientCodegen For more information, please visit https://www.edenai.co

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install eden_ai_api_documentation --save

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your eden_ai_api_documentation from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('eden_ai_api_documentation') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/edenai/GIT_REPO_ID then install it via:

    npm install edenai/GIT_REPO_ID --save

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 EdenAiApiDocumentation = require('eden_ai_api_documentation');

var defaultClient = EdenAiApiDocumentation.ApiClient.instance;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new EdenAiApiDocumentation.AutoMLTextDataApi()

var projectId = "projectId_example"; // {String} 

var trainId = "trainId_example"; // {String} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.automlTextDataDelete(projectId, trainId, callback);

Documentation for API Endpoints

All URIs are relative to https://api.edenai.run/v1

Class	Method	HTTP request	Description
EdenAiApiDocumentation.EdenAIToolsApi	search	POST /tools/search
EdenAiApiDocumentation.OCRApi	ocr	POST /pretrained/ocr/ocr
EdenAiApiDocumentation.OCRApi	ocrInvoice	POST /pretrained/ocr/ocr_invoice
EdenAiApiDocumentation.PipelinesApi	pipelines	POST /pipelines
EdenAiApiDocumentation.SpeechApi	asyncSpeechToText	POST /pretrained/audio/speech_recognition_async
EdenAiApiDocumentation.SpeechApi	asyncSpeechToText_0	GET /pretrained/audio/speech_recognition_async/{job_id}
EdenAiApiDocumentation.SpeechApi	speechToText	POST /pretrained/audio/speech_to_text
EdenAiApiDocumentation.SpeechApi	textToSpeech	POST /pretrained/audio/text_to_speech
EdenAiApiDocumentation.TextApi	keywordExtraction	POST /pretrained/text/keyword_extraction
EdenAiApiDocumentation.TextApi	namedEntityRecognition	POST /pretrained/text/named_entity_recognition
EdenAiApiDocumentation.TextApi	sentimentAnalysis	POST /pretrained/text/sentiment_analysis
EdenAiApiDocumentation.TextApi	syntaxAnalysis	POST /pretrained/text/syntax_analysis
EdenAiApiDocumentation.TranslationApi	automaticTranslation	POST /pretrained/translation/automatic_translation
EdenAiApiDocumentation.TranslationApi	languageDetection	POST /pretrained/translation/language_detection
EdenAiApiDocumentation.VisionApi	explicitContentDetection	POST /pretrained/vision/explicit_content_detection
EdenAiApiDocumentation.VisionApi	faceDetection	POST /pretrained/vision/face_detection
EdenAiApiDocumentation.VisionApi	objectDetection	POST /pretrained/vision/object_detection

Documentation for Authorization

Bearer

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header