Update package to 0.1.1 (#122)

Author: tylerhutcherson

README.md

@@ -80,8 +80,6 @@ Choose from multiple Redis deployment options:
 
     [Load a schema](https://www.redisvl.com/user_guide/getting_started_01.html#example-schema-creation) from a [YAML file](schemas/schema.yaml):
     ```yaml
-    version: '0.1.0'
-
     index:
         name: user-index-v1
         prefix: user
@@ -231,7 +229,7 @@ embedding = co.embed(
 
 embeddings = co.embed_many(
     texts=["my document chunk content", "my other document chunk content"],
-    search_type="search_documents"
+    input_type="search_document"
 )
 ```
 

docs/_static/version_names.json

@@ -1,10 +1,15 @@
 [
   {
-    "name": "0.1.0 (stable)",
-    "version": "0.1.0",
+    "name": "0.1.1 (stable)",
+    "version": "0.1.1",
     "url": "/",
     "preferred": true
   },
+  {
+    "name": "0.1.0",
+    "version": "0.1.0",
+    "url": "/0.1.0/"
+  },
   {
     "name": "0.0.7",
     "version": "0.0.7",

docs/conf.py

@@ -19,7 +19,7 @@
 project = 'RedisVL'
 copyright = '2024, Redis Inc.'
 author = 'RedisVentures'
-version = "0.1.0"
+version = "0.1.1"
 
 # The full version, including alpha/beta/rc tags
 release = version

docs/overview/cli.ipynb

@@ -24,7 +24,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "\u001b[32m20:09:02\u001b[0m \u001b[34m[RedisVL]\u001b[0m \u001b[1;30mINFO\u001b[0m   RedisVL version 0.0.7\n"
+      "\u001b[32m09:00:12\u001b[0m \u001b[34m[RedisVL]\u001b[0m \u001b[1;30mINFO\u001b[0m   RedisVL version 0.1.1\n"
      ]
     }
    ],
@@ -39,11 +39,27 @@
    "source": [
     "# Index\n",
     "\n",
-    "The ``rvl index`` command is can be used for a number of tasks related to creating and managing vector indices. Wether you are working in Python or another language, this cli tool can still be useful for managing and inspecting your indices.\n",
+    "The ``rvl index`` command is can be used for a number of tasks related to creating and managing indices. Wether you are working in Python or another language, this cli tool can still be useful for managing and inspecting your indices.\n",
     "\n",
-    "first, we will create an index from a yaml schema that looks like the following\n",
+    "First, we will create an index from a yaml schema that looks like the following:\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Writing schema.yaml\n"
+     ]
+    }
+   ],
+   "source": [
+    "%%writefile schema.yaml\n",
     "\n",
-    "```yaml\n",
     "version: '0.1.0'\n",
     "\n",
     "index:\n",
@@ -59,20 +75,19 @@
     "      attrs:\n",
     "        dims: 768\n",
     "        algorithm: flat\n",
-    "        distance_metric: cosine\n",
-    "```"
+    "        distance_metric: cosine"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 2,
+   "execution_count": 3,
    "metadata": {},
    "outputs": [
     {
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "\u001b[32m20:09:04\u001b[0m \u001b[34m[RedisVL]\u001b[0m \u001b[1;30mINFO\u001b[0m   Index created successfully\n"
+      "\u001b[32m09:00:13\u001b[0m \u001b[34m[RedisVL]\u001b[0m \u001b[1;30mINFO\u001b[0m   Index created successfully\n"
      ]
     }
    ],
@@ -83,15 +98,15 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
+   "execution_count": 4,
    "metadata": {},
    "outputs": [
     {
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "\u001b[32m20:09:05\u001b[0m \u001b[34m[RedisVL]\u001b[0m \u001b[1;30mINFO\u001b[0m   Indices:\n",
-      "\u001b[32m20:09:05\u001b[0m \u001b[34m[RedisVL]\u001b[0m \u001b[1;30mINFO\u001b[0m   1. vectorizers\n"
+      "\u001b[32m09:00:15\u001b[0m \u001b[34m[RedisVL]\u001b[0m \u001b[1;30mINFO\u001b[0m   Indices:\n",
+      "\u001b[32m09:00:15\u001b[0m \u001b[34m[RedisVL]\u001b[0m \u001b[1;30mINFO\u001b[0m   1. vectorizers\n"
      ]
     }
    ],
