Yelp

YelpToolSpec

Bases: BaseToolSpec

Yelp工具规范。

Source code in llama_index/tools/yelp/base.py

class YelpToolSpec(BaseToolSpec):
    """Yelp工具规范。"""

    # TODO add disclaimer
    spec_functions = ["business_search", "business_reviews"]

    def __init__(self, api_key: str, client_id: str) -> Document:
        """使用参数进行初始化。"""
        from yelpapi import YelpAPI

        self.client = YelpAPI(api_key)

    def business_search(self, location: str, term: str, radius: Optional[int] = None):
        """向Yelp发出查询，以查找给定位置的企业。

Args:
响应中返回的企业可能不严格位于指定的位置内。
term（str）：搜索词，例如“食物”或“餐馆”，该词也可以是企业的名称，如“星巴克”
radius（int）：建议的搜索半径（以米为单位）。此字段用作搜索的建议。在密集城市地区，实际搜索半径可能低于建议的半径，在商业密度较低的地区可能更高。
"""
        response = self.client.search_query(location=location, term=term)
        return [Document(text=str(response))]

    def business_reviews(self, id: str):
        """向Yelp发出查询，使用business_search中的id来查找商家。

Args:
    # 商家的id
"""
        response = self.client.reviews_query(id=id)
        return [Document(text=str(response))]

business_search

business_search(
    location: str, term: str, radius: Optional[int] = None
)

向Yelp发出查询，以查找给定位置的企业。

Args: 响应中返回的企业可能不严格位于指定的位置内。 term（str）：搜索词，例如“食物”或“餐馆”，该词也可以是企业的名称，如“星巴克” radius（int）：建议的搜索半径（以米为单位）。此字段用作搜索的建议。在密集城市地区，实际搜索半径可能低于建议的半径，在商业密度较低的地区可能更高。

Source code in llama_index/tools/yelp/base.py

    def business_search(self, location: str, term: str, radius: Optional[int] = None):
        """向Yelp发出查询，以查找给定位置的企业。

Args:
响应中返回的企业可能不严格位于指定的位置内。
term（str）：搜索词，例如“食物”或“餐馆”，该词也可以是企业的名称，如“星巴克”
radius（int）：建议的搜索半径（以米为单位）。此字段用作搜索的建议。在密集城市地区，实际搜索半径可能低于建议的半径，在商业密度较低的地区可能更高。
"""
        response = self.client.search_query(location=location, term=term)
        return [Document(text=str(response))]

business_reviews

business_reviews(id: str)

向Yelp发出查询，使用business_search中的id来查找商家。

Source code in llama_index/tools/yelp/base.py

    def business_reviews(self, id: str):
        """向Yelp发出查询，使用business_search中的id来查找商家。

Args:
    # 商家的id
"""
        response = self.client.reviews_query(id=id)
        return [Document(text=str(response))]