flashdata-dev commited on
Commit
80b6a02
·
verified ·
1 Parent(s): 09acaa1

Clarify capability names and simplify documentation

Browse files
Files changed (4) hide show
  1. README.md +37 -40
  2. index.html +5 -5
  3. task.json +6 -5
  4. tool.py +1 -1
README.md CHANGED
@@ -1,12 +1,13 @@
1
  ---
2
- title: "Google Places local business shortlist"
3
- emoji: 🔎
4
- colorFrom: blue
5
- colorTo: indigo
6
- sdk: static
7
- app_file: index.html
 
8
  pinned: false
9
- license: mit
10
  tags:
11
  - smolagents
12
  - tool
@@ -14,25 +15,27 @@ tags:
14
  - google-places
15
  ---
16
 
17
- # Google Places local business shortlist — FlashData
18
 
19
- Help an operations assistant find nearby businesses for a concrete service need. Collect names, addresses and available ratings or contact details for a location-specific shortlist.
20
 
21
- **Try this task:** Find coworking spaces in Singapore for a team offsite.
22
 
23
- [FlashData google places documentation](https://flashdata.dev/docs/sources/google_places?utm_source=hugging-face&utm_medium=integration&utm_campaign=intent_gtm_2026q4&utm_content=google-places-shortlist-flashdata) · [Create a FlashData account](https://flashdata.dev/signup)
24
 
25
- ## Run it
26
 
27
- Open the Space to edit a request and inspect a documentation response sample. The interactive page runs locally in your browser; it does not send a FlashData query or collect an API key. The Python tool runs in your own process.
28
 
29
- Use Python 3.10 or newer. Install the pinned dependencies:
 
 
30
 
31
  ```sh
32
  python -m pip install "smolagents==1.26.0" "langchain-flashdata==0.2.1"
33
  ```
34
 
35
- Create an API key in the FlashData console, fund the required credits, and supply the key in your local environment. Review `tool.py` before enabling remote code execution.
36
 
37
  ```python
38
  import getpass
@@ -45,39 +48,33 @@ result = tool(**{'gl': 'sg', 'num': 10, 'query': 'coworking spaces Singapore'})
45
  print(result)
46
  ```
47
 
48
- This is a native smolagents Tool with typed task inputs. Add the loaded tool to your own agent; model choice, prompts and model fees remain under your control. Direct calls above do not need a model.
49
 
50
  ## Inputs
51
 
52
- | Parameter | Type | Required / default | Details |
53
- | --- | --- | --- | --- |
54
- | `query` | string | Required | Search query, between 1 and 2,000 characters. |
55
- | `num` | integer | None | Requested result count. minimum=1, maximum=100 |
56
- | `page` | integer | None | Search result page. minimum=1, maximum=100 |
57
- | `autocorrect` | boolean | None | Enable spelling autocorrection. |
58
- | `gl` | string | None | Two-letter country code, for example us. pattern=^[A-Za-z]{2}$ |
59
- | `hl` | string | None | Interface language code, for example en. pattern=^[A-Za-z0-9-]{1,35}$ |
60
- | `location` | string | None | Optional geographic search location. |
61
- | `tbs` | string | None | Optional Google time filter, for example qdr:w. |
62
-
63
- Optional `None` values are omitted; the documented adapter defaults apply.
64
-
65
- Full validation rules are in `input-schema.json`.
66
-
67
- ## Output and next step
68
 
69
- The useful data is at `results.0.places`. Relevant fields: `title`, `address`, `rating`, `website`, `phoneNumber`.
70
 
71
- Check each business website for current availability and terms before contacting or booking.
72
 
73
- The Space includes a recorded documentation example and its original request. It is not a fresh result for the task prompt above. Optional fields may be absent.
74
 
75
- ## Costs, limits and failures
76
 
77
- Contact fields can be missing. Results are not an exhaustive business database and do not establish opening hours or availability.
78
 
79
- The tool is MIT licensed. It is free to install. **FlashData API calls are paid**; installation does not include free data queries. Check current [FlashData pricing](https://flashdata.dev/pricing) and your console balance. Platform, model and customer storage charges are separate. Each search/page is a separate request; Extended Search has its own rate. Downloads are charged by delivered data volume.
80
 
81
- An uncertain timeout can still represent a charged request. Check Jobs in the FlashData console before trying again; this integration does not automatically retry paid submissions. A 401 means the key was rejected, 402 means insufficient credits, and 429 means a rate or quota limit.
82
 
83
- [Get started with this FlashData capability](https://flashdata.dev/docs/sources/google_places?utm_source=hugging-face&utm_medium=integration&utm_campaign=intent_gtm_2026q4&utm_content=google-places-shortlist-flashdata)
 
1
  ---
2
+ title: "Google Places Search"
3
+ short_description: "Local businesses, addresses, ratings and contact details."
4
+ emoji: "🔎"
5
+ colorFrom: "blue"
6
+ colorTo: "indigo"
7
+ sdk: "static"
8
+ app_file: "index.html"
9
  pinned: false
10
+ license: "mit"
11
  tags:
12
  - smolagents
13
  - tool
 
15
  - google-places
16
  ---
17
 
18
+ # Google Places Search
19
 
20
+ Find local businesses and places by query and location. Get names, addresses, ratings and available website or contact details.
21
 
22
+ [API documentation](https://flashdata.dev/docs/sources/google_places?utm_source=hugging-face&utm_medium=integration&utm_campaign=intent_gtm_2026q4&utm_content=google-places-shortlist-flashdata) · [Get an API key](https://flashdata.dev/app/api-keys) · [Pricing](https://flashdata.dev/pricing)
23
 
24
+ Requires your own FlashData API key and paid Credits. The Python tool is free to install.
25
 
26
+ ## Try the inputs
27
 
28
+ Edit the JSON in this Space, generate a Python call, and inspect the included sample response or paste your own JSON. This page runs locally in your browser; it does not run a data query or collect your API key.
29
 
30
+ ## Run with Python
31
+
32
+ Use Python 3.10 or newer:
33
 
34
  ```sh
35
  python -m pip install "smolagents==1.26.0" "langchain-flashdata==0.2.1"
36
  ```
37
 
38
+ Review [tool.py](tool.py) before enabling `trust_remote_code`. Run locally with your key:
39
 
40
  ```python
41
  import getpass
 
48
  print(result)
49
  ```
50
 
51
+ The same loaded tool can be used with smolagents. A direct Python call does not require a model.
52
 
53
  ## Inputs
54
 
55
+ | Parameter | Required / default | Details |
56
+ | --- | --- | --- |
57
+ | `query` | Required | Search query, between 1 and 2,000 characters. |
58
+ | `num` | None | Requested result count. minimum=1, maximum=100 |
59
+ | `page` | None | Search result page. minimum=1, maximum=100 |
60
+ | `autocorrect` | None | Enable spelling autocorrection. |
61
+ | `gl` | None | Two-letter country code, for example us. |
62
+ | `hl` | None | Interface language code, for example en. |
63
+ | `location` | None | Optional geographic search location. |
64
+ | `tbs` | None | Optional Google time filter, for example qdr:w. |
 
 
 
 
 
 
65
 
66
+ See [input-schema.json](input-schema.json) for full validation rules. Optional `None` values are omitted; adapter defaults apply.
67
 
68
+ ## Output
69
 
70
+ Read `results.0.places`. Fields: `title`, `address`, `rating`, `website`, `phoneNumber`. Optional fields may be absent.
71
 
72
+ [example.json](example.json) contains a recorded response and its original request, not a new result for the input shown in the Space.
73
 
74
+ ## Limits and cost
75
 
76
+ Available fields vary by place; results are not an exhaustive business directory.
77
 
78
+ Each data request uses FlashData Credits. Check [current pricing](https://flashdata.dev/pricing) before running. Any model or hosting charges are separate.
79
 
80
+ For an uncertain timeout, check your FlashData Jobs before retrying; this tool does not automatically retry paid submissions.
index.html CHANGED
@@ -3,18 +3,18 @@
3
  <head>
4
  <meta charset="UTF-8">
5
  <meta name="viewport" content="width=device-width,initial-scale=1">
6
- <title>FlashData research tool</title>
7
  <link rel="stylesheet" href="style.css">
8
  </head>
9
  <body>
10
  <main>
11
- <header><a href="https://flashdata.dev" class="brand" target="_blank" rel="noopener">FLASHDATA</a><span>Research tools for AI agents</span></header>
12
- <section class="intro"><p class="eyebrow">SMOLAGENTS TOOL · PYTHON</p><h1 id="title">Loading tool…</h1><p id="scenario"></p><a id="docs" class="cta" target="_blank" rel="noopener">Get an API key and read the docs ↗</a></section>
13
  <div class="grid">
14
  <section class="panel"><h2>Build a request</h2><p id="task"></p><label for="parameters">Tool inputs (JSON)</label><textarea id="parameters" spellcheck="false"></textarea><button id="generate" type="button">Generate Python call</button><p id="input-status" role="status"></p><pre><code id="python"></code></pre><p class="hint">Run this code in your Python environment. Your API key is entered there, not on this page.</p></section>
15
- <section class="panel"><h2>Inspect the response</h2><p class="hint">This is a recorded documentation sample, not a live response to the request on the left. You can paste your own response JSON to explore its fields.</p><details><summary>Original sample request</summary><pre id="sample-request"></pre></details><label for="response">Response JSON</label><textarea id="response" spellcheck="false"></textarea><button id="inspect" type="button">Inspect results</button><p id="response-status" role="status"></p><div id="results"></div></section>
16
  </div>
17
- <section class="panel next"><h2>Use the result</h2><p id="next"></p><h3>Limits and costs</h3><p id="limit"></p><p>The tool is free to install. <strong>FlashData API calls are paid.</strong> Platform, model and customer storage costs are separate. No API or model call is made by this page. <a href="https://flashdata.dev/pricing" target="_blank" rel="noopener">Check pricing ↗</a></p><p>For an uncertain timeout, check Jobs before retrying a paid submission. Download jobs must be read with their saved ID; do not submit again while pending.</p></section>
18
  <footer><a id="source" target="_blank" rel="noopener">Review tool.py</a><a id="readme" target="_blank" rel="noopener">Installation and input reference</a><span>MIT licensed integration · FlashData API terms apply separately</span></footer>
19
  </main>
20
  <script type="module" src="app.js"></script>
 
3
  <head>
4
  <meta charset="UTF-8">
5
  <meta name="viewport" content="width=device-width,initial-scale=1">
6
+ <title>Search and video data tools</title>
7
  <link rel="stylesheet" href="style.css">
8
  </head>
9
  <body>
10
  <main>
11
+ <header><a href="https://flashdata.dev" class="brand" target="_blank" rel="noopener">FLASHDATA</a><span>Search &amp; video data</span></header>
12
+ <section class="intro"><p class="eyebrow">PYTHON TOOL · REQUEST EXAMPLES</p><h1 id="title">Loading tool…</h1><p id="scenario"></p><a id="docs" class="cta" target="_blank" rel="noopener">API documentation &amp; setup ↗</a></section>
13
  <div class="grid">
14
  <section class="panel"><h2>Build a request</h2><p id="task"></p><label for="parameters">Tool inputs (JSON)</label><textarea id="parameters" spellcheck="false"></textarea><button id="generate" type="button">Generate Python call</button><p id="input-status" role="status"></p><pre><code id="python"></code></pre><p class="hint">Run this code in your Python environment. Your API key is entered there, not on this page.</p></section>
15
+ <section class="panel"><h2>Inspect the response</h2><p class="hint">View the included sample or paste your own response JSON. Editing the request does not run a query.</p><details><summary>Original sample request</summary><pre id="sample-request"></pre></details><label for="response">Response JSON</label><textarea id="response" spellcheck="false"></textarea><button id="inspect" type="button">Inspect results</button><p id="response-status" role="status"></p><div id="results"></div></section>
16
  </div>
17
+ <section class="panel next"><h2>Use the result</h2><p id="next"></p><h3>Limits and costs</h3><p id="limit"></p><p>Requires your FlashData API key. <strong>Data calls use paid Credits.</strong> This page only prepares code and displays JSON. <a href="https://flashdata.dev/pricing" target="_blank" rel="noopener">Check pricing ↗</a></p><p>Check FlashData Jobs before retrying a request that timed out.</p></section>
18
  <footer><a id="source" target="_blank" rel="noopener">Review tool.py</a><a id="readme" target="_blank" rel="noopener">Installation and input reference</a><span>MIT licensed integration · FlashData API terms apply separately</span></footer>
19
  </main>
20
  <script type="module" src="app.js"></script>
task.json CHANGED
@@ -1,8 +1,8 @@
1
  {
2
  "slug": "google-places-shortlist-flashdata",
3
- "title": "Google Places local business shortlist \u2014 FlashData",
4
- "scenario": "Help an operations assistant find nearby businesses for a concrete service need. Collect names, addresses and available ratings or contact details for a location-specific shortlist.",
5
- "task": "Find coworking spaces in Singapore for a team offsite.",
6
  "input": {
7
  "query": "coworking spaces Singapore",
8
  "gl": "sg",
@@ -16,8 +16,9 @@
16
  "website",
17
  "phoneNumber"
18
  ],
19
- "next": "Check each business website for current availability and terms before contacting or booking.",
20
- "limit": "Contact fields can be missing. Results are not an exhaustive business database and do not establish opening hours or availability.",
 
21
  "source": "google_places",
22
  "repo_id": "flashdata-dev/google-places-shortlist-flashdata"
23
  }
 
1
  {
2
  "slug": "google-places-shortlist-flashdata",
3
+ "title": "Google Places Search",
4
+ "scenario": "Find local businesses and places by query and location. Get names, addresses, ratings and available website or contact details.",
5
+ "task": "Search for a business type in a city.",
6
  "input": {
7
  "query": "coworking spaces Singapore",
8
  "gl": "sg",
 
16
  "website",
17
  "phoneNumber"
18
  ],
19
+ "next": "Read results.0.places for business details and source links.",
20
+ "limit": "Available fields vary by place; results are not an exhaustive business directory.",
21
+ "short_description": "Local businesses, addresses, ratings and contact details.",
22
  "source": "google_places",
23
  "repo_id": "flashdata-dev/google-places-shortlist-flashdata"
24
  }
tool.py CHANGED
@@ -3,7 +3,7 @@ from smolagents import Tool
3
 
4
  class FlashDataTool(Tool):
5
  name = 'google_places'
6
- description = 'Help an operations assistant find nearby businesses for a concrete service need. Collect names, addresses and available ratings or contact details for a location-specific shortlist. Contact fields can be missing. Results are not an exhaustive business database and do not establish opening hours or availability. Uses paid FlashData API credits. Never automatically retry an uncertain submission; check Jobs first.'
7
  inputs = {'autocorrect': {'description': 'Enable spelling autocorrection. Default: None.',
8
  'nullable': True,
9
  'type': 'boolean'},
 
3
 
4
  class FlashDataTool(Tool):
5
  name = 'google_places'
6
+ description = 'Find local businesses and places by query and location. Get names, addresses, ratings and available website or contact details. Available fields vary by place; results are not an exhaustive business directory. Uses paid FlashData API credits. Never automatically retry an uncertain submission; check Jobs first.'
7
  inputs = {'autocorrect': {'description': 'Enable spelling autocorrection. Default: None.',
8
  'nullable': True,
9
  'type': 'boolean'},