hed_schema_querying.ipynb

{
 "cells": [
  {
   "cell_type": "code",
   "execution_count": 5,
   "metadata": {},
   "outputs": [],
   "source": [
    "import json\n",
    "import os\n",
    "\n",
    "import chromadb\n",
    "\n",
    "import autogen\n",
    "from autogen.agentchat.contrib.retrieve_assistant_agent import RetrieveAssistantAgent\n",
    "from autogen.agentchat.contrib.retrieve_user_proxy_agent import RetrieveUserProxyAgent\n",
    "\n",
    "# Accepted file formats for that can be stored in\n",
    "# a vector database instance\n",
    "from autogen.retrieve_utils import TEXT_FORMATS\n",
    "# When using a single openai endpoint, you can use the following:\n",
    "config_list = [{\"model\": \"gpt-4\", \"api_key\": os.getenv(\"OPENAI_API_KEY\")}]"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "metadata": {},
   "outputs": [
    {
     "name": "stderr",
     "output_type": "stream",
     "text": [
      "/var/folders/c2/k7vlgt7j1y306mj9yk_51jvr0000gn/T/ipykernel_49681/1805897931.py:20: XMLParsedAsHTMLWarning: It looks like you're parsing an XML document using an HTML parser. If this really is an HTML document (maybe it's XHTML?), you can ignore or filter this warning. If it's XML, you should know that using an XML parser will be more reliable. To parse this document as XML, make sure you have the lxml package installed, and pass the keyword argument `features=\"xml\"` into the BeautifulSoup constructor.\n",
      "  soup = BeautifulSoup(xml_content, \"lxml\")\n"
     ]
    }
   ],
   "source": [
    "import requests\n",
    "from io import StringIO\n",
    "from bs4 import BeautifulSoup\n",
    "import os\n",
    "def get_hed_vocab():\n",
    "    if os.path.exists('HEDLatest_terms'):\n",
    "        with open('HEDLatest_terms', 'r') as fin:\n",
    "            return fin.read()\n",
    "    else:\n",
    "        # URL of the XML file\n",
    "        url = \"https://raw.githubusercontent.com/hed-standard/hed-schemas/main/standard_schema/hedxml/HEDLatest.xml\"\n",
    "        \n",
    "        # Send a GET request to the URL\n",
    "        response = requests.get(url)\n",
    "        \n",
    "        # Check if the request was successful (status code 200)\n",
    "        if response.status_code == 200:\n",
    "            # Parse the XML content\n",
    "            xml_content = response.text\n",
    "            soup = BeautifulSoup(xml_content, \"lxml\")\n",
    "        \n",
    "            # Find all nodes and extract their names\n",
    "            all_nodes = soup.find_all('node')\n",
    "            node_names = [node.find('name', recursive=False).string for node in all_nodes]\n",
    "            description = []\n",
    "            for node in all_nodes:\n",
    "                if node.find('description', recursive=False):\n",
    "                    description.append(node.find('description', recursive=False).string)\n",
    "                else:\n",
    "                    description.append('')\n",
    "                # print(node.find('description', recursive=False).string)\n",
    "        \n",
    "            return dict(zip(node_names, description))\n",
    "            # return node_names\n",
    "        else:\n",
    "            print(f\"Failed to retrieve data from the URL. Status code: {response.status_code}\") \n",
    "hed_vocab_description = get_hed_vocab()"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 8,
   "metadata": {},
   "outputs": [],
   "source": [
    "import json\n",
    "with open('hed_vocab_description.json', 'w', encoding='utf-8') as out:\n",
    "    json.dump(hed_vocab_description, out, indent=4)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 12,
   "metadata": {},
   "outputs": [],
   "source": [
    "# 1. create an RetrieveAssistantAgent instance named \"assistant\"\n",
    "assistant = RetrieveAssistantAgent(\n",
    "    name=\"assistant\",\n",
    "    system_message=\"You are a helpful assistant.\",\n",
    "    llm_config={\n",
    "        \"timeout\": 600,\n",
    "        \"cache_seed\": 42,\n",
    "        \"config_list\": config_list,\n",
    "    },\n",
    ")\n",
    "\n",
    "ragproxyagent = RetrieveUserProxyAgent(\n",
    "    name=\"ragproxyagent\",\n",
    "    human_input_mode=\"NEVER\",\n",
    "    # max_consecutive_auto_reply=3,\n",
    "    retrieve_config={\n",
    "        \"task\": \"code\",\n",
    "        \"docs_path\": [\n",
    "            \"https://raw.githubusercontent.com/hed-standard/hed-schemas/main/standard_schema/hedxml/HEDLatest.xml\"\n",
    "        ],\n",
    "        # \"custom_text_types\": [\"non-existent-type\"],\n",
    "        # \"chunk_token_size\": 2000,\n",
    "        \"model\": config_list[0][\"model\"],\n",
    "        # \"client\": chromadb.PersistentClient(path=\"/tmp/chromadb\"),  # deprecated, use \"vector_db\" instead\n",
    "        \"vector_db\": \"chroma\",  # to use the deprecated `client` parameter, set to None and uncomment the line above\n",
    "        \"overwrite\": True,  # set to True if you want to overwrite an existing collection\n",
    "    },\n",
    "    code_execution_config=False,  # set to False if you don't want to execute the code\n",
    ")"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 13,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Trying to create collection.\n"
     ]
    },
    {
     "name": "stderr",
     "output_type": "stream",
     "text": [
      "max_tokens is too small to fit a single line of text. Breaking this line:\n",
      "\t ...\n",
      "Failed to split docs with must_break_at_empty_line being True, set to False.\n",
      "2024-06-11 14:08:51,356 - autogen.agentchat.contrib.retrieve_user_proxy_agent - INFO - Found 15 chunks.\u001b[0m\n",
      "2024-06-11 14:08:51,361 - autogen.agentchat.contrib.vectordb.chromadb - INFO - No content embedding is provided. Will use the VectorDB's embedding function to generate the content embedding.\u001b[0m\n",
      "Number of requested results 20 is greater than number of elements in index 15, updating n_results = 15\n"
     ]
    },
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "VectorDB returns doc_ids:  [['a5042372', '8fc3eac8', '916dc60e', 'f69230a5', '36409436', 'c0fabc27', '94229ac3', 'dd34596f', '3e05f163', '8956a23f', 'cf31629e', '317f5077', 'beb6a151', '55b9e55e', 'cfe19a68']]\n",
      "\u001b[32mSkip doc_id a5042372 as it is too long to fit in the context.\u001b[0m\n",
      "\u001b[32mSkip doc_id 8fc3eac8 as it is too long to fit in the context.\u001b[0m\n",
      "\u001b[32mAdding content of doc 916dc60e to context.\u001b[0m\n",
      "\u001b[32mAdding content of doc f69230a5 to context.\u001b[0m\n",
      "\u001b[32mSkip doc_id 36409436 as it is too long to fit in the context.\u001b[0m\n",
      "\u001b[32mSkip doc_id c0fabc27 as it is too long to fit in the context.\u001b[0m\n",
      "\u001b[32mSkip doc_id 94229ac3 as it is too long to fit in the context.\u001b[0m\n",
      "\u001b[32mSkip doc_id dd34596f as it is too long to fit in the context.\u001b[0m\n",
      "\u001b[32mSkip doc_id 3e05f163 as it is too long to fit in the context.\u001b[0m\n",
      "\u001b[32mSkip doc_id 8956a23f as it is too long to fit in the context.\u001b[0m\n",
      "\u001b[32mSkip doc_id cf31629e as it is too long to fit in the context.\u001b[0m\n",
      "\u001b[32mSkip doc_id 317f5077 as it is too long to fit in the context.\u001b[0m\n",
      "\u001b[32mSkip doc_id beb6a151 as it is too long to fit in the context.\u001b[0m\n",
      "\u001b[32mSkip doc_id 55b9e55e as it is too long to fit in the context.\u001b[0m\n",
      "\u001b[32mSkip doc_id cfe19a68 as it is too long to fit in the context.\u001b[0m\n",
      "\u001b[33mragproxyagent\u001b[0m (to assistant):\n",
      "\n",
      "You're a retrieve augmented coding assistant. You answer user's questions based on your own knowledge and the\n",
      "context provided by the user.\n",
      "If you can't answer the question with or without the current context, you should reply exactly `UPDATE CONTEXT`.\n",
      "For code generation, you must obey the following rules:\n",
      "Rule 1. You MUST NOT install any packages because all the packages needed are already installed.\n",
      "Rule 2. You must follow the formats below to write your code:\n",
      "```language\n",
      "# your code\n",
      "```\n",
      "\n",
      "User's question is: You have knowledge of the tags in the Hierarchical Event Descriptor (HED) system.\n",
      "Tell me the tags that might be relevant to the following sentence description and why\n",
      "A picture of a blue square on a red background\n",
      "\n",
      "\n",
      "Context is: <?xml version=\"1.0\" ?>\n",
      "<HED xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" version=\"8.3.0\" xsi:noNamespaceSchemaLocation=\"https://github.com/hed-standard/hed-specification/raw/master/hedxml/HED8.0.0.xsd\">\n",
      "   <prologue>The HED standard schema is a hierarchically-organized vocabulary for annotating events and experimental structure. HED annotations consist of comma-separated tags drawn from this vocabulary. This vocabulary can be augmented by terms drawn from specialized library schema. \n",
      "</property>\n",
      "      </schemaAttributeDefinition>\n",
      "      <schemaAttributeDefinition>\n",
      "         <name>rooted</name>\n",
      "         <description>This top-level library schema node should have a parent which is the indicated node in the partnered standard schema.</description>\n",
      "         <property>\n",
      "            <name>tagDomain</name>\n",
      "         </property>\n",
      "         <property>\n",
      "            <name>tagRange</name>\n",
      "         </property>\n",
      "         <property>\n",
      "            <name>hedId</name>\n",
      "            <value>HED_0010502</value>\n",
      "         </property>\n",
      "         <property>\n",
      "            <name>annotationProperty</name>\n",
      "         </property>\n",
      "      </schemaAttributeDefinition>\n",
      "      <schemaAttributeDefinition>\n",
      "         <name>takesValue</name>\n",
      "         <description>This tag is a hashtag placeholder that is expected to be replaced with a user-defined value.</description>\n",
      "         <property>\n",
      "            <name>tagDomain</name>\n",
      "         </property>\n",
      "         <property>\n",
      "            <name>boolRange</name>\n",
      "         </property>\n",
      "         <property>\n",
      "            <name>hedId</name>\n",
      "            <value>HED_0010503</value>\n",
      "         </property>\n",
      "         <property>\n",
      "            <name>annotationProperty</name>\n",
      "         </property>\n",
      "      </schemaAttributeDefinition>\n",
      "      <schemaAttributeDefinition>\n",
      "         <name>defaultUnits</name>\n",
      "         <description>The default units to use if the placeholder has a unit class but the substituted value has no units.</description>\n",
      "         <property>\n",
      "            <name>unitClassDomain</name>\n",
      "         </property>\n",
      "         <property>\n",
      "            <name>unitRange</name>\n",
      "         </property>\n",
      "         <property>\n",
      "            <name>hedId</name>\n",
      "            <value>HED_0010104</value>\n",
      "         </property>\n",
      "      </schemaAttributeDefinition>\n",
      "      <schemaAttributeDefinition>\n",
      "         <name>isPartOf</name>\n",
      "         <description>This tag is part of the indicated tag -- as in the nose is part of the face.</description>\n",
      "         <property>\n",
      "            <name>tagDomain</name>\n",
      "         </property>\n",
      "         <property>\n",
      "            <name>tagRange</name>\n",
      "         </property>\n",
      "         <property>\n",
      "            <name>hedId</name>\n",
      "            <value>HED_0010109</value>\n",
      "         </property>\n",
      "      </schemaAttributeDefinition>\n",
      "      <schemaAttributeDefinition>\n",
      "         <name>relatedTag</name>\n",
      "         <description>A HED tag that is closely related to this tag. This attribute is used by tagging tools.</description>\n",
      "         <property>\n",
      "            <name>tagDomain</name>\n",
      "         </property>\n",
      "         <property>\n",
      "            <name>tagRange</name>\n",
      "         </property>\n",
      "         <property>\n",
      "            <name>hedId</name>\n",
      "            <value>HED_0010105</value>\n",
      "         </property>\n",
      "      </schemaAttributeDefinition>\n",
      "      <schemaAttributeDefinition>\n",
      "         <name>suggestedTag</name>\n",
      "         <description>A tag that is often associated with this tag. This attribute is used by tagging tools to provide tagging suggestions.</description>\n",
      "         <property>\n",
      "            <name>tagDomain</name>\n",
      "         </property>\n",
      "         <property>\n",
      "            <name>tagRange</name>\n",
      "         </property>\n",
      "         <property>\n",
      "            <name>hedId</name>\n",
      "            <value>HED_0010106</value>\n",
      "         </property>\n",
      "      </schemaAttributeDefinition>\n",
      "      <schemaAttributeDefinition>\n",
      "         <name>unitClass</name>\n",
      "         <description>The unit class that the value of a placeholder node can belong to.</description>\n",
      "         <property>\n",
      "            <name>tagDomain</name>\n",
      "         </property>\n",
      "         <property>\n",
      "            <name>unitClassRange</name>\n",
      "         </property>\n",
      "         <property>\n",
      "            <name>hedId</name>\n",
      "            <value>HED_0010107</value>\n",
      "         </property>\n",
      "      </schemaAttributeDefinition>\n",
      "      <schemaAttributeDefinition>\n",
      "         <name>valueClass</name>\n",
      "         <description>Type of value taken on by the value of a placeholder node.</description>\n",
      "         <property>\n",
      "            <name>tagDomain</name>\n",
      "         </property>\n",
      "         <property>\n",
      "            <name>valueClassRange</name>\n",
      "         </property>\n",
      "         <property>\n",
      "            <name>hedId</name>\n",
      "            <value>HED_0010108</value>\n",
      "         </property>\n",
      "      </schemaAttributeDefinition>\n",
      "      <schemaAttributeDefinition>\n",
      "         <name>allowedCharacter</name>\n",
      "         <description>A special character that is allowed in expressing the value of a placeholder of a specified value class. Allowed characters may be listed individual, named individually, or named as a group as specified in Section 2.2 Character sets and restrictions of the HED specification.</description>\n",
      "         <property>\n",
      "            <name>unitDomain</name>\n",
      "         </property>\n",
      "         <property>\n",
      "            <name>unitModifierDomain</name>\n",
      "         </property>\n",
      "         <property>\n",
      "            <name>valueClassDomain</name>\n",
      "         </property>\n",
      "         <property>\n",
      "            <name>stringRange</name>\n",
      "         </property>\n",
      "         <property>\n",
      "            <name>hedId</name>\n",
      "            <value>HED_0010304</value>\n",
      "         </property>\n",
      "      </schemaAttributeDefinition>\n",
      "      <schemaAttributeDefinition>\n",
      "         <name>conversionFactor</name>\n",
      "         <description>The factor to multiply these units or unit modifiers by to convert to default units.</description>\n",
      "         <property>\n",
      "            <name>unitDomain</name>\n",
      "         </property>\n",
      "         <property>\n",
      "            <name>unitModifierDomain</name>\n",
      "         </property>\n",
      "         <property>\n",
      "            <name>numericRange</name>\n",
      "         </property>\n",
      "         <property>\n",
      "            <name>hedId</name>\n",
      "            <value>HED_0010305</value>\n",
      "         </property>\n",
      "      </schemaAttributeDefinition>\n",
      "      <schemaAttributeDefinition>\n",
      "         <name>deprecatedFrom</name>\n",
      "         <description>The latest schema version in which the element was not deprecated.</description>\n",
      "         <property>\n",
      "            <name>elementDomain</name>\n",
      "         </property>\n",
      "         <property>\n",
      "            <name>stringRange</name>\n",
      "         </property>\n",
      "         <property>\n",
      "            <name>hedId</name>\n",
      "            <value>HED_0010306</value>\n",
      "         </property>\n",
      "      </schemaAttributeDefinition>\n",
      "      <schemaAttributeDefinition>\n",
      "         <name>extensionAllowed</name>\n",
      "         <description>Users can add unlimited levels of child nodes under this tag. This tag is propagated to child nodes except for hashtag placeholders.</description>\n",
      "         <property>\n",
      "            <name>tagDomain</name>\n",
      "         </property>\n",
      "         <property>\n",
      "            <name>boolRange</name>\n",
      "         </property>\n",
      "         <property>\n",
      "            <name>hedId</name>\n",
      "            <value>HED_0010307</value>\n",
      "         </property>\n",
      "      </schemaAttributeDefinition>\n",
      "      <schemaAttributeDefinition>\n",
      "         <name>inLibrary</name>\n",
      "         <description>The named library schema that this schema element is from. This attribute is added by tools when a library schema is merged into its partnered standard schema.</description>\n",
      "         <property>\n",
      "            <name>elementDomain</name>\n",
      "         </property>\n",
      "         <property>\n",
      "            <name>stringRange</name>\n",
      "         </property>\n",
      "         <property>\n",
      "            <name>hedId</name>\n",
      "            <value>HED_0010309</value>\n",
      "         </property>\n",
      "      </schemaAttributeDefinition>\n",
      "      <schemaAttributeDefinition>\n",
      "         <name>reserved</name>\n",
      "         <description>This tag has special meaning and requires special handling by tools.</description>\n",
      "         <property>\n",
      "            <name>tagDomain</name>\n",
      "         </property>\n",
      "         <property>\n",
      "            <name>boolRange</name>\n",
      "         </property>\n",
      "         <property>\n",
      "            <name>hedId</name>\n",
      "            <value>HED_0010310</value>\n",
      "         </property>\n",
      "      </schemaAttributeDefinition>\n",
      "      <schemaAttributeDefinition>\n",
      "         <name>SIUnit</name>\n",
      "         <description>This unit element is an SI unit and can be modified by multiple and sub-multiple names. Note that some units such as byte are designated as SI units although they are not part of the standard.</description>\n",
      "         <property>\n",
      "            <name>unitDomain</name>\n",
      "         </property>\n",
      "         <property>\n",
      "            <name>boolRange</name>\n",
      "         </property>\n",
      "         <property>\n",
      "            <name>hedId</name>\n",
      "            <value>HED_0010311</value>\n",
      "         </property>\n",
      "      </schemaAttributeDefinition>\n",
      "      <schemaAttributeDefinition>\n",
      "         <name>SIUnitModifier</name>\n",
      "         <description>This SI unit modifier represents a multiple or sub-multiple of a base unit rather than a unit symbol.</description>\n",
      "         <property>\n",
      "            <name>unitModifierDomain</name>\n",
      "         </property>\n",
      "         <property>\n",
      "            <name>boolRange</name>\n",
      "         </property>\n",
      "         <property>\n",
      "            <name>hedId</name>\n",
      "            <value>HED_0010312</value>\n",
      "         </property>\n",
      "      </schemaAttributeDefinition>\n",
      "      <schemaAttributeDefinition>\n",
      "         <name>SIUnitSymbolModifier</name>\n",
      "         <description>This SI unit modifier represents a multiple or sub-multiple of a unit symbol rather than a base symbol.</description>\n",
      "         <property>\n",
      "            <name>unitModifierDomain</name>\n",
      "         </property>\n",
      "         <property>\n",
      "            <name>boolRange</name>\n",
      "         </property>\n",
      "         <property>\n",
      "            <name>hedId</name>\n",
      "            <value>HED_0010313</value>\n",
      "         </property>\n",
      "      </schemaAttributeDefinition>\n",
      "      <schemaAttributeDefinition>\n",
      "         <name>tagGroup</name>\n",
      "         <description>This tag can only appear inside a tag group.</description>\n",
      "         <property>\n",
      "            <name>tagDomain</name>\n",
      "         </property>\n",
      "         <property>\n",
      "            <name>boolRange</name>\n",
      "         </property>\n",
      "         <property>\n",
      "            <name>hedId</name>\n",
      "            <value>HED_0010314</value>\n",
      "         </property>\n",
      "      </schemaAttributeDefinition>\n",
      "      <schemaAttributeDefinition>\n",
      "         <name>topLevelTagGroup</name>\n",
      "         <description>This tag (or its descendants) can only appear in a top-level tag group. There are additional tag-specific restrictions on what other tags can appear in the group with this tag.</description>\n",
      "         <property>\n",
      "            <name>tagDomain</name>\n",
      "         </property>\n",
      "         <property>\n",
      "            <name>boolRange</name>\n",
      "         </property>\n",
      "         <property>\n",
      "            <name>hedId</name>\n",
      "            <value>HED_0010315</value>\n",
      "         </property>\n",
      "      </schemaAttributeDefinition>\n",
      "      <schemaAttributeDefinition>\n",
      "         <name>unique</name>\n",
      "         <description>Only one of this tag or its descendants can be used in the event-level HED string.</description>\n",
      "         <property>\n",
      "            <name>tagDomain</name>\n",
      "         </property>\n",
      "         <property>\n",
      "            <name>boolRange</name>\n",
      "         </property>\n",
      "         <property>\n",
      "            <name>hedId</name>\n",
      "            <value>HED_0010316</value>\n",
      "         </property>\n",
      "      </schemaAttributeDefinition>\n",
      "      <schemaAttributeDefinition>\n",
      "         <name>unitPrefix</name>\n",
      "         <description>This unit is a prefix unit (e.g., dollar sign in the currency units).</description>\n",
      "         <property>\n",
      "            <name>unitDomain</name>\n",
      "         </property>\n",
      "         <property>\n",
      "            <name>boolRange</name>\n",
      "         </property>\n",
      "         <property>\n",
      "            <name>hedId</name>\n",
      "            <value>HED_0010317</value>\n",
      "         </property>\n",
      "      </schemaAttributeDefinition>\n",
      "      <schemaAttributeDefinition>\n",
      "         <name>unitSymbol</name>\n",
      "         <description>This tag is an abbreviation or symbol representing a type of unit. Unit symbols represent both the singular and the plural and thus cannot be pluralized.</description>\n",
      "         <property>\n",
      "            <name>unitDomain</name>\n",
      "         </property>\n",
      "         <property>\n",
      "            <name>boolRange</name>\n",
      "         </property>\n",
      "         <property>\n",
      "            <name>hedId</name>\n",
      "            <value>HED_0010318</value>\n",
      "         </property>\n",
      "      </schemaAttributeDefinition>\n",
      "   </schemaAttributeDefinitions>\n",
      "   <propertyDefinitions>\n",
      "      <propertyDefinition>\n",
      "         <name>annotationProperty</name>\n",
      "         <description>The value is not inherited by child nodes.</description>\n",
      "         <property>\n",
      "            <name>hedId</name>\n",
      "            <value>HED_0010701</value>\n",
      "         </property>\n",
      "      </propertyDefinition>\n",
      "      <propertyDefinition>\n",
      "         <name>boolRange</name>\n",
      "         <description>This schema attribute's value can be true or false. This property was formerly named boolProperty.</description>\n",
      "         <property>\n",
      "            <name>hedId</name>\n",
      "            <value>HED_0010702</value>\n",
      "         </property>\n",
      "      </propertyDefinition>\n",
      "      <propertyDefinition>\n",
      "         <name>elementDomain</name>\n",
      "         <description>This schema attribute can apply to any type of element class (i.e., tag, unit, unit class, unit modifier, or value class). This property was formerly named elementProperty.</description>\n",
      "         <property>\n",
      "            <name>hedId</name>\n",
      "            <value>HED_0010703</value>\n",
      "         </property>\n",
      "      </propertyDefinition>\n",
      "      <propertyDefinition>\n",
      "         <name>tagDomain</name>\n",
      "         <description>This schema attribute can apply to node (tag-term) elements. This was added so attributes could apply to multiple types of elements. This property was formerly named nodeProperty.</description>\n",
      "         <property>\n",
      "            <name>hedId</name>\n",
      "            <value>HED_0010704</value>\n",
      "         </property>\n",
      "      </propertyDefinition>\n",
      "      <propertyDefinition>\n",
      "         <name>tagRange</name>\n",
      "         <description>This schema attribute's value can be a node. This property was formerly named nodeProperty.</description>\n",
      "         <property>\n",
      "            <name>hedId</name>\n",
      "            <value>HED_0010705</value>\n",
      "         </property>\n",
      "      </propertyDefinition>\n",
      "      <propertyDefinition>\n",
      "         <name>numericRange</name>\n",
      "         <description>This schema attribute's value can be numeric.</description>\n",
      "         <property>\n",
      "            <name>hedId</name>\n",
      "            <value>HED_0010706</value>\n",
      "         </property>\n",
      "      </propertyDefinition>\n",
      "      <propertyDefinition>\n",
      "         <name>stringRange</name>\n",
      "         <description>This schema attribute's value can be a string.</description>\n",
      "         <property>\n",
      "            <name>hedId</name>\n",
      "            <value>HED_0010707</value>\n",
      "         </property>\n",
      "      </propertyDefinition>\n",
      "      <propertyDefinition>\n",
      "         <name>unitClassDomain</name>\n",
      "         <description>This schema attribute can apply to unit classes. This property was formerly named unitClassProperty.</description>\n",
      "         <property>\n",
      "            <name>hedId</name>\n",
      "            <value>HED_0010708</value>\n",
      "         </property>\n",
      "      </propertyDefinition>\n",
      "      <propertyDefinition>\n",
      "         <name>unitClassRange</name>\n",
      "         <description>This schema attribute's value can be a unit class.</description>\n",
      "         <property>\n",
      "            <name>hedId</name>\n",
      "            <value>HED_0010709</value>\n",
      "         </property>\n",
      "      </propertyDefinition>\n",
      "      <propertyDefinition>\n",
      "         <name>unitModifierDomain</name>\n",
      "         <description>This schema attribute can apply to unit modifiers. This property was formerly named unitModifierProperty.</description>\n",
      "         <property>\n",
      "            <name>hedId</name>\n",
      "            <value>HED_0010710</value>\n",
      "         </property>\n",
      "      </propertyDefinition>\n",
      "      <propertyDefinition>\n",
      "         <name>unitDomain</name>\n",
      "         <description>This schema attribute can apply to units. This property was formerly named unitProperty.</description>\n",
      "         <property>\n",
      "            <name>hedId</name>\n",
      "            <value>HED_0010711</value>\n",
      "         </property>\n",
      "      </propertyDefinition>\n",
      "      <propertyDefinition>\n",
      "         <name>unitRange</name>\n",
      "         <description>This schema attribute's value can be units.</description>\n",
      "         <property>\n",
      "            <name>hedId</name>\n",
      "            <value>HED_0010712</value>\n",
      "         </property>\n",
      "      </propertyDefinition>\n",
      "      <propertyDefinition>\n",
      "         <name>valueClassDomain</name>\n",
      "         <description>This schema attribute can apply to value classes. This property was formerly named valueClassProperty.</description>\n",
      "         <property>\n",
      "            <name>hedId</name>\n",
      "            <value>HED_0010713</value>\n",
      "         </property>\n",
      "      </propertyDefinition>\n",
      "      <propertyDefinition>\n",
      "         <name>valueClassRange</name>\n",
      "         <description>This schema attribute's value can be a value class.</description>\n",
      "         <property>\n",
      "            <name>hedId</name>\n",
      "            <value>HED_0010714</value>\n",
      "         </property>\n",
      "      </propertyDefinition>\n",
      "   </propertyDefinitions>\n",
      "   <epilogue>This schema is released under the Creative Commons Attribution 4.0 International and is a product of the HED Working Group. The DOI for the latest version of the HED standard schema is 10.5281/zenodo.7876037.</epilogue>\n",
      "</HED>\n",
      "\n",
      "\n",
      "\n",
      "--------------------------------------------------------------------------------\n",
      "\u001b[33massistant\u001b[0m (to ragproxyagent):\n",
      "\n",
      "The Hierarchical Event Descriptor (HED) system provides a standardized way of annotating events in human data records. However, the context provided here doesn't list the specific HED tags and their descriptions so it's difficult to pinpoint exact tags for the given sentence description \"A picture of a blue square on a red background\".\n",
      "\n",
      "However, based on a general understanding of the HED system, here are potential relevant tags the sentence might be associated with and why:\n",
      "\n",
      "1. Sensory presentation: As the sentence describes a visual stimulus, a Sensory presentation tag might be relevant specifically focusing on visual sensory presentation.\n",
      "\n",
      "2. Item: Since we are discussing a square, an Item tag might be relevant to specify the type of object being viewed.\n",
      "\n",
      "3. Attribute/Color: The colors blue and red are mentioned in the sentence. Hence, there might be tags under Attribute that describe colors. \n",
      "\n",
      "These tags are purely hypothetical as the true tags can only be identified if the actual HED schema or ontology with all its tagged definitions is given.\n",
      "\n",
      "Would you mind providing this or should I update the context?\n",
      "\n",
      "--------------------------------------------------------------------------------\n"
     ]
    }
   ],
   "source": [
    "# reset the assistant. Always reset the assistant before starting a new conversation.\n",
    "assistant.reset()\n",
    "\n",
    "# given a problem, we use the ragproxyagent to generate a prompt to be sent to the assistant as the initial message.\n",
    "# the assistant receives the message and generates a response. The response will be sent back to the ragproxyagent for processing.\n",
    "# The conversation continues until the termination condition is met, in RetrieveChat, the termination condition when no human-in-loop is no code block detected.\n",
    "# With human-in-loop, the conversation will continue until the user says \"exit\".\n",
    "code_problem = \"You have knowledge of the tags in the Hierarchical Event Descriptor (HED) system.\\n\" \\\n",
    "    \"Tell me the tags that might be relevant to the following sentence description and why\\n\" \\\n",
    "    \"A picture of a blue square on a red background\\n\" \n",
    "chat_result = ragproxyagent.initiate_chat(\n",
    "    assistant, \n",
    "    message=ragproxyagent.message_generator, \n",
    "    problem=code_problem, \n",
    ")"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": []
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": ".venv",
   "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.11.9"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}