actions/opensearch-pyd
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Added k-nn user guide and samples. (#449)

Browse Source 
* Added k-nn user guide and samples.

Signed-off-by: dblock <dblock@amazon.com>

* Added async samples.

Signed-off-by: dblock <dblock@amazon.com>

* Renamed Lucene Filters with Efficient Filters.

Signed-off-by: dblock <dblock@amazon.com>

* Fixing TOC from Lucene filters to Efficient filters

Signed-off-by: Vacha Shah <vachshah@amazon.com>

---------

Signed-off-by: dblock <dblock@amazon.com>
Signed-off-by: Vacha Shah <vachshah@amazon.com>
Co-authored-by: Vacha Shah <vachshah@amazon.com>
This commit is contained in:
Daniel (dB.) Doubrovkine
2023-07-25 21:04:13 -05:00
committed by GitHub
parent 58217d98ff
commit f54973e583
12 changed files with 1265 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
USER_GUIDE.md
+5 -7
View File
@@ -26,11 +26,7 @@ Then import it like any other module:
from opensearchpy import OpenSearch
```
For better performance we recommend the async client. To add the async client to your project, install it using [pip](https://pip.pypa.io/):
```bash
pip install opensearch-py[async]
```
For better performance we recommend the async client. See [Asynchronous I/O](guides/async.md) for more information.
In general, we recommend using a package manager, such as [poetry](https://python-poetry.org/docs/), for your projects. This is the package manager used for [samples](samples).
@@ -61,7 +57,7 @@ info = client.info()
print(f"Welcome to {info['version']['distribution']} {info['version']['number']}!")
```
See [hello.py](samples/hello/hello.py) for a working sample, and [guides/ssl](guides/ssl.md) for how to setup SSL certificates.
See [hello.py](samples/hello/hello.py) for a working synchronous sample, and [guides/ssl](guides/ssl.md) for how to setup SSL certificates.
### Creating an Index
@@ -148,6 +144,7 @@ print(response)
## Advanced Features
- [Asynchronous I/O](guides/async.md)
- [Authentication (IAM, SigV4)](guides/auth.md)
- [Configuring SSL](guides/ssl.md)
- [Bulk Indexing](guides/bulk.md)
@@ -161,4 +158,5 @@ print(response)
- [Security](guides/plugins/security.md)
- [Alerting](guides/plugins/alerting.md)
- [Index Management](guides/plugins/index_management.md)
- [Index Management](guides/plugins/index_management.md)
- [k-NN](guides/plugins/knn.md)