Use these APIs to retrieve information about your aiWARE engines or control engine access.
Enumerate cognition engine categories
Lists the predefined cognition engine categories.
Example
query enumerateCognitionEngineCategories {
engineCategories(type:"Cognition") {
records {
categoryType
totalEngines
id
description
type {
name
}
}
}
}
Response
{
"data": {
"engineCategories": {
"records": [
{
"categoryType": "transcode",
"totalEngines": 101,
"id": "581dbb32-ea5b-4458-bd15-8094942345e3",
"description": "Converts incoming data formats to another.",
"type": {
"name": "Cognition"
}
},
{
"categoryType": "transcript",
"totalEngines": 4693,
"id": "67cd4dd0-2f75-445d-a6f0-2f297d6cd182",
"description": "Converts speech audio to text.",
"type": {
"name": "Cognition"
}
},
{
"categoryType": "sentiment",
"totalEngines": 134,
"id": "f2554098-f14b-4d81-9be1-41d0f992a22f",
"description": "Classifies text according to sentiment. May include a score representing negative, neutral, or positive or include a wider breadth of tags such as "happy" or "excited."",
"type": {
"name": "Cognition"
}
},
{
"categoryType": "fingerprint",
"totalEngines": 178,
"id": "17d62b84-8b49-465b-a6be-fe3ea3bc8f05",
"description": "Recognizes a specific audio segment, e.g., a radio advertisement, as it appears in a longer audio file or on its own.",
"type": {
"name": "Cognition"
}
},
{
"categoryType": "face",
"totalEngines": 542,
"id": "6faad6b7-0837-45f9-b161-2f6bf31b7a07",
"description": "Detects the presence of one or multiple faces in an image or video and associates each individual's face with their name.",
"type": {
"name": "Cognition"
}
},
{
"categoryType": "object",
"totalEngines": 609,
"id": "088a31be-9bd6-4628-a6f0-e4004e362ea0",
"description": "Detects one or multiple objects or concepts in an image or video from a general/broad ontology, e.g., "car" or "person."",
"type": {
"name": "Cognition"
}
},
{
"categoryType": "translate",
"totalEngines": 491,
"id": "3b2b2ff8-44aa-4db4-9b71-ff96c3bf5923",
"description": "Translates natural language from a text source. Includes translating plain text, rich text, extracted text, recognized text(OCR), and transcripts.",
"type": {
"name": "Cognition"
}
},
{
"categoryType": "audio",
"totalEngines": 62,
"id": "c6e07fe3-f15f-48a7-8914-951b852d54d0",
"description": "Detects characteristics of sound, including alarms, breaking glass, gunshots, and more within audio.",
"type": {
"name": "Cognition"
}
},
{
"categoryType": "music",
"totalEngines": 0,
"id": "c96b5d0e-3ce1-4fd7-9c38-d25ddef87a5f",
"description": "Identifies the music playing in the background of media content.",
"type": {
"name": "Cognition"
}
},
{
"categoryType": "geolocation",
"totalEngines": 21,
"id": "203ad7c2-3dbd-45f9-95a6-855f911563d0",
"description": "Identifies the geographic location of a person or object in the real world or some virtual equivalent.",
"type": {
"name": "Cognition"
}
},
{
"categoryType": "stationPlayout",
"totalEngines": 1,
"id": "935c4838-dcf6-415c-99c4-5ceb0a8944be",
"description": "Finds ads and songs for radio station mentions using 3rd party data.",
"type": {
"name": "Cognition"
}
},
{
"categoryType": "ocr",
"totalEngines": 150,
"id": "3b4ac603-9bfa-49d3-96b3-25ca3b502325",
"description": "AKA Optical Character Recognition. Converts alphanumeric characters in a document, image, or video to text.",
"type": {
"name": "Cognition"
}
},
{
"categoryType": "logo",
"totalEngines": 80,
"id": "5a511c83-2cbd-4f2d-927e-cd03803a8a9c",
"description": "Recognizes one or more logos or branding elements in an image or video.",
"type": {
"name": "Cognition"
}
},
{
"categoryType": "utility",
"totalEngines": 30,
"id": "f951fbf9-aa69-47a2-87c8-12dfb51a1f18",
"description": "Miscellaneous utility engines for cognition.",
"type": {
"name": "Cognition"
}
},
{
"categoryType": "speech",
"totalEngines": 32,
"id": "09f48865-c9e5-47b9-be79-8581047477c4",
"description": "Turns text into lifelike speech.",
"type": {
"name": "Cognition"
}
},
{
"categoryType": "correlation",
"totalEngines": 106,
"id": "a70df3f6-84a7-4570-b8f4-daa122127e37",
"description": "Associates two data products based on some commonality, such as occurrence over time. For example, may associate weather data on a given date with stock prices on that date.",
"type": {
"name": "Cognition"
}
},
{
"categoryType": "voice",
"totalEngines": 6,
"id": "19bfa716-309a-41dc-9dac-d07a1e7008cd",
"description": "Detects and identifies multiple voices within rich media content.",
"type": {
"name": "Cognition"
}
},
{
"categoryType": "workflow",
"totalEngines": 168208,
"id": "c5458876-43d2-41e8-a340-f734702df04a",
"description": "Executes business rules on a scheduled, event-driven, or manually triggered basis.",
"type": {
"name": "Cognition"
}
},
{
"categoryType": "speaker",
"totalEngines": 266,
"id": "a856c447-1030-4fb0-917f-08179f949c4e",
"description": "AKA Speaker Separation, Diarization. Partitions an input audio stream into segments according to who is speaking when.",
"type": {
"name": "Cognition"
}
},
{
"categoryType": "document",
"totalEngines": 100,
"id": "ba2a423e-99c9-4422-b3a5-0b188d8388ab",
"description": "Extracts textual information from documents, and expresses that extracted text in a structured format.",
"type": {
"name": "Cognition"
}
},
{
"categoryType": "entity",
"totalEngines": 42,
"id": "a9fa3b20-96ab-44ce-86bc-7694a3b01d82",
"description": "AKA Named-entity recognition. Classifies named entities located in unstructured text into predefined categories such as people, organizations, and locations.",
"type": {
"name": "Cognition"
}
},
{
"categoryType": "alpr",
"totalEngines": 38,
"id": "efb9867a-4349-42a3-9277-71fd4ad701a9",
"description": "Produces a text string of alphanumeric characters for each license plate recognized in an image or video.",
"type": {
"name": "Cognition"
}
},
{
"categoryType": "concept",
"totalEngines": 58,
"id": "0481ff76-00c5-4e2d-b73d-2e3aaeef79eb",
"description": "Categorizes one or multiple documents according to a pre-defined ontology.",
"type": {
"name": "Cognition"
}
},
{
"categoryType": "keyword",
"totalEngines": 6536,
"id": "6c772d3b-6f40-4d85-a672-ddb75dbae0a4",
"description": "Identifies key terms and/or phrases that appear in documents, based on parts of speech, salience, or other criteria.",
"type": {
"name": "Cognition"
}
},
{
"categoryType": "language",
"totalEngines": 20,
"id": "975f846e-79e6-4ead-8a49-23f02a5d068a",
"description": "Detects one or multiple natural languages in text.",
"type": {
"name": "Cognition"
}
},
{
"categoryType": "summary",
"totalEngines": 12,
"id": "24ffd12d-fcda-4f47-8843-b2e5dbfbb01f",
"description": "Generates a readable summary of a given piece of text.",
"type": {
"name": "Cognition"
}
},
{
"categoryType": "reducer",
"totalEngines": 3,
"id": "70e54f46-7586-4ff1-876c-5f918357aec6",
"description": "Combines engine outputs from multiple segments.",
"type": {
"name": "Cognition"
}
},
{
"categoryType": "human",
"totalEngines": 13,
"id": "3b3cfe77-da94-4362-9ac2-3ed89747a68b",
"description": "Tasks to be performed by humans.",
"type": {
"name": "Cognition"
}
},
{
"categoryType": null,
"totalEngines": 26,
"id": "d110089c-9a95-4dee-8411-b79472a0be50",
"description": "Automate Flows and Engines used for Alteryx Integration.",
"type": {
"name": "Cognition"
}
}
]
}
}
}
List available engines
Lists all of the available engines.
[Tip] This sample query uses limit: 1000. As a best practice, use a lower limit. To paginate through the list of engines use the offset parameter until you receive an empty list.
Example
query listEngines {
engines(limit: 1000) {
count
records {
id
name
category {
id
name
}
fields {
name
type
max
min
step
info
label
defaultValue
options {
key
value
}
}
}
}
}
List available engines and associated categories
Lists engines categories and their associated available engines.
[Note] The list of available engines in the aiWARE OS is constantly growing. This list also depends on the user's permissions.
The fields property on the engines defines the set of input parameters the engine accepts.
Example
query {
engineCategories {
records {
id
name
engines(limit: 200) {
records {
id
name
fields {
name
options {
value
}
}
}
}
}
}
}
Response
{
"data": {
"engineCategories": {
"records": [
{
"id": "3b2b2ff8-44aa-4db4-9b71-ff96c3bf5923",
"name": "Translate",
"engines": {
"records": [
{
"id": "6f47f6d4-57e0-4c2c-9f4f-a3e95e7a725e",
"name": "Translate - D",
"fields": []
},
{
"id": "388d951e-c90c-f001-9d6b-8bb70b9e6267",
"name": "Jupiter",
"fields": [
{
"name": "target",
"type": "Picklist",
"options": [
{
"value": "en"
},
{
"value": "af"
},
{
"value": "ar"
}
...
To test how these various options behave, you can run engines against media. In Data Center, click the title of a media file. Click Run Cognitive Engine. On the Processing Page, click Advanced Cognitive Workflow and then choose from the Available Engines options.
To limit a returned dataset, specify a particular engine category or search by engine name.
Example
query {
engines(name: "Supernova", categoryId: "67cd4dd0-2f75-445d-a6f0-2f297d6cd182") {
records {
id
name
}
}
}
Response
{
"data": {
"engines": {
"records": [
{
"id": "906b4561-5c53-1d3b-6038-aff9c153545c",
"name": "Supernova-Russian"
},
{
"id": "3cbc180c-0b60-25f5-a850-c06d71f89e30",
"name": "Supernova-Japanese"
}
]
}
}
}
The engine IDs return what are submitted as the engineId in task definitions.
The returned fields specify the keys and values to submit as the payload in the task definitions.
List available engines (grouped by category)
Lists the available engines in groups based on categories.
[Tip] This sample query uses limit: 1000. As a best practice, use a lower limit. To paginate through the list of engines use the offset parameter until you receive an empty list.
query listEnginesByCategory {
engineCategories {
records {
id
name
engines(limit: 1000) {
records {
id
name
fields {
name
options {
value
}
}
}
}
}
}
}
List available engine categories
Lists the categories that are available for engines.
Example
query listEngineCategories {
engineCategories {
records {
id
name
description
}
}
}
List engines for a specific category
Lists engines within a specific category.
[Tip] This sample query uses limit: 1000. As a best practice, use a lower limit. To paginate through the list of engines use the offset parameter until you receive an empty list.
Example
query listEnginesForCategory {
engines(category: "transcription", limit: 1000) {
count
records {
id
name
fields {
name
type
max
min
step
info
label
defaultValue
options {
key
value
}
}
}
}
}
List engine's custom fields
Lists the customs fields for an engine based on a specified ID.
Example
query engineCustomFields {
engine(id: "b396fa74-83ff-4052-88a7-c37808a25673") {
id
fields {
type
name
defaultValue
info
options {
key
value
}
}
}
}
Add engines to allowlist
Add engines to the allowlist. The engine allowlist is a list of users within an organization that determines which users can search, view, and use a set of engines available to the organization. aiWARE manages these lists in accordance with the organization's needs.
[Note] This operation requires elevated rights in the system.
mutation addToWhiteList {
addToEngineWhitelist(toAdd:{
organizationId:13456
engineIds:["<engine Id>","<engine2 Id>"]
}){
organizationId
engines{
name
id
}
}
}
More API examples
