Requests

RequestsToolSpec

Bases: BaseToolSpec

请求工具。

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

class RequestsToolSpec(BaseToolSpec):
    """请求工具。"""

    spec_functions = ["get_request", "post_request", "patch_request"]

    def __init__(self, domain_headers: Optional[dict] = {}):
        self.domain_headers = domain_headers

    def get_request(self, url: str, params: Optional[dict] = {}):
        """使用此方法从网站获取内容。

Args:
    url ([str]): 要发起GET请求的URL
    params (Optional[dict]): 要与GET请求一起提供的参数
"""
        if not self._valid_url(url):
            return INVALID_URL_PROMPT

        res = requests.get(url, headers=self._get_headers_for_url(url), params=params)
        return res.json()

    def post_request(self, url: str, data: Optional[dict] = {}):
        """使用此方法将内容发送到网站。

Args:
    url ([str]): 发起get请求的url
    data (Optional[dict]): 要提供给get请求的键值对。
"""
        if not self._valid_url(url):
            return INVALID_URL_PROMPT

        res = requests.post(url, headers=self._get_headers_for_url(url), json=data)
        return res.json()

    def patch_request(self, url: str, data: Optional[dict] = {}):
        """用于向网站发送PATCH请求。

Args:
    url（[str]）：要发起GET请求的URL
    data（可选[dict]）：要随GET请求提供的键值对
"""
        if not self._valid_url(url):
            return INVALID_URL_PROMPT

        requests.patch(url, headers=self._get_headers_for_url(url), json=data)
        return None

    def _valid_url(self, url: str) -> bool:
        parsed = urlparse(url)
        return parsed.scheme and parsed.hostname

    def _get_domain(self, url: str) -> str:
        return urlparse(url).hostname

    def _get_headers_for_url(self, url: str) -> dict:
        return self.domain_headers[self._get_domain(url)]

get_request

get_request(url: str, params: Optional[dict] = {})

使用此方法从网站获取内容。

Parameters:

Name	Type	Description	Default
url	[str]	要发起GET请求的URL	required
params	Optional[dict]	要与GET请求一起提供的参数	{}

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

    def get_request(self, url: str, params: Optional[dict] = {}):
        """使用此方法从网站获取内容。

Args:
    url ([str]): 要发起GET请求的URL
    params (Optional[dict]): 要与GET请求一起提供的参数
"""
        if not self._valid_url(url):
            return INVALID_URL_PROMPT

        res = requests.get(url, headers=self._get_headers_for_url(url), params=params)
        return res.json()

post_request

post_request(url: str, data: Optional[dict] = {})

使用此方法将内容发送到网站。

Parameters:

Name	Type	Description	Default
url	[str]	发起get请求的url	required
data	Optional[dict]	要提供给get请求的键值对。	{}

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

    def post_request(self, url: str, data: Optional[dict] = {}):
        """使用此方法将内容发送到网站。

Args:
    url ([str]): 发起get请求的url
    data (Optional[dict]): 要提供给get请求的键值对。
"""
        if not self._valid_url(url):
            return INVALID_URL_PROMPT

        res = requests.post(url, headers=self._get_headers_for_url(url), json=data)
        return res.json()

patch_request

patch_request(url: str, data: Optional[dict] = {})

用于向网站发送PATCH请求。

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

    def patch_request(self, url: str, data: Optional[dict] = {}):
        """用于向网站发送PATCH请求。

Args:
    url（[str]）：要发起GET请求的URL
    data（可选[dict]）：要随GET请求提供的键值对
"""
        if not self._valid_url(url):
            return INVALID_URL_PROMPT

        requests.patch(url, headers=self._get_headers_for_url(url), json=data)
        return None