langchain-azure-storage
This package contains the LangChain integrations for Azure Storage. Currently, it includes:
- Document loader support for Azure Blob Storage
- Deep Agents filesystem backend backed by Azure Blob Storage
[!NOTE] This package is in Public Preview. For more information, see Supplemental Terms of Use for Microsoft Azure Previews.
Installation
pip install -U langchain-azure-storage
Configuration
langchain-azure-storage should work without any explicit credential configuration.
The langchain-azure-storage interface defaults to DefaultAzureCredential
for credentials which automatically retrieves Microsoft Entra ID tokens based on
your current environment. For more information on using credentials with
langchain-azure-storage, see the override default credentials section.
Azure Blob Storage Document Loader Usage
Document Loaders are used to load data from many sources (e.g., cloud storage, web pages, etc.) and turn them into LangChain Documents, which can then be used in AI applications (e.g., RAG). This package offers the AzureBlobStorageLoader which downloads blob content from Azure Blob Storage and parses it as UTF-8 by default. Additionally, parsing customization is also available to handle content of various file types and customize document chunking.
The AzureBlobStorageLoader replaces the current AzureBlobStorageContainerLoader and AzureBlobStorageFileLoader in the LangChain Community Document Loaders. Refer to the migration section for more details.
The following examples go over the various use cases for the document loader.
Load from container
Below shows how to load documents from all blobs in a given container in Azure Blob Storage:
from langchain_azure_storage.document_loaders import AzureBlobStorageLoader
loader = AzureBlobStorageLoader(
account_url="https://<my-storage-account-name>.blob.core.windows.net",
container_name="<my-container-name>",
)
for doc in loader.lazy_load():
print(doc.page_content) # Prints content of each blob in UTF-8 encoding.
The example below shows how to load documents from blobs in a container with a given prefix:
from langchain_azure_storage.document_loaders import AzureBlobStorageLoader
loader = AzureBlobStorageLoader(
account_url="https://<my-storage-account-name>.blob.core.windows.net",
container_name="<my-container-name>",
prefix="test",
)
for doc in loader.lazy_load():
print(doc.page_content)
Load from container by blob name
The example below shows how to load documents from a list of blobs in Azure Blob Storage. This approach does not call list blobs and instead uses only the blobs provided:
from langchain_azure_storage.document_loaders import AzureBlobStorageLoader
loader = AzureBlobStorageLoader(
account_url="https://<my-storage-account-name>.blob.core.windows.net",
container_name="<my-container-name>",
blob_names=["blob-1", "blob-2", "blob-3"],
)
for doc in loader.lazy_load():
print(doc.page_content)
Override default credentials
Below shows how to override the default credentials used by the document loader:
from azure.core.credentials import AzureSasCredential
from azure.identity import ManagedIdentityCredential
from langchain_azure_storage.document_loaders import AzureBlobStorageLoader
# Override with SAS token
loader = AzureBlobStorageLoader(
"https://<my-storage-account-name>.blob.core.windows.net",
"<my-container-name>",
credential=AzureSasCredential("<sas-token>")
)
# Override with more specific token credential than the entire
# default credential chain (e.g., system-assigned managed identity)
loader = AzureBlobStorageLoader(
"https://<my-storage-account-name>.blob.core.windows.net",
"<my-container-name>",
credential=ManagedIdentityCredential()
)
Customizing blob content parsing
Currently, the default when parsing each blob is to return the content as a single Document object with UTF-8 encoding regardless of the file type. For file types that require specific parsing (e.g., PDFs, CSVs, etc.) or when you want to control the document content format, you can provide the loader_factory argument to take in an already existing document loader (e.g., PyPDFLoader, CSVLoader, etc.) or a customized loader.
This works by downloading the blob content to a temporary file. The loader_factory then gets called with the filepath to use the specified document loader to load/parse the file and return the Document object(s).
Below shows how to override the default loader used to parse blobs as PDFs using the using the PyPDFLoader:
from langchain_azure_storage.document_loaders import AzureBlobStorageLoader
from langchain_community.document_loaders import PyPDFLoader
loader = AzureBlobStorageLoader(
account_url="https://<my-storage-account-name>.blob.core.windows.net",
container_name="<my-container-name>",
blob_names="<my-pdf-file.pdf>",
loader_factory=PyPDFLoader,
)
for doc in loader.lazy_load():
print(doc.page_content) # Prints content of each page as a separate document
To provide additional configuration, you can define a callable that returns an instantiated document loader as shown below:
from langchain_azure_storage.document_loaders import AzureBlobStorageLoader
from langchain_community.document_loaders import PyPDFLoader
def loader_factory(file_path: str) -> PyPDFLoader:
return PyPDFLoader(
file_path,
mode="single", # To return the PDF as a single document instead of extracting documents by page
)
loader = AzureBlobStorageLoader(
account_url="https://<my-storage-account-name>.blob.core.windows.net",
container_name="<my-container-name>",
blob_names="<my-pdf-file.pdf>",
loader_factory=loader_factory,
)
for doc in loader.lazy_load():
print(doc.page_content)
Migrating from LangChain Community Azure Storage Document Loaders
This section goes over the actions required to migrate from the existing community document loaders to the new Azure Blob Storage document loader:
- Depend on the
langchain-azure-storagepackage instead oflangchain-community. - Update import statements from
langchain_community.document_loaderstolangchain_azure_storage.document_loaders. - Change class names from
AzureBlobStorageFileLoaderandAzureBlobStorageContainerLoadertoAzureBlobStorageLoader. - Update document loader constructor calls to:
- Use an account URL instead of a connection string.
- Specify
UnstructuredLoaderas theloader_factoryif they want to continue to use Unstructured for parsing documents.
- Ensure environment has proper credentials (e.g., running
azure logincommand, setting up managed identity, etc.) as the connection string would have previously contained the credentials.
The examples below show the before and after migrating to the langchain-azure-storage package:
Before migration
from langchain_community.document_loaders import AzureBlobStorageFileLoader, AzureBlobStorageContainerLoader
file_loader = AzureBlobStorageFileLoader(
conn_str="<my-connection-string>",
container="<my-container-name>",
blob_name="<my-blob-name>",
)
container_loader = AzureBlobStorageContainerLoader(
conn_str="<my-connection-string>",
container="<my-container-name>",
prefix="<prefix>",
)
After migration
from langchain_azure_storage.document_loaders import AzureBlobStorageLoader
from langchain_unstructured import UnstructuredLoader
file_loader = AzureBlobStorageLoader(
account_url="https://<my-storage-account-name>.blob.core.windows.net",
container_name="<my-container-name>",
blob_names="<my-blob-name>",
)
container_loader = AzureBlobStorageLoader(
account_url="https://<my-storage-account-name>.blob.core.windows.net",
container_name="<my-container-name>",
prefix="<prefix>",
loader_factory=UnstructuredLoader,
)
Deep Agents Azure Blob Storage Backend Usage
Deep Agents exposes a BackendProtocol — a pluggable interface for file operations (read, write, edit, ls, glob, grep, plus batch upload/download) that an agent uses as its virtual filesystem. This package provides AzureBlobBackend, an Azure Blob Storage implementation of that interface, so a deep agent can persist its workspace in a blob container.
The backend requires the optional deepagents extra (which itself requires Python 3.11+):
pip install -U "langchain-azure-storage[deepagents]"
AzureBlobBackend is imported from the deepagents subpackage:
from langchain_azure_storage.deepagents import AzureBlobBackend
[!NOTE] Importing it without the
deepagentsextra installed raises anImportErrordirecting you to install the extra. The document loader does not require the extra.
Quick start
from deepagents import create_deep_agent
from langchain_azure_storage.deepagents import AzureBlobBackend
backend = AzureBlobBackend(
account_url="https://<my-storage-account-name>.blob.core.windows.net",
container_name="agent-workspace",
prefix="session-001/", # Optional: isolate each agent/session under a prefix.
)
agent = create_deep_agent(backend=backend)
result = agent.invoke(
{"messages": [{"role": "user", "content": "Write a hello world script to hello.py"}]}
)
# The agent's write_file tool call persists the script through the backend. With
# the configuration above, it lands in the "agent-workspace" container at
# https://<my-storage-account-name>.blob.core.windows.net/agent-workspace/session-001/hello.py
Runnable examples — including a workspace that persists across agent lifetimes and a
composite agent with memory and subagents — live in
samples/deepagents-storage-backend/.
File content is stored as UTF-8 text in blob bodies (binary uploads are preserved as bytes). Directories are synthesized from blob key prefixes (no directory marker blobs are created). The backend exposes both synchronous methods (read, write, edit, ls, glob, grep, upload_files, download_files) and their a-prefixed async counterparts (aread, awrite, …).
Authentication
Like the document loader, AzureBlobBackend defaults to DefaultAzureCredential and accepts a credential override:
from azure.identity import ManagedIdentityCredential
backend = AzureBlobBackend(
account_url="https://<account>.blob.core.windows.net",
container_name="agent-workspace",
credential=ManagedIdentityCredential(), # or any Azure credential object
)
For local development against the Azurite emulator, use from_connection_string instead of account_url + credential:
backend = AzureBlobBackend.from_connection_string(
"<connection-string>",
container_name="agent-workspace",
)
Resource lifecycle
AzureBlobBackend creates its underlying Azure SDK client (and, unless you pass a credential, a DefaultAzureCredential) lazily on first use and reuses it across calls.
When you use the async methods (aread, awrite, …), close the backend when you're done so the underlying aiohttp session is released; otherwise you'll see Unclosed client session warnings. Use it as an async context manager, or call aclose():
async with AzureBlobBackend(account_url="...", container_name="agent-workspace") as backend:
agent = create_deep_agent(backend=backend)
...
# equivalently: await backend.aclose() when you're done
The sync client releases its resources on garbage collection, so closing it is optional; you can still use with (or call close()) to release it promptly.
Changelog
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 langchain_azure_storage-1.1.0.tar.gz.
File metadata
- Download URL: langchain_azure_storage-1.1.0.tar.gz
- Upload date:
- Size: 20.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
aba4bcbf1b3542ea7385ccab386689aed9cf3d31ceb94285a33ab7faa9a03aba
|
|
| MD5 |
6b9bf6344c9aa0170e98ce4fc70e8ec6
|
|
| BLAKE2b-256 |
e55a8da2fb74b0456ed6690dc479024a588ed5fed1702e27f5bbe983277a52bb
|
File details
Details for the file langchain_azure_storage-1.1.0-py3-none-any.whl.
File metadata
- Download URL: langchain_azure_storage-1.1.0-py3-none-any.whl
- Upload date:
- Size: 21.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f94c0048c846e6cda01e67ee4fc9283e606b889a9de2b617abc5526780cdd9b6
|
|
| MD5 |
6a05de1241a778c447b4f046c40f7093
|
|
| BLAKE2b-256 |
0df8e65693c5ce8f93a88b375a2eda286c8015a1795d3b5cbd67bbc019b6592f
|