Skip to content

Commit

Permalink
add AVS setup note
Browse files Browse the repository at this point in the history
  • Loading branch information
dwelch-spike committed Aug 15, 2024
1 parent 420da15 commit 5267e2d
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions basic-search/basic_search.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,19 @@
"id": "c60c757f-2f3a-4a84-9a8f-09adfc1d3d72",
"metadata": {},
"source": [
"AVS provides a gRPC API and a Python client that developers can use to create AI applications leveraging the search capability.\n",
"## Overview\n",
"\n",
"## Prerequisites\n",
"AVS provides a gRPC API and a Python client that developers can use to create AI applications leveraging its search capability. This example shows basic usage of the Aerospike Vector Search Python client including, writing, reading, and searching for vectors with AVS. For more detailed client documentation visit the [Python client's read the docs page](https://aerospike-vector-search-python-client.readthedocs.io/en/latest/).\n",
"\n",
"## Setup\n",
"Before getting started, you need to setup a running Aerospike Vector Search (AVS) deployment.\n",
"See the [AVS installation guide](https://aerospike.com/docs/vector/install) for tips on setting up AVS.\n",
"\n",
"### Prerequisites\n",
"\n",
"- Python 3.9 or higher\n",
"- pip 9.0.1 or higher\n",
"- An accessible AVS deployment\n",
"\n",
"## Installing the Aerospike Vector Search Client\n",
"\n",
Expand Down Expand Up @@ -61,7 +68,9 @@
"source": [
"## Creating a Vector Admin Client\n",
"\n",
"Initialize a new admin client by providing one or more seed hosts to which the client can connect."
"Initialize a new admin client by providing one or more seed hosts to which the client can connect. If your AVS deployment is not running on \"localhost\" at port \"5000\" please change the `host` and `port` variables to match your deployment.\n",
"\n",
"If your AVS deployment is not accessible on address \"localhost\" and port \"5000\" change the `host` and `port` variables below to match your deployment."
]
},
{
Expand Down

0 comments on commit 5267e2d

Please sign in to comment.