{"record":{"id":"90989a06dbb252e6","repo":"mem0ai/mem0","slug":"the-azure-search-documents-library-is-required","errorCode":null,"errorMessage":"The 'azure-search-documents' library is required. Please install it using 'pip install azure-search-documents==11.5.2'.","messagePattern":"The 'azure-search-documents' library is required\\. Please install it using 'pip install azure-search-documents==11\\.5\\.2'\\.","errorType":"exception","errorClass":"ImportError","httpStatus":null,"severity":"error","filePath":"mem0/vector_stores/azure_ai_search.py","lineNumber":30,"sourceCode":"    from azure.core.credentials import AzureKeyCredential\n    from azure.core.exceptions import ResourceNotFoundError\n    from azure.identity import DefaultAzureCredential\n    from azure.search.documents import SearchClient\n    from azure.search.documents.indexes import SearchIndexClient\n    from azure.search.documents.indexes.models import (\n        BinaryQuantizationCompression,\n        HnswAlgorithmConfiguration,\n        ScalarQuantizationCompression,\n        SearchField,\n        SearchFieldDataType,\n        SearchIndex,\n        SimpleField,\n        VectorSearch,\n        VectorSearchProfile,\n    )\n    from azure.search.documents.models import VectorizedQuery\nexcept ImportError:\n    raise ImportError(\n        \"The 'azure-search-documents' library is required. Please install it using 'pip install azure-search-documents==11.5.2'.\"\n    )\n\nlogger = logging.getLogger(__name__)\n\n\nclass OutputData(BaseModel):\n    id: Optional[str]\n    score: Optional[float]\n    payload: Optional[dict]\n\n\nclass AzureAISearch(VectorStoreBase):\n    def __init__(\n        self,\n        service_name,\n        collection_name,\n        api_key,","sourceCodeStart":12,"sourceCodeEnd":48,"githubUrl":"https://github.com/mem0ai/mem0/blob/001c235229be8795e3834520467bd0d661ed8f34/mem0/vector_stores/azure_ai_search.py#L12-L48","documentation":"Raised at module import of mem0.vector_stores.azure_ai_search when the azure.search.documents package (or its azure.identity/azure.core companions imported alongside) is not installed. The SDK is an optional dependency and mem0 pins the message to azure-search-documents==11.5.2 because newer 12.x versions changed the models API that this store imports (VectorizedQuery, compression types).","triggerScenarios":"Configuring vector_store.provider='azure_ai_search' without the SDK installed; having azure-search-documents 12.x installed where VectorizedQuery/compression model imports moved, making the try-import fail even though a version is present; broken azure-identity install.","commonSituations":"pip install mem0ai alone then selecting Azure AI Search; a project that upgraded azure-search-documents to 12.x breaking the pinned imports; partially installed azure packages after a failed pip resolve.","solutions":["pip install azure-search-documents==11.5.2 (exact pin — the import block targets 11.x model paths)","Also ensure azure-identity and azure-core are installed: pip install azure-identity","Check the installed version: pip show azure-search-documents; downgrade if it is 12.x","Pin the version in requirements.txt so future upgrades do not silently break the store"],"exampleFix":"# before: ImportError: The 'azure-search-documents' library is required ...\nfrom mem0 import Memory\nm = Memory.from_config(azure_search_cfg)\n\n# after\n# pip install azure-search-documents==11.5.2 azure-identity\nfrom mem0 import Memory\nm = Memory.from_config(azure_search_cfg)","handlingStrategy":"validation","validationCode":"import importlib.metadata as md\ntry:\n    v = md.version('azure-search-documents')\nexcept md.PackageNotFoundError:\n    v = None\nif v is None or not v.startswith('11.'):\n    raise ConfigError('pip install azure-search-documents==11.5.2')","typeGuard":null,"tryCatchPattern":"try:\n    from mem0.vector_stores.azure_ai_search import AzureAISearch\nexcept ImportError as e:\n    if 'azure-search-documents' in str(e):\n        raise ConfigError('install azure-search-documents==11.5.2') from e\n    raise","preventionTips":["Pin azure-search-documents==11.5.2 in requirements — 12.x moved the model imports mem0 uses","Install azure-identity alongside it for DefaultAzureCredential flows","Add a CI import test for each configured vector store provider"],"tags":["dependencies","azure","vector-store","version-pinning","import"],"backgroundTag":null,"analyzedSha":"001c235229be8795e3834520467bd0d661ed8f34","analyzedAt":"2026-08-15T01:55:42.685Z","schemaVersion":2},"datasetVersion":"2026-08-15T22:17:37.221Z"}