Train Yes/No Intents - Cognigy Documentation

Documentation Index

Fetch the complete documentation index at: /llms.txt

Use this file to discover all available pages before exploring further.

POST

/ v2.0 / locales / {localeId} / yesnointents / train

Train Yes/No Intents

cURL

curl --request POST \
  --url https://api-trial.cognigy.ai/new/v2.0/locales/{localeId}/yesnointents/train \
  --header 'X-API-Key: <api-key>'

Python

import requests

url = "https://api-trial.cognigy.ai/new/v2.0/locales/{localeId}/yesnointents/train"

headers = {"X-API-Key": "<api-key>"}

response = requests.post(url, headers=headers)

print(response.text)

JavaScript

const options = {method: 'POST', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api-trial.cognigy.ai/new/v2.0/locales/{localeId}/yesnointents/train', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

PHP

$curl = curl_init();

curl_setopt_array($curl, [\
  CURLOPT_URL => "https://api-trial.cognigy.ai/new/v2.0/locales/{localeId}/yesnointents/train",\
  CURLOPT_RETURNTRANSFER => true,\
  CURLOPT_ENCODING => "",\
  CURLOPT_MAXREDIRS => 10,\
  CURLOPT_TIMEOUT => 30,\
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\
  CURLOPT_CUSTOMREQUEST => "POST",\
  CURLOPT_HTTPHEADER => [\
    "X-API-Key: <api-key>"\
  ],\
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Go

package main

import (
    "fmt"
    "net/http"
    "io"
)

func main() {

url := "https://api-trial.cognigy.ai/new/v2.0/locales/{localeId}/yesnointents/train"

req, _ := http.NewRequest("POST", url, nil)

req.Header.Add("X-API-Key", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
    body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))
}

Responses

Status Code Description
202 Successfully created Tasks to train YesNoIntents.
400 Bad Request Error
401 Unauthorized Error
402 Payment Required Error
403 Forbidden Error
404 Not Found Error
500 Internal Server Error

Example Response

[\
  {\
    "_id": "<string>",\
    "status": "queued",\
    "type": "trainIntents",\
    "parameters": {},\
    "lastChangedAt": 1594243850,\
    "lastCreatedAt": 1594243850,\
    "currentStep": 0,\
    "totalStep": 100\
  }\
]

{\
  "type": "Bad Request",\
  "title": "Bad Request Error",\
  "status": 400,\
  "detail": "Validation failed. Missing payload.",\
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",\
  "code": 1000,\
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",\
  "details": {}\
}

Authorizations

X-API-Key