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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

llama_index_tools_yelp-0.6.0.tar.gz (4.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

llama_index_tools_yelp-0.6.0-py3-none-any.whl (4.3 kB view details)

Uploaded Python 3

File details

Details for the file llama_index_tools_yelp-0.6.0.tar.gz.

File metadata

  • Download URL: llama_index_tools_yelp-0.6.0.tar.gz
  • Upload date:
  • Size: 4.5 kB
  • Tags: Source
  • Uploaded using 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}

File hashes

Hashes for llama_index_tools_yelp-0.6.0.tar.gz
Algorithm Hash digest
SHA256 14df09e91925d5f76eb382c70f5d0bdc6141f267576d9385a673451499448927
MD5 86afc689b202a8b44b3d78c19a8d4a1c
BLAKE2b-256 1e94829083b0ddc980c406cc7057449020ce1cef02a9cedbff2b5ced9b13142f

See more details on using hashes here.

File details

Details for the file llama_index_tools_yelp-0.6.0-py3-none-any.whl.

File metadata

  • Download URL: llama_index_tools_yelp-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 4.3 kB
  • Tags: Python 3
  • Uploaded using 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}

File hashes

Hashes for llama_index_tools_yelp-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fe5fbd67f3936ad004e1fdead295e75bc241eef2fa725c6a03d9e9d48b1be80a
MD5 3a186388d519a804941bf0138acd2c4c
BLAKE2b-256 35d6ee194eee4ec6c69dfbed1a30f3b58091ca5f84d6dd9715e2ce12dc466849

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.6.0 This release

2 files

0.5.0

2 files

0.4.1

2 files

0.4.0

2 files

0.3.0

2 files

0.2.0

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

0.0.1

2 files

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