FeaturizeApi.md

DeepAffects.FeaturizeApi

All URIs are relative to https://localhost

Method	HTTP request	Description
asyncFeaturizeAudio	POST /api/v1/async/featurize	featurize an audio file
syncFeaturizeAudio	POST /api/v1/sync/featurize	featurize an audio file

asyncFeaturizeAudio

AsyncResponse asyncFeaturizeAudio(body, webhook, opts)

featurize an audio file

Extract paralinguistic feature from an audio file.

Example

var DeepAffects = require('deep_affects');
var defaultClient = DeepAffects.ApiClient.instance;

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

var apiInstance = new DeepAffects.FeaturizeApi();

var body = new DeepAffects.Audio(); // Audio | Audio object that needs to be featurized.

var webhook = "webhook_example"; // String | The webhook url where result from async resource is posted

var opts = {
  'requestId': "requestId_example" // String | Unique identifier for the request
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.asyncFeaturizeAudio(body, webhook, opts, callback);

Parameters

Name	Type	Description	Notes
body	Audio	Audio object that needs to be featurized.
webhook	String	The webhook url where result from async resource is posted
requestId	String	Unique identifier for the request	[optional]

Return type

AsyncResponse

Authorization

UserSecurity

HTTP request headers

• Content-Type: application/json
• Accept: application/json

syncFeaturizeAudio

AudioFeatures syncFeaturizeAudio(body)

featurize an audio file

Extract paralinguistic feature from an audio file.

Example

var DeepAffects = require('deep_affects');
var defaultClient = DeepAffects.ApiClient.instance;

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

var apiInstance = new DeepAffects.FeaturizeApi();

var body = new DeepAffects.Audio(); // Audio | Audio object that needs to be featurized.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.syncFeaturizeAudio(body, callback);

Parameters

Name	Type	Description	Notes
body	Audio	Audio object that needs to be featurized.

Return type

AudioFeatures

Authorization

UserSecurity

HTTP request headers

• Content-Type: application/json
• Accept: application/json