Skip to main content

Yelp Tool

This tool connects to Yelp and allows the Agent to search for business and fetch the reviews.

Usage

This tool has more extensive example usage documented in a Jupyter notebook here

Here's an example usage of the YelpToolSpec.

from llama_index.tools.yelp import YelpToolSpec
from llama_index.core.agent.workflow import FunctionAgent
from llama_index.llms.openai import OpenAI


tool_spec = YelpToolSpec(api_key="your-key", client_id="your-id")

agent = FunctionAgent(
    tools=tool_spec.to_tool_list(),
    llm=OpenAI(model="gpt-4.1"),
)

print(await agent.run("what good restaurants are in toronto"))
print(await agent.run("what are the details of lao lao bar"))

business_search: Use a natural language query to search for businesses business_reviews: Use a business id to fetch reviews

This loader is designed to be used as a way to load data as a Tool in a Agent.

Metadata

Release files for llama-index-tools-yelp 0.6.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for llama-index-tools-yelp 0.6.0
File Size Uploaded Provenance Actions
llama_index_tools_yelp-0.6.0.tar.gz 4.5 kB Without provenance Details for llama_index_tools_yelp-0.6.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for llama-index-tools-yelp 0.6.0
File Interpreter ABI Platform Actions
llama_index_tools_yelp-0.6.0-py3-none-any.whl Python 3 none any Details for llama_index_tools_yelp-0.6.0-py3-none-any.whl

Total release size: 8.8 kB

Release files / llama_index_tools_yelp-0.6.0.tar.gz

Download URL llama_index_tools_yelp-0.6.0.tar.gz
Size 4.5 kB
Tags Source
SHA-256 checksum
How to use checksums
14df09e91925d5f76eb382c70f5d0bdc6141f267576d9385a673451499448927
BLAKE2b-256 checksum
How to use checksums
1e94829083b0ddc980c406cc7057449020ce1cef02a9cedbff2b5ced9b13142f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.12.7 {"installer":{"name":"uv","version":"0.12.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / llama_index_tools_yelp-0.6.0-py3-none-any.whl

Download URL llama_index_tools_yelp-0.6.0-py3-none-any.whl
Size 4.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
fe5fbd67f3936ad004e1fdead295e75bc241eef2fa725c6a03d9e9d48b1be80a
BLAKE2b-256 checksum
How to use checksums
35d6ee194eee4ec6c69dfbed1a30f3b58091ca5f84d6dd9715e2ce12dc466849
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.12.7 {"installer":{"name":"uv","version":"0.12.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for llama-index-tools-yelp 0.6.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page