NaturalLanguageSearchBody

Fields

Field	Type	Required	Description and constraints
streamIds	array of string (uuid)	No	default []
startTime	string (date-time) or null	No
endTime	string (date-time) or null	No
limit	integer	Yes	minimum 1.0. maximum 1000.0
kind	"naturalLanguage"	Yes
text	string	Yes	Description compared against automatic standalone color substitutions, or generic object when no supported color occurs. Match scores are relative relevance, not probability. minimum length 1. maximum length 4096

Additional properties are rejected by this schema.

JSON schema

{
  "properties": {
    "streamIds": {
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "type": "array",
      "title": "Streamids",
      "default": []
    },
    "startTime": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "null"
        }
      ],
      "title": "Starttime"
    },
    "endTime": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "null"
        }
      ],
      "title": "Endtime"
    },
    "limit": {
      "type": "integer",
      "maximum": 1000.0,
      "minimum": 1.0,
      "title": "Limit"
    },
    "kind": {
      "type": "string",
      "const": "naturalLanguage",
      "title": "Kind"
    },
    "text": {
      "type": "string",
      "maxLength": 4096,
      "minLength": 1,
      "title": "Text",
      "description": "Description compared against automatic standalone color substitutions, or generic object when no supported color occurs. Match scores are relative relevance, not probability."
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "limit",
    "kind",
    "text"
  ],
  "title": "NaturalLanguageSearchBody"
}