Azure SDK for Python 中查询重写调试信息的获取方法

在Azure搜索服务开发过程中，查询重写(Query Rewrite)是一个重要的调试功能。本文介绍如何在Python SDK中获取查询重写相关的调试信息。

查询重写功能概述

查询重写是Azure搜索服务中的一项功能，它会对用户输入的查询进行优化和扩展，以提高搜索结果的准确性和相关性。在Azure门户中，开发者可以直接看到查询重写的过程和结果。

Python SDK中的调试信息获取

最新版本的Azure SDK for Python已经支持获取查询重写相关的调试信息。与门户中的展示方式不同，SDK中需要通过特定方法来获取这些信息。

获取方法

1. 首先执行搜索操作：

client = SearchClient(...)
search_results = client.search(...)

2. 然后调用get_debug_info()方法获取调试信息：

debug_info = search_results.get_debug_info()

3. 调试信息中包含查询重写详情：

{
    'query_rewrites': {
        'text': {
            'input_query': '<原始查询>', 
            'rewrites': ['重写查询1', '重写查询2', ...]
        }, 
        'vectors': []
    }
}

重要说明

• 查询重写信息是搜索级别的元数据，不会出现在单个文档结果中
• 这与Azure门户中的展示逻辑一致，门户也是在整个搜索层面展示重写信息
• 不要尝试通过@search.document_debug_info获取这些信息，因为它们是不同层级的调试数据

最佳实践

建议开发者在以下场景使用查询重写调试信息：

1. 当搜索结果不符合预期时，检查查询是否被正确重写
2. 优化搜索相关性时，了解系统对查询的扩展方式
3. 调试复杂查询时，验证查询重写是否符合设计预期

通过合理利用这些调试信息，开发者可以更好地理解和优化搜索行为。