| Argument | Category | Description |
|---|---|---|
| TargetIDColumns | Required | Specifies the names of the columns that comprise the target vector identifier. You must partition the target input table by these columns and specify them with this argument. |
| TargetFeatureColumn | Required | Specifies the name of the column that contains the target vector feature name (for example, the axis of a 3-D vector). An entry with a NULL value in a feature_column is dropped.
|
| TargetValueColumn | Optional | Specifies the name of the column that contains the value for the target vector feature. An entry with a NULL value in a value_column is dropped.
|
| RefIDColumns | Optional | Specifies the names of the columns that comprise the reference vector identifier. The default value is the TargetIDColumns argument value. |
| RefFeatureColumn | Optional | Specifies the name of the column that contains the reference vector feature name. The default value is the TargetFeatureColumn argument value. An entry with a NULL value in a feature_column is dropped.
|
| RefValueColumn | Optional | Specifies the name of the column that contains the value for the reference vector feature. The default value is the TargetValueColumn argument value. An entry with a NULL value in a value_column is dropped.
|
| RefTableSize | Optional | Specifies the size of the reference table. Specify 'LARGE' only if the reference table does not fit in memory. The default value, 'SMALL', allows faster processing. |
| DistanceMeasure | Optional | Specifies the distance measures that the function uses. The default value is 'cosine'. |
| IgnoreMismatch | Optional | Specifies whether to drop mismatched dimensions. The default value is 'true'. If DistanceMeasure is 'cosine', then this argument is 'false'. If you specify 'true', then two vectors with no common features become two empty vectors when only their common features are considered, and the function cannot measure the distance between them. |
| ReplaceInvalid | Optional | Specifies the value to return when the function encounters an infinite value or empty vectors. For custom, you can supply any DOUBLE PRECISION value. The default value is 'PositiveInfinity'. |
| TopK | Optional | Specifies, for each target vector and for each measure, the maximum number of closest reference vectors to include in the output table. For k, you can supply any INTEGER value. The default value is the maximum INTEGER value (2,147,483,647). |
| MaxDistance | Optional | Specifies the maximum distance between a pair of target and reference vectors. If the distance exceeds the threshold, the pair does not appear in the output table. If the DistanceMeasure argument specifies multiple measures, then the MaxDistance argument must specify a threshold for each measure. The ith threshold corresponds to the ith measure. Each threshold can be any DOUBLE PRECISION value. If you omit this argument, then the function returns all results. |