:class:`ApiRetriever`
=====================


.. py:class:: ansys.fluent.mcp.solve.catalog.retriever.ApiRetriever

   Bases: :py:obj:`abc.ABC`


   
   ABC for an API retriever. Async by convention.
















   ..
       !! processed by numpydoc !!



.. py:currentmodule:: ApiRetriever

Overview
--------

.. tab-set::

   .. tab-item:: Abstract methods

      .. list-table::
          :header-rows: 0
          :widths: auto

          * - :py:attr:`~retrieve`
            - Retrieve API hits that match the query and filters.



   .. tab-item:: Methods

      .. list-table::
          :header-rows: 0
          :widths: auto

          * - :py:attr:`~aclose`
            - Close resources for the ApiRetriever object.



   .. tab-item:: Attributes

      .. list-table::
          :header-rows: 0
          :widths: auto

          * - :py:attr:`~name`
            - 






Import detail
-------------

.. code-block:: python

    from ansys.fluent.mcp.solve.catalog.retriever import ApiRetriever


Attribute detail
----------------

.. py:attribute:: name
   :type:  str
   :value: 'abstract'




Method detail
-------------

.. py:method:: retrieve(query: str, *, top_k: int = 10, kinds: Optional[Sequence[str]] = None, under: Optional[str] = None) -> list[ApiHit]
   :abstractmethod:

   :async:


   
   Retrieve API hits that match the query and filters.


   :Parameters:

       **query** : :class:`python:str`
           Search text or user request to evaluate.

       **top_k** : :class:`python:int`
           Maximum number of results to return.

       **kinds** : :obj:`Optional`\[:obj:`Sequence`\[:class:`python:str`]]
           Optional result kinds used to narrow the operation.

       **under** : :obj:`Optional`\[:class:`python:str`]
           Optional path prefix used to scope the operation.



   :Returns:

       :class:`python:list`\[:obj:`ApiHit`]
           List of results produced by the operation.











   ..
       !! processed by numpydoc !!

.. py:method:: aclose() -> None
   :async:


   
   Close resources for the ApiRetriever object.





   :Returns:

       :data:`python:None`
           The function completes through its side effects.











   ..
       !! processed by numpydoc !!