voicebase-v-2-beta-rest-api
Advanced tools
Changelog
0.0.1 - 2014-12-19
Readme
Browser and node module for making API requests against Voicebase /v2-beta REST API.
Please note: This module uses Popsicle to make API requests. Promises must be supported or polyfilled on all target environments.
npm install voicebase-v-2-beta-rest-api --save
bower install voicebase-v-2-beta-rest-api --save
var VoicebaseV2BetaRestApi = require('voicebase-v-2-beta-rest-api');
var client = new VoicebaseV2BetaRestApi();
<script src="voicebase-v-2-beta-rest-api/index.js">
<script>
var client = new window.VoicebaseV2BetaRestApi();
</script>
You can set options when you initialize a client or at any time with the options property. You may also override options for a single request by passing an object as the second argument of any request method. For example:
var client = new VoicebaseV2BetaRestApi({ ... });
client.options = { ... };
client.resource('/').get(null, {
baseUri: 'http://example.com',
headers: {
'Content-Type': 'application/json'
}
});
You can override the base URI by setting the baseUri property, or initializing a client with a base URI. For example:
new VoicebaseV2BetaRestApi({
baseUri: 'https://example.com'
});
If the base URI has parameters inline, you can set them by updating the baseUriParameters property. For example:
client.options.baseUriParameters.version = 'v2-beta';
All methods return a HTTP request instance of Popsicle, which allows the use of promises (and streaming in node).
Collection of all media and associated analytical results.
var resource = client.resources.media;
Retrieve from the media colection.
resource.get().then(function (res) { ... });
resource.get({ ... });
A unique identifier in an external system, set in metadata on POST.
Upload new new media to the service as an attachment or from a url.
resource.post().then(function (res) { ... });
multipart/form-data
{
"media": [
{
"description": "Media file attached to the request.",
"type": "file",
"required": true,
"repeat": false,
"displayName": "media"
},
{
"description": "URL where media file can be downloaded.",
"type": "string",
"required": true,
"repeat": false,
"displayName": "media"
}
],
"configuration": {
"description": "A JSON object with configuration options.\n",
"type": "file",
"required": false,
"repeat": false,
"example": "{\n \"configuration\" : { \n \"template\" : {\n \"name\" : \"default\"\n },\n \"transcripts\" : {\n \"vocabularies\" : [\n\n {\n \"name\": \"earningsCalls\"\n },\n {\n \"terms\" : [\n \"Bob Okunski\",\n \"Chuck Boynton\",\n \"Tom Werner\"\n ]\n }\n\n ]\n },\n \"keywords\" : {\n \"groups\" : [ \"mobile-phone\" ]\n },\n \"predictions\" : {\n \"models\" : {\n \"sales-lead\" : {\n \"output\" : \"extended.sales-followup\"\n },\n \"not-a-sales-lead\" : {\n \"output\" : \"extended.sales-ignore\"\n }\n }\n },\n \"publish\" : {\n \"callbacks\" : [\n \"https://api.example.org/callbacks/{mediaId}\"\n ]\n }\n }\n}\n",
"displayName": "configuration"
},
"metadata": {
"description": "Metadata about the file being posted.",
"type": "file",
"required": false,
"repeat": false,
"example": "{\n \"metadata\": {\n \"external\" : {\n \"id\" : \"abc12312321412342315324563443\"\n },\n \"extended\" : {\n \"customer\" : \"John Doe\",\n \"channel\" : \"1 (800) EXAMPLE\",\n \"IVR\" : [ \"existing customer\", \"account services\", \"change my address\" ]\n }\n }\n}\n",
"displayName": "metadata"
},
"transcript": {
"description": "attached transcript",
"type": "file",
"required": false,
"repeat": false,
"displayName": "transcript"
}
}
Media item and associated analytical results.
var resource = client.resources.media.mediaId(mediaId);
Get this media item and associated analytics.
resource.get().then(function (res) { ... });
Delete this media.
resource.delete().then(function (res) { ... });
Upload new configuration, metadata and/or transcript for re-processing of a media document.
resource.post().then(function (res) { ... });
multipart/form-data
{
"configuration": {
"description": "A JSON object with configuration options.\n",
"type": "file",
"required": false,
"repeat": false,
"example": "{\n \"configuration\" : { \n \"template\" : {\n \"name\" : \"default\"\n },\n \"transcripts\" : {\n \"vocabularies\" : [\n\n {\n \"name\": \"earningsCalls\"\n },\n {\n \"terms\" : [\n \"Bob Okunski\",\n \"Chuck Boynton\",\n \"Tom Werner\"\n ]\n }\n\n ]\n },\n \"keywords\" : {\n \"groups\" : [ \"mobile-phone\" ]\n },\n \"predictions\" : {\n \"models\" : {\n \"sales-lead\" : {\n \"output\" : \"extended.sales-followup\"\n },\n \"not-a-sales-lead\" : {\n \"output\" : \"extended.sales-ignore\"\n }\n }\n },\n \"publish\" : {\n \"callbacks\" : [\n \"https://api.example.org/callbacks/{mediaId}\"\n ]\n }\n }\n}\n",
"displayName": "configuration"
},
"metadata": {
"description": "Metadata about the file being posted.",
"type": "file",
"required": false,
"repeat": false,
"example": "{\n \"metadata\": {\n \"external\" : {\n \"id\" : \"abc12312321412342315324563443\"\n },\n \"extended\" : {\n \"customer\" : \"John Doe\",\n \"channel\" : \"1 (800) EXAMPLE\",\n \"IVR\" : [ \"existing customer\", \"account services\", \"change my address\" ]\n }\n }\n}\n",
"displayName": "metadata"
},
"transcript": {
"description": "attached transcript",
"type": "file",
"required": false,
"repeat": false,
"displayName": "transcript"
}
}
Collection of transcripts available for this media item.
var resource = client.resources.media.mediaId(mediaId).transcripts;
Get available transcripts.
resource.get().then(function (res) { ... });
var resource = client.resources.media.mediaId(mediaId).transcripts.transcriptId(transcriptId);
Get a specific transcript.
resource.get().then(function (res) { ... });
Collection of processing phases.
var resource = client.resources.media.mediaId(mediaId).progress;
Get progress phases.
resource.get().then(function (res) { ... });
Streaming formats for uploaded media.
var resource = client.resources.media.mediaId(mediaId).streams;
Get available media URLs.
resource.get().then(function (res) { ... });
Redirects to the original version of the file.
var resource = client.resources.media.mediaId(mediaId).streams.original;
resource.get().then(function (res) { ... });
resource.get({ ... });
Used to send a valid OAuth 2 Bearer token.
The metadata for the media item.
var resource = client.resources.media.mediaId(mediaId).metadata;
Get the media metadata.
resource.get().then(function (res) { ... });
Update the media metadata.
resource.put().then(function (res) { ... });
application/json
Allows definition of complex behaviors or reusable data sets.
var resource = client.resources.definitions;
resource.get().then(function (res) { ... });
var resource = client.resources.definitions.keywords;
Get definition types for keywords.
resource.get().then(function (res) { ... });
Define keyword groups for spotting important topics.
var resource = client.resources.definitions.keywords.groups;
Get all defined keyword groups.
resource.get().then(function (res) { ... });
A group of a set of related keywords.
var resource = client.resources.definitions.keywords.groups.groupId(groupId);
Get the keyword group.
resource.get().then(function (res) { ... });
Create or update group from a set of keywords.
resource.put().then(function (res) { ... });
application/json
Delete this keyword group.
resource.delete().then(function (res) { ... });
var resource = client.resources.definitions.transcripts;
Get definition types for transcripts.
resource.get().then(function (res) { ... });
Define custom vocabularies for more accurate transcription.
var resource = client.resources.definitions.transcripts.vocabularies;
Get all defined custom vocabularies.
resource.get().then(function (res) { ... });
A custom vocabulary based on a set of documents or recordings.
var resource = client.resources.definitions.transcripts.vocabularies.vocabularyId(vocabularyId);
Get the custom vocabulary.
resource.get().then(function (res) { ... });
Create a custom vocabulary from a set of media.
resource.put().then(function (res) { ... });
application/json
Delete this custom vocabulary.
resource.delete().then(function (res) { ... });
var resource = client.resources.definitions.media;
Get definition types for media.
resource.get().then(function (res) { ... });
Define extended metadata searchable fields.
var resource = client.resources.definitions.media.search;
Get searchable fields.
resource.get().then(function (res) { ... });
Create or update custom parameters of metadata for search.
resource.put().then(function (res) { ... });
application/json
var resource = client.resources.definitions.predictions;
Get definition types for predictions.
resource.get().then(function (res) { ... });
Retrieve available predicitive models.
var resource = client.resources.definitions.predictions.models;
Get all available predictive models.
resource.get().then(function (res) { ... });
A predictive model.
var resource = client.resources.definitions.predictions.models.modelName(modelName);
Get the predictive model.
resource.get().then(function (res) { ... });
Manage profile keys.
var resource = client.resources.profile;
Profile keys operations.
resource.get().then(function (res) { ... });
var resource = client.resources.profile.keys;
Returns all current Api keys for current user.
resource.get().then(function (res) { ... });
Create a new Api key for the current user.
resource.post().then(function (res) { ... });
application/json
var resource = client.resources.profile.keys.keyId(keyId);
Get information about this Api key.
resource.get().then(function (res) { ... });
Delete and revoke this Api key.
resource.delete().then(function (res) { ... });
You can make requests to a custom path in the API using the #resource(path) method.
client.resource('/example/path').get();
Apache 2.0
FAQs
Browser and node module for making API requests against [Voicebase /v2-beta REST API](https://apis.voicebase.com/v2-beta).
We found that voicebase-v-2-beta-rest-api demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.
Security News
Socket is joining forces with CISA and other industry leaders at the RSA Conference to sign the Secure by Design pledge, committing to uphold the highest security standards in our products.
Research
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.