VEvectorize
Entities

Get entity co-occurrence graph

Changed on

Return a graph of entities (nodes) and their co-occurrences (edges) for visualization.

get/v1/default/banks/{bank_id}/entities/graph

Request

Path parameters

bank_idstring required

Query parameters

limitinteger

Maximum number of co-occurrence edges to return

min_countinteger

Minimum cooccurrence_count to include an edge

tagsstring[] nullable

Only count memories carrying these tags. Edges and node mention counts are computed from the matching memories only.

tags_match'any' | 'all' | 'any_strict' | 'all_strict' | 'exact'

How tags match (same modes as listing memories).

tag_groupsstring nullable

Compound tag filter as a JSON-encoded list of tag groups — the same shape tag_groups takes in a recall body (leaves {tags, match, resolve} and {and: [...]}, {or: [...]}, {not: ...}; groups are AND-ed). Mutually exclusive with tags.

Headers

authorizationstring nullable

Response

Successful Response

total_entitiesinteger required
total_edgesinteger required
limitinteger required

Example response

{
  "edges": [
    {
      "data": {
        "color": "#ffd700",
        "id": "uuid-1-uuid-2",
        "lastCooccurred": "2024-02-01T14:00:00Z",
        "lineStyle": "solid",
        "linkType": "cooccurrence",
        "source": "uuid-1",
        "target": "uuid-2",
        "weight": 5
      }
    }
  ],
  "limit": 1000,
  "nodes": [
    {
      "data": {
        "color": "#42a5f5",
        "id": "uuid-1",
        "label": "Alice",
        "mentionCount": 12
      }
    },
    {
      "data": {
        "color": "#42a5f5",
        "id": "uuid-2",
        "label": "Google",
        "mentionCount": 8
      }
    }
  ],
  "total_edges": 1,
  "total_entities": 2
}

Changes

  • 4fda98b75f63Revision changes
    • warning

      for the query request parameter limit, the min was set to 0.00

    • warning

      removed the optional property // from the response with the status

    • info

      added the new optional query request parameter tag_groups

    • info

      added the new optional query request parameter tags

    • info

      added the new optional query request parameter tags_match

    • info

      added the non-success response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

  • 0d08f271b9dbRevision changes
    • info

      endpoint added