SimilaritySearchBody

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	"similarity"	Yes
seedRecordId	string or null	No	Archive similarity record ID, or a natural-language detection record ID with an indexed similarity counterpart. The backend resolves the detection to its similarity embedding.
referenceId	string (uuid) or null	No

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": "similarity",
      "title": "Kind"
    },
    "seedRecordId": {
      "anyOf": [
        {
          "type": "string",
          "minLength": 1
        },
        {
          "type": "null"
        }
      ],
      "title": "Seedrecordid",
      "description": "Archive similarity record ID, or a natural-language detection record ID with an indexed similarity counterpart. The backend resolves the detection to its similarity embedding."
    },
    "referenceId": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid"
        },
        {
          "type": "null"
        }
      ],
      "title": "Referenceid"
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "limit",
    "kind"
  ],
  "title": "SimilaritySearchBody"
}