feat: adding basic example for MVI

.github/workflows/on-pull-request-mvi.yml

@@ -0,0 +1,67 @@
+name: On Pull Request
+
+on:
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: macos-latest
+    strategy:
+      max-parallel: 2
+      matrix:
+        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+        new-python-protobuf: ["true"]
+        include:
+          - python-version: "3.7"
+            new-python-protobuf: "false"
+
+    env:
+      TEST_AUTH_TOKEN: ${{ secrets.ALPHA_TEST_AUTH_TOKEN }}
+      TEST_CACHE_NAME: python-integration-test-${{ matrix.python-version }}-${{ matrix.new-python-protobuf }}-${{ github.sha }}
+      TEST_VECTOR_INDEX_NAME: python-integration-test-vector-${{ matrix.python-version }}-${{ matrix.new-python-protobuf }}-${{ github.sha }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Commitlint and Other Shared Build Steps
+        uses: momentohq/standards-and-practices/github-actions/shared-build@gh-actions-v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Setup Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Bootstrap poetry
+        run: |
+          curl -sL https://install.python-poetry.org | python - -y --version 1.3.1
+
+      - name: Configure poetry
+        run: /Users/runner/.local/bin/poetry config virtualenvs.in-project true
+
+      - name: Install dependencies
+        run: /Users/runner/.local/bin/poetry install
+
+      - name: Install Old Protobuf
+        # Exercises the wire types generated against the old protobuf library
+        if: matrix.new-python-protobuf == 'false'
+        run: /Users/runner/.local/bin/poetry add "protobuf<3.20"
+
+      - name: Run mypy
+        # mypy has inconsistencies between 3.7 and the rest; default to lowest common denominator
+        if: matrix.python-version == '3.7'
+        run: /Users/runner/.local/bin/poetry run mypy src tests
+
+      - name: Run flake8
+        run: /Users/runner/.local/bin/poetry run flake8 src tests
+
+      - name: Run black
+        run: /Users/runner/.local/bin/poetry run black src tests --check --diff
+
+      - name: Run isort
+        run: /Users/runner/.local/bin/poetry run isort . --check --diff
+
+      - name: Run tests
+        run: /Users/runner/.local/bin/poetry run pytest tests/momento/vector_index_client -p no:sugar -q

.github/workflows/on-pull-request.yml

@@ -14,9 +14,11 @@ jobs:
         include:
           - python-version: "3.7"
             new-python-protobuf: "false"
+
     env:
       TEST_AUTH_TOKEN: ${{ secrets.ALPHA_TEST_AUTH_TOKEN }}
       TEST_CACHE_NAME: python-integration-test-${{ matrix.python-version }}-${{ matrix.new-python-protobuf }}-${{ github.sha }}
+      TEST_VECTOR_INDEX_NAME: python-integration-test-vector-${{ matrix.python-version }}-${{ matrix.new-python-protobuf }}-${{ github.sha }}
 
     steps:
       - uses: actions/checkout@v3
@@ -61,7 +63,7 @@ jobs:
         run: poetry run isort . --check --diff
 
       - name: Run tests
-        run: poetry run pytest -p no:sugar -q
+        run: poetry run pytest -p no:sugar -q --ignore=tests/momento/vector_index_client
 
   test-examples:
     runs-on: ubuntu-20.04

.github/workflows/on-push-to-release-branch.yml

@@ -41,6 +41,9 @@ jobs:
     env:
       TEST_AUTH_TOKEN: ${{ secrets.ALPHA_TEST_AUTH_TOKEN }}
       TEST_CACHE_NAME: python-integration-test-${{ matrix.python-version }}-${{ matrix.new-python-protobuf }}-${{ github.sha }}
+      TEST_VECTOR_INDEX_NAME: python-integration-test-vector-${{ matrix.python-version }}-${{ matrix.new-python-protobuf }}-${{ github.sha }}
+
+
     steps:
       - uses: actions/checkout@v3
 
@@ -79,7 +82,7 @@ jobs:
         run: poetry run isort . --check --diff
 
       - name: Run tests
-        run: poetry run pytest -p no:sugar -q
+        run: poetry run pytest -p no:sugar -q --ignore=tests/momento/vector_index_client
 
   publish:
     runs-on: ubuntu-20.04

.gitignore

@@ -15,4 +15,5 @@ dist/
 momento-examples-env/
 
 *.egg-info
-build
+build
+certs

Makefile

@@ -28,7 +28,10 @@ lint:
 do-gen-sync:
 	@poetry run python src/momento/internal/codegen.py src/momento/internal/aio/_scs_control_client.py src/momento/internal/synchronous/_scs_control_client.py
 	@poetry run python src/momento/internal/codegen.py src/momento/internal/aio/_scs_data_client.py src/momento/internal/synchronous/_scs_data_client.py
+	@poetry run python src/momento/internal/codegen.py src/momento/internal/aio/_vector_index_control_client.py src/momento/internal/synchronous/_vector_index_control_client.py
+	@poetry run python src/momento/internal/codegen.py src/momento/internal/aio/_vector_index_data_client.py src/momento/internal/synchronous/_vector_index_data_client.py
 	@poetry run python src/momento/internal/codegen.py src/momento/cache_client_async.py src/momento/cache_client.py
+	@poetry run python src/momento/internal/codegen.py src/momento/vector_index_client_async.py src/momento/vector_index_client.py
 	@poetry run python src/momento/internal/codegen.py tests/momento/cache_client/shared_behaviors_async.py tests/momento/cache_client/shared_behaviors.py
 	@poetry run python src/momento/internal/codegen.py tests/momento/cache_client/test_init_async.py tests/momento/cache_client/test_init.py
 	@poetry run python src/momento/internal/codegen.py tests/momento/cache_client/test_control_async.py tests/momento/cache_client/test_control.py
@@ -38,6 +41,8 @@ do-gen-sync:
 	@poetry run python src/momento/internal/codegen.py tests/momento/cache_client/test_set_async.py tests/momento/cache_client/test_set.py
 	@poetry run python src/momento/internal/codegen.py tests/momento/cache_client/test_sorted_set_async.py tests/momento/cache_client/test_sorted_set.py
 	@poetry run python src/momento/internal/codegen.py tests/momento/cache_client/test_sorted_set_simple_async.py tests/momento/cache_client/test_sorted_set_simple.py
+	@poetry run python src/momento/internal/codegen.py tests/momento/vector_index_client/test_control_async.py tests/momento/vector_index_client/test_control.py
+	@poetry run python src/momento/internal/codegen.py tests/momento/vector_index_client/test_data_async.py tests/momento/vector_index_client/test_data.py
 
 .PHONY: gen-sync
 ## Generate synchronous code and tests from asynchronous code.

examples/vector-index/README.md

@@ -0,0 +1,25 @@
+<img src="https://docs.momentohq.com/img/logo.svg" alt="logo" width="400"/>
+
+# Momento Python Vector Index Client Examples
+
+## Prereqs
+
+- [Python 3.7 or above is required](https://www.python.org/downloads/)
+- A Momento Auth Token is required, you can generate one from the [Momento Console](https://console.gomomento.com).
+- Developer libraries (gcc/python dev headers) installed on machine you intend to run on
+
+## Running the Example Using Poetry (Recommended)
+
+- We use [poetry](https://python-poetry.org/docs/) to manage dependencies and packaging. This allows us to cleanly separate release vs development dependencies, as well as streamline deployment. See the [poetry docs](https://python-poetry.org/docs/#installation) for installation instructions.
+
+To set up the `poetry` environment for this project:
+
+```bash
+poetry install
+```
+
+To run the basic Momento Vector Index example
+
+```bash
+MOMENTO_AUTH_TOKEN=<YOUR_TOKEN> poetry run python -m example
+```

examples/vector-index/example.py

@@ -0,0 +1,99 @@
+from time import sleep
+
+from momento import VectorIndexConfigurations, PreviewVectorIndexClient, CredentialProvider
+from momento.config import VectorIndexConfiguration
+from momento.requests.vector_index import Item
+from momento.responses.vector_index import CreateIndex, ListIndexes, AddItemBatch, DeleteItemBatch, Search, DeleteIndex
+
+VECTOR_INDEX_CONFIGURATION: VectorIndexConfiguration = VectorIndexConfigurations.Default.latest()
+VECTOR_AUTH_PROVIDER = CredentialProvider.from_environment_variable("MOMENTO_AUTH_TOKEN")
+
+def _print_start_banner() -> None:
+    print("******************************************************************")
+    print("*                      Momento Example Start                     *")
+    print("******************************************************************\n")
+
+
+def create_index(index_name: str) -> None:
+    print("Creating index with name " + index_name)
+    create_index_response = _client.create_index(index_name, num_dimensions=2)
+    if isinstance(create_index_response, CreateIndex.Success):
+        print("Index with name " + index_name + " successfully created!")
+    elif isinstance(create_index_response, CreateIndex.IndexAlreadyExists):
+        print("Index with name " + index_name + " already exists")
+    elif isinstance(create_index_response, CreateIndex.Error):
+        raise(Exception("Error while creating index " + create_index_response.message))
+    print("******************************************************************\n")
+
+
+def list_indexes():
+    print("Listing indexes")
+    list_indexes_response = _client.list_indexes()
+    if isinstance(list_indexes_response, ListIndexes.Success):
+        for index in list_indexes_response.index_names:
+            print("Account has an index with name " + index)
+    elif isinstance(list_indexes_response, ListIndexes.Error):
+        print(Exception("Error while listing indexes " + list_indexes_response.message))
+    print("******************************************************************\n")
+
+def add_items(index_name):
+    items = [
+        Item(id="test_item_1", vector=[1.0, 2.0], metadata={"key1": "value1"}),
+        Item(id="test_item_2", vector=[3.0, 4.0], metadata={"key2": "value2"}),
+        Item(id="test_item_3", vector=[5.0, 6.0], metadata={"key1": "value3", "key3": "value3"}),
+    ]
+    print("Adding items " + str(items))
+    add_response = _client.add_item_batch(
+        index_name,
+        items=items,
+    )
+    if isinstance(add_response, AddItemBatch.Success):
+        print("Successfully added items")
+    elif isinstance(add_response, AddItemBatch.Error):
+        raise(Exception("Error while adding items to index " + index_name + " " + add_response.message))
+    print("******************************************************************\n")
+
+
+def search(index_name):
+    query_vector = [1.0, 2.0]
+    top_k = 3
+    print("Searching index " + index_name + " with query_vector " + str(query_vector) + " and top " + str(top_k) + " elements")
+    search_response = _client.search(index_name, query_vector=query_vector, top_k=top_k)
+    if isinstance(search_response, Search.Success):
+        print("Search succeeded with " + str(len(search_response.hits)) + " matches")
+    elif isinstance(search_response, Search.Error):
+        raise(Exception("Error while searching on index " + index_name + " " + search_response.message))
+    print("******************************************************************\n")
+
+def delete_items(index_name):
+    delete_response = _client.delete_item_batch(index_name, ids=["test_item_1", "test_item_3"])
+    if isinstance(delete_response, DeleteItemBatch.Success):
+        print("Successfully deleted items")
+    elif isinstance(delete_response, DeleteItemBatch.Error):
+        raise(Exception("Error while deleting items " + delete_response.message))
+
+def delete_index(index_name):
+    print("Deleting index " + index_name)
+    del_response = _client.delete_index(index_name)
+
+    if isinstance(del_response, DeleteIndex.Success):
+        print("Index " + index_name + " deleted successfully!")
+    elif isinstance(del_response, DeleteIndex.Error):
+        raise(Exception("Failed to delete index " + index_name + " with error " + del_response.message))
+
+if __name__ == "__main__":
+    _print_start_banner()
+    with PreviewVectorIndexClient(VECTOR_INDEX_CONFIGURATION, VECTOR_AUTH_PROVIDER) as _client:
+        index_name = "hello_momento_index"
+
+        create_index(index_name)
+        list_indexes()
+        add_items(index_name)
+        sleep(2)
+        search(index_name)
+        delete_items(index_name)
+        sleep(2)
+        print("\nDeleted two items; search will return 1 hit now")
+        search(index_name)
+        delete_index(index_name)
+

pyproject.toml

@@ -30,7 +30,7 @@ exclude = ["src/momento/internal/codegen.py"]
 [tool.poetry.dependencies]
 python = "^3.7"
 
-momento-wire-types = "^0.67"
+momento-wire-types = "^0.75.0"
 grpcio = "^1.46.0"
 # note if you bump this presigned url test need be updated
 pyjwt = "^2.4.0"
@@ -108,6 +108,9 @@ module = [
   "momento.internal.synchronous._scs_control_client",
   "momento.internal.synchronous._scs_data_client",
   "momento.internal.synchronous._scs_grpc_manager",
+  "momento.internal.synchronous._vector_index_control_client",
+  "momento.internal.synchronous._vector_index_data_client",
+  "momento.internal.synchronous._vector_index_grpc_manager",
   "momento.internal.synchronous._add_header_client_interceptor",
   "momento.internal.synchronous._retry_interceptor",
   "momento.internal.common._data_client_ops",
@@ -117,6 +120,9 @@ module = [
   "momento.internal.aio._scs_control_client",
   "momento.internal.aio._scs_data_client",
   "momento.internal.aio._scs_grpc_manager",
+  "momento.internal.aio._vector_index_control_client",
+  "momento.internal.aio._vector_index_data_client",
+  "momento.internal.aio._vector_index_grpc_manager",
   "momento.internal.aio._utilities",
   "momento.responses.control.signing_key.*",
 ]

src/momento/__init__.py

@@ -12,9 +12,11 @@
 from .auth import CredentialProvider
 from .cache_client import CacheClient
 from .cache_client_async import CacheClientAsync
-from .config import Configurations, TopicConfigurations
+from .config import Configurations, TopicConfigurations, VectorIndexConfigurations
 from .topic_client import TopicClient
 from .topic_client_async import TopicClientAsync
+from .vector_index_client import PreviewVectorIndexClient
+from .vector_index_client_async import PreviewVectorIndexClientAsync
 
 logging.getLogger("momentosdk").addHandler(logging.NullHandler())
 logs.initialize_momento_logging()
@@ -23,8 +25,11 @@
     "CredentialProvider",
     "Configurations",
     "TopicConfigurations",
+    "VectorIndexConfigurations",
     "CacheClient",
     "CacheClientAsync",
     "TopicClient",
     "TopicClientAsync",
+    "PreviewVectorIndexClient",
+    "PreviewVectorIndexClientAsync",
 ]

src/momento/auth/momento_endpoint_resolver.py

@@ -7,6 +7,7 @@
 from jwt.exceptions import DecodeError
 
 from momento.errors import InvalidArgumentException
+from momento.internal.services import Service
 
 _MOMENTO_CONTROL_ENDPOINT_PREFIX = "control."
 _MOMENTO_CACHE_ENDPOINT_PREFIX = "cache."
@@ -29,7 +30,7 @@ class _Base64DecodedV1Token:
 
 def resolve(auth_token: str) -> _TokenAndEndpoints:
     if not auth_token:
-        raise InvalidArgumentException("malformed auth token")
+        raise InvalidArgumentException("malformed auth token", Service.AUTH)
 
     if _is_base64(auth_token):
         decoded_b64_token = base64.b64decode(auth_token).decode("utf-8")
@@ -52,7 +53,7 @@ def _get_endpoint_from_token(auth_token: str) -> _TokenAndEndpoints:
             auth_token=auth_token,
         )
     except (DecodeError, KeyError) as e:
-        raise InvalidArgumentException("Invalid Auth token.") from e
+        raise InvalidArgumentException("Invalid Auth token.", Service.AUTH) from e
 
 
 def _is_base64(value: Union[bytes, str]) -> bool: