Search doc fixes (Azure#41315)

* Fix docs

* update changelog

Author: xiangyan99

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

@@ -4,6 +4,8 @@
 
 ### Features Added
 
+- Added `azure.search.documents.models.DebugInfo`.
+
 ### Breaking Changes
 
 ### Bugs Fixed

sdk/search/azure-search-documents/azure/search/documents/_generated/models/_models_py3.py

@@ -1920,7 +1920,7 @@ def __init__(self, **kwargs: Any) -> None:
 
 
 class SearchScoreThreshold(VectorThreshold):
-    """The results of the vector query will filter based on the '@search.score' value. Note this is
+    """The results of the vector query will filter based on the '\\@search.score' value. Note this is
     the @search.score returned as part of the search response. The threshold direction will be
     chosen for higher @search.score.
 
@@ -1929,7 +1929,7 @@ class SearchScoreThreshold(VectorThreshold):
     :ivar kind: The kind of threshold used to filter vector queries. Required. Known values are:
      "vectorSimilarity" and "searchScore".
     :vartype kind: str or ~azure.search.documents.models.VectorThresholdKind
-    :ivar value: The threshold will filter based on the '@search.score' value. Note this is the
+    :ivar value: The threshold will filter based on the '\\@search.score' value. Note this is the
      @search.score returned as part of the search response. The threshold direction will be chosen
      for higher @search.score. Required.
     :vartype value: float
@@ -1947,7 +1947,7 @@ class SearchScoreThreshold(VectorThreshold):
 
     def __init__(self, *, value: float, **kwargs: Any) -> None:
         """
-        :keyword value: The threshold will filter based on the '@search.score' value. Note this is the
+        :keyword value: The threshold will filter based on the '\\@search.score' value. Note this is the
          @search.score returned as part of the search response. The threshold direction will be chosen
          for higher @search.score. Required.
         :paramtype value: float

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

@@ -75,7 +75,7 @@ async def get_answers(self) -> Optional[List[QueryAnswerResult]]:
         and answers are requested in the search query via the query_answer parameter.
 
         :return: Answers.
-        :rtype: list[~azure.search.documents.QueryAnswerResult]
+        :rtype: list[~azure.search.documents.models.QueryAnswerResult]
         """
         return cast(List[QueryAnswerResult], await self._first_iterator_instance().get_answers())
 

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

@@ -292,7 +292,7 @@ async def analyze_text(self, index_name: str, analyze_request: AnalyzeTextOption
         :param analyze_request: The text and analyzer or analysis components to test.
         :type analyze_request: ~azure.search.documents.indexes.models.AnalyzeTextOptions
         :return: AnalyzeResult
-        :rtype: ~azure.search.documents.indexes.models.AnalyzeRequest
+        :rtype: ~azure.search.documents.indexes.models.AnalyzeResult
         :raises ~azure.core.exceptions.HttpResponseError: If the operation fails.
 
         .. admonition:: Example:
@@ -487,7 +487,7 @@ def list_index_stats_summary(self, **kwargs: Any) -> AsyncItemPaged[IndexStatist
         """Get index level statistics for a search service.
 
         :return: Index statistics result.
-        :rtype: ~azure.core.paging.AsyncItemPaged[~azure.search.documents.indexes.models.IndexStatisticsSummary]
+        :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.search.documents.indexes.models.IndexStatisticsSummary]
         """
         kwargs["headers"] = self._merge_client_headers(kwargs.get("headers"))
         # pylint:disable=protected-access
@@ -503,7 +503,7 @@ def list_aliases(self, *, select: Optional[List[str]] = None, **kwargs) -> Async
             properties.
         :paramtype select: list[str]
         :return: List of Aliases
-        :rtype: ~azure.core.paging.AsyncItemPaged[~azure.search.documents.indexes.models.SearchAlias]
+        :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.search.documents.indexes.models.SearchAlias]
         :raises ~azure.core.exceptions.HttpResponseError: If the operation fails.
         """
         kwargs["headers"] = self._merge_client_headers(kwargs.get("headers"))
@@ -517,7 +517,7 @@ def list_alias_names(self, **kwargs) -> AsyncItemPaged[str]:
         """List the alias names in an Azure Search service.
 
         :return: List of alias names
-        :rtype: ~azure.core.paging.AsyncItemPaged[str]
+        :rtype: ~azure.core.async_paging.AsyncItemPaged[str]
         :raises ~azure.core.exceptions.HttpResponseError: If the operation fails.
         """
         kwargs["headers"] = self._merge_client_headers(kwargs.get("headers"))
@@ -554,7 +554,7 @@ async def delete_alias(
         :type alias: str or ~azure.search.documents.indexes.models.SearchAlias
         :keyword match_condition: The match condition to use upon the etag
         :paramtype match_condition: ~azure.core.MatchConditions
-         ~azure.core.exceptions.HttpResponseError: If the operation fails.
+        :raises ~azure.core.exceptions.HttpResponseError: If the operation fails.
 
         .. admonition:: Example:
 
@@ -733,7 +733,7 @@ def list_agents(self, **kwargs) -> AsyncItemPaged[KnowledgeAgent]:
         """List the agents in an Azure Search service.
 
         :return: List of Knowledge Agents
-        :rtype: ~azure.core.paging.AsyncItemPaged[~azure.search.documents.indexes.models.KnowledgeAgent]
+        :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.search.documents.indexes.models.KnowledgeAgent]
         :raises ~azure.core.exceptions.HttpResponseError: If the operation fails.
         """
         kwargs["headers"] = self._merge_client_headers(kwargs.get("headers"))

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

@@ -174,7 +174,7 @@ async def get_indexers(self, *, select: Optional[List[str]] = None, **kwargs) ->
             properties.
         :paramtype select: list[str]
         :return: List of all the SearchIndexers.
-        :rtype: `list[~azure.search.documents.indexes.models.SearchIndexer]`
+        :rtype: list[~azure.search.documents.indexes.models.SearchIndexer]
 
         .. admonition:: Example:
 
@@ -475,6 +475,8 @@ async def get_data_source_connection(
         :return: The SearchIndexerDataSourceConnection that is fetched.
         :rtype: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection
 
+        .. admonition:: Example:
+
             .. literalinclude:: ../samples/async_samples/sample_data_source_operations_async.py
                 :start-after: [START get_data_source_connection_async]
                 :end-before: [END get_data_source_connection_async]

sdk/search/azure-search-documents/azure/search/documents/models/__init__.py

@@ -26,6 +26,7 @@
 
 from .._generated.models import (
     AutocompleteMode,
+    DebugInfo,
     HybridCountAndFacetMode,
     HybridSearch,
     IndexAction,
@@ -60,6 +61,7 @@
 
 __all__ = (
     "AutocompleteMode",
+    "DebugInfo",
     "HybridCountAndFacetMode",
     "HybridSearch",
     "IndexAction",