Get a Sentence - Cognigy Documentation

GET

v2.0

flows

{flowId}

intents

{intentId}

sentences

{sentenceId}

Get a Sentence

curl --request GET \
  --url https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/intents/{intentId}/sentences/{sentenceId} \
  --header 'Authorization: Bearer <token>' \
  --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>"
}

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

flowId

string

required

The Id of the Flow

Required string length: 24

intentId

string

required

The Id of the Intent

Required string length: 24

sentenceId

string

required

The Id of the Sentence

Required string length: 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.

localeReference

string

Required string length: 24

feedbackReport

object

Show child attributes

text

string

Example:

"I want to buy a pizza."

slots

object[]

Option 1
Option 2
Option 3

Show child attributes

_id

string

Required string length: 24

createdAt

integer

Unix-timestamp

Required range: 0 <= x <= 2147483647

Example:

1694518620

lastChanged

integer

Unix-timestamp

Required range: 0 <= x <= 2147483647

Example:

1694518620

createdBy

string

Required string length: 24

lastChangedBy

string

Required string length: 24

Delete an SentenceDelete an [Sentence](doc:sentence).

⌘I

Get a Sentence

curl --request GET \
  --url https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/intents/{intentId}/sentences/{sentenceId} \
  --header 'Authorization: Bearer <token>' \
  --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>"
}