azure-search-documents

[matt3o]

• azure-search-documents
• 11.6.0b10
• Ubuntu 24.04
• Python 3.12.3

Describe the bug

In the most recent prerelease, setting debug='all' in the search() call raises a DeserializationError. This is due the newly available debug information DocumentDebugInfo which apparently cannot be deserialized into a dictionary.
Sadly I cannot provide any sample code at this point but I am happy to provide additional information if needed.
Currently this makes the debug flag ununsable in Python code.

To Reproduce
Steps to reproduce the behavior:

1. Call azure.search.documents.indexes.aio.SearchIndexClient.search() with debug='all'
2. Iterate over the results with async for doc in result: -> Boom this crashes

Expected behavior
No exception raised, it should be returned as a dict

Additional context

ERROR  [178742] 2025-03-19 14:25:27  xxx   - error: HTTPException(status_code=500, detail='SearchException: RetryError[<Future at 0x7f7abcd552b0 state=finished raised DeserializationError>]')
tb: Traceback (most recent call last):
  File "/home/matteo/linux_code/xxx/.lvenv/lib/python3.12/site-packages/azure/search/documents/_generated/_serialization.py", line 1680, in deserialize_data
    return self.deserialize_type[iter_type](data, data_type[1:-1])
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/matteo/linux_code/xxx/.lvenv/lib/python3.12/site-packages/azure/search/documents/_generated/_serialization.py", line 1707, in deserialize_iter
    raise DeserializationError("Cannot deserialize as [{}] an object of type {}".format(iter_type, type(attr)))
azure.core.exceptions.DeserializationError: Cannot deserialize as [DocumentDebugInfo] an object of type <class 'dict'>

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "/home/matteo/linux_code/xxx/.lvenv/lib/python3.12/site-packages/azure/search/documents/_generated/_serialization.py", line 1680, in deserialize_data
    return self.deserialize_type[iter_type](data, data_type[1:-1])
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/matteo/linux_code/xxx/.lvenv/lib/python3.12/site-packages/azure/search/documents/_generated/_serialization.py", line 1708, in deserialize_iter
    return [self.deserialize_data(a, iter_type) for a in attr]
            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/matteo/linux_code/xxx/.lvenv/lib/python3.12/site-packages/azure/search/documents/_generated/_serialization.py", line 1692, in deserialize_data
    return self._deserialize(obj_type, data)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/matteo/linux_code/xxx/.lvenv/lib/python3.12/site-packages/azure/search/documents/_generated/_serialization.py", line 1495, in _deserialize
    value = self.deserialize_data(raw_value, attr_desc["type"])
            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/matteo/linux_code/xxx/.lvenv/lib/python3.12/site-packages/azure/search/documents/_generated/_serialization.py", line 1691, in deserialize_data
    raise DeserializationError(msg) from err
azure.core.exceptions.DeserializationError: Unable to deserialize response data. Data: {'semantic': None, 'vectors': {'subscores': {'documentBoost': 10.0, 'text': {'searchScore': 23.989803314208984}, 'vectors': [{'embedding': {'searchScore': 0.7097161412239075, 'vectorSimilarity': 0.5909859704254476}}]}}}, [DocumentDebugInfo]```

[github-actions]

Hello @matt3o. I'm an AI assistant for the azure-sdk-for-python repository. I have some suggestions that you can try out while the team gets back to you.

• The issue appears to be caused by the new debug information – specifically the inclusion of a DocumentDebugInfo element – which the deserialization logic isn’t currently handling as expected (receiving a dict instead of a well‐formed model).

• This bug seems similar in nature to other deserialization problems we’ve seen recently (see DeserializationError for SearchIndexerSkillset), and we are actively investigating a fix in upcoming prerelease updates.

• As a temporary workaround, consider omitting the debug='all' flag in production code until our next patch release addresses the issue.

• For further details on SDK behavior and ongoing fixes, please refer to our documentation at Azure Search SDK for Python and continue to share any additional logs or reproduction steps you encounter.

The team will get back to you shortly, hopefully this helps in the meantime.

[xiangyan99]

Thanks for reaching out.

The fix is shipped in https://pypi.org/project/azure-search-documents/11.6.0b11/.

Please let us know if you have any questions.

[github-actions]

Hi @matt3o. Thank you for opening this issue and giving us the opportunity to assist. We believe that this has been addressed. If you feel that further discussion is needed, please add a comment with the text "/unresolve" to remove the "issue-addressed" label and continue the conversation.