Update an NLUConnector - Cognigy Documentation

PATCH

v2.0

nluconnectors

{nluConnectorId}

Update an NLUConnector

curl --request PATCH \
  --url https://api-trial.cognigy.ai/new/v2.0/nluconnectors/{nluConnectorId} \
  --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
  }
}'

This response does not have an example.

Authorizations

X-API-Key

string

header

required

Supply the API Key in the HTTP-Header

Authorization

string

header

required

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

api_key

string

query

required

Supply the API Key in the Url-Query

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

Path Parameters

nluConnectorId

string

required

The Id of the NLUConnector

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

transformer

object

Show child attributes

Response

Successfully updated NLUConnector

Resolves the options for a field.Resolves the options for a field.

⌘I

Update an NLUConnector

curl --request PATCH \
  --url https://api-trial.cognigy.ai/new/v2.0/nluconnectors/{nluConnectorId} \
  --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
  }
}'

This response does not have an example.