add example for accessing in return statement

Author: rbs333

docs/user_guide/05_hash_vs_json.ipynb

@@ -513,7 +513,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 32,
+   "execution_count": 45,
    "metadata": {},
    "outputs": [
     {
@@ -526,11 +526,8 @@
     }
    ],
    "source": [
-    "import warnings\n",
     "from redisvl.utils.vectorize import HFTextVectorizer\n",
     "\n",
-    "warnings.filterwarnings(\"ignore\", category=FutureWarning, message=r\".*clean_up_tokenization_spaces.*\")\n",
-    "\n",
     "emb_model = HFTextVectorizer()\n",
     "\n",
     "bike_data = [\n",
@@ -573,12 +570,12 @@
     "        {\n",
     "            \"name\": \"brand\",\n",
     "            \"type\": \"tag\",\n",
-    "            \"path\": \"$.metadata.brand\" # note the '$'\n",
+    "            \"path\": \"$.metadata.brand\"\n",
     "        },\n",
     "        {\n",
     "            \"name\": \"price\",\n",
     "            \"type\": \"numeric\",\n",
-    "            \"path\": \"$.metadata.price\" # note the '$'\n",
+    "            \"path\": \"$.metadata.price\"\n",
     "        },\n",
     "        {\n",
     "            \"name\": \"bike_embedding\",\n",
@@ -597,7 +594,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 39,
+   "execution_count": 46,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -613,17 +610,17 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 40,
+   "execution_count": 47,
    "metadata": {},
    "outputs": [
     {
      "data": {
       "text/plain": [
-       "['bike-json:6c32bfb9d5114e23866d564af694a15b',\n",
-       " 'bike-json:a22a2757f0f043f4a0abdd4ad5322989']"
+       "['bike-json:de92cb9955434575b20f4e87a30b03d5',\n",
+       " 'bike-json:054ab3718b984532b924946fa5ce00c6']"
       ]
      },
-     "execution_count": 40,
+     "execution_count": 47,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -634,7 +631,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 43,
+   "execution_count": 48,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -647,30 +644,40 @@
     "                return_fields=[\n",
     "                    \"brand\",\n",
     "                    \"name\",\n",
+    "                    \"$.metadata.type\"\n",
     "                ]\n",
     "            )\n",
     "\n",
     "\n",
     "results = bike_index.query(v)"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "**Note:** As shown in the example if you want to retrieve a field from json object that was not indexed you will also need to supply the full path as with `$.metadata.type`."
+   ]
+  },
   {
    "cell_type": "code",
-   "execution_count": 42,
+   "execution_count": 49,
    "metadata": {},
    "outputs": [
     {
      "data": {
       "text/plain": [
-       "[{'id': 'bike-json:a22a2757f0f043f4a0abdd4ad5322989',\n",
+       "[{'id': 'bike-json:054ab3718b984532b924946fa5ce00c6',\n",
        "  'vector_distance': '0.519989073277',\n",
-       "  'brand': 'Trek'},\n",
-       " {'id': 'bike-json:6c32bfb9d5114e23866d564af694a15b',\n",
+       "  'brand': 'Trek',\n",
+       "  '$.metadata.type': 'Enduro bikes'},\n",
+       " {'id': 'bike-json:de92cb9955434575b20f4e87a30b03d5',\n",
        "  'vector_distance': '0.657624483109',\n",
-       "  'brand': 'Specialized'}]"
+       "  'brand': 'Specialized',\n",
+       "  '$.metadata.type': 'Enduro bikes'}]"
       ]
      },
-     "execution_count": 42,
+     "execution_count": 49,
      "metadata": {},
      "output_type": "execute_result"
     }