Help us improve our product documentation on docs.cognigy.com by sharing your thoughts in a quick survey. Your feedback shapes the future of our content!
Help us improve our product documentation on docs.cognigy.com by sharing your thoughts in a quick survey. Your feedback shapes the future of our content!
Get a Sentence
Gets a Sentence from a Yes/No Intent.
curl --request GET \
--url https://api-trial.cognigy.ai/new/v2.0/locales/{localeId}/yesnointents/{intentId}/sentences/{sentenceId} \
--header 'X-API-Key: <api-key>'{
"localeReference": "<string>",
"feedbackReport": {
"findings": [
{
"type": "poorScore"
}
],
"info": {
"trueIntent": "<string>",
"topIntent": "<string>",
"runnerUp": "<string>",
"topScore": 123,
"runnerUpScore": 123,
"difference": 123,
"trueIntentName": "<string>",
"topIntentName": "<string>",
"runnerUpIntentName": "<string>"
}
},
"text": "I want to buy a pizza.",
"slots": [
{
"type": "anySlot",
"name": "<string>",
"start": 123,
"end": 123
}
],
"_id": "<string>",
"createdAt": 1694518620,
"lastChanged": 1694518620,
"createdBy": "<string>",
"lastChangedBy": "<string>"
}Documentation Index
Fetch the complete documentation index at: https://docs.cognigy.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Supply the API Key in the HTTP-Header
Headers
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.
application/json, application/hal+json, application/xml, text/xml, text/csv Path Parameters
The unique identifier for the Locale.
24^[a-z0-9]{24}$The unique identifier for the Intent.
24^[a-z0-9]{24}$The unique identifier for the Example Sentence.
24^[a-z0-9]{24}$Response
Returns Sentence 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.
24^[a-z0-9]{24}$Show child attributes
Show child attributes
The text in the Example Sentence.
"I want to buy a pizza."
The Slot segments in the Example Sentence. Each item defines a start and end indexes, and the Slot type: system-defined or user-defined Slot.
A Slot defined by the start and end indexes in the Example Sentence. The value is the text that appears in the range between the start and end indexes.
- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
24^[a-z0-9]{24}$Unix-timestamp
0 <= x <= 21474836471694518620
Unix-timestamp
0 <= x <= 21474836471694518620
24^[a-z0-9]{24}$24^[a-z0-9]{24}$curl --request GET \
--url https://api-trial.cognigy.ai/new/v2.0/locales/{localeId}/yesnointents/{intentId}/sentences/{sentenceId} \
--header 'X-API-Key: <api-key>'{
"localeReference": "<string>",
"feedbackReport": {
"findings": [
{
"type": "poorScore"
}
],
"info": {
"trueIntent": "<string>",
"topIntent": "<string>",
"runnerUp": "<string>",
"topScore": 123,
"runnerUpScore": 123,
"difference": 123,
"trueIntentName": "<string>",
"topIntentName": "<string>",
"runnerUpIntentName": "<string>"
}
},
"text": "I want to buy a pizza.",
"slots": [
{
"type": "anySlot",
"name": "<string>",
"start": 123,
"end": 123
}
],
"_id": "<string>",
"createdAt": 1694518620,
"lastChanged": 1694518620,
"createdBy": "<string>",
"lastChangedBy": "<string>"
}