Skip to content

Commit 64ef7cf

Browse files
committed
fix: correct enrichment doc paths, CLI name, and broken link
Fix user-facing references in the enrichment docs and runtime messages that point to names/paths that don't exist: kcenrich -> kcagent and demo-dataset -> demo_ecommerce in toolbox/enrichment/README.md; broken ../docs/sharepoint-setup.md link in agents/enrichment/README.md; and toolbox/enrichment/... -> agents/enrichment/... setup-script paths in sharepoint-setup.md and the agent_runner.py / sharepoint_tools.py runtime messages. Docs/help-text only; no behavior change.
1 parent e911292 commit 64ef7cf

5 files changed

Lines changed: 10 additions & 10 deletions

File tree

agents/enrichment/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -363,7 +363,7 @@ list). `--project`, `--model`, and `--output_dir` are required in **every** mode
363363
364364
#### SharePoint input *(all modes)*
365365
366-
- **`--sharepoint_sites`** — Comma-separated SharePoint sites — accepts full site URLs from your browser's address bar, e.g. `--sharepoint_sites=https://contoso.sharepoint.com/sites/Marketing`. Walks each site's default document library and reads topic-relevant files via the Microsoft Graph REST API (text read in full; `.docx`/`.xlsx`/`.pptx`/PDF extracted locally). SharePoint URLs may also be dropped into `--docs` / `--folders`. Auth uses an MSAL token cache or `MICROSOFT_ACCESS_TOKEN` — see [docs/sharepoint-setup.md](../docs/sharepoint-setup.md) and `scripts/setup_sharepoint.py`.
366+
- **`--sharepoint_sites`** — Comma-separated SharePoint sites — accepts full site URLs from your browser's address bar, e.g. `--sharepoint_sites=https://contoso.sharepoint.com/sites/Marketing`. Walks each site's default document library and reads topic-relevant files via the Microsoft Graph REST API (text read in full; `.docx`/`.xlsx`/`.pptx`/PDF extracted locally). SharePoint URLs may also be dropped into `--docs` / `--folders`. Auth uses an MSAL token cache or `MICROSOFT_ACCESS_TOKEN` — see [docs/sharepoint-setup.md](docs/sharepoint-setup.md) and `scripts/setup_sharepoint.py`.
367367
368368
#### Output format *(all modes)*
369369

agents/enrichment/docs/sharepoint-setup.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ result.
107107
From the repo root:
108108

109109
```bash
110-
python3 toolbox/enrichment/scripts/setup_sharepoint.py
110+
python3 agents/enrichment/scripts/setup_sharepoint.py
111111
```
112112

113113
What it does, in order:
@@ -140,11 +140,11 @@ After this succeeds:
140140

141141
```bash
142142
# Read-only state check — no prompts, no OAuth.
143-
python3 toolbox/enrichment/scripts/setup_sharepoint.py --doctor
143+
python3 agents/enrichment/scripts/setup_sharepoint.py --doctor
144144

145145
# Force a fresh device-code sign-in even if the cache is still valid
146146
# (e.g. after rotating an Entra secret or changing accounts).
147-
python3 toolbox/enrichment/scripts/setup_sharepoint.py --re-auth
147+
python3 agents/enrichment/scripts/setup_sharepoint.py --re-auth
148148
```
149149

150150
---
@@ -157,15 +157,15 @@ Two flag shapes for pointing the agent at SharePoint content:
157157
# (a) Pass full SharePoint URLs in --folders (or --docs). Any URL on a
158158
# site that starts with /sites/<NAME>/... gets recognized and the
159159
# agent walks that site's default library.
160-
python3 toolbox/enrichment/src/agent_runner.py \
160+
python3 agents/enrichment/src/agent_runner.py \
161161
--mode=doc \
162162
--topic="Order pipeline metadata" \
163163
--folders="https://<tenant>.sharepoint.com/sites/<NAME>/SitePages/Home.aspx" \
164164
--entry_group=<project>.<location>.<entryGroupId> \
165165
--project=<gcp_project> --model=<vertex_model> --output_dir=<local_out>
166166

167167
# (b) Or pass them explicitly via the typed --sharepoint_* flags.
168-
python3 toolbox/enrichment/src/agent_runner.py \
168+
python3 agents/enrichment/src/agent_runner.py \
169169
--mode=doc \
170170
--topic="Order pipeline metadata" \
171171
--sharepoint_sites="https://<tenant>.sharepoint.com/sites/<NAME>" \

agents/enrichment/src/agent_runner.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -568,7 +568,7 @@ def _union(*lists) -> list:
568568
msg = (
569569
"SharePoint sources were specified but no Microsoft credentials"
570570
" are configured. Run:\n"
571-
" python3 toolbox/enrichment/scripts/setup_sharepoint.py\n"
571+
" python3 agents/enrichment/scripts/setup_sharepoint.py\n"
572572
"for a one-time interactive walkthrough (registers Entra app +"
573573
" populates MSAL cache for silent refresh)."
574574
)

agents/enrichment/src/tools/sharepoint_tools.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1331,7 +1331,7 @@ async def gather_sharepoint_context(
13311331
print(
13321332
"[SharePoint] ⚠️ No Microsoft credentials available — skipping"
13331333
" SharePoint source. Either populate the MSAL cache by running"
1334-
" `python3 toolbox/enrichment/scripts/setup_sharepoint.py` (one"
1334+
" `python3 agents/enrichment/scripts/setup_sharepoint.py` (one"
13351335
" time; enables silent refresh thereafter), or export"
13361336
f" ${_TOKEN_ENV} with a Graph bearer for a one-shot run.",
13371337
flush=True,

toolbox/enrichment/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Follow the instructions on that page on using the `kcmd` tool.
1313

1414
### CLI
1515

16-
The package provides the `kcenrich` CLI tool. This is distributed as a standalone binary.
16+
The package provides the `kcagent` CLI tool. This is distributed as a standalone binary.
1717

1818
```bash
1919
# Initialize a new catalog snapshot for a bigquery dataset
@@ -164,5 +164,5 @@ Copy over the individual markdown files from [here](https://github.com/GoogleClo
164164

165165
**Clean up**
166166
```bash
167-
bq rm -r ${DEMO_CLOUD_PROJECT}:demo-dataset
167+
bq rm -r ${DEMO_CLOUD_PROJECT}:demo_ecommerce
168168
```

0 commit comments

Comments
 (0)