> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt
> Use this file to discover all available pages before exploring further.

# AggregateKMeansRequest

> AggregateKMeansRequest — Kinetica Node.js API

interface AggregateKMeansRequest \{\
&#x20;[column\_names](#column_names): string\[];\
&#x20;[k](#k): number;\
&#x20;[options](#options)?: Record\<string, string>;\
&#x20;[table\_name](#table_name): string;\
&#x20;[tolerance](#tolerance): number;\
}

<ul>
  <li>Defined in [src/types.ts:578](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L578)</li>
</ul>

##### Index

### Properties

[column\_names](#column_names) [k](#k) [options?](#options) [table\_name](#table_name) [tolerance](#tolerance)&#x20;

## Properties

### column\_names

column\_names: string\[]

List of column names on which the operation would be performed. If n columns are provided then each of the k result points will have n dimensions corresponding to the n columns.

<ul>
  <li>Defined in [src/types.ts:582](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L582)</li>
</ul>

### k

k: number

The number of mean points to be determined by the algorithm.

<ul>
  <li>Defined in [src/types.ts:584](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L584)</li>
</ul>

### `Optional`options

options?: Record\<string, string>

Optional parameters.

<ul>
  <li>Defined in [src/types.ts:588](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L588)</li>
</ul>

### table\_name

table\_name: string

Name of the table on which the operation will be performed. Must be an existing table, in \[schema\_name.]table\_name format, using standard name resolution rules.

<ul>
  <li>Defined in [src/types.ts:580](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L580)</li>
</ul>

### tolerance

tolerance: number

Stop iterating when the distances between successive points is less than the given tolerance.

<ul>
  <li>Defined in [src/types.ts:586](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L586)</li>
</ul>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.