Keyword

Schema

• A keyword:

  • must be an object

  • must have a text property

  • must have a caseSensitive property

  • must have a score property

  • may have a feedback property

• The text property:

  • must be a string

• The caseSensitive property:

  • must be a boolean

• The score property:

  • must be a number

• The feedback property:

  • must be a string

Examples

Basic

{
  "text": "lorem ipsum",
  "caseSensitive": false,
  "score": 2
}

With feedback

{
  "text": "lorem ipsum",
  "caseSensitive": false,
  "score": 2,
  "feedback": "This is the feedback"
}