IQ Engines NodeJS API Bindings

Dependencies

• NodeJS version 0.4.0 or greater
• npm (optional for easier installation)

Install

You can install the module by using npm and running the command below.

npm install iqengines

Or, you can also use this module by including it directly inside your project directory.

Example Usage

function onQuerySent (response) {
    console.log("=> Query with qid=" + qid + " sent!");
    console.log(JSON.stringify(response));
}

function onResultsReady (response) {
    console.log("=> Results found! printing ..");
    console.log(JSON.stringify(response));
}

var iqengines = require('iqengines'),
    api       = new iqengines.Api(<YOUR_KEY>, <YOUR_SECRET>),
    qid       = api.sendQuery({img: 'sample.png'}, onQuerySent); 
api.waitResults({}, onResultsReady);

Api Reference

### new Api(key, secret) ###

A constructor that returns a handle to the iqengines API. key and secret is your API key/secret obtained from signing up for an account at http://developer.iqengines.com/. If these are left undefined, the module will look up their values from the IQE_KEY and IQE_SECRET environment variables.

### Api.sendQuery(options, [callback])###

Sends an image query to the iqengines servers. Returns a qid representing the unique identifier for the given query. callback is a function taking a single argument response. It is called when you've successfully sent a query to the iqengiens server.

Options:

• img - The file path to your image (jpg, png) (required)
• multiple_results - If true then all identified images are returned in the results (default = null)
• device_id - A unique string used to filter out the results when retrieving results using the waitResult method (default = null)
• webhook - The URL where the results are sent via HTTP POST once the results have been computed (default = null)
• extra - A string that is posted back when the webhook is called or when retreiving results. It is useful for passing JSON-encoded extra parameters about the query that your application can then use once the results are available (default = null)
• json - If true, then the response sent to the callback is formatted as a JSON object (default = true)

### Api.getResult(options, callback) ###

Retrieves the result for a given query. callback is a function taking a single argument representing the response from the IQ Engines server. It is called when IQ Engines responds to the getResult request. response here will either contain the results of the query if it has been processed or a message specifying that query has not been processed yet.

• qid - The unique identifier returned from the sendQuery method (default = true)
• json - If true, then the response sent to the callback is formatted as a JSON object (default = true)

### Api.createObject(options, callback) ###

Creates an object in your computer vision database. callback is a function taking a single argument representing the response from the IQ Engines server. It is called when IQ Engines responds to the createObject request. response here will either contain the results of the create operation along with object ID if it has been processed or a message specifying that operation was not successful.

• name - This is a unique name for the object you want to associate to the image
• images - A list of paths to the images you want to have indexed
• json - If true, then the response sent to the callback is formatted as a JSON object (default = true)

Optional:

• meta - A JSON object holding extra meta information about the uploaded images
• collection - A name for the collection you want to upload to
• custom_id - An id you can assign to this object that you can later use to look up the object

### Api.updateObject(options, callback) ###

Use this api to add images to existing objects. callback is a function taking a single argument representing the response from the IQ Engines server. It is called when IQ Engines responds to the updateObject request. response here will contain the results of the operation with an error flag set if any errors were encountered.

• obj_id - The object id that you want to add additional images to
• images - A list of paths to the images you want to have indexed
• json - If true, then the response sent to the callback is formatted as a JSON object (default = true)

### Api.getObject(options, callback) ###

Use this api retrieve an object using it's obj_id. callback is a function taking a single argument representing the response from the IQ Engines server. It is called when IQ Engines responds to the updateObject request. response here will either contain the details of the object or a message specifying that operation was not successful.

• obj_id - The object id of the object you want to retrieve
• json - If true, then the response sent to the callback is formatted as a JSON object (default = true)

### Api.delObject(options, callback) ###

Deletes an object. callback is a function taking a single argument representing the response from the IQ Engines server. It is called when IQ Engines responds to the updateObject request. response here will contain the results of the operation with an error flag set if any errors were encountered.

• obj_id - The object id of the object you want to delete
• json - If true, then the response sent to the callback is formatted as a JSON object (default = true)

### Api.waitResults(options, callback) ###

Opens a long polling connection to the IQ Engines servers and waits until results are ready. callback is a function taking a single argument representing the response from the IQ Engines server. It is called when results are ready.

• device_id - if given, the waitResult call will only return when results are ready from queries sent with the corresponding device_id (default = null)
• json - If true, then the response sent to the callback is formatted as a JSON object (default = true)