NaturalLanguageLiveSearchBody

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
durationSeconds	number or null	No
trackAlertCooldownSeconds	number	No	minimum 0.0. maximum 86400.0. default 5
alertThreshold	number	No	minimum -1.0. maximum 1.0. default 0.8
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
className	string or null	No
genetecEventId	integer or null	No	Optional Genetec custom event delivered by the server for accepted live matches.

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"
    },
    "durationSeconds": {
      "anyOf": [
        {
          "type": "number",
          "maximum": 31536000.0,
          "exclusiveMinimum": 0.0
        },
        {
          "type": "null"
        }
      ],
      "title": "Durationseconds"
    },
    "trackAlertCooldownSeconds": {
      "type": "number",
      "maximum": 86400.0,
      "minimum": 0.0,
      "title": "Trackalertcooldownseconds",
      "default": 5
    },
    "alertThreshold": {
      "type": "number",
      "maximum": 1.0,
      "minimum": -1.0,
      "title": "Alertthreshold",
      "default": 0.8
    },
    "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."
    },
    "className": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 128,
          "minLength": 1
        },
        {
          "type": "null"
        }
      ],
      "title": "Classname"
    },
    "genetecEventId": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 2147483647.0,
          "minimum": 1.0
        },
        {
          "type": "null"
        }
      ],
      "title": "Geneteceventid",
      "description": "Optional Genetec custom event delivered by the server for accepted live matches."
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "kind",
    "text"
  ],
  "title": "NaturalLanguageLiveSearchBody"
}