stylelens_detector v0.0.1
stylelens_detector
StylelensDetector - JavaScript client for stylelens_detector This is a API document for Object Detection on fashion ite ms This SDK is automatically generated by the Swagger Codegen project:
- API version: 0.0.1
- Package version: 0.0.1
- Build package: io.swagger.codegen.languages.JavascriptClientCodegen
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 stylelens_detector --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 stylelens_detector from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
You should now be able to require('stylelens_detector')
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/YOUR_USERNAME/stylelens_detector then install it via:
npm install YOUR_USERNAME/stylelens_detector --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 StylelensDetector = require('stylelens_detector');
var api = new StylelensDetector.DetectApi()
var opts = {
'file': "/path/to/file.txt" // {File} Image file to upload (only support jpg format yet)
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.detectObjects(opts, callback);
Documentation for API Endpoints
All URIs are relative to http://objdetect.stylelens.io
Class | Method | HTTP request | Description |
---|---|---|---|
StylelensDetector.DetectApi | detectObjects | POST / | Query to detect obejects in the image you sent |
Documentation for Models
- StylelensDetector.BoxArray
- StylelensDetector.BoxObject
- StylelensDetector.DetectObjectsResponse
- StylelensDetector.DetectObjectsResponseData
Documentation for Authorization
api_key
- Type: API key
- API key parameter name: api_key
- Location: HTTP header
7 years ago