@@ -102,7 +117,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": 5,
    "metadata": {},
    "outputs": [
     {
@@ -134,14 +149,14 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 5,
+   "execution_count": 6,
    "metadata": {},
    "outputs": [
     {
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "\u001b[32m20:09:09\u001b[0m \u001b[34m[RedisVL]\u001b[0m \u001b[1;30mINFO\u001b[0m   Index deleted successfully\n"
+      "\u001b[32m09:00:18\u001b[0m \u001b[34m[RedisVL]\u001b[0m \u001b[1;30mINFO\u001b[0m   Index deleted successfully\n"
      ]
     }
    ],
@@ -152,14 +167,14 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 6,
+   "execution_count": 7,
    "metadata": {},
    "outputs": [
     {
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "\u001b[32m20:09:11\u001b[0m \u001b[34m[RedisVL]\u001b[0m \u001b[1;30mINFO\u001b[0m   Indices:\n"
+      "\u001b[32m09:00:20\u001b[0m \u001b[34m[RedisVL]\u001b[0m \u001b[1;30mINFO\u001b[0m   Indices:\n"
      ]
     }
    ],
@@ -179,14 +194,14 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 7,
+   "execution_count": 8,
    "metadata": {},
    "outputs": [
     {
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "\u001b[32m20:09:12\u001b[0m \u001b[34m[RedisVL]\u001b[0m \u001b[1;30mINFO\u001b[0m   Index created successfully\n"
+      "\u001b[32m09:00:22\u001b[0m \u001b[34m[RedisVL]\u001b[0m \u001b[1;30mINFO\u001b[0m   Index created successfully\n"
      ]
     }
    ],
@@ -197,15 +212,15 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 8,
+   "execution_count": 9,
    "metadata": {},
    "outputs": [
     {
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "\u001b[32m20:09:14\u001b[0m \u001b[34m[RedisVL]\u001b[0m \u001b[1;30mINFO\u001b[0m   Indices:\n",
-      "\u001b[32m20:09:14\u001b[0m \u001b[34m[RedisVL]\u001b[0m \u001b[1;30mINFO\u001b[0m   1. vectorizers\n"
+      "\u001b[32m09:00:23\u001b[0m \u001b[34m[RedisVL]\u001b[0m \u001b[1;30mINFO\u001b[0m   Indices:\n",
+      "\u001b[32m09:00:23\u001b[0m \u001b[34m[RedisVL]\u001b[0m \u001b[1;30mINFO\u001b[0m   1. vectorizers\n"
      ]
     }
    ],
@@ -216,7 +231,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 9,
+   "execution_count": 10,
    "metadata": {},
    "outputs": [
     {
@@ -265,7 +280,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "\u001b[32m20:09:33\u001b[0m \u001b[34m[RedisVL]\u001b[0m \u001b[1;30mINFO\u001b[0m   Index deleted successfully\n"
+      "\u001b[32m09:00:27\u001b[0m \u001b[34m[RedisVL]\u001b[0m \u001b[1;30mINFO\u001b[0m   Index deleted successfully\n"
      ]
     }
    ],

docs/overview/installation.md

@@ -14,7 +14,7 @@ There are a few ways to install RedisVL. The easiest way is to use pip.
 Install `redisvl` into your Python (>=3.8) environment using `pip`:
 
 ```bash
-$ pip install redisvl
+$ pip install -U redisvl
 ```
 
 RedisVL comes with a few dependencies that are automatically installed, however, a few dependencies

docs/overview/schema.yaml

@@ -0,0 +1,17 @@
+
+version: '0.1.0'
+
+index:
+    name: vectorizers
+    prefix: doc
+    storage_type: hash
+
+fields:
+    - name: sentence
+      type: text
+    - name: embedding
+      type: vector
+      attrs:
+        dims: 768
+        algorithm: flat
+        distance_metric: cosine