@sense.ai.tion/senseaition_apideprecated

This_is_the_interface_for_the_sense_ai_tion_services__Everything_working_in_the_WEB_application_of_sense_ai_tion_can_be_done_with_this_API_too__In_fact_the_WEB_application_is_based_on_this_interface_and_doesnt_use_any_other_service__Dont_wait_Get_a_sense_

Usage no npm install needed!

<script type="module">
  import senseAiTionSenseaitionApi from 'https://cdn.skypack.dev/@sense.ai.tion/senseaition_api';
</script>

README

sense_ai_tion_api

SenseAiTionApi - JavaScript client for sense_ai_tion_api 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.1.0
  • Package version: 1.1.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_api --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_api 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 SenseAiTionApi = require('sense_ai_tion_api');

var defaultClient = SenseAiTionApi.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: googleIdToken
var googleIdToken = defaultClient.authentications['googleIdToken'];
googleIdToken.accessToken = "YOUR ACCESS TOKEN"

var api = new SenseAiTionApi.InformationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.health(callback);

Documentation for API Endpoints

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

Class Method HTTP request Description
SenseAiTionApi.InformationApi health GET /health
SenseAiTionApi.InformationApi serviceGet GET /service/{id} gets the description of a service
SenseAiTionApi.InformationApi serviceGetList GET /services gets the list of all services available
SenseAiTionApi.InformationApi simplePing GET /ping ping-pong
SenseAiTionApi.InformationApi versionGet GET /version gets the api version
SenseAiTionApi.InformationApi workflowGet GET /workflow/{id} gets the description of a workflow
SenseAiTionApi.InformationApi workflowGetList GET /workflows gets the description of all defined workflows, currently in the system
SenseAiTionApi.InterfaceApi cuiAnswer GET /cui/answer/{chatSessionID} answers from the conversational user interface
SenseAiTionApi.InterfaceApi cuiQuery POST /cui/query query to the conversational user interface
SenseAiTionApi.OrdersApi orderChangeState PATCH /orders/state/{id} changes the current state of an order
SenseAiTionApi.OrdersApi orderDownloadPart GET /orders/download/{id}/{partid} download a textual or audio part of an order
SenseAiTionApi.OrdersApi orderGet GET /orders/{id} get an order
SenseAiTionApi.OrdersApi orderGetList GET /orders/list gets all orders, using the filter
SenseAiTionApi.OrdersApi orderGetResult GET /orders/result/{id} get the result of an order
SenseAiTionApi.OrdersApi orderGetState GET /orders/state/{id} get the current state of an order
SenseAiTionApi.OrdersApi orderGetTranscript GET /orders/transcript/{id}/{format} get the transcript of an order
SenseAiTionApi.OrdersApi orderUploadPart POST /orders/upload upload a textual or audio part of an order
SenseAiTionApi.OrdersApi ordersPlaceOne POST /orders/place place a new order at the sense.ai.tion cloud system
SenseAiTionApi.OrdersApi personCreate POST /person create a new person
SenseAiTionApi.OrdersApi personDelete DELETE /person/{id} delete/anonymize a person object
SenseAiTionApi.OrdersApi personGet GET /person/{id} get a person object
SenseAiTionApi.OrdersApi personGetList GET /persons list all persons
SenseAiTionApi.OrdersApi personUpdate PATCH /person/{id} update a person object
SenseAiTionApi.ProfileApi customerGet GET /customer gets the customer profile
SenseAiTionApi.ProfileApi projectCreate POST /project creates a new project
SenseAiTionApi.ProfileApi projectDelete DELETE /project/{id} disables the project
SenseAiTionApi.ProfileApi projectGet GET /project/{id} gets the project description
SenseAiTionApi.ProfileApi projectGetList GET /projects gets all project descriptions for the current customer
SenseAiTionApi.ProfileApi projectState GET /project/state/{id} changes the state of a project to active or archived
SenseAiTionApi.ProfileApi projectUpdate PATCH /project/{id} change/updates some values of a project
SenseAiTionApi.ProfileApi userAPIKey GET /user/apikey/{id} adds a new API-Key to the specified user profile
SenseAiTionApi.ProfileApi userCreate POST /user creates a new user profile
SenseAiTionApi.ProfileApi userDelete DELETE /user/{id} disables the user profile
SenseAiTionApi.ProfileApi userGet GET /user/{id} gets the user profile
SenseAiTionApi.ProfileApi userGetCurrent GET /user gets the profile of the authenticated user
SenseAiTionApi.ProfileApi userGetList GET /users lists the user profiles for the current customer
SenseAiTionApi.ProfileApi userUpdate PATCH /user/{id} change/updates some values of an user profile
SenseAiTionApi.StorageApi invoiceGet GET /invoice/{id} get an invoice object
SenseAiTionApi.StorageApi invoiceGetList GET /invoices list all invoices

Documentation for Models

Documentation for Authorization

APIKeyHeader

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

googleIdToken