flashdata-dev commited on
Commit
6fccf23
·
verified ·
1 Parent(s): d60fb7f

Publish youtube_suggestions tool and request guide

Browse files
Files changed (10) hide show
  1. LICENSE +21 -0
  2. README.md +72 -6
  3. app.js +75 -0
  4. example.json +36 -0
  5. index.html +20 -17
  6. input-schema.json +29 -0
  7. requirements.txt +2 -0
  8. style.css +1 -28
  9. task.json +17 -0
  10. tool.py +19 -0
LICENSE ADDED
@@ -0,0 +1,21 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ MIT License
2
+
3
+ Copyright (c) 2026 FlashData contributors
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
README.md CHANGED
@@ -1,12 +1,78 @@
1
  ---
2
- title: Youtube Autocomplete Topics Flashdata
3
- emoji: 🏆
4
- colorFrom: indigo
5
- colorTo: green
6
  sdk: static
 
7
  pinned: false
8
  license: mit
9
- short_description: YouTube autocomplete topic discovery
 
 
 
 
10
  ---
11
 
12
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ title: "YouTube autocomplete topic discovery"
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
13
+ - flashdata
14
+ - youtube-suggestions
15
  ---
16
 
17
+ # YouTube autocomplete topic discovery — FlashData
18
+
19
+ Explore how a topic prefix expands into suggested searches before building a video research plan. Set language and region, collect phrases, then choose which ones deserve a real search.
20
+
21
+ **Try this task:** Explore English US autocomplete phrases for the prefix AI agents.
22
+
23
+ [FlashData youtube suggestions documentation](https://flashdata.dev/docs/sources/youtube_suggestions?utm_source=hugging-face&utm_medium=integration&utm_campaign=intent_gtm_2026q4&utm_content=youtube-autocomplete-topics-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
39
+ import os
40
+ from smolagents import load_tool
41
+
42
+ os.environ["FLASHDATA_API_KEY"] = getpass.getpass("FlashData API key: ")
43
+ tool = load_tool("flashdata-dev/youtube-autocomplete-topics-flashdata", trust_remote_code=True)
44
+ result = tool(**{'language': 'en', 'query': 'AI agents', 'region': 'US'})
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 | YouTube search prefix. |
55
+ | `language` | string | 'en' | language pattern=^[A-Za-z0-9-]{1,35}$ |
56
+ | `region` | string | 'US' | region pattern=^[A-Za-z]{2}$ |
57
+
58
+ Optional `None` values are omitted; the documented adapter defaults apply.
59
+
60
+ Full validation rules are in `input-schema.json`.
61
+
62
+ ## Output and next step
63
+
64
+ The useful data is at `results.0`. Relevant fields: suggested phrase strings.
65
+
66
+ Review and select phrases before calling YouTube Search. Suggestions are ideas to investigate, not evidence of audience demand.
67
+
68
+ 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.
69
+
70
+ ## Costs, limits and failures
71
+
72
+ Returns suggested phrases, not video results, keyword search volume or trend measurements. Empty suggestions are valid.
73
+
74
+ 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.
75
+
76
+ 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.
77
+
78
+ [Get started with this FlashData capability](https://flashdata.dev/docs/sources/youtube_suggestions?utm_source=hugging-face&utm_medium=integration&utm_campaign=intent_gtm_2026q4&utm_content=youtube-autocomplete-topics-flashdata)
app.js ADDED
@@ -0,0 +1,75 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ const byId = id => document.getElementById(id);
2
+ const pythonLiteral = value => {
3
+ if (value === null) return 'None';
4
+ if (typeof value === 'boolean') return value ? 'True' : 'False';
5
+ if (Array.isArray(value)) return `[${value.map(pythonLiteral).join(', ')}]`;
6
+ if (typeof value === 'object') return `{${Object.entries(value).map(([k,v]) => `${JSON.stringify(k)}: ${pythonLiteral(v)}`).join(', ')}}`;
7
+ return JSON.stringify(value);
8
+ };
9
+
10
+ const [task, example, schema] = await Promise.all(['task.json','example.json','input-schema.json'].map(async file => {
11
+ const response = await fetch(file);
12
+ if (!response.ok) throw new Error(`Unable to load ${file}`);
13
+ return response.json();
14
+ }));
15
+
16
+ document.title = task.title;
17
+ for (const key of ['title','scenario','task','next','limit']) byId(key).textContent = task[key];
18
+ byId('docs').href = `https://flashdata.dev/docs/sources/${task.source}?utm_source=hugging-face&utm_medium=integration&utm_campaign=intent_gtm_2026q4&utm_content=${task.slug}`;
19
+ byId('source').href = `https://huggingface.co/spaces/${task.repo_id}/blob/main/tool.py`;
20
+ byId('readme').href = `https://huggingface.co/spaces/${task.repo_id}/blob/main/README.md`;
21
+ byId('parameters').value = JSON.stringify(task.input,null,2);
22
+ byId('response').value = JSON.stringify(example.response,null,2);
23
+ byId('sample-request').textContent = JSON.stringify(example.request,null,2);
24
+
25
+ function generate() {
26
+ try {
27
+ const args = JSON.parse(byId('parameters').value);
28
+ if (!args || Array.isArray(args) || typeof args !== 'object') throw new Error('Enter a JSON object.');
29
+ const allowed = task.source === 'youtube_download' ? ['operation','parameters','job_id'] : Object.keys(schema.properties);
30
+ if (Object.keys(args).some(key => !allowed.includes(key))) throw new Error('Use only the documented inputs; keep credentials in your local environment.');
31
+ const code = [
32
+ '# Install: python -m pip install smolagents==1.26.0 langchain-flashdata==0.2.1',
33
+ 'import getpass', 'import os', 'from smolagents import load_tool', '',
34
+ 'os.environ["FLASHDATA_API_KEY"] = getpass.getpass("FlashData API key: ")',
35
+ ...(task.source === 'youtube_download' && args.operation === 'submit' ? ['os.environ["FLASHDATA_DOWNLOAD_STORAGE"] = getpass.getpass("Customer storage JSON: ")'] : []),
36
+ `tool = load_tool(${JSON.stringify(task.repo_id)}, trust_remote_code=True)`,
37
+ `result = tool(**${pythonLiteral(args)})`, 'print(result)'
38
+ ];
39
+ byId('python').textContent = code.join('\n');
40
+ byId('input-status').textContent = 'Python call generated. The tool validates full parameter constraints before a request.';
41
+ } catch (error) {
42
+ byId('python').textContent = '';
43
+ byId('input-status').textContent = error.message;
44
+ }
45
+ }
46
+
47
+ function inspect() {
48
+ byId('results').replaceChildren();
49
+ try {
50
+ const response = JSON.parse(byId('response').value);
51
+ const selected = task.path.split('.').reduce((value, key) => value?.[key], response);
52
+ if (selected === undefined || selected === null) throw new Error(`No value at ${task.path}. Check the response format; failed or pending requests may have different fields.`);
53
+ const rows = Array.isArray(selected) ? selected : [selected];
54
+ byId('response-status').textContent = `${rows.length} item(s) at ${task.path}. Showing up to 10.`;
55
+ for (const row of rows.slice(0,10)) {
56
+ const card = document.createElement('div'); card.className = 'result';
57
+ const fields = typeof row === 'object' && row !== null ? task.fields.filter(key => Object.hasOwn(row,key)) : [];
58
+ if (!fields.length) { const p=document.createElement('p'); p.className='field'; p.textContent=typeof row === 'string' ? row : JSON.stringify(row); card.append(p); }
59
+ for (const key of fields) {
60
+ const line=document.createElement('p'); line.className='field';
61
+ const label=document.createElement('b'); label.textContent=key+': '; line.append(label);
62
+ const value=row[key];
63
+ if (typeof value === 'string' && /^https?:\/\//.test(value)) {
64
+ const link=document.createElement('a'); link.href=value; link.textContent=value; link.target='_blank'; link.rel='noopener noreferrer'; line.append(link);
65
+ } else line.append(document.createTextNode(typeof value === 'object' ? JSON.stringify(value) : String(value)));
66
+ card.append(line);
67
+ }
68
+ byId('results').append(card);
69
+ }
70
+ } catch (error) { byId('response-status').textContent=error.message; }
71
+ }
72
+
73
+ byId('generate').addEventListener('click',generate);
74
+ byId('inspect').addEventListener('click',inspect);
75
+ generate(); inspect();
example.json ADDED
@@ -0,0 +1,36 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "request": {
3
+ "source": "youtube_suggestions",
4
+ "query": "python",
5
+ "params": {
6
+ "language": "en",
7
+ "region": "us"
8
+ }
9
+ },
10
+ "response": {
11
+ "source": "youtube_suggestions",
12
+ "status": "done",
13
+ "results": [
14
+ [
15
+ "python for beginners",
16
+ "python hunting everglades",
17
+ "python",
18
+ "python full course",
19
+ "python funk",
20
+ "python got7",
21
+ "python commands",
22
+ "python cowboy",
23
+ "python tutorial",
24
+ "python projects",
25
+ "python coding",
26
+ "python course",
27
+ "python snake",
28
+ "python basics"
29
+ ]
30
+ ],
31
+ "usage": {
32
+ "credits": 0.01
33
+ },
34
+ "created_at": "2026-09-16T07:41:47.147Z"
35
+ }
36
+ }
index.html CHANGED
@@ -1,19 +1,22 @@
1
  <!doctype html>
2
- <html>
3
- <head>
4
- <meta charset="utf-8" />
5
- <meta name="viewport" content="width=device-width" />
6
- <title>My static Space</title>
7
- <link rel="stylesheet" href="style.css" />
8
- </head>
9
- <body>
10
- <div class="card">
11
- <h1>Welcome to your static Space!</h1>
12
- <p>You can modify this app directly by editing <i>index.html</i> in the Files and versions tab.</p>
13
- <p>
14
- Also don't forget to check the
15
- <a href="https://huggingface.co/docs/hub/spaces" target="_blank">Spaces documentation</a>.
16
- </p>
17
- </div>
18
- </body>
 
 
 
19
  </html>
 
1
  <!doctype html>
2
+ <html lang="en">
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">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">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">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">Review tool.py</a><a id="readme">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>
21
+ </body>
22
  </html>
input-schema.json ADDED
@@ -0,0 +1,29 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "additionalProperties": false,
3
+ "properties": {
4
+ "query": {
5
+ "description": "YouTube search prefix.",
6
+ "maxLength": 2000,
7
+ "minLength": 1,
8
+ "title": "Query",
9
+ "type": "string"
10
+ },
11
+ "language": {
12
+ "default": "en",
13
+ "pattern": "^[A-Za-z0-9-]{1,35}$",
14
+ "title": "Language",
15
+ "type": "string"
16
+ },
17
+ "region": {
18
+ "default": "US",
19
+ "pattern": "^[A-Za-z]{2}$",
20
+ "title": "Region",
21
+ "type": "string"
22
+ }
23
+ },
24
+ "required": [
25
+ "query"
26
+ ],
27
+ "title": "YouTubeSuggestionsInput",
28
+ "type": "object"
29
+ }
requirements.txt ADDED
@@ -0,0 +1,2 @@
 
 
 
1
+ smolagents==1.26.0
2
+ langchain-flashdata==0.2.1
style.css CHANGED
@@ -1,28 +1 @@
1
- body {
2
- padding: 2rem;
3
- font-family: -apple-system, BlinkMacSystemFont, "Arial", sans-serif;
4
- }
5
-
6
- h1 {
7
- font-size: 16px;
8
- margin-top: 0;
9
- }
10
-
11
- p {
12
- color: rgb(107, 114, 128);
13
- font-size: 15px;
14
- margin-bottom: 10px;
15
- margin-top: 5px;
16
- }
17
-
18
- .card {
19
- max-width: 620px;
20
- margin: 0 auto;
21
- padding: 16px;
22
- border: 1px solid lightgray;
23
- border-radius: 16px;
24
- }
25
-
26
- .card p:last-child {
27
- margin-bottom: 0;
28
- }
 
1
+ :root{color-scheme:light;font-family:Inter,ui-sans-serif,system-ui,-apple-system,sans-serif;color:#14243b;background:#f4f7fb;font-synthesis:none}*{box-sizing:border-box}body{margin:0}main{max-width:1240px;margin:auto;padding:32px}a{color:#175bc1;text-underline-offset:3px}header{display:flex;align-items:center;gap:24px;border-bottom:1px solid #dce3ed;padding-bottom:24px;color:#64748b;font-size:14px}.brand{font-size:21px;letter-spacing:.1em;font-weight:850;text-decoration:none;color:#123364}.intro{max-width:900px;padding:52px 0 38px}.eyebrow{font-size:12px;letter-spacing:.13em;font-weight:750;color:#4977aa}h1{font-size:clamp(28px,4vw,46px);line-height:1.12;letter-spacing:-.035em;margin:18px 0}h2{font-size:22px;margin:0 0 14px}h3{font-size:17px;margin:28px 0 8px}p{line-height:1.65}.intro>p:not(.eyebrow){font-size:18px;color:#4d6077}.cta{display:inline-block;background:#164f9b;color:white;padding:12px 18px;border-radius:7px;text-decoration:none;font-weight:600;margin-top:12px}.grid{display:grid;grid-template-columns:1fr 1fr;gap:22px}.panel{background:#fff;border:1px solid #dce3ed;border-radius:12px;padding:26px;min-width:0;box-shadow:0 5px 20px #12336405}.hint{color:#61738b;font-size:13px}label{display:block;font-size:13px;font-weight:650;margin:20px 0 8px}textarea{display:block;width:100%;height:190px;resize:vertical;border:1px solid #cbd6e6;border-radius:7px;padding:13px;font:13px/1.55 ui-monospace,SFMono-Regular,monospace;color:#253c58;background:#fbfcff}button{margin-top:12px;border:1px solid #b5c9e4;border-radius:7px;background:#edf4ff;color:#164f9b;padding:10px 15px;cursor:pointer;font:600 14px inherit}button:hover{background:#dfecff}pre{white-space:pre-wrap;overflow-wrap:anywhere;background:#f4f7fb;padding:15px;border-radius:7px;font:12px/1.6 ui-monospace,SFMono-Regular,monospace}details{font-size:13px}summary{cursor:pointer;color:#175bc1}.result{padding:14px 0;border-bottom:1px solid #e5ebf3}.result:first-child{padding-top:0}.field{font-size:13px;line-height:1.6;overflow-wrap:anywhere;margin:4px 0}.field b{color:#62758b;font-weight:500}.next{margin-top:22px}footer{display:flex;flex-wrap:wrap;gap:20px;padding:25px 0;color:#718096;font-size:12px}[role=status]{font-size:13px;color:#536b88}:focus-visible{outline:3px solid #7ea9ee;outline-offset:3px}@media(max-width:800px){main{padding:20px}.grid{grid-template-columns:1fr}.intro{padding-top:30px}header{flex-wrap:wrap;gap:8px}.panel{padding:20px}h1{font-size:32px}}
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
task.json ADDED
@@ -0,0 +1,17 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "slug": "youtube-autocomplete-topics-flashdata",
3
+ "title": "YouTube autocomplete topic discovery \u2014 FlashData",
4
+ "scenario": "Explore how a topic prefix expands into suggested searches before building a video research plan. Set language and region, collect phrases, then choose which ones deserve a real search.",
5
+ "task": "Explore English US autocomplete phrases for the prefix AI agents.",
6
+ "input": {
7
+ "query": "AI agents",
8
+ "language": "en",
9
+ "region": "US"
10
+ },
11
+ "path": "results.0",
12
+ "fields": [],
13
+ "next": "Review and select phrases before calling YouTube Search. Suggestions are ideas to investigate, not evidence of audience demand.",
14
+ "limit": "Returns suggested phrases, not video results, keyword search volume or trend measurements. Empty suggestions are valid.",
15
+ "source": "youtube_suggestions",
16
+ "repo_id": "flashdata-dev/youtube-autocomplete-topics-flashdata"
17
+ }
tool.py ADDED
@@ -0,0 +1,19 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ from smolagents import Tool
2
+
3
+
4
+ class FlashDataTool(Tool):
5
+ name = 'youtube_suggestions'
6
+ description = 'Explore how a topic prefix expands into suggested searches before building a video research plan. Set language and region, collect phrases, then choose which ones deserve a real search. Returns suggested phrases, not video results, keyword search volume or trend measurements. Empty suggestions are valid. Uses paid FlashData API credits. Never automatically retry an uncertain submission; check Jobs first.'
7
+ inputs = {'language': {'description': "Language. pattern: ^[A-Za-z0-9-]{1,35}$. Default: 'en'.",
8
+ 'nullable': True,
9
+ 'type': 'string'},
10
+ 'query': {'description': 'YouTube search prefix.', 'type': 'string'},
11
+ 'region': {'description': "Region. pattern: ^[A-Za-z]{2}$. Default: 'US'.",
12
+ 'nullable': True,
13
+ 'type': 'string'}}
14
+ output_type = 'object'
15
+
16
+ def forward(self, query: str, language: str = 'en', region: str = 'US') -> dict:
17
+ from langchain_flashdata import FlashDataYouTubeSuggestions
18
+ values = {'query': query, 'language': language, 'region': region}
19
+ return FlashDataYouTubeSuggestions().invoke({key: value for key, value in values.items() if value is not None})