> ## 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.

# AggregateKMeansResponse

> AggregateKMeansResponse — Kinetica TypeScript API

<div className="kinetica-typedoc">
  <div className="tsd-page-title" />

  <div className="tsd-signature"><span className="tsd-signature-keyword">interface</span> <span className="tsd-kind-interface">AggregateKMeansResponse</span> <span className="tsd-signature-symbol">{"{"}</span><br /> <a className="tsd-kind-property" href="#count">count</a><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">number</span><span className="tsd-signature-symbol">;</span><br /> <a className="tsd-kind-property" href="#counts">counts</a><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">number</span><span className="tsd-signature-symbol">\[]</span><span className="tsd-signature-symbol">;</span><br /> <a className="tsd-kind-property" href="#info">info</a><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">Record</span><span className="tsd-signature-symbol">\<</span><span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">,</span> <span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">></span><span className="tsd-signature-symbol">;</span><br /> <a className="tsd-kind-property" href="#means">means</a><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">number</span><span className="tsd-signature-symbol">\[]</span><span className="tsd-signature-symbol">\[]</span><span className="tsd-signature-symbol">;</span><br /> <a className="tsd-kind-property" href="#num_iters">num\_iters</a><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">number</span><span className="tsd-signature-symbol">;</span><br /> <a className="tsd-kind-property" href="#request_time_secs">request\_time\_secs</a><span className="tsd-signature-symbol">?:</span> <span className="tsd-signature-type">number</span><span className="tsd-signature-symbol">;</span><br /> <a className="tsd-kind-property" href="#rms_dist">rms\_dist</a><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">number</span><span className="tsd-signature-symbol">;</span><br /> <a className="tsd-kind-property" href="#rms_dists">rms\_dists</a><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">number</span><span className="tsd-signature-symbol">\[]</span><span className="tsd-signature-symbol">;</span><br /> <a className="tsd-kind-property" href="#tolerance">tolerance</a><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">number</span><span className="tsd-signature-symbol">;</span><br /><span className="tsd-signature-symbol">{"}"}</span></div>

  <div className="aside tsd-sources">
    <ul>
      <li>Defined in <a href="https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L591">src/types.ts:591</a></li>
    </ul>
  </div>

  <div className="section tsd-panel-group tsd-index-group">
    <div className="section tsd-panel tsd-index-panel">
      <div className="details tsd-index-content tsd-accordion" open="">
        <div className="summary tsd-accordion-summary tsd-index-summary">
          <h5 className="tsd-index-heading uppercase">Index</h5>
        </div>

        <div className="tsd-accordion-details">
          <div className="section tsd-index-section">
            <h3 className="tsd-index-heading tsd-anchor-link" id="properties">Properties</h3>
            <div className="tsd-index-list"><a href="#count" className="tsd-index-link"><span>count</span></a> <a href="#counts" className="tsd-index-link"><span>counts</span></a> <a href="#info" className="tsd-index-link"><span>info</span></a> <a href="#means" className="tsd-index-link"><span>means</span></a> <a href="#num_iters" className="tsd-index-link"><span>num\_iters</span></a> <a href="#request_time_secs" className="tsd-index-link"><span>request\_time\_secs?</span></a> <a href="#rms_dist" className="tsd-index-link"><span>rms\_dist</span></a> <a href="#rms_dists" className="tsd-index-link"><span>rms\_dists</span></a> <a href="#tolerance" className="tsd-index-link"><span>tolerance</span></a> </div>
          </div>
        </div>
      </div>
    </div>
  </div>

  <div className="details tsd-panel-group tsd-member-group tsd-accordion" open="">
    <div className="summary tsd-accordion-summary" data-key="section-Properties">
      <h2 className="tsd-anchor-link" id="properties-1">Properties</h2>
    </div>

    <div className="section">
      <div className="section tsd-panel tsd-member">
        <h3 className="tsd-anchor-link" id="count"><span>count</span></h3>
        <div className="tsd-signature"><span className="tsd-kind-property">count</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">number</span></div>

        <div className="tsd-comment tsd-typography">
          <p>The total count of all the clusters - will be the size of the input table.</p>
        </div>

        <div className="aside tsd-sources">
          <ul>
            <li>Defined in <a href="https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L599">src/types.ts:599</a></li>
          </ul>
        </div>
      </div>

      <div className="section tsd-panel tsd-member">
        <h3 className="tsd-anchor-link" id="counts"><span>counts</span></h3>
        <div className="tsd-signature"><span className="tsd-kind-property">counts</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">number</span><span className="tsd-signature-symbol">\[]</span></div>

        <div className="tsd-comment tsd-typography">
          <p>The number of elements in the cluster closest the corresponding k-means values.</p>
        </div>

        <div className="aside tsd-sources">
          <ul>
            <li>Defined in <a href="https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L595">src/types.ts:595</a></li>
          </ul>
        </div>
      </div>

      <div className="section tsd-panel tsd-member">
        <h3 className="tsd-anchor-link" id="info"><span>info</span></h3>
        <div className="tsd-signature"><span className="tsd-kind-property">info</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">Record</span><span className="tsd-signature-symbol">\<</span><span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">,</span> <span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">></span></div>

        <div className="tsd-comment tsd-typography">
          <p>Additional information.</p>
        </div>

        <div className="aside tsd-sources">
          <ul>
            <li>Defined in <a href="https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L607">src/types.ts:607</a></li>
          </ul>
        </div>
      </div>

      <div className="section tsd-panel tsd-member">
        <h3 className="tsd-anchor-link" id="means"><span>means</span></h3>
        <div className="tsd-signature"><span className="tsd-kind-property">means</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">number</span><span className="tsd-signature-symbol">\[]</span><span className="tsd-signature-symbol">\[]</span></div>

        <div className="tsd-comment tsd-typography">
          <p>The k-mean values found.</p>
        </div>

        <div className="aside tsd-sources">
          <ul>
            <li>Defined in <a href="https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L593">src/types.ts:593</a></li>
          </ul>
        </div>
      </div>

      <div className="section tsd-panel tsd-member">
        <h3 className="tsd-anchor-link" id="num_iters"><span>num\_iters</span></h3>
        <div className="tsd-signature"><span className="tsd-kind-property">num\_iters</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">number</span></div>

        <div className="tsd-comment tsd-typography">
          <p>The number of iterations the algorithm executed before it quit.</p>
        </div>

        <div className="aside tsd-sources">
          <ul>
            <li>Defined in <a href="https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L605">src/types.ts:605</a></li>
          </ul>
        </div>
      </div>

      <div className="section tsd-panel tsd-member">
        <h3 className="tsd-anchor-link" id="request_time_secs"><code className="tsd-tag">Optional</code><span>request\_time\_secs</span></h3>
        <div className="tsd-signature"><span className="tsd-kind-property">request\_time\_secs</span><span className="tsd-signature-symbol">?:</span> <span className="tsd-signature-type">number</span></div>

        <div className="tsd-comment tsd-typography">
          <p>Server-reported request time in seconds, when it sent one</p>
        </div>

        <div className="aside tsd-sources">
          <ul>
            <li>Defined in <a href="https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L609">src/types.ts:609</a></li>
          </ul>
        </div>
      </div>

      <div className="section tsd-panel tsd-member">
        <h3 className="tsd-anchor-link" id="rms_dist"><span>rms\_dist</span></h3>
        <div className="tsd-signature"><span className="tsd-kind-property">rms\_dist</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">number</span></div>

        <div className="tsd-comment tsd-typography">
          <p>The sum of all the rms\_dists - the value the k-means algorithm is attempting to minimize.</p>
        </div>

        <div className="aside tsd-sources">
          <ul>
            <li>Defined in <a href="https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L601">src/types.ts:601</a></li>
          </ul>
        </div>
      </div>

      <div className="section tsd-panel tsd-member">
        <h3 className="tsd-anchor-link" id="rms_dists"><span>rms\_dists</span></h3>
        <div className="tsd-signature"><span className="tsd-kind-property">rms\_dists</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">number</span><span className="tsd-signature-symbol">\[]</span></div>

        <div className="tsd-comment tsd-typography">
          <p>The root mean squared distance of the elements in the cluster for each of the k-means values.</p>
        </div>

        <div className="aside tsd-sources">
          <ul>
            <li>Defined in <a href="https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L597">src/types.ts:597</a></li>
          </ul>
        </div>
      </div>

      <div className="section tsd-panel tsd-member">
        <h3 className="tsd-anchor-link" id="tolerance"><span>tolerance</span></h3>
        <div className="tsd-signature"><span className="tsd-kind-property">tolerance</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">number</span></div>

        <div className="tsd-comment tsd-typography">
          <p>The distance between the last two iterations of the algorithm before it quit.</p>
        </div>

        <div className="aside tsd-sources">
          <ul>
            <li>Defined in <a href="https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L603">src/types.ts:603</a></li>
          </ul>
        </div>
      </div>
    </div>
  </div>
</div>


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