Expose document_debug_info and fix samples (Azure#39019)

* Expose document_debug_info and fix samples

* update

Author: xiangyan99

sdk/search/azure-search-documents/CHANGELOG.md

@@ -8,6 +8,8 @@
 
 ### Bugs Fixed
 
+- Exposed `@search.document_debug_info` in the search results.
+
 ### Other Changes
 
 ## 11.6.0b8 (2024-11-21)

sdk/search/azure-search-documents/azure/search/documents/_paging.py

@@ -20,6 +20,7 @@ def convert_search_result(result):
     ret["@search.reranker_score"] = result.reranker_score
     ret["@search.highlights"] = result.highlights
     ret["@search.captions"] = result.captions
+    ret["@search.document_debug_info"] = result.document_debug_info
     return ret
 
 
@@ -44,6 +45,7 @@ def unpack_continuation_token(token):
 
 class SearchItemPaged(ItemPaged[ReturnType]):
     """A pageable list of search results."""
+
     def __init__(self, *args, **kwargs) -> None:
         super(SearchItemPaged, self).__init__(*args, **kwargs)
         self._first_page_iterator_instance: Optional[SearchPageIterator] = None
@@ -118,6 +120,7 @@ def wrapper(self, *args, **kw):
 
 class SearchPageIterator(PageIterator):
     """An iterator over search results."""
+
     def __init__(self, client, initial_query, kwargs, continuation_token=None) -> None:
         super(SearchPageIterator, self).__init__(
             get_next=self._get_next_cb,

sdk/search/azure-search-documents/azure/search/documents/_search_client.py

@@ -101,7 +101,7 @@ def __repr__(self) -> str:
 
     def close(self) -> None:
         """Close the session.
-        
+
         :return: None
         :rtype: None
         """

sdk/search/azure-search-documents/azure/search/documents/_search_indexing_buffered_sender.py

@@ -111,7 +111,7 @@ def actions(self) -> List[IndexAction]:
     @distributed_trace
     def close(self, **kwargs) -> None:  # pylint: disable=unused-argument
         """Close the session.
-        
+
         :return: None
         :rtype: None
         """

sdk/search/azure-search-documents/azure/search/documents/aio/_paging.py

@@ -18,6 +18,7 @@
 
 class AsyncSearchItemPaged(AsyncItemPaged[ReturnType]):
     """A pageable list of search results."""
+
     def __init__(self, *args, **kwargs) -> None:
         super(AsyncSearchItemPaged, self).__init__(*args, **kwargs)
         self._first_page_iterator_instance: Optional[AsyncSearchPageIterator] = None
@@ -86,6 +87,7 @@ async def get_debug_info(self) -> DebugInfo:
         """
         return cast(DebugInfo, await self._first_iterator_instance().get_debug_info())
 
+
 # The pylint error silenced below seems spurious, as the inner wrapper does, in
 # fact, become a method of the class when it is applied.
 def _ensure_response(f):
@@ -101,6 +103,7 @@ async def wrapper(self, *args, **kw):
 
 class AsyncSearchPageIterator(AsyncPageIterator[ReturnType]):
     """An iterator of search results."""
+
     def __init__(self, client, initial_query, kwargs, continuation_token=None) -> None:
         super(AsyncSearchPageIterator, self).__init__(
             get_next=self._get_next_cb,

sdk/search/azure-search-documents/azure/search/documents/aio/_search_client_async.py

@@ -103,7 +103,7 @@ def __repr__(self) -> str:
 
     async def close(self) -> None:
         """Close the session.
-        
+
         :return: None
         :rtype: None
         """

sdk/search/azure-search-documents/azure/search/documents/indexes/_search_index_client.py

@@ -136,7 +136,7 @@ def list_index_names(self, **kwargs: Any) -> ItemPaged[str]:
 
     @distributed_trace
     def get_index(self, name: str, **kwargs: Any) -> SearchIndex:
-        """ Retrieve a named index in an Azure Search service
+        """Retrieve a named index in an Azure Search service
 
         :param name: The name of the index to retrieve.
         :type name: str

sdk/search/azure-search-documents/azure/search/documents/indexes/aio/_search_index_client.py

@@ -134,7 +134,7 @@ def list_index_names(self, **kwargs: Any) -> AsyncItemPaged[str]:
 
     @distributed_trace_async
     async def get_index(self, name: str, **kwargs: Any) -> SearchIndex:
-        """ Retrieve a named index in an Azure Search service
+        """Retrieve a named index in an Azure Search service
 
         :param name: The name of the index to retrieve.
         :type name: str
@@ -513,7 +513,7 @@ def list_alias_names(self, **kwargs) -> AsyncItemPaged[str]:
 
     @distributed_trace_async
     async def get_alias(self, name: str, **kwargs) -> SearchAlias:
-        """ Retrieve a named alias in an Azure Search service
+        """Retrieve a named alias in an Azure Search service
 
         :param name: The name of the alias to retrieve.
         :type name: str

sdk/search/azure-search-documents/azure/search/documents/indexes/models/_models.py

@@ -442,6 +442,7 @@ def _from_generated(cls, skill):
 
 class AnalyzeTextOptions(_serialization.Model):
     """Specifies some text and analysis components used to break that text into tokens."""
+
     def __init__(
         self,
         *,
@@ -1414,7 +1415,7 @@ def _from_generated(cls, search_indexer) -> Optional[Self]:
 
     def serialize(self, keep_readonly: bool = False, **kwargs: Any) -> MutableMapping[str, Any]:
         """Return the JSON that would be sent to server from this model.
-        
+
         :param bool keep_readonly: If you want to serialize the readonly attributes
         :returns: A dict JSON compatible object
         :rtype: dict

sdk/search/azure-search-documents/samples/async_samples/sample_semantic_search_async.py

@@ -52,7 +52,14 @@ async def semantic_ranking():
 
     credential = AzureKeyCredential(key)
     client = SearchClient(endpoint=service_endpoint, index_name=index_name, credential=credential)
-    results = list(client.search(search_text="luxury", query_type="semantic", query_language="en-us"))
+    results = list(
+        client.search(
+            search_text="luxury",
+            query_type="semantic",
+            semantic_configuration_name="semantic_config_name",
+            query_language="en-us",
+        )
+    )
 
     for result in results:
         print("{}\n{}\n)".format(result["hotelId"], result["hotelName"]))