nlweb-retrieval
Bundle package containing all retrieval providers for NLWeb.
Included Providers
This package includes clients for:
- Azure AI Search - Azure's vector search service with managed identity support
- Elasticsearch - Popular open-source search and analytics engine
- Milvus - Open-source vector database
- Qdrant - Vector similarity search engine
- PostgreSQL (pgvector) - PostgreSQL with vector extension
- OpenSearch - Open-source search and analytics suite
- Snowflake Cortex Search - Snowflake's vector search
- Shopify MCP - Shopify Model Context Protocol
- Cloudflare AutoRAG - Cloudflare's RAG service
- Bing Search - Microsoft Bing web search
Installation
pip install nlweb-core nlweb-retrieval
Configuration Example
Create config.yaml:
retrieval:
provider: elasticsearch
import_path: nlweb_retrieval.elasticsearch_client
class_name: ElasticsearchClient
api_endpoint_env: ELASTICSEARCH_URL
index_name: my_index
use_knn: true
Azure AI Search Example
retrieval:
provider: azure_ai_search
import_path: nlweb_retrieval.azure_search_client
class_name: AzureSearchClient
api_endpoint_env: AZURE_SEARCH_ENDPOINT
auth_method: azure_ad # or api_key
index_name: my-search-index
Qdrant Example
retrieval:
provider: qdrant
import_path: nlweb_retrieval.qdrant
class_name: QdrantVectorClient
database_path: ./data/qdrant_db # for local storage
# OR for remote:
# api_endpoint_env: QDRANT_URL
# api_key_env: QDRANT_API_KEY
Usage
import nlweb_core
# Initialize with config
nlweb_core.init(config_path="./config.yaml")
# Use retrieval
from nlweb_core import retriever
# Search
results = await retriever.search(
query="example query",
site="example.com",
num_results=10
)
Provider Import Paths
Use these in your config file:
| Provider | import_path | class_name |
|---|---|---|
| Azure AI Search | nlweb_retrieval.azure_search_client |
AzureSearchClient |
| Elasticsearch | nlweb_retrieval.elasticsearch_client |
ElasticsearchClient |
| Milvus | nlweb_retrieval.milvus_client |
MilvusVectorClient |
| Qdrant | nlweb_retrieval.qdrant |
QdrantVectorClient |
| PostgreSQL | nlweb_retrieval.postgres_client |
PgVectorClient |
| OpenSearch | nlweb_retrieval.opensearch_client |
OpenSearchClient |
| Snowflake | nlweb_retrieval.snowflake_client |
SnowflakeCortexSearchClient |
| Shopify MCP | nlweb_retrieval.shopify_mcp |
ShopifyMCPClient |
| Cloudflare | nlweb_retrieval.cf_autorag_client |
CloudflareAutoRAGClient |
| Bing Search | nlweb_retrieval.bing_search_client |
BingSearchClient |
License
MIT License - Copyright (c) 2025 Microsoft Corporation
Metadata
Release files for nlweb-retrieval 0.5.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| nlweb_retrieval-0.5.0.tar.gz | 30.2 kB | Without provenance | Details for nlweb_retrieval-0.5.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| nlweb_retrieval-0.5.0-py3-none-any.whl | Python 3 | none | any | Details for nlweb_retrieval-0.5.0-py3-none-any.whl |
Total release size: 68.9 kB
Release files / nlweb_retrieval-0.5.0.tar.gz
| Download URL | nlweb_retrieval-0.5.0.tar.gz |
|---|---|
| Size | 30.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
fc06465d126a677b5662e6be6ac25fe52c941ffa19c8d8ab7d10709b0eb5ced0
|
|
BLAKE2b-256 checksum How to use checksums |
dd4d3d95946ea51f1faaacbf19743fe9ffa740921a1f20a7d6b6866c1076fe74
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.7
|
Release files / nlweb_retrieval-0.5.0-py3-none-any.whl
| Download URL | nlweb_retrieval-0.5.0-py3-none-any.whl |
|---|---|
| Size | 38.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f31d206c0cb165e913d11e59165748b3a31c7d1777b86f98a3b0037359b41ae3
|
|
BLAKE2b-256 checksum How to use checksums |
6856fa3b2f66a542b03c54b9668a8fd41097df7963eac3fa1b87c6ca14e6e966
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.7
|
Security for nlweb-retrieval 0.5.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.