Create a new NLUConnector - Cognigy Documentation

POST

v2.0

nluconnectors

Create a new NLUConnector

curl --request POST \
  --url 'https://api-trial.cognigy.ai/new/v2.0/nluconnectors?api_key=' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "New NLUConnector",
  "type": "cognigy",
  "settings": {
    "invocationName": "<string>",
    "reparseAlexaSlots": true,
    "skill": {
      "lastUpdated": "<string>",
      "nameByLocale": {
        "en-US": "<string>",
        "de-DE": "<string>",
        "ja-JP": "<string>",
        "en-GB": "<string>",
        "en-IN": "<string>"
      },
      "skillId": "<string>",
      "stage": "<string>"
    }
  },
  "transformer": {
    "abortOnError": false,
    "transformerStackEnabled": false,
    "transformer": "<string>",
    "preNluTransformerEnabled": false,
    "postNluTransformerEnabled": false,
    "nluCodeTransformerEnabled": false
  },
  "projectId": "<string>"
}
'

{
  "name": "New NLUConnector",
  "type": "cognigy",
  "settings": {
    "invocationName": "<string>",
    "reparseAlexaSlots": true,
    "skill": {
      "lastUpdated": "<string>",
      "nameByLocale": {
        "en-US": "<string>",
        "de-DE": "<string>",
        "ja-JP": "<string>",
        "en-GB": "<string>",
        "en-IN": "<string>"
      },
      "skillId": "<string>",
      "stage": "<string>"
    }
  },
  "transformer": {
    "abortOnError": false,
    "transformerStackEnabled": false,
    "transformer": "<string>",
    "preNluTransformerEnabled": false,
    "postNluTransformerEnabled": false,
    "nluCodeTransformerEnabled": false
  },
  "referenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "_id": "<string>",
  "createdAt": 1694518620,
  "lastChanged": 1694518620,
  "createdBy": "<string>",
  "lastChangedBy": "<string>"
}

Authorizations

X-API-Key

string

header

required

Supply the API Key in the HTTP-Header

api_key

string

query

required

Supply the API Key in the Url-Query

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

enum<string>

The default media type is application/hal+json. Use application/json for pure data results.

Available options:

application/json,

application/hal+json,

application/xml,

text/xml,

text/csv

Query Parameters

resourceId

string

An Id of a resource within the corresponding project to copy from

Required string length: 24

Body

application/json

name

string

The name of the NLUConnector

Example:

"New NLUConnector"

type

enum<string>

The NLUConnector type

Available options:

alexa,

dialogflow,

dialogflowBuiltIn,

amazonLexBuiltIn,

luis,

watson,

noNlu,

cognigy,

code,

generativeAI,

lex

Example:

"cognigy"

settings

object

Settings used by the Alexa NLUConnector

Option 1
Option 2
Option 3
Option 4
Option 5

Show child attributes

settings.invocationName

string

The invocation name of the Alexa skill. Necessary to start Alexa simulations.

settings.reparseAlexaSlots

boolean

Whether to reparse slots from Alexa with our own keyphrase mapper. Used by Alexa.

settings.skill

object

Show child attributes

settings.skill.lastUpdated

string

When the skill was last updated

settings.skill.nameByLocale

object

Gives the name of the skill for different locales

Show child attributes

settings.skill.nameByLocale.en-US

string

settings.skill.nameByLocale.de-DE

string

settings.skill.nameByLocale.ja-JP

string

settings.skill.nameByLocale.en-GB

string

settings.skill.nameByLocale.en-IN

string

settings.skill.skillId

string

The unique id of the skill

settings.skill.stage

string

The current stage of the skills life cycle (e.g. is it in development, production..)

transformer

object

Show child attributes

transformer.abortOnError

string

If true, then we will abort the message processing if the transformer throws an error. Otherwise, we will continue with normal message processing in the event of an error.

Example:

false

transformer.transformerStackEnabled

string

If true, then we will write the transformer stack in the input object, when the channel is adminconsole.

Example:

false

transformer.transformer

string

The transformer object as written by the user. This will be displayed in the UI since it includes typings.

transformer.preNluTransformerEnabled

string

Example:

false

transformer.postNluTransformerEnabled

string

Example:

false

transformer.nluCodeTransformerEnabled

string

Example:

false

projectId

string

Required string length: 24

Response

Returns NLUConnector metadata object.

The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.

name

string

The name of the NLUConnector

Example:

"New NLUConnector"

type

enum<string>

The NLUConnector type

Available options:

alexa,

dialogflow,

dialogflowBuiltIn,

amazonLexBuiltIn,

luis,

watson,

noNlu,

cognigy,

code,

generativeAI,

lex

Example:

"cognigy"

settings

object

Settings used by the Alexa NLUConnector

Option 1
Option 2
Option 3
Option 4
Option 5

Show child attributes

settings.invocationName

string

The invocation name of the Alexa skill. Necessary to start Alexa simulations.

settings.reparseAlexaSlots

boolean

Whether to reparse slots from Alexa with our own keyphrase mapper. Used by Alexa.

settings.skill

object

Show child attributes

settings.skill.lastUpdated

string

When the skill was last updated

settings.skill.nameByLocale

object

Gives the name of the skill for different locales

Show child attributes

settings.skill.nameByLocale.en-US

string

settings.skill.nameByLocale.de-DE

string

settings.skill.nameByLocale.ja-JP

string

settings.skill.nameByLocale.en-GB

string

settings.skill.nameByLocale.en-IN

string

settings.skill.skillId

string

The unique id of the skill

settings.skill.stage

string

The current stage of the skills life cycle (e.g. is it in development, production..)

transformer

object

Show child attributes

transformer.abortOnError

string

If true, then we will abort the message processing if the transformer throws an error. Otherwise, we will continue with normal message processing in the event of an error.

Example:

false

transformer.transformerStackEnabled

string

If true, then we will write the transformer stack in the input object, when the channel is adminconsole.

Example:

false

transformer.transformer

string

The transformer object as written by the user. This will be displayed in the UI since it includes typings.

transformer.preNluTransformerEnabled

string

Example:

false

transformer.postNluTransformerEnabled

string

Example:

false

transformer.nluCodeTransformerEnabled

string

Example:

false

referenceId

string<uuid>

_id

string

Required string length: 24

createdAt

integer

Unix-timestamp

Required range: 0 <= x <= 2147483647

Example:

1694518620

lastChanged

integer

Unix-timestamp

Required range: 0 <= x <= 2147483647

Example:

1694518620

createdBy

string

Required string length: 24

lastChangedBy

string

Required string length: 24

Batch Operations on NLUConnectorsBatch Operations on NLUConnectors.

⌘I

Create a new NLUConnector

curl --request POST \
  --url 'https://api-trial.cognigy.ai/new/v2.0/nluconnectors?api_key=' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "New NLUConnector",
  "type": "cognigy",
  "settings": {
    "invocationName": "<string>",
    "reparseAlexaSlots": true,
    "skill": {
      "lastUpdated": "<string>",
      "nameByLocale": {
        "en-US": "<string>",
        "de-DE": "<string>",
        "ja-JP": "<string>",
        "en-GB": "<string>",
        "en-IN": "<string>"
      },
      "skillId": "<string>",
      "stage": "<string>"
    }
  },
  "transformer": {
    "abortOnError": false,
    "transformerStackEnabled": false,
    "transformer": "<string>",
    "preNluTransformerEnabled": false,
    "postNluTransformerEnabled": false,
    "nluCodeTransformerEnabled": false
  },
  "projectId": "<string>"
}
'

{
  "name": "New NLUConnector",
  "type": "cognigy",
  "settings": {
    "invocationName": "<string>",
    "reparseAlexaSlots": true,
    "skill": {
      "lastUpdated": "<string>",
      "nameByLocale": {
        "en-US": "<string>",
        "de-DE": "<string>",
        "ja-JP": "<string>",
        "en-GB": "<string>",
        "en-IN": "<string>"
      },
      "skillId": "<string>",
      "stage": "<string>"
    }
  },
  "transformer": {
    "abortOnError": false,
    "transformerStackEnabled": false,
    "transformer": "<string>",
    "preNluTransformerEnabled": false,
    "postNluTransformerEnabled": false,
    "nluCodeTransformerEnabled": false
  },
  "referenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "_id": "<string>",
  "createdAt": 1694518620,
  "lastChanged": 1694518620,
  "createdBy": "<string>",
  "lastChangedBy": "<string>"
}

Overview

API

Authorizations

Headers

Query Parameters

Body

Response