added auth details

yorek · yorek · commit 269afbedf27d · 2024-04-25T09:27:42.000-07:00
diff --git a/python/README.md b/python/README.md
@@ -9,4 +9,34 @@ In this sample the local model [multi-qa-MiniLM-L6-cos-v1](https://huggingface.c
 - use [Fulltext search in Azure SQL database with BM25 ranking](https://learn.microsoft.com/en-us/sql/relational-databases/search/limit-search-results-with-rank?view=sql-server-ver16#ranking-of-freetexttable)
 - do re-ranking applying Reciprocal Rank Fusion (RRF) to combine the BM25 ranking with the cosine similarity ranking
 
-Make sure to setup the database for this sample using the `./python/00-setup-database.sql` script. Database can be either an Azure SQL DB or a SQL Server database.
+Make sure to setup the database for this sample using the `./python/00-setup-database.sql` script. Database can be either an Azure SQL DB or a SQL Server database. Once the database has been created, you can run the `./python/hybrid_search.py` script to do the hybrid search:
+
+First, set up the virtual environment and install the required packages:
+
+```bash
+python -m venv .venv
+```
+
+Activate the virtual environment and then install the required packages:
+
+```bash
+pip install -r requirements.txt
+```
+
+Create an environment file `.env` with the connection string to Azure SQL database. You can use the `.env.sample` as a starting point. The sample `.env` file shows how to use Entra ID to connect to the database, which looks like:
+
+```text
+MSSQL='Driver={ODBC Driver 18 for SQL Server};Server=tcp:<server>,1433;Database=<database>;Encrypt=yes;TrustServerCertificate=no;Connection Timeout=30'
+```
+
+If you want to use SQL Authentication the connection string would instead look like the following:
+
+```
+MSSQL='Driver={ODBC Driver 18 for SQL Server};Server=tcp:<server>,1433;Database=<database>;UID=<user>;PWD=<password>;Encrypt=yes;TrustServerCertificate=yes;Connection Timeout=30'
+```
+
+Then run the script:    
+
+```bash
+python hybrid_search.py
+```
