docs/dsms_sdk/tutorials/5_search.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# 5. Searching KItems with the SDK\n",
    "\n",
    "In this tutorial we see how to search existing Kitems"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### 5.1. Setting up\n",
    "Before you run this tutorial: make sure to have access to a DSMS-instance of your interest, alongwith with installation of this package and have establised access to the DSMS through DSMS-SDK (refer to [Connecting to DSMS](../dsms_sdk.md#connecting-to-dsms))\n",
    "\n",
    "\n",
    "Now let us import the needed classes and functions for this tutorial."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "metadata": {},
   "outputs": [],
   "source": [
    "from dsms import DSMS, KItem"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Now source the environmental variables from an `.env` file and start the DSMS-session."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "metadata": {},
   "outputs": [],
   "source": [
    "dsms = DSMS(env=\".env\")"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### 5.2. Searching for KItems"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "In this section, we would like to search for specfic KItems we created in the DSMS.\n",
    "\n",
    "For this purpose, we will firstly create some KItems and apply the `search`-method on the `DSMS`-object later on in order to find them again in the DSMS.\n",
    "\n",
    "We also want to demonstrate here, that we can link KItems to each other in order to find e.g. a related item of type `DatasetCatalog`. For this strategy, we are using the `linked_kitems`- attribute and the `id` of the item which we would like to link.\n",
    "\n",
    "The procedure looks like this:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 3,
   "metadata": {},
   "outputs": [
    {
     "name": "stderr",
     "output_type": "stream",
     "text": [
      "/app/dsms/knowledge/kitem.py:573: UserWarning: A flat dictionary was provided for custom properties.\n",
      "                    Will be transformed into `KItemCustomPropertiesModel`.\n",
      "  warnings.warn(\n",
      "/app/dsms/knowledge/webform.py:655: UserWarning: No webform was defined for entry `Room Number`. Cannot check if value is of correct type.\n",
      "  warnings.warn(\n",
      "/app/dsms/knowledge/webform.py:655: UserWarning: No webform was defined for entry `Description`. Cannot check if value is of correct type.\n",
      "  warnings.warn(\n",
      "/app/dsms/knowledge/webform.py:655: UserWarning: No webform was defined for entry `Length`. Cannot check if value is of correct type.\n",
      "  warnings.warn(\n"
     ]
    }
   ],
   "source": [
    "item1 = KItem(\n",
    "    name=\"Machine-1\",\n",
    "    ktype_id=dsms.ktypes.TestingMachine,\n",
    "    annotations=[\"https://w3id.org/steel/ProcessOntology/TestingMachine\"],\n",
    "    custom_properties={\"Producer\": \"TestingLab GmBH\",\n",
    "                       \"Room Number\": \"A404\",\n",
    "                       \"Description\": \"Bending Test Machine\"\n",
    "                       }\n",
    ")\n",
    "\n",
    "item2 = KItem(\n",
    "    name=\"Machine-2\",\n",
    "    ktype_id=dsms.ktypes.TestingMachine,\n",
    "    annotations=[\"https://w3id.org/steel/ProcessOntology/TestingMachine\"],\n",
    "    custom_properties={\"Producer\": \"StressStrain GmBH\",\n",
    "                       \"Room Number\": \"B500\",\n",
    "                       \"Description\": \"Compression Test Machine\"\n",
    "                       }\n",
    ")\n",
    "\n",
    "item3 = KItem(\n",
    "    name=\"Specimen-1\", \n",
    "    ktype_id=dsms.ktypes.Specimen,\n",
    "    linked_kitems=[item1],\n",
    "    annotations=[\"https://w3id.org/steel/ProcessOntology/TestPiece\"],\n",
    "    custom_properties = {\n",
    "        \"Width\": 0.5,\n",
    "        \"Length\": [0.1, 0.2],\n",
    "    }\n",
    "\n",
    ")\n",
    "item4 = KItem(\n",
    "    name=\"Specimen-2\",\n",
    "    ktype_id=dsms.ktypes.Specimen,\n",
    "    linked_kitems=[item2],\n",
    "    annotations=[\"https://w3id.org/steel/ProcessOntology/TestPiece\"],\n",
    "    custom_properties = {\n",
    "        \"Width\": 0.8,\n",
    "        \"Length\": [0.8, 0.9],\n",
    "    }\n",
    ")\n",
    "\n",
    "item5 = KItem(\n",
    "    name=\"Research Institute ABC\",\n",
    "    ktype_id=dsms.ktypes.Organization,\n",
    "    linked_kitems=[item1,item2],\n",
    "    annotations=[\"www.researchBACiri.org/foo\"],\n",
    ")\n",
    "\n",
    "dsms.commit()"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "\n",
    "<b> <p style=\"color:red;\">Note : Here in this tutorial, we use dsms.search with `limit=1` to maintain readability but the user can adjust the variable `limit` as per requirement. </p>    </b> \n",
    "\n",
    "\n",
    "Now, we are apply to search for e.g. kitems of type `TestingMachine`:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 4,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "hits:\n",
      "- kitem:\n",
      "    name: Specimen-1\n",
      "    id: b0505a0f-8739-4162-9cad-240139338cd4\n",
      "    ktype_id: specimen\n",
      "    slug: specimen-1-b0505a0f\n",
      "    annotations:\n",
      "    - iri: https://w3id.org/steel/ProcessOntology/TestPiece\n",
      "      label: TestPiece\n",
      "      namespace: https://w3id.org/steel/ProcessOntology\n",
      "    attachments:\n",
      "    - name: subgraph.ttl\n",
      "      content: null\n",
      "    linked_kitems:\n",
      "    - id: 01bb6156-dc37-4bed-86f2-cfd22ad2ffcc\n",
      "      name: Machine-1\n",
      "      slug: machine-1-01bb6156\n",
      "      ktype_id: testing-machine\n",
      "      summary: null\n",
      "      avatar_exists: false\n",
      "      annotations:\n",
      "      - iri: https://w3id.org/steel/ProcessOntology/TestingMachine\n",
      "        label: TestingMachine\n",
      "        namespace: https://w3id.org/steel/ProcessOntology\n",
      "      linked_kitems:\n",
      "      - id: a0688216-78fe-41da-9d55-0b897cece9db\n",
      "      - id: b0505a0f-8739-4162-9cad-240139338cd4\n",
      "      external_links: []\n",
      "      contacts: []\n",
      "      authors:\n",
      "      - user_id: 7f0e5a37-353b-4bbc-b1f1-b6ad575f562d\n",
      "      linked_affiliations: []\n",
      "      attachments:\n",
      "      - name: subgraph.ttl\n",
      "        content: null\n",
      "      user_groups: []\n",
      "      custom_properties:\n",
      "        sections:\n",
      "        - id: id717506ec647db\n",
      "          name: ''\n",
      "          entries:\n",
      "          - id: id699fb85c65df4\n",
      "            type: Text\n",
      "            label: Producer\n",
      "            value: TestingLab GmBH\n",
      "            measurementUnit: null\n",
      "            relationMapping: null\n",
      "        - id: id1738065716294lzgvq9\n",
      "          name: Misc\n",
      "          entries:\n",
      "          - id: id1738065716294eddmjb\n",
      "            type: Text\n",
      "            label: Room Number\n",
      "            value: A404\n",
      "            measurementUnit: null\n",
      "            relationMapping: null\n",
      "          - id: id17380657162945c1q9b\n",
      "            type: Text\n",
      "            label: Description\n",
      "            value: Bending Test Machine\n",
      "            measurementUnit: null\n",
      "            relationMapping: null\n",
      "      created_at: '2025-01-28T12:01:56.972740'\n",
      "      updated_at: '2025-01-28T12:01:56.972740'\n",
      "    affiliations: []\n",
      "    authors:\n",
      "    - user_id: 7f0e5a37-353b-4bbc-b1f1-b6ad575f562d\n",
      "    avatar_exists: false\n",
      "    contacts: []\n",
      "    created_at: 2025-01-28 12:01:57.317338\n",
      "    updated_at: 2025-01-28 12:01:57.317338\n",
      "    external_links: []\n",
      "    kitem_apps: []\n",
      "    user_groups: []\n",
      "    custom_properties:\n",
      "      sections:\n",
      "      - id: id0595fb5f1853a8\n",
      "        name: ''\n",
      "        entries:\n",
      "        - id: idba92210e193128\n",
      "          type: Number\n",
      "          label: Width\n",
      "          value: 0.5\n",
      "          measurement_unit:\n",
      "            iri: http://qudt.org/vocab/unit/MilliM\n",
      "            label: Millimetre\n",
      "            namespace: http://qudt.org/vocab/unit\n",
      "      - id: id1738065716575k25bj4\n",
      "        name: Misc\n",
      "        entries:\n",
      "        - id: id1738065716575quvhev\n",
      "          type: Slider\n",
      "          label: Length\n",
      "          value:\n",
      "          - 0.1\n",
      "          - 0.2\n",
      "    rdf_exists: true\n",
      "  fuzzy: false\n",
      "- kitem:\n",
      "    name: Specimen-2\n",
      "    id: 1d7e410b-bc16-4509-b7c9-64f9a8a77c93\n",
      "    ktype_id: specimen\n",
      "    slug: specimen-2-1d7e410b\n",
      "    annotations:\n",
      "    - iri: https://w3id.org/steel/ProcessOntology/TestPiece\n",
      "      label: TestPiece\n",
      "      namespace: https://w3id.org/steel/ProcessOntology\n",
      "    attachments:\n",
      "    - name: subgraph.ttl\n",
      "      content: null\n",
      "    linked_kitems:\n",
      "    - id: 74438e78-0311-46a6-86dc-204f3ba8e550\n",
      "      name: Machine-2\n",
      "      slug: machine-2-74438e78\n",
      "      ktype_id: testing-machine\n",
      "      summary: null\n",
      "      avatar_exists: false\n",
      "      annotations:\n",
      "      - iri: https://w3id.org/steel/ProcessOntology/TestingMachine\n",
      "        label: TestingMachine\n",
      "        namespace: https://w3id.org/steel/ProcessOntology\n",
      "      linked_kitems:\n",
      "      - id: 1d7e410b-bc16-4509-b7c9-64f9a8a77c93\n",
      "      - id: a0688216-78fe-41da-9d55-0b897cece9db\n",
      "      external_links: []\n",
      "      contacts: []\n",
      "      authors:\n",
      "      - user_id: 7f0e5a37-353b-4bbc-b1f1-b6ad575f562d\n",
      "      linked_affiliations: []\n",
      "      attachments:\n",
      "      - name: subgraph.ttl\n",
      "        content: null\n",
      "      user_groups: []\n",
      "      custom_properties:\n",
      "        sections:\n",
      "        - id: id717506ec647db\n",
      "          name: ''\n",
      "          entries:\n",
      "          - id: id699fb85c65df4\n",
      "            type: Text\n",
      "            label: Producer\n",
      "            value: StressStrain GmBH\n",
      "            measurementUnit: null\n",
      "            relationMapping: null\n",
      "        - id: id1738065716436sytize\n",
      "          name: Misc\n",
      "          entries:\n",
      "          - id: id1738065716436ch8ekr\n",
      "            type: Text\n",
      "            label: Room Number\n",
      "            value: B500\n",
      "            measurementUnit: null\n",
      "            relationMapping: null\n",
      "          - id: id1738065716436opl3l2\n",
      "            type: Text\n",
      "            label: Description\n",
      "            value: Compression Test Machine\n",
      "            measurementUnit: null\n",
      "            relationMapping: null\n",
      "      created_at: '2025-01-28T12:01:57.123339'\n",
      "      updated_at: '2025-01-28T12:01:57.123339'\n",
      "    affiliations: []\n",
      "    authors:\n",
      "    - user_id: 7f0e5a37-353b-4bbc-b1f1-b6ad575f562d\n",
      "    avatar_exists: false\n",
      "    contacts: []\n",
      "    created_at: 2025-01-28 12:01:57.472362\n",
      "    updated_at: 2025-01-28 12:01:57.472362\n",
      "    external_links: []\n",
      "    kitem_apps: []\n",
      "    user_groups: []\n",
      "    custom_properties:\n",
      "      sections:\n",
      "      - id: id0595fb5f1853a8\n",
      "        name: ''\n",
      "        entries:\n",
      "        - id: idba92210e193128\n",
      "          type: Number\n",
      "          label: Width\n",
      "          value: 0.8\n",
      "          measurement_unit:\n",
      "            iri: http://qudt.org/vocab/unit/MilliM\n",
      "            label: Millimetre\n",
      "            namespace: http://qudt.org/vocab/unit\n",
      "      - id: id1738065716713aniyng\n",
      "        name: Misc\n",
      "        entries:\n",
      "        - id: id1738065716713am6zck\n",
      "          type: Slider\n",
      "          label: Length\n",
      "          value:\n",
      "          - 0.8\n",
      "          - 0.9\n",
      "    rdf_exists: true\n",
      "  fuzzy: false\n",
      "total_count: 2\n",
      "\n",
      "Name of the first kitem:\n",
      "Specimen-1\n"
     ]
    }
   ],
   "source": [
    "result = dsms.search(ktypes=[dsms.ktypes.Specimen], limit=2)\n",
    "print(result)\n",
    "print(\"Name of the first kitem:\")\n",
    "print(result.hits[0].kitem.name)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "... and for all of type `Organization` and `Testingmachine`:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 5,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "kitem:\n",
      "  name: Machine-1\n",
      "  id: 01bb6156-dc37-4bed-86f2-cfd22ad2ffcc\n",
      "  ktype_id: testing-machine\n",
      "  slug: machine-1-01bb6156\n",
      "  annotations:\n",
      "  - iri: https://w3id.org/steel/ProcessOntology/TestingMachine\n",
      "    label: TestingMachine\n",
      "    namespace: https://w3id.org/steel/ProcessOntology\n",
      "  attachments:\n",
      "  - name: subgraph.ttl\n",
      "    content: null\n",
      "  linked_kitems:\n",
      "  - id: a0688216-78fe-41da-9d55-0b897cece9db\n",
      "    name: Research Institute ABC\n",
      "    slug: researchinstituteabc-a0688216\n",
      "    ktype_id: organization\n",
      "    summary: null\n",
      "    avatar_exists: false\n",
      "    annotations:\n",
      "    - iri: www.researchBACiri.org/foo\n",
      "      label: foo\n",
      "      namespace: www.researchBACiri.org\n",
      "    linked_kitems:\n",
      "    - id: 01bb6156-dc37-4bed-86f2-cfd22ad2ffcc\n",
      "    - id: 74438e78-0311-46a6-86dc-204f3ba8e550\n",
      "    external_links: []\n",
      "    contacts: []\n",
      "    authors:\n",
      "    - user_id: 7f0e5a37-353b-4bbc-b1f1-b6ad575f562d\n",
      "    linked_affiliations: []\n",
      "    attachments: []\n",
      "    user_groups: []\n",
      "    custom_properties: null\n",
      "    created_at: '2025-01-28T12:01:57.622925'\n",
      "    updated_at: '2025-01-28T12:01:57.622925'\n",
      "  - id: b0505a0f-8739-4162-9cad-240139338cd4\n",
      "    name: Specimen-1\n",
      "    slug: specimen-1-b0505a0f\n",
      "    ktype_id: specimen\n",
      "    summary: null\n",
      "    avatar_exists: false\n",
      "    annotations:\n",
      "    - iri: https://w3id.org/steel/ProcessOntology/TestPiece\n",
      "      label: TestPiece\n",
      "      namespace: https://w3id.org/steel/ProcessOntology\n",
      "    linked_kitems:\n",
      "    - id: 01bb6156-dc37-4bed-86f2-cfd22ad2ffcc\n",
      "    external_links: []\n",
      "    contacts: []\n",
      "    authors:\n",
      "    - user_id: 7f0e5a37-353b-4bbc-b1f1-b6ad575f562d\n",
      "    linked_affiliations: []\n",
      "    attachments:\n",
      "    - name: subgraph.ttl\n",
      "      content: null\n",
      "    user_groups: []\n",
      "    custom_properties:\n",
      "      sections:\n",
      "      - id: id0595fb5f1853a8\n",
      "        name: ''\n",
      "        entries:\n",
      "        - id: idba92210e193128\n",
      "          type: Number\n",
      "          label: Width\n",
      "          value: 0.5\n",
      "          measurementUnit:\n",
      "            iri: http://qudt.org/vocab/unit/MilliM\n",
      "            label: Millimetre\n",
      "            symbol: null\n",
      "            namespace: http://qudt.org/vocab/unit\n",
      "          relationMapping: null\n",
      "      - id: id1738065716575k25bj4\n",
      "        name: Misc\n",
      "        entries:\n",
      "        - id: id1738065716575quvhev\n",
      "          type: Slider\n",
      "          label: Length\n",
      "          value:\n",
      "          - 0.1\n",
      "          - 0.2\n",
      "          measurementUnit: null\n",
      "          relationMapping: null\n",
      "    created_at: '2025-01-28T12:01:57.317338'\n",
      "    updated_at: '2025-01-28T12:01:57.317338'\n",
      "  affiliations: []\n",
      "  authors:\n",
      "  - user_id: 7f0e5a37-353b-4bbc-b1f1-b6ad575f562d\n",
      "  avatar_exists: false\n",
      "  contacts: []\n",
      "  created_at: 2025-01-28 12:01:56.972740\n",
      "  updated_at: 2025-01-28 12:01:56.972740\n",
      "  external_links: []\n",
      "  kitem_apps: []\n",
      "  user_groups: []\n",
      "  custom_properties:\n",
      "    sections:\n",
      "    - id: id717506ec647db\n",
      "      name: ''\n",
      "      entries:\n",
      "      - id: id699fb85c65df4\n",
      "        type: Text\n",
      "        label: Producer\n",
      "        value: TestingLab GmBH\n",
      "    - id: id1738065716294lzgvq9\n",
      "      name: Misc\n",
      "      entries:\n",
      "      - id: id1738065716294eddmjb\n",
      "        type: Text\n",
      "        label: Room Number\n",
      "        value: A404\n",
      "      - id: id17380657162945c1q9b\n",
      "        type: Text\n",
      "        label: Description\n",
      "        value: Bending Test Machine\n",
      "  rdf_exists: true\n",
      "\n",
      "fuzziness:  False\n",
      "\n",
      "\n"
     ]
    }
   ],
   "source": [
    "for result in dsms.search(ktypes=[dsms.ktypes.Organization, dsms.ktypes.TestingMachine], limit=1):\n",
    "    print(result.kitem)\n",
    "    print(\"fuzziness: \", result.fuzzy)\n",
    "    print(\"\\n\")\n",
    "    "
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "... or for all of type `Specimen` with `Specimen1` in the name:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 6,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "kitem:\n",
      "  name: Specimen-1\n",
      "  id: b0505a0f-8739-4162-9cad-240139338cd4\n",
      "  ktype_id: specimen\n",
      "  slug: specimen-1-b0505a0f\n",
      "  annotations:\n",
      "  - iri: https://w3id.org/steel/ProcessOntology/TestPiece\n",
      "    label: TestPiece\n",
      "    namespace: https://w3id.org/steel/ProcessOntology\n",
      "  attachments:\n",
      "  - name: subgraph.ttl\n",
      "    content: null\n",
      "  linked_kitems:\n",
      "  - id: 01bb6156-dc37-4bed-86f2-cfd22ad2ffcc\n",
      "    name: Machine-1\n",
      "    slug: machine-1-01bb6156\n",
      "    ktype_id: testing-machine\n",
      "    summary: null\n",
      "    avatar_exists: false\n",
      "    annotations:\n",
      "    - iri: https://w3id.org/steel/ProcessOntology/TestingMachine\n",
      "      label: TestingMachine\n",
      "      namespace: https://w3id.org/steel/ProcessOntology\n",
      "    linked_kitems:\n",
      "    - id: a0688216-78fe-41da-9d55-0b897cece9db\n",
      "    - id: b0505a0f-8739-4162-9cad-240139338cd4\n",
      "    external_links: []\n",
      "    contacts: []\n",
      "    authors:\n",
      "    - user_id: 7f0e5a37-353b-4bbc-b1f1-b6ad575f562d\n",
      "    linked_affiliations: []\n",
      "    attachments:\n",
      "    - name: subgraph.ttl\n",
      "      content: null\n",
      "    user_groups: []\n",
      "    custom_properties:\n",
      "      sections:\n",
      "      - id: id717506ec647db\n",
      "        name: ''\n",
      "        entries:\n",
      "        - id: id699fb85c65df4\n",
      "          type: Text\n",
      "          label: Producer\n",
      "          value: TestingLab GmBH\n",
      "          measurementUnit: null\n",
      "          relationMapping: null\n",
      "      - id: id1738065716294lzgvq9\n",
      "        name: Misc\n",
      "        entries:\n",
      "        - id: id1738065716294eddmjb\n",
      "          type: Text\n",
      "          label: Room Number\n",
      "          value: A404\n",
      "          measurementUnit: null\n",
      "          relationMapping: null\n",
      "        - id: id17380657162945c1q9b\n",
      "          type: Text\n",
      "          label: Description\n",
      "          value: Bending Test Machine\n",
      "          measurementUnit: null\n",
      "          relationMapping: null\n",
      "    created_at: '2025-01-28T12:01:56.972740'\n",
      "    updated_at: '2025-01-28T12:01:56.972740'\n",
      "  affiliations: []\n",
      "  authors:\n",
      "  - user_id: 7f0e5a37-353b-4bbc-b1f1-b6ad575f562d\n",
      "  avatar_exists: false\n",
      "  contacts: []\n",
      "  created_at: 2025-01-28 12:01:57.317338\n",
      "  updated_at: 2025-01-28 12:01:57.317338\n",
      "  external_links: []\n",
      "  kitem_apps: []\n",
      "  user_groups: []\n",
      "  custom_properties:\n",
      "    sections:\n",
      "    - id: id0595fb5f1853a8\n",
      "      name: ''\n",
      "      entries:\n",
      "      - id: idba92210e193128\n",
      "        type: Number\n",
      "        label: Width\n",
      "        value: 0.5\n",
      "        measurement_unit:\n",
      "          iri: http://qudt.org/vocab/unit/MilliM\n",
      "          label: Millimetre\n",
      "          namespace: http://qudt.org/vocab/unit\n",
      "    - id: id1738065716575k25bj4\n",
      "      name: Misc\n",
      "      entries:\n",
      "      - id: id1738065716575quvhev\n",
      "        type: Slider\n",
      "        label: Length\n",
      "        value:\n",
      "        - 0.1\n",
      "        - 0.2\n",
      "  rdf_exists: true\n",
      "fuzzy: false\n",
      "\n"
     ]
    }
   ],
   "source": [
    "for result in dsms.search(query=\"Specimen-1\", ktypes=[dsms.ktypes.Specimen], limit=1):\n",
    "    print(result)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "... and for all of type `Organization` with the annotation `www.researchBACiri.org/foo`:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 7,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "kitem:\n",
      "  name: Research Institute ABC\n",
      "  id: a0688216-78fe-41da-9d55-0b897cece9db\n",
      "  ktype_id: organization\n",
      "  slug: researchinstituteabc-a0688216\n",
      "  annotations:\n",
      "  - iri: www.researchBACiri.org/foo\n",
      "    label: foo\n",
      "    namespace: www.researchBACiri.org\n",
      "  attachments: []\n",
      "  linked_kitems:\n",
      "  - id: 01bb6156-dc37-4bed-86f2-cfd22ad2ffcc\n",
      "    name: Machine-1\n",
      "    slug: machine-1-01bb6156\n",
      "    ktype_id: testing-machine\n",
      "    summary: null\n",
      "    avatar_exists: false\n",
      "    annotations:\n",
      "    - iri: https://w3id.org/steel/ProcessOntology/TestingMachine\n",
      "      label: TestingMachine\n",
      "      namespace: https://w3id.org/steel/ProcessOntology\n",
      "    linked_kitems:\n",
      "    - id: a0688216-78fe-41da-9d55-0b897cece9db\n",
      "    - id: b0505a0f-8739-4162-9cad-240139338cd4\n",
      "    external_links: []\n",
      "    contacts: []\n",
      "    authors:\n",
      "    - user_id: 7f0e5a37-353b-4bbc-b1f1-b6ad575f562d\n",
      "    linked_affiliations: []\n",
      "    attachments:\n",
      "    - name: subgraph.ttl\n",
      "      content: null\n",
      "    user_groups: []\n",
      "    custom_properties:\n",
      "      sections:\n",
      "      - id: id717506ec647db\n",
      "        name: ''\n",
      "        entries:\n",
      "        - id: id699fb85c65df4\n",
      "          type: Text\n",
      "          label: Producer\n",
      "          value: TestingLab GmBH\n",
      "          measurementUnit: null\n",
      "          relationMapping: null\n",
      "      - id: id1738065716294lzgvq9\n",
      "        name: Misc\n",
      "        entries:\n",
      "        - id: id1738065716294eddmjb\n",
      "          type: Text\n",
      "          label: Room Number\n",
      "          value: A404\n",
      "          measurementUnit: null\n",
      "          relationMapping: null\n",
      "        - id: id17380657162945c1q9b\n",
      "          type: Text\n",
      "          label: Description\n",
      "          value: Bending Test Machine\n",
      "          measurementUnit: null\n",
      "          relationMapping: null\n",
      "    created_at: '2025-01-28T12:01:56.972740'\n",
      "    updated_at: '2025-01-28T12:01:56.972740'\n",
      "  - id: 74438e78-0311-46a6-86dc-204f3ba8e550\n",
      "    name: Machine-2\n",
      "    slug: machine-2-74438e78\n",
      "    ktype_id: testing-machine\n",
      "    summary: null\n",
      "    avatar_exists: false\n",
      "    annotations:\n",
      "    - iri: https://w3id.org/steel/ProcessOntology/TestingMachine\n",
      "      label: TestingMachine\n",
      "      namespace: https://w3id.org/steel/ProcessOntology\n",
      "    linked_kitems:\n",
      "    - id: 1d7e410b-bc16-4509-b7c9-64f9a8a77c93\n",
      "    - id: a0688216-78fe-41da-9d55-0b897cece9db\n",
      "    external_links: []\n",
      "    contacts: []\n",
      "    authors:\n",
      "    - user_id: 7f0e5a37-353b-4bbc-b1f1-b6ad575f562d\n",
      "    linked_affiliations: []\n",
      "    attachments:\n",
      "    - name: subgraph.ttl\n",
      "      content: null\n",
      "    user_groups: []\n",
      "    custom_properties:\n",
      "      sections:\n",
      "      - id: id717506ec647db\n",
      "        name: ''\n",
      "        entries:\n",
      "        - id: id699fb85c65df4\n",
      "          type: Text\n",
      "          label: Producer\n",
      "          value: StressStrain GmBH\n",
      "          measurementUnit: null\n",
      "          relationMapping: null\n",
      "      - id: id1738065716436sytize\n",
      "        name: Misc\n",
      "        entries:\n",
      "        - id: id1738065716436ch8ekr\n",
      "          type: Text\n",
      "          label: Room Number\n",
      "          value: B500\n",
      "          measurementUnit: null\n",
      "          relationMapping: null\n",
      "        - id: id1738065716436opl3l2\n",
      "          type: Text\n",
      "          label: Description\n",
      "          value: Compression Test Machine\n",
      "          measurementUnit: null\n",
      "          relationMapping: null\n",
      "    created_at: '2025-01-28T12:01:57.123339'\n",
      "    updated_at: '2025-01-28T12:01:57.123339'\n",
      "  affiliations: []\n",
      "  authors:\n",
      "  - user_id: 7f0e5a37-353b-4bbc-b1f1-b6ad575f562d\n",
      "  avatar_exists: false\n",
      "  contacts: []\n",
      "  created_at: 2025-01-28 12:01:57.622925\n",
      "  updated_at: 2025-01-28 12:01:57.622925\n",
      "  external_links: []\n",
      "  kitem_apps: []\n",
      "  user_groups: []\n",
      "  rdf_exists: false\n",
      "fuzzy: false\n",
      "\n"
     ]
    }
   ],
   "source": [
    "for result in dsms.search(\n",
    "          ktypes=[dsms.ktypes.Organization], annotations=[\"www.researchBACiri.org/foo\"], limit=1\n",
    "    ):\n",
    "    print(result)\n"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## 5.3. Fetching linked KItems from a KItem"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "In the beginning under **5.1** we created some kitems and linked each other. Now we want to fetch the linked kitems and display them to the user. For this we use the `linked_kitems` attribute."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 8,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "[linked_kitem:\n",
       "   id: 01bb6156-dc37-4bed-86f2-cfd22ad2ffcc\n",
       "   name: Machine-1\n",
       "   slug: machine-1-01bb6156\n",
       "   ktype_id: testing-machine\n",
       "   summary: null\n",
       "   avatar_exists: false\n",
       "   annotations:\n",
       "   - iri: https://w3id.org/steel/ProcessOntology/TestingMachine\n",
       "     label: TestingMachine\n",
       "     namespace: https://w3id.org/steel/ProcessOntology\n",
       "   linked_kitems:\n",
       "   - id: a0688216-78fe-41da-9d55-0b897cece9db\n",
       "   - id: b0505a0f-8739-4162-9cad-240139338cd4\n",
       "   external_links: []\n",
       "   contacts: []\n",
       "   authors:\n",
       "   - user_id: 7f0e5a37-353b-4bbc-b1f1-b6ad575f562d\n",
       "   linked_affiliations: []\n",
       "   attachments:\n",
       "   - name: subgraph.ttl\n",
       "     content: null\n",
       "   user_groups: []\n",
       "   custom_properties:\n",
       "     sections:\n",
       "     - id: id717506ec647db\n",
       "       name: ''\n",
       "       entries:\n",
       "       - id: id699fb85c65df4\n",
       "         type: Text\n",
       "         label: Producer\n",
       "         value: TestingLab GmBH\n",
       "         measurementUnit: null\n",
       "         relationMapping: null\n",
       "     - id: id1738065716294lzgvq9\n",
       "       name: Misc\n",
       "       entries:\n",
       "       - id: id1738065716294eddmjb\n",
       "         type: Text\n",
       "         label: Room Number\n",
       "         value: A404\n",
       "         measurementUnit: null\n",
       "         relationMapping: null\n",
       "       - id: id17380657162945c1q9b\n",
       "         type: Text\n",
       "         label: Description\n",
       "         value: Bending Test Machine\n",
       "         measurementUnit: null\n",
       "         relationMapping: null\n",
       "   created_at: '2025-01-28T12:01:56.972740'\n",
       "   updated_at: '2025-01-28T12:01:56.972740',\n",
       " linked_kitem:\n",
       "   id: 74438e78-0311-46a6-86dc-204f3ba8e550\n",
       "   name: Machine-2\n",
       "   slug: machine-2-74438e78\n",
       "   ktype_id: testing-machine\n",
       "   summary: null\n",
       "   avatar_exists: false\n",
       "   annotations:\n",
       "   - iri: https://w3id.org/steel/ProcessOntology/TestingMachine\n",
       "     label: TestingMachine\n",
       "     namespace: https://w3id.org/steel/ProcessOntology\n",
       "   linked_kitems:\n",
       "   - id: 1d7e410b-bc16-4509-b7c9-64f9a8a77c93\n",
       "   - id: a0688216-78fe-41da-9d55-0b897cece9db\n",
       "   external_links: []\n",
       "   contacts: []\n",
       "   authors:\n",
       "   - user_id: 7f0e5a37-353b-4bbc-b1f1-b6ad575f562d\n",
       "   linked_affiliations: []\n",
       "   attachments:\n",
       "   - name: subgraph.ttl\n",
       "     content: null\n",
       "   user_groups: []\n",
       "   custom_properties:\n",
       "     sections:\n",
       "     - id: id717506ec647db\n",
       "       name: ''\n",
       "       entries:\n",
       "       - id: id699fb85c65df4\n",
       "         type: Text\n",
       "         label: Producer\n",
       "         value: StressStrain GmBH\n",
       "         measurementUnit: null\n",
       "         relationMapping: null\n",
       "     - id: id1738065716436sytize\n",
       "       name: Misc\n",
       "       entries:\n",
       "       - id: id1738065716436ch8ekr\n",
       "         type: Text\n",
       "         label: Room Number\n",
       "         value: B500\n",
       "         measurementUnit: null\n",
       "         relationMapping: null\n",
       "       - id: id1738065716436opl3l2\n",
       "         type: Text\n",
       "         label: Description\n",
       "         value: Compression Test Machine\n",
       "         measurementUnit: null\n",
       "         relationMapping: null\n",
       "   created_at: '2025-01-28T12:01:57.123339'\n",
       "   updated_at: '2025-01-28T12:01:57.123339']"
      ]
     },
     "execution_count": 8,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "item5.linked_kitems"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "However, this linked KItem is not a \"real\" KItem. Due to performance reasons, we only display a slim representation of the linked KItem. Imagine if the linked KItem also has a linked KItem... this might lead to an infinite recursion. We can fetch the \"real\" KItem by using the `fetch` method of the linked KItem:\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 9,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "kitem:\n",
       "  name: Machine-1\n",
       "  id: 01bb6156-dc37-4bed-86f2-cfd22ad2ffcc\n",
       "  ktype_id: testing-machine\n",
       "  slug: machine-1-01bb6156\n",
       "  annotations:\n",
       "  - iri: https://w3id.org/steel/ProcessOntology/TestingMachine\n",
       "    label: TestingMachine\n",
       "    namespace: https://w3id.org/steel/ProcessOntology\n",
       "  attachments:\n",
       "  - name: subgraph.ttl\n",
       "    content: null\n",
       "  linked_kitems:\n",
       "  - id: a0688216-78fe-41da-9d55-0b897cece9db\n",
       "    name: Research Institute ABC\n",
       "    slug: researchinstituteabc-a0688216\n",
       "    ktype_id: organization\n",
       "    summary: null\n",
       "    avatar_exists: false\n",
       "    annotations:\n",
       "    - iri: www.researchBACiri.org/foo\n",
       "      label: foo\n",
       "      namespace: www.researchBACiri.org\n",
       "    linked_kitems:\n",
       "    - id: 01bb6156-dc37-4bed-86f2-cfd22ad2ffcc\n",
       "    - id: 74438e78-0311-46a6-86dc-204f3ba8e550\n",
       "    external_links: []\n",
       "    contacts: []\n",
       "    authors:\n",
       "    - user_id: 7f0e5a37-353b-4bbc-b1f1-b6ad575f562d\n",
       "    linked_affiliations: []\n",
       "    attachments: []\n",
       "    user_groups: []\n",
       "    custom_properties: null\n",
       "    created_at: '2025-01-28T12:01:57.622925'\n",
       "    updated_at: '2025-01-28T12:01:57.622925'\n",
       "  - id: b0505a0f-8739-4162-9cad-240139338cd4\n",
       "    name: Specimen-1\n",
       "    slug: specimen-1-b0505a0f\n",
       "    ktype_id: specimen\n",
       "    summary: null\n",
       "    avatar_exists: false\n",
       "    annotations:\n",
       "    - iri: https://w3id.org/steel/ProcessOntology/TestPiece\n",
       "      label: TestPiece\n",
       "      namespace: https://w3id.org/steel/ProcessOntology\n",
       "    linked_kitems:\n",
       "    - id: 01bb6156-dc37-4bed-86f2-cfd22ad2ffcc\n",
       "    external_links: []\n",
       "    contacts: []\n",
       "    authors:\n",
       "    - user_id: 7f0e5a37-353b-4bbc-b1f1-b6ad575f562d\n",
       "    linked_affiliations: []\n",
       "    attachments:\n",
       "    - name: subgraph.ttl\n",
       "      content: null\n",
       "    user_groups: []\n",
       "    custom_properties:\n",
       "      sections:\n",
       "      - id: id0595fb5f1853a8\n",
       "        name: ''\n",
       "        entries:\n",
       "        - id: idba92210e193128\n",
       "          type: Number\n",
       "          label: Width\n",
       "          value: 0.5\n",
       "          measurementUnit:\n",
       "            iri: http://qudt.org/vocab/unit/MilliM\n",
       "            label: Millimetre\n",
       "            symbol: null\n",
       "            namespace: http://qudt.org/vocab/unit\n",
       "          relationMapping: null\n",
       "      - id: id1738065716575k25bj4\n",
       "        name: Misc\n",
       "        entries:\n",
       "        - id: id1738065716575quvhev\n",
       "          type: Slider\n",
       "          label: Length\n",
       "          value:\n",
       "          - 0.1\n",
       "          - 0.2\n",
       "          measurementUnit: null\n",
       "          relationMapping: null\n",
       "    created_at: '2025-01-28T12:01:57.317338'\n",
       "    updated_at: '2025-01-28T12:01:57.317338'\n",
       "  affiliations: []\n",
       "  authors:\n",
       "  - user_id: 7f0e5a37-353b-4bbc-b1f1-b6ad575f562d\n",
       "  avatar_exists: false\n",
       "  contacts: []\n",
       "  created_at: 2025-01-28 12:01:56.972740\n",
       "  updated_at: 2025-01-28 12:01:56.972740\n",
       "  external_links: []\n",
       "  kitem_apps: []\n",
       "  user_groups: []\n",
       "  custom_properties:\n",
       "    sections:\n",
       "    - id: id717506ec647db\n",
       "      name: ''\n",
       "      entries:\n",
       "      - id: id699fb85c65df4\n",
       "        type: Text\n",
       "        label: Producer\n",
       "        value: TestingLab GmBH\n",
       "    - id: id1738065716294lzgvq9\n",
       "      name: Misc\n",
       "      entries:\n",
       "      - id: id1738065716294eddmjb\n",
       "        type: Text\n",
       "        label: Room Number\n",
       "        value: A404\n",
       "      - id: id17380657162945c1q9b\n",
       "        type: Text\n",
       "        label: Description\n",
       "        value: Bending Test Machine\n",
       "  rdf_exists: true"
      ]
     },
     "execution_count": 9,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "item5.linked_kitems[0].fetch()"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "We can also get the linked KItems grouped by annotation:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 10,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "{'https://w3id.org/steel/ProcessOntology/TestingMachine': [linked_kitem:\n",
       "    id: 01bb6156-dc37-4bed-86f2-cfd22ad2ffcc\n",
       "    name: Machine-1\n",
       "    slug: machine-1-01bb6156\n",
       "    ktype_id: testing-machine\n",
       "    summary: null\n",
       "    avatar_exists: false\n",
       "    annotations:\n",
       "    - iri: https://w3id.org/steel/ProcessOntology/TestingMachine\n",
       "      label: TestingMachine\n",
       "      namespace: https://w3id.org/steel/ProcessOntology\n",
       "    linked_kitems:\n",
       "    - id: a0688216-78fe-41da-9d55-0b897cece9db\n",
       "    - id: b0505a0f-8739-4162-9cad-240139338cd4\n",
       "    external_links: []\n",
       "    contacts: []\n",
       "    authors:\n",
       "    - user_id: 7f0e5a37-353b-4bbc-b1f1-b6ad575f562d\n",
       "    linked_affiliations: []\n",
       "    attachments:\n",
       "    - name: subgraph.ttl\n",
       "      content: null\n",
       "    user_groups: []\n",
       "    custom_properties:\n",
       "      sections:\n",
       "      - id: id717506ec647db\n",
       "        name: ''\n",
       "        entries:\n",
       "        - id: id699fb85c65df4\n",
       "          type: Text\n",
       "          label: Producer\n",
       "          value: TestingLab GmBH\n",
       "          measurementUnit: null\n",
       "          relationMapping: null\n",
       "      - id: id1738065716294lzgvq9\n",
       "        name: Misc\n",
       "        entries:\n",
       "        - id: id1738065716294eddmjb\n",
       "          type: Text\n",
       "          label: Room Number\n",
       "          value: A404\n",
       "          measurementUnit: null\n",
       "          relationMapping: null\n",
       "        - id: id17380657162945c1q9b\n",
       "          type: Text\n",
       "          label: Description\n",
       "          value: Bending Test Machine\n",
       "          measurementUnit: null\n",
       "          relationMapping: null\n",
       "    created_at: '2025-01-28T12:01:56.972740'\n",
       "    updated_at: '2025-01-28T12:01:56.972740',\n",
       "  linked_kitem:\n",
       "    id: 74438e78-0311-46a6-86dc-204f3ba8e550\n",
       "    name: Machine-2\n",
       "    slug: machine-2-74438e78\n",
       "    ktype_id: testing-machine\n",
       "    summary: null\n",
       "    avatar_exists: false\n",
       "    annotations:\n",
       "    - iri: https://w3id.org/steel/ProcessOntology/TestingMachine\n",
       "      label: TestingMachine\n",
       "      namespace: https://w3id.org/steel/ProcessOntology\n",
       "    linked_kitems:\n",
       "    - id: 1d7e410b-bc16-4509-b7c9-64f9a8a77c93\n",
       "    - id: a0688216-78fe-41da-9d55-0b897cece9db\n",
       "    external_links: []\n",
       "    contacts: []\n",
       "    authors:\n",
       "    - user_id: 7f0e5a37-353b-4bbc-b1f1-b6ad575f562d\n",
       "    linked_affiliations: []\n",
       "    attachments:\n",
       "    - name: subgraph.ttl\n",
       "      content: null\n",
       "    user_groups: []\n",
       "    custom_properties:\n",
       "      sections:\n",
       "      - id: id717506ec647db\n",
       "        name: ''\n",
       "        entries:\n",
       "        - id: id699fb85c65df4\n",
       "          type: Text\n",
       "          label: Producer\n",
       "          value: StressStrain GmBH\n",
       "          measurementUnit: null\n",
       "          relationMapping: null\n",
       "      - id: id1738065716436sytize\n",
       "        name: Misc\n",
       "        entries:\n",
       "        - id: id1738065716436ch8ekr\n",
       "          type: Text\n",
       "          label: Room Number\n",
       "          value: B500\n",
       "          measurementUnit: null\n",
       "          relationMapping: null\n",
       "        - id: id1738065716436opl3l2\n",
       "          type: Text\n",
       "          label: Description\n",
       "          value: Compression Test Machine\n",
       "          measurementUnit: null\n",
       "          relationMapping: null\n",
       "    created_at: '2025-01-28T12:01:57.123339'\n",
       "    updated_at: '2025-01-28T12:01:57.123339']}"
      ]
     },
     "execution_count": 10,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "item5.linked_kitems.by_annotation"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Again, we are able to fetch the \"real\" KItem by using the `fetch` method of the linked KItem:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 11,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "kitem:\n",
       "  name: Machine-1\n",
       "  id: 01bb6156-dc37-4bed-86f2-cfd22ad2ffcc\n",
       "  ktype_id: testing-machine\n",
       "  slug: machine-1-01bb6156\n",
       "  annotations:\n",
       "  - iri: https://w3id.org/steel/ProcessOntology/TestingMachine\n",
       "    label: TestingMachine\n",
       "    namespace: https://w3id.org/steel/ProcessOntology\n",
       "  attachments:\n",
       "  - name: subgraph.ttl\n",
       "    content: null\n",
       "  linked_kitems:\n",
       "  - id: a0688216-78fe-41da-9d55-0b897cece9db\n",
       "    name: Research Institute ABC\n",
       "    slug: researchinstituteabc-a0688216\n",
       "    ktype_id: organization\n",
       "    summary: null\n",
       "    avatar_exists: false\n",
       "    annotations:\n",
       "    - iri: www.researchBACiri.org/foo\n",
       "      label: foo\n",
       "      namespace: www.researchBACiri.org\n",
       "    linked_kitems:\n",
       "    - id: 01bb6156-dc37-4bed-86f2-cfd22ad2ffcc\n",
       "    - id: 74438e78-0311-46a6-86dc-204f3ba8e550\n",
       "    external_links: []\n",
       "    contacts: []\n",
       "    authors:\n",
       "    - user_id: 7f0e5a37-353b-4bbc-b1f1-b6ad575f562d\n",
       "    linked_affiliations: []\n",
       "    attachments: []\n",
       "    user_groups: []\n",
       "    custom_properties: null\n",
       "    created_at: '2025-01-28T12:01:57.622925'\n",
       "    updated_at: '2025-01-28T12:01:57.622925'\n",
       "  - id: b0505a0f-8739-4162-9cad-240139338cd4\n",
       "    name: Specimen-1\n",
       "    slug: specimen-1-b0505a0f\n",
       "    ktype_id: specimen\n",
       "    summary: null\n",
       "    avatar_exists: false\n",
       "    annotations:\n",
       "    - iri: https://w3id.org/steel/ProcessOntology/TestPiece\n",
       "      label: TestPiece\n",
       "      namespace: https://w3id.org/steel/ProcessOntology\n",
       "    linked_kitems:\n",
       "    - id: 01bb6156-dc37-4bed-86f2-cfd22ad2ffcc\n",
       "    external_links: []\n",
       "    contacts: []\n",
       "    authors:\n",
       "    - user_id: 7f0e5a37-353b-4bbc-b1f1-b6ad575f562d\n",
       "    linked_affiliations: []\n",
       "    attachments:\n",
       "    - name: subgraph.ttl\n",
       "      content: null\n",
       "    user_groups: []\n",
       "    custom_properties:\n",
       "      sections:\n",
       "      - id: id0595fb5f1853a8\n",
       "        name: ''\n",
       "        entries:\n",
       "        - id: idba92210e193128\n",
       "          type: Number\n",
       "          label: Width\n",
       "          value: 0.5\n",
       "          measurementUnit:\n",
       "            iri: http://qudt.org/vocab/unit/MilliM\n",
       "            label: Millimetre\n",
       "            symbol: null\n",
       "            namespace: http://qudt.org/vocab/unit\n",
       "          relationMapping: null\n",
       "      - id: id1738065716575k25bj4\n",
       "        name: Misc\n",
       "        entries:\n",
       "        - id: id1738065716575quvhev\n",
       "          type: Slider\n",
       "          label: Length\n",
       "          value:\n",
       "          - 0.1\n",
       "          - 0.2\n",
       "          measurementUnit: null\n",
       "          relationMapping: null\n",
       "    created_at: '2025-01-28T12:01:57.317338'\n",
       "    updated_at: '2025-01-28T12:01:57.317338'\n",
       "  affiliations: []\n",
       "  authors:\n",
       "  - user_id: 7f0e5a37-353b-4bbc-b1f1-b6ad575f562d\n",
       "  avatar_exists: false\n",
       "  contacts: []\n",
       "  created_at: 2025-01-28 12:01:56.972740\n",
       "  updated_at: 2025-01-28 12:01:56.972740\n",
       "  external_links: []\n",
       "  kitem_apps: []\n",
       "  user_groups: []\n",
       "  custom_properties:\n",
       "    sections:\n",
       "    - id: id717506ec647db\n",
       "      name: ''\n",
       "      entries:\n",
       "      - id: id699fb85c65df4\n",
       "        type: Text\n",
       "        label: Producer\n",
       "        value: TestingLab GmBH\n",
       "    - id: id1738065716294lzgvq9\n",
       "      name: Misc\n",
       "      entries:\n",
       "      - id: id1738065716294eddmjb\n",
       "        type: Text\n",
       "        label: Room Number\n",
       "        value: A404\n",
       "      - id: id17380657162945c1q9b\n",
       "        type: Text\n",
       "        label: Description\n",
       "        value: Bending Test Machine\n",
       "  rdf_exists: true"
      ]
     },
     "execution_count": 11,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "item5.linked_kitems.by_annotation[\"https://w3id.org/steel/ProcessOntology/TestingMachine\"][0].fetch()"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Additionally, we can retrieve the linked KItems grouped by ktype:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 12,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "{ktype:\n",
       "   id: testing-machine\n",
       "   name: Testing Machine\n",
       "   webform:\n",
       "     semantics_enabled: true\n",
       "     sections_enabled: false\n",
       "     class_mapping:\n",
       "     - https://w3id.org/steel/ProcessOntology/TestingMachine\n",
       "     sections:\n",
       "     - id: id717506ec647db\n",
       "       name: ''\n",
       "       inputs:\n",
       "       - id: id699fb85c65df4\n",
       "         label: Producer\n",
       "         widget: Text\n",
       "         required: false\n",
       "         value: null\n",
       "         hint: null\n",
       "         hidden: false\n",
       "         ignore: false\n",
       "         select_options: []\n",
       "         measurement_unit: null\n",
       "         relation_mapping:\n",
       "           iri: https://w3id.org/steel/ProcessOntology/hasIdentifier\n",
       "           type: data_property\n",
       "           class_iri: null\n",
       "         relation_mapping_extra: null\n",
       "         multiple_selection: false\n",
       "         knowledge_type: null\n",
       "         range_options: null\n",
       "         placeholder: null\n",
       "       hidden: false\n",
       "   json_schema:\n",
       "     iri:\n",
       "     - https://w3id.org/steel/ProcessOntology/TestingMachine\n",
       "     suffix: slug\n",
       "     source: testing-machine[*]\n",
       "     suffix_from_location: true\n",
       "     custom_relations:\n",
       "     - object_location: producer\n",
       "       relation: https://w3id.org/steel/ProcessOntology/hasIdentifier\n",
       "       relation_type: data_property\n",
       "       object_type: string\n",
       "     - object_location: Name\n",
       "       relation: http://www.w3.org/2000/01/rdf-schema#label\n",
       "       relation_type: annotation_property\n",
       "       object_data_type: string\n",
       "   created_at: '2025-01-22T10:27:30.326818'\n",
       "   updated_at: '2025-01-22T10:27:30.326818': [linked_kitem:\n",
       "    id: 01bb6156-dc37-4bed-86f2-cfd22ad2ffcc\n",
       "    name: Machine-1\n",
       "    slug: machine-1-01bb6156\n",
       "    ktype_id: testing-machine\n",
       "    summary: null\n",
       "    avatar_exists: false\n",
       "    annotations:\n",
       "    - iri: https://w3id.org/steel/ProcessOntology/TestingMachine\n",
       "      label: TestingMachine\n",
       "      namespace: https://w3id.org/steel/ProcessOntology\n",
       "    linked_kitems:\n",
       "    - id: a0688216-78fe-41da-9d55-0b897cece9db\n",
       "    - id: b0505a0f-8739-4162-9cad-240139338cd4\n",
       "    external_links: []\n",
       "    contacts: []\n",
       "    authors:\n",
       "    - user_id: 7f0e5a37-353b-4bbc-b1f1-b6ad575f562d\n",
       "    linked_affiliations: []\n",
       "    attachments:\n",
       "    - name: subgraph.ttl\n",
       "      content: null\n",
       "    user_groups: []\n",
       "    custom_properties:\n",
       "      sections:\n",
       "      - id: id717506ec647db\n",
       "        name: ''\n",
       "        entries:\n",
       "        - id: id699fb85c65df4\n",
       "          type: Text\n",
       "          label: Producer\n",
       "          value: TestingLab GmBH\n",
       "          measurementUnit: null\n",
       "          relationMapping: null\n",
       "      - id: id1738065716294lzgvq9\n",
       "        name: Misc\n",
       "        entries:\n",
       "        - id: id1738065716294eddmjb\n",
       "          type: Text\n",
       "          label: Room Number\n",
       "          value: A404\n",
       "          measurementUnit: null\n",
       "          relationMapping: null\n",
       "        - id: id17380657162945c1q9b\n",
       "          type: Text\n",
       "          label: Description\n",
       "          value: Bending Test Machine\n",
       "          measurementUnit: null\n",
       "          relationMapping: null\n",
       "    created_at: '2025-01-28T12:01:56.972740'\n",
       "    updated_at: '2025-01-28T12:01:56.972740',\n",
       "  linked_kitem:\n",
       "    id: 74438e78-0311-46a6-86dc-204f3ba8e550\n",
       "    name: Machine-2\n",
       "    slug: machine-2-74438e78\n",
       "    ktype_id: testing-machine\n",
       "    summary: null\n",
       "    avatar_exists: false\n",
       "    annotations:\n",
       "    - iri: https://w3id.org/steel/ProcessOntology/TestingMachine\n",
       "      label: TestingMachine\n",
       "      namespace: https://w3id.org/steel/ProcessOntology\n",
       "    linked_kitems:\n",
       "    - id: 1d7e410b-bc16-4509-b7c9-64f9a8a77c93\n",
       "    - id: a0688216-78fe-41da-9d55-0b897cece9db\n",
       "    external_links: []\n",
       "    contacts: []\n",
       "    authors:\n",
       "    - user_id: 7f0e5a37-353b-4bbc-b1f1-b6ad575f562d\n",
       "    linked_affiliations: []\n",
       "    attachments:\n",
       "    - name: subgraph.ttl\n",
       "      content: null\n",
       "    user_groups: []\n",
       "    custom_properties:\n",
       "      sections:\n",
       "      - id: id717506ec647db\n",
       "        name: ''\n",
       "        entries:\n",
       "        - id: id699fb85c65df4\n",
       "          type: Text\n",
       "          label: Producer\n",
       "          value: StressStrain GmBH\n",
       "          measurementUnit: null\n",
       "          relationMapping: null\n",
       "      - id: id1738065716436sytize\n",
       "        name: Misc\n",
       "        entries:\n",
       "        - id: id1738065716436ch8ekr\n",
       "          type: Text\n",
       "          label: Room Number\n",
       "          value: B500\n",
       "          measurementUnit: null\n",
       "          relationMapping: null\n",
       "        - id: id1738065716436opl3l2\n",
       "          type: Text\n",
       "          label: Description\n",
       "          value: Compression Test Machine\n",
       "          measurementUnit: null\n",
       "          relationMapping: null\n",
       "    created_at: '2025-01-28T12:01:57.123339'\n",
       "    updated_at: '2025-01-28T12:01:57.123339']}"
      ]
     },
     "execution_count": 12,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "item5.linked_kitems.by_ktype"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "... and retrieve them by type:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 13,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "kitem:\n",
       "  name: Machine-1\n",
       "  id: 01bb6156-dc37-4bed-86f2-cfd22ad2ffcc\n",
       "  ktype_id: testing-machine\n",
       "  slug: machine-1-01bb6156\n",
       "  annotations:\n",
       "  - iri: https://w3id.org/steel/ProcessOntology/TestingMachine\n",
       "    label: TestingMachine\n",
       "    namespace: https://w3id.org/steel/ProcessOntology\n",
       "  attachments:\n",
       "  - name: subgraph.ttl\n",
       "    content: null\n",
       "  linked_kitems:\n",
       "  - id: a0688216-78fe-41da-9d55-0b897cece9db\n",
       "    name: Research Institute ABC\n",
       "    slug: researchinstituteabc-a0688216\n",
       "    ktype_id: organization\n",
       "    summary: null\n",
       "    avatar_exists: false\n",
       "    annotations:\n",
       "    - iri: www.researchBACiri.org/foo\n",
       "      label: foo\n",
       "      namespace: www.researchBACiri.org\n",
       "    linked_kitems:\n",
       "    - id: 01bb6156-dc37-4bed-86f2-cfd22ad2ffcc\n",
       "    - id: 74438e78-0311-46a6-86dc-204f3ba8e550\n",
       "    external_links: []\n",
       "    contacts: []\n",
       "    authors:\n",
       "    - user_id: 7f0e5a37-353b-4bbc-b1f1-b6ad575f562d\n",
       "    linked_affiliations: []\n",
       "    attachments: []\n",
       "    user_groups: []\n",
       "    custom_properties: null\n",
       "    created_at: '2025-01-28T12:01:57.622925'\n",
       "    updated_at: '2025-01-28T12:01:57.622925'\n",
       "  - id: b0505a0f-8739-4162-9cad-240139338cd4\n",
       "    name: Specimen-1\n",
       "    slug: specimen-1-b0505a0f\n",
       "    ktype_id: specimen\n",
       "    summary: null\n",
       "    avatar_exists: false\n",
       "    annotations:\n",
       "    - iri: https://w3id.org/steel/ProcessOntology/TestPiece\n",
       "      label: TestPiece\n",
       "      namespace: https://w3id.org/steel/ProcessOntology\n",
       "    linked_kitems:\n",
       "    - id: 01bb6156-dc37-4bed-86f2-cfd22ad2ffcc\n",
       "    external_links: []\n",
       "    contacts: []\n",
       "    authors:\n",
       "    - user_id: 7f0e5a37-353b-4bbc-b1f1-b6ad575f562d\n",
       "    linked_affiliations: []\n",
       "    attachments:\n",
       "    - name: subgraph.ttl\n",
       "      content: null\n",
       "    user_groups: []\n",
       "    custom_properties:\n",
       "      sections:\n",
       "      - id: id0595fb5f1853a8\n",
       "        name: ''\n",
       "        entries:\n",
       "        - id: idba92210e193128\n",
       "          type: Number\n",
       "          label: Width\n",
       "          value: 0.5\n",
       "          measurementUnit:\n",
       "            iri: http://qudt.org/vocab/unit/MilliM\n",
       "            label: Millimetre\n",
       "            symbol: null\n",
       "            namespace: http://qudt.org/vocab/unit\n",
       "          relationMapping: null\n",
       "      - id: id1738065716575k25bj4\n",
       "        name: Misc\n",
       "        entries:\n",
       "        - id: id1738065716575quvhev\n",
       "          type: Slider\n",
       "          label: Length\n",
       "          value:\n",
       "          - 0.1\n",
       "          - 0.2\n",
       "          measurementUnit: null\n",
       "          relationMapping: null\n",
       "    created_at: '2025-01-28T12:01:57.317338'\n",
       "    updated_at: '2025-01-28T12:01:57.317338'\n",
       "  affiliations: []\n",
       "  authors:\n",
       "  - user_id: 7f0e5a37-353b-4bbc-b1f1-b6ad575f562d\n",
       "  avatar_exists: false\n",
       "  contacts: []\n",
       "  created_at: 2025-01-28 12:01:56.972740\n",
       "  updated_at: 2025-01-28 12:01:56.972740\n",
       "  external_links: []\n",
       "  kitem_apps: []\n",
       "  user_groups: []\n",
       "  custom_properties:\n",
       "    sections:\n",
       "    - id: id717506ec647db\n",
       "      name: ''\n",
       "      entries:\n",
       "      - id: id699fb85c65df4\n",
       "        type: Text\n",
       "        label: Producer\n",
       "        value: TestingLab GmBH\n",
       "    - id: id1738065716294lzgvq9\n",
       "      name: Misc\n",
       "      entries:\n",
       "      - id: id1738065716294eddmjb\n",
       "        type: Text\n",
       "        label: Room Number\n",
       "        value: A404\n",
       "      - id: id17380657162945c1q9b\n",
       "        type: Text\n",
       "        label: Description\n",
       "        value: Bending Test Machine\n",
       "  rdf_exists: true"
      ]
     },
     "execution_count": 13,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "item5.linked_kitems.by_ktype[dsms.ktypes.TestingMachine][0].fetch()"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Clean up the DSMS from the tutortial:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 14,
   "metadata": {},
   "outputs": [],
   "source": [
    "del dsms[item1]\n",
    "del dsms[item2]\n",
    "del dsms[item3]\n",
    "del dsms[item4]\n",
    "del dsms[item5]\n",
    "\n",
    "dsms.commit()"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.10.15"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}