azure-documentdb-haystack
Haystack document store and retrievers for Azure DocumentDB.
Installation
pip install azure-documentdb-haystack
Authentication
Microsoft Entra ID is the default and recommended authentication method. DefaultAzureCredential supports local Azure
CLI credentials, workload identity, and managed identity without changing application code. Assign the identity an
appropriate Azure DocumentDB data-plane role, then set the cluster name:
AZURE_DOCUMENTDB_CLUSTER_NAME=my-cluster
For local development and integration testing only, a connection string can be supplied through
AZURE_DOCUMENTDB_CONNECTION_STRING. The integration emits a warning whenever this fallback is used.
Usage
from haystack_integrations.document_stores.azure_documentdb import AzureDocumentDBDocumentStore
store = AzureDocumentDBDocumentStore(
database_name="haystack",
collection_name="documents",
)
# Create once. The collection must exist before initializing the store.
store.create_vector_index(dimensions=1536, kind="vector-hnsw", similarity="COS", m=16, efConstruction=64)
Use AzureDocumentDBEmbeddingRetriever for cosmosSearch vector queries. AzureDocumentDBFullTextRetriever supports
Azure DocumentDB BM25 full-text search, which is currently a gated preview and must be enabled on the cluster.
Contributing
Refer to the general Contribution Guidelines.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file azure_documentdb_haystack-1.0.0.tar.gz.
File metadata
- Download URL: azure_documentdb_haystack-1.0.0.tar.gz
- Upload date:
- Size: 23.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9ace28f4fcd6c92c3fc864ae61b25cf740de64d25a53d38512154b4fcd955f52
|
|
| MD5 |
c97989ab19e478c207d4b76e914004b9
|
|
| BLAKE2b-256 |
04a6fde9cebc002af261b3cc386957d3d2ac9af4b78ae6110f1506b18c2127bb
|
Provenance
The following attestation bundles were made for azure_documentdb_haystack-1.0.0.tar.gz:
Publisher:
CI_pypi_release.yml on deepset-ai/haystack-core-integrations
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
azure_documentdb_haystack-1.0.0.tar.gz -
Subject digest:
9ace28f4fcd6c92c3fc864ae61b25cf740de64d25a53d38512154b4fcd955f52 - Sigstore transparency entry: 2712615785
- Sigstore integration time:
-
Permalink:
deepset-ai/haystack-core-integrations@42c66f5bddd47824d1f5d2477cb23e06fd435215 -
Branch / Tag:
refs/tags/integrations/azure_documentdb-v1.0.0 - Owner: https://github.com/deepset-ai
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
CI_pypi_release.yml@42c66f5bddd47824d1f5d2477cb23e06fd435215 -
Trigger Event:
push
-
Statement type:
File details
Details for the file azure_documentdb_haystack-1.0.0-py3-none-any.whl.
File metadata
- Download URL: azure_documentdb_haystack-1.0.0-py3-none-any.whl
- Upload date:
- Size: 18.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1aa1dd6ac7041614d4f3b1a238b871c5b6e4ef0302fa6f3231b89167ba5cfa2b
|
|
| MD5 |
60f6d456016a21eb398568cf0844665c
|
|
| BLAKE2b-256 |
2596a4c0fefa5aee02c7f5563e9e79c8dcac6a4643b514e11540a18eb8e3803c
|
Provenance
The following attestation bundles were made for azure_documentdb_haystack-1.0.0-py3-none-any.whl:
Publisher:
CI_pypi_release.yml on deepset-ai/haystack-core-integrations
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
azure_documentdb_haystack-1.0.0-py3-none-any.whl -
Subject digest:
1aa1dd6ac7041614d4f3b1a238b871c5b6e4ef0302fa6f3231b89167ba5cfa2b - Sigstore transparency entry: 2712615929
- Sigstore integration time:
-
Permalink:
deepset-ai/haystack-core-integrations@42c66f5bddd47824d1f5d2477cb23e06fd435215 -
Branch / Tag:
refs/tags/integrations/azure_documentdb-v1.0.0 - Owner: https://github.com/deepset-ai
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
CI_pypi_release.yml@42c66f5bddd47824d1f5d2477cb23e06fd435215 -
Trigger Event:
push
-
Statement type:
