Nuix · Schema

ClusterRunResponse

Schema for ClusterRunResponse in Nuix REST API

ForensicseDiscoveryInvestigationsComplianceData ProcessingLegal TechnologyIntelligence

Properties

Name Type Description
guid string The GUID of the cluster run.
clusterName string The name of the cluster run.
clusters array A list of all clusters associated with this cluster run.
resemblanceThreshold number Gets the resemblance threshold associated with the cluster run, irrespective of what clustering options are set.
useChainedNearDuplicatesEnabled boolean Gets whether or not chained near-duplicates were used during clustering.
useEmailThreadsEnabled boolean Gets whether or not email threads were used during clustering.
View JSON Schema on GitHub

JSON Schema

nuix-rest-clusterrunresponse.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/nuix/refs/heads/main/json-schema/nuix-rest-clusterrunresponse.json",
  "title": "ClusterRunResponse",
  "description": "Schema for ClusterRunResponse in Nuix REST API",
  "type": "object",
  "properties": {
    "guid": {
      "type": "string",
      "description": "The GUID of the cluster run."
    },
    "clusterName": {
      "type": "string",
      "description": "The name of the cluster run."
    },
    "clusters": {
      "type": "array",
      "description": "A list of all clusters associated with this cluster run.",
      "items": {
        "type": "string"
      }
    },
    "resemblanceThreshold": {
      "type": "number",
      "description": "Gets the resemblance threshold associated with the cluster run, irrespective of what clustering options are set.",
      "format": "float"
    },
    "useChainedNearDuplicatesEnabled": {
      "type": "boolean",
      "description": "Gets whether or not chained near-duplicates were used during clustering."
    },
    "useEmailThreadsEnabled": {
      "type": "boolean",
      "description": "Gets whether or not email threads were used during clustering."
    }
  }
}