Skip to main content
PATCH
/
v2.0
/
locales
/
{localeId}
/
yesnointents
/
{intentId}
Update a Yes/No Intent
curl --request PATCH \
  --url https://api-trial.cognigy.ai/new/v2.0/locales/{localeId}/yesnointents/{intentId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "rules": "[ci.text.includes(\"indeed\"), ci.text.includes(\"roger that\")]",
  "isDisabled": true
}
'
{
  "yesIntent": {
    "isDisabled": true,
    "name": "pizza",
    "_id": "<string>",
    "rules": [
      "<string>"
    ]
  },
  "noIntent": {
    "isDisabled": true,
    "name": "pizza",
    "_id": "<string>",
    "rules": [
      "<string>"
    ]
  },
  "rejectIntent": {
    "isDisabled": true,
    "name": "pizza",
    "_id": "<string>",
    "rules": [
      "<string>"
    ]
  }
}

Authorizations

X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

Headers

Accept
enum<string>

The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.

Available options:
application/json,
application/hal+json,
application/xml,
text/xml,
text/csv

Path Parameters

localeId
string
required

The unique identifier for the Locale.

Required string length: 24
Pattern: ^[a-z0-9]{24}$
intentId
string
required

The unique identifier for the Intent.

Required string length: 24
Pattern: ^[a-z0-9]{24}$

Body

application/json

The payload for updating Yes/No Intent metadata.

rules
string[]

A CognigyScript expression that is evaluated to determine if the Yes/No Intent is applicable. If the CognigyScript is evaluated as true, the Intent is recognized.

Example:

"[ci.text.includes(\"indeed\"), ci.text.includes(\"roger that\")]"

isDisabled
boolean

If set to true, the Yes/No Intent is deactivated.

Response

Returns an object containing the yesIntent, noIntent, rejectIntent for the given locale

yesIntent
object
noIntent
object
rejectIntent
object