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

# GetGraphEntitiesResponse

> GetGraphEntitiesResponse — 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">GetGraphEntitiesResponse</span> <span className="tsd-signature-symbol">{"{"}</span><br /> <a className="tsd-kind-property" href="#entities_double">entities\_double</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="#entities_int">entities\_int</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="#entities_string">entities\_string</a><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="#entities_weight">entities\_weight</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="#labels">labels</a><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="#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="#result">result</a><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">boolean</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#L3097">src/types.ts:3097</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="#entities_double" className="tsd-index-link"><span>entities\_double</span></a> <a href="#entities_int" className="tsd-index-link"><span>entities\_int</span></a> <a href="#entities_string" className="tsd-index-link"><span>entities\_string</span></a> <a href="#entities_weight" className="tsd-index-link"><span>entities\_weight</span></a> <a href="#info" className="tsd-index-link"><span>info</span></a> <a href="#labels" className="tsd-index-link"><span>labels</span></a> <a href="#request_time_secs" className="tsd-index-link"><span>request\_time\_secs?</span></a> <a href="#result" className="tsd-index-link"><span>result</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="entities_double"><span>entities\_double</span></h3>
        <div className="tsd-signature"><span className="tsd-kind-property">entities\_double</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>Compact double-packed payload for WKT (geo/XY) graphs. WKT graphs ALWAYS use this array — 'POINT(x y)' strings are never emitted anywhere. Stride 3 for nodes: \[x, y, label\_index, ...]. Stride 6 for edges (non-concise): \[edge\_id, x0, y0, x1, y1, label\_index, ...]. Empty for non-WKT graphs and when concise mode emits edges into <code>entities\_int</code> instead. label\_index/edge\_id occupy double slots (representable exactly up to 2^53). When 'concise\_edge\_connectivity' is 'true' and entity\_type is 'node', tombstoned (deleted) WKT slots emit \[0.0, 0.0, 0.0] to keep position indices stable. Roughly 4x smaller on the wire than 'POINT(x y)' strings and avoids any client-side regex parse.</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#L3105">src/types.ts:3105</a></li>
          </ul>
        </div>
      </div>

      <div className="section tsd-panel tsd-member">
        <h3 className="tsd-anchor-link" id="entities_int"><span>entities\_int</span></h3>
        <div className="tsd-signature"><span className="tsd-kind-property">entities\_int</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>Flat array of entity data for integer-identifier graphs with a repeating stride. For node entities (stride 2): \[node\_id, label\_index, ...]. For edge entities (stride 4): \[edge\_id, node1\_id, node2\_id, label\_index, ...]. Populated when the graph uses integer identifiers; empty otherwise. The label\_index is a 1-based index into the <code>labels</code> array; 0 indicates no label. When the request option 'concise\_edge\_connectivity' is 'true', this array is also used (regardless of graph identifier type) for edge entities and carries \[edge\_id, node1\_index, node2\_index, edge\_label\_index] where node1\_index/node2\_index are 0-based positions into the node array returned from a paired node call on the same graph.</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#L3101">src/types.ts:3101</a></li>
          </ul>
        </div>
      </div>

      <div className="section tsd-panel tsd-member">
        <h3 className="tsd-anchor-link" id="entities_string"><span>entities\_string</span></h3>
        <div className="tsd-signature"><span className="tsd-kind-property">entities\_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>Flat array of entity data for name-identifier (string) graphs only. For node entities (stride 2): \[node\_name, label\_index, ...]. For edge entities (stride 4): \[edge\_id, node1\_name, node2\_name, label\_index, ...]. Populated only when the graph uses string identifiers. Empty for integer-identifier graphs (data goes to <code>entities\_int</code>) and for WKT/geo-XY graphs (data always goes to <code>entities\_double</code> — 'POINT(x y)' strings are never emitted). The label\_index is a string representation of a 1-based index into the <code>labels</code> array; '0' indicates no label.</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#L3103">src/types.ts:3103</a></li>
          </ul>
        </div>
      </div>

      <div className="section tsd-panel tsd-member">
        <h3 className="tsd-anchor-link" id="entities_weight"><span>entities\_weight</span></h3>
        <div className="tsd-signature"><span className="tsd-kind-property">entities\_weight</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>Per-edge weight values, populated only when the request option 'include\_weights' is 'true' and <code>options entity\_type</code> is 'edge'. Stride 1, aligned 1:1 with the edge records emitted in <code>entities\_int</code> or <code>entities\_string</code> (i.e. the i-th weight corresponds to the i-th edge record). Empty when the graph has no weights component, when requesting nodes, or when the option is not set. Single-precision float matches the graph server's native weight storage.</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#L3107">src/types.ts:3107</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 map. Contains the following keys: 'identifier\_type' — describes the graph's native node identifier type: 'int', 'string', or 'wkt' (geo/XY graph). 'payload\_type' — describes which array actually holds this response payload: 'int' (<code>entities\_int</code>), 'string' (<code>entities\_string</code>), or 'double' (<code>entities\_double</code>). WKT graphs ALWAYS use 'double' for both nodes and edges — 'POINT(x y)' strings are never emitted. In concise edge mode payload\_type is 'int' regardless of graph type. Clients should dispatch on 'payload\_type', not 'identifier\_type', to parse the response. 'total\_count' — total number of entities available in the graph for the requested entity\_type, used for pagination; this is the live (non-deleted) count by default, or the raw count (including deleted slots) when 'concise\_edge\_connectivity' is true for a node request. 'status\_message' — set to 'Cancelled' if the request was cancelled mid-iteration (with <code>result</code> set to false). 'concise\_edge\_connectivity' — set to 'true' when the response was produced with the concise option (edges emitted as \[edge\_id, v0\_index, v1\_index, label\_idx] in <code>entities\_int</code>; WKT-graph nodes emitted as \[x, y, label\_idx] in <code>entities\_double</code>; non-WKT nodes still in their native array; node output includes deleted slots to keep indices stable). 'include\_weights' — set to 'true' when <code>entities\_weight</code> is populated.</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#L3111">src/types.ts:3111</a></li>
          </ul>
        </div>
      </div>

      <div className="section tsd-panel tsd-member">
        <h3 className="tsd-anchor-link" id="labels"><span>labels</span></h3>
        <div className="tsd-signature"><span className="tsd-kind-property">labels</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>Array of distinct label strings. The label\_index values in <code>entities\_int</code>, <code>entities\_string</code>, or <code>entities\_double</code> are 1-based indexes into this array; index 0 means no label.</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#L3109">src/types.ts:3109</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#L3113">src/types.ts:3113</a></li>
          </ul>
        </div>
      </div>

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

        <div className="tsd-comment tsd-typography">
          <p>Indicates a successful retrieval.</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#L3099">src/types.ts:3099</a></li>
          </ul>
        </div>
      </div>
    </div>
  </div>
</div>


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