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
Metadata
1 maintainer
Release files for azure-documentdb-haystack 2.0.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 | |
|---|---|---|---|---|
| azure_documentdb_haystack-2.0.0.tar.gz | 23.8 kB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| azure_documentdb_haystack-2.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 42.6 kB
Release files / azure_documentdb_haystack-2.0.0.tar.gz
| Download URL | azure_documentdb_haystack-2.0.0.tar.gz |
|---|---|
| Size | 23.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0f1f5a107a52e88b1f483d124a36c2772a319d1f9a58c4ebca77495e25cde463
|
|
BLAKE2b-256 checksum How to use checksums |
33266441cdbd812843bf88f21f2925ccfbdc5a5193fecd6b0bd3104ce0a0c356
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 19, 2026.
Transparency logRelease files / azure_documentdb_haystack-2.0.0-py3-none-any.whl
| Download URL | azure_documentdb_haystack-2.0.0-py3-none-any.whl |
|---|---|
| Size | 18.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8b2dc3e40b92e743600c1c1fa733fbc04ad806479b5eee5d1ff73a481c4fa180
|
|
BLAKE2b-256 checksum How to use checksums |
f1f936667814e7baf42b7389aebfa72831cf93df4469b309a43388d70e4a2c61
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 19, 2026.
Transparency logSecurity for azure-documentdb-haystack 2.0.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.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for azure_documentdb_haystack-2.0.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 19, 2026.
Transparency logA 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.
