Requests

RequestsToolSpec

Bases: BaseToolSpec

Requests Tool.

Source code in llama-index-integrations/tools/llama-index-tools-requests/llama_index/tools/requests/base.py

class RequestsToolSpec(BaseToolSpec):
    """Requests Tool."""

    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] = {}):
        """
        Use this to GET content from a website.

        Args:
            url ([str]): The url to make the get request against
            params (Optional[dict]): the parameters to provide with the get request

        """
        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] = {}):
        """
        Use this to POST content to a website.

        Args:
            url ([str]): The url to make the get request against
            data (Optional[dict]): the key-value pairs to provide with the get request

        """
        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] = {}):
        """
        Use this to PATCH content to a website.

        Args:
            url ([str]): The url to make the get request against
            data (Optional[dict]): the key-value pairs to provide with the get request

        """
        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] = {})

Use this to GET content from a website.

Parameters:

Name	Type	Description	Default
url	[str]	The url to make the get request against	required
params	Optional[dict]	the parameters to provide with the get request	{}

Source code in llama-index-integrations/tools/llama-index-tools-requests/llama_index/tools/requests/base.py

def get_request(self, url: str, params: Optional[dict] = {}):
    """
    Use this to GET content from a website.

    Args:
        url ([str]): The url to make the get request against
        params (Optional[dict]): the parameters to provide with the get request

    """
    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] = {})

Use this to POST content to a website.

Parameters:

Name	Type	Description	Default
url	[str]	The url to make the get request against	required
data	Optional[dict]	the key-value pairs to provide with the get request	{}

Source code in llama-index-integrations/tools/llama-index-tools-requests/llama_index/tools/requests/base.py

def post_request(self, url: str, data: Optional[dict] = {}):
    """
    Use this to POST content to a website.

    Args:
        url ([str]): The url to make the get request against
        data (Optional[dict]): the key-value pairs to provide with the get request

    """
    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] = {})

Use this to PATCH content to a website.

Parameters:

Name	Type	Description	Default
url	[str]	The url to make the get request against	required
data	Optional[dict]	the key-value pairs to provide with the get request	{}

Source code in llama-index-integrations/tools/llama-index-tools-requests/llama_index/tools/requests/base.py

def patch_request(self, url: str, data: Optional[dict] = {}):
    """
    Use this to PATCH content to a website.

    Args:
        url ([str]): The url to make the get request against
        data (Optional[dict]): the key-value pairs to provide with the get request

    """
    if not self._valid_url(url):
        return INVALID_URL_PROMPT

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