@sense.ai.tion/sense_ai_tion_api v2.1.279

sense_ai_tion

SenseAiTion - JavaScript client for sense_ai_tion This is the interface for the sense.ai.tion services. With it you can access the services for analysing audio streams or text of communications. You can produce transcripts and get deeper information. Emotional and psychological data can fetched as annotation to the text. This API is used by the sense.ai.tion WEB applications (e.g. the PWA) too. That means, that everything what is working in the WEB application of sense.ai.tion can be done with this API - there is nothing else. Don't wait: Get a sense.ai.tion account and take a deep dive into the world of emotions, personality and motivations. This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.2.0
• Package version: 1.2.0
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit https://senseaition.com/

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 sense_ai_tion --save

Finally, you need to build the module:

npm run build

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

To use the link you just defined in your project, switch to the directory you want to use your sense_ai_tion from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

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

    npm install GIT_USER_ID/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):

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 SenseAiTion = require('sense_ai_tion');

var defaultClient = SenseAiTion.ApiClient.instance;
// Configure API key authorization: APIKeyHeader
var APIKeyHeader = defaultClient.authentications['APIKeyHeader'];
APIKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//APIKeyHeader.apiKeyPrefix['X-API-Key'] = "Token"
// Configure OAuth2 access token for authorization: googleFireBase
var googleFireBase = defaultClient.authentications['googleFireBase'];
googleFireBase.accessToken = "YOUR ACCESS TOKEN"

var api = new SenseAiTion.CampaignApi()
var red = 56; // {Number} red value from 50 to 150
var green = 56; // {Number} green value from 50 to 150
var blue = 56; // {Number} blue value from 50 to 150
var yellow = 56; // {Number} yellow value from 50 to 150
var black = 56; // {Number} black value from 50 to 150
var white = 56; // {Number} white value from 50 to 150
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.campaignGetQR(red, green, blue, yellow, black, white, callback);

Documentation for API Endpoints

All URIs are relative to https://api.senseaition.rocks/v1

Documentation for Models

• SenseAiTion.Address
• SenseAiTion.AnnotationChange
• SenseAiTion.AttachmentAnnotation
• SenseAiTion.AttachmentAnnotationValues
• SenseAiTion.AudioPart
• SenseAiTion.BillingInfo
• SenseAiTion.ChecklistKeyword
• SenseAiTion.CommunicationChannel
• SenseAiTion.Converter
• SenseAiTion.Customer
• SenseAiTion.CustomerBaseProduct
• SenseAiTion.CustomerImage
• SenseAiTion.CustomerOption
• SenseAiTion.CustomerProduct
• SenseAiTion.CustomerProductChange
• SenseAiTion.CustomerProductStats
• SenseAiTion.DataPart
• SenseAiTion.DataPartVector
• SenseAiTion.ErrorModel
• SenseAiTion.ExternalTransaction
• SenseAiTion.ExternalTransactionChange
• SenseAiTion.GroupPermissions
• SenseAiTion.GroupUser
• SenseAiTion.InlineObject
• SenseAiTion.InlineResponse200
• SenseAiTion.InlineResponse2001
• SenseAiTion.InlineResponse2002
• SenseAiTion.InlineResponse2003
• SenseAiTion.Invoice
• SenseAiTion.InvoiceDetail
• SenseAiTion.InvoiceResult
• SenseAiTion.Mail
• SenseAiTion.MailActions
• SenseAiTion.MailAttachment
• SenseAiTion.MailTags
• SenseAiTion.MailTemplate
• SenseAiTion.MailTemplateUsage
• SenseAiTion.Messenger
• SenseAiTion.Order
• SenseAiTion.OrderOption
• SenseAiTion.OrderPlace
• SenseAiTion.OrderResult
• SenseAiTion.OrderResultSync
• SenseAiTion.OrderResultWithMotivation
• SenseAiTion.OrderState
• SenseAiTion.OrderStateServices
• SenseAiTion.PermissionsMapping
• SenseAiTion.Person
• SenseAiTion.PersonChange
• SenseAiTion.PersonResult
• SenseAiTion.Preference
• SenseAiTion.PreferencePack
• SenseAiTion.Principal
• SenseAiTion.ProfilingData
• SenseAiTion.ProfilingDataResults
• SenseAiTion.Project
• SenseAiTion.ProjectAnswer
• SenseAiTion.ProjectChange
• SenseAiTion.ProjectOption
• SenseAiTion.ProjectQuestion
• SenseAiTion.Quota
• SenseAiTion.Result
• SenseAiTion.ResultAttachment
• SenseAiTion.ResultChangeData
• SenseAiTion.ResultChangeDataPersonChange
• SenseAiTion.ResultChangeDataTwentyfiveChange
• SenseAiTion.ResultPart
• SenseAiTion.ResultPartWord
• SenseAiTion.ResultSpeakers
• SenseAiTion.Service
• SenseAiTion.ServiceLog
• SenseAiTion.SingleHistoryEntry
• SenseAiTion.TextPart
• SenseAiTion.TwentyFive
• SenseAiTion.TwentyFiveLayer
• SenseAiTion.TwentyFiveLayerVector
• SenseAiTion.User
• SenseAiTion.UserChange
• SenseAiTion.UserGroup
• SenseAiTion.UserGroupChange
• SenseAiTion.UserGroupMember
• SenseAiTion.UserGroupOption
• SenseAiTion.UserOption
• SenseAiTion.ValidObject
• SenseAiTion.Workflow
• SenseAiTion.WorkflowOverview

Documentation for Authorization

APIKeyHeader

• Type: API key
• API key parameter name: X-API-Key
• Location: HTTP header

OTPKeyHeader

• Type: API key
• API key parameter name: X-OTP
• Location: HTTP header

googleFireBase

• Type: OAuth
• Flow: implicit
• Authorization URL: http://www.example.com
• Scopes: N/A