clusterprobability-dmx.md

title	ClusterProbability (DMX) | Microsoft Docs
ms.date	06/07/2018
ms.prod	sql
ms.technology	analysis-services
ms.custom	dmx
ms.topic	conceptual
ms.author	owend
ms.reviewer	owend
author	minewiskan

ClusterProbability (DMX)

[!INCLUDEssas-appliesto-sqlas]

Returns the probability that the input case belongs to the specified cluster.

Syntax

  
ClusterProbability([<Node_Caption>])  

Applies To

This function can be used only if the underlying data mining model supports clustering.

Return Type

A scalar value.

Remarks

The following syntax uses the mining model content schema rowset to return the node captions that exist in the mining model.

SELECT NODE_CAPTION FROM <model>.CONTENT  

For more information about using this syntax, see SELECT FROM <model>.CONTENT (DMX). For more information about the mining model content schema rowset, see DMSCHEMA_MINING_MODEL_CONTENT Rowset.

If a <node caption> is not specified, the function returns the probability that the input cases belong to the most likely cluster. Use the Cluster function to return the most likely cluster.

Examples

The following example returns the probability that the specified case exists in the cluster labeled Cluster 2.

SELECT  
  ClusterProbability('Cluster 2')  
From  
  [TM Clustering]  
NATURAL PREDICTION JOIN  
(SELECT 28 AS [Age],  
  '2-5 Miles' AS [Commute Distance],  
  'Graduate Degree' AS [Education],  
  0 AS [Number Cars Owned],  
  0 AS [Number Children At Home]) AS t  

See Also

Cluster (DMX)
Data Mining Extensions (DMX) Function Reference
Functions (DMX)
General Prediction Functions (DMX)