list_types

List the types. The kinds of concept in the Forest (their type), across every tree or some: how many concepts have each, and which trees have them. To read them, search with types and trees. Read-only.

Parameters

Parameter	Type	Required	Description
trees	list of strings	No	The trees’ slugs, as list_trees gives them (not their names). Only these trees; omit for every tree.

Returns

One JSON object (see All tools):

Field	Type	Always	Description
types	list of objects	Yes	Each type in use, most used first. Spellings stay apart (Policy, policy); get_inventory flags likely duplicates.
types[].type	string	Yes	The type, as written.
types[].concepts	number	Yes	How many concepts have it.
types[].trees	list of objects	Yes	The trees that have it, most first.
types[].trees[].slug	string	Yes	The tree’s slug.
types[].trees[].concepts	number	Yes	How many of its concepts have it.
types[].url	string	Yes	A search for it in OKForest.
untyped	number	Yes	How many concepts have no type.
unreadTrees	list of strings	Yes	The slugs of trees that couldn’t be read, so their concepts are missing.

Example

Asked “What kinds of knowledge do we keep?”, an assistant might call list_types with:

Arguments

{}

On OKForest’s test Forest (Acme’s made-up company knowledge), it returns:

Result

{
  "types": [
    {
      "type": "Competitor",
      "concepts": 2,
      "trees": [
        {
          "slug": "company",
          "concepts": 1
        },
        {
          "slug": "public",
          "concepts": 1
        }
      ],
      "url": "https://app.okforest.ai/@/3f2b8c1e-9a4d-4c7b-8e2f-6d1a0b5c9e7f/-/search?q=&type=Competitor"
    },
    {
      "type": "Customer",
      "concepts": 2,
      "trees": [
        {
          "slug": "company",
          "concepts": 1
        },
        {
          "slug": "public",
          "concepts": 1
        }
      ],
      "url": "https://app.okforest.ai/@/3f2b8c1e-9a4d-4c7b-8e2f-6d1a0b5c9e7f/-/search?q=&type=Customer"
    },
    {
      "type": "Policy",
      "concepts": 2,
      "trees": [
        {
          "slug": "company",
          "concepts": 1
        },
        {
          "slug": "public",
          "concepts": 1
        }
      ],
      "url": "https://app.okforest.ai/@/3f2b8c1e-9a4d-4c7b-8e2f-6d1a0b5c9e7f/-/search?q=&type=Policy"
    }
  ],
  "untyped": 0,
  "unreadTrees": []
}