Class BingAPI

bmtools/tools/bing_search/api.py:14–90

A class for performing searches on the Bing search engine. Attributes ---------- bing_api : BingAPI The Bing API to use for performing searches. Methods ------- __init__(self, subscription_key: str) -> None: Initialize the BingSearch instance with the g

RESULT_TARGET_PAGE_PER_TEXT_COUNT = 500

class BingAPI:
    """
    A class for performing searches on the Bing search engine.

    Attributes
    ----------
    bing_api : BingAPI
        The Bing API to use for performing searches.

    Methods
    -------
    __init__(self, subscription_key: str) -> None:
        Initialize the BingSearch instance with the given subscription key.
    search_top3(self, key_words: str) -> List[str]:
        Perform a search on the Bing search engine with the given keywords and return the top 3 search results.
    load_page_index(self, idx: int) -> str:
        Load the detailed page of the search result at the given index.
    """
    def __init__(self, subscription_key : str) -> None:
        """
        Initialize the BingSearch instance with the given subscription key.

        Parameters
        ----------
        subscription_key : str
            The subscription key to use for the Bing API.
        """
        self._headers = {
            'Ocp-Apim-Subscription-Key': subscription_key
        }
        self._endpoint = "https://api.bing.microsoft.com/v7.0/search"
        self._mkt = 'en-US'
    
    def search(self, key_words : str, max_retry : int = 3):
        for _ in range(max_retry):
            try:
                result = requests.get(self._endpoint, headers=self._headers, params={'q': key_words, 'mkt': self._mkt }, timeout=10)
            except Exception:
                # failed, retry
                continue

            if result.status_code == 200:
                result = result.json()
                # search result returned here
                return result
            else:
                # failed, retry
                continue
        raise RuntimeError("Failed to access Bing Search API.")
    
    def load_page(self, url : str, max_retry : int = 3) -> Tuple[bool, str]:
        for _ in range(max_retry):
            try:
                res = requests.get(url, timeout=15)
                if res.status_code == 200:
                    res.raise_for_status()
                else:
                    raise RuntimeError("Failed to load page, code {}".format(res.status_code))