Update a YesNoIntent - Cognigy Documentation

PATCH

v2.0

locales

{localeId}

yesnointents

{intentId}

Update a YesNoIntent

curl --request PATCH \
  --url https://api-trial.cognigy.ai/new/v2.0/locales/{localeId}/yesnointents/{intentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "rules": [
    "this should be a valid rule"
  ],
  "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

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

localeId

string

required

The Id of the Locale

Required string length: 24

intentId

string

required

The Id of the Intent

Required string length: 24

Body

application/json

rules

string[]

The intent rules

Example:

["this should be a valid rule"]

isDisabled

boolean

Response

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

yesIntent

object

Show child attributes

noIntent

object

Show child attributes

rejectIntent

object

Show child attributes

Get SentencesGet 25 [Sentences](https://docs.cognigy.com/ai/nlu/nlu-overview/ml-intents/#example-sentences) in a project by default. To change the default value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results.

⌘I

Update a YesNoIntent

curl --request PATCH \
  --url https://api-trial.cognigy.ai/new/v2.0/locales/{localeId}/yesnointents/{intentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "rules": [
    "this should be a valid rule"
  ],
  "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>"
    ]
  }
}