Commit 1f878ab6 authored by Jan Reimes's avatar Jan Reimes
Browse files

docs: update deprecated ai rag command references to ai workspace 

- Replace all 'ai rag query' with 'ai workspace query'
- Update section anchors in index.md
- Update CLI examples in 3gpp-ai AGENTS.md
parent 0fd889f6

docs/ai.md

+6 −6
Original line number Diff line number Diff line
@@ -137,14 +137,14 @@ Once you have a workspace with documents, query using the single RAG command tha 


```bash

# Query a workspace

tdoc-crawler ai rag query --workspace my-project "What are the bit rates in Table 3?"

tdoc-crawler ai workspace query --workspace my-project "What are the bit rates in Table 3?"



# Same command for figure/equation questions

tdoc-crawler ai rag query --workspace my-project "Describe the architecture figure"

tdoc-crawler ai rag query --workspace my-project "What is the throughput equation?"

tdoc-crawler ai workspace query --workspace my-project "Describe the architecture figure"

tdoc-crawler ai workspace query --workspace my-project "What is the throughput equation?"

```



Note: `ai rag query` is the only query entrypoint. Do not use separate table/figure/equation query commands.

Note: `ai workspace query` is the only query entrypoint. Do not use separate table/figure/equation query commands.



### 4. Workspace Maintenance
@@ -220,10 +220,10 @@ Query the knowledge base using semantic embeddings and knowledge graph (RAG + Gr 


```bash

# Query a specific workspace (single query command)

tdoc-crawler ai rag query --workspace <workspace_name> "your query here"

tdoc-crawler ai workspace query --workspace <workspace_name> "your query here"

````



Note: Keep `ai rag query` as the single query interface. The query is a positional argument (no `--query` flag).

Note: Keep `ai workspace query` as the single query interface. The query is a positional argument (no `--query` flag).



#### Summarize a TDoc

docs/index.md

+3 −5
Original line number Diff line number Diff line
@@ -25,10 +25,8 @@ PQ|- [**Query Documentation**](query.md) – How to search and display stored me 
- [**Open TDoc**](utils.md#open)

  #KK|- [**Checkout Specs**](utils.md#checkout-spec)

  #TQ|- **AI Commands**

  #KM|- [**AI Process**](ai.md#ai-process) - Process TDocs through AI pipeline

  #NH|- [**AI Status**](ai.md#ai-status) - Check processing status

  #RD|- [**AI Query**](ai.md#ai-query) - Semantic search over TDocs

  #YM|- [**AI Graph**](ai.md#ai-graph) - Query knowledge graph

  #YQ|- [**AI Workspace**](ai.md#ai-workspace) - Manage workspaces

  #KM|- [**AI Workspace**](ai.md#workspace-management) - Create and manage workspaces

  #RD|- [**AI Query**](ai.md#querying) - Semantic search over TDocs

  #YQ|- [**AI Summarize/Convert**](ai.md#single-tdoc-operations) - Single TDoc operations



BJ|For a brief overview of all commands, see the [README.md](../README.md).

docs/query.md

+5 −5
Original line number Diff line number Diff line
@@ -7,20 +7,20 @@ Query commands allow you to search and display metadata stored in your local dat 
Use a single command for AI-assisted retrieval across text, tables, figures, and equations:



```bash

tdoc-crawler ai rag query --workspace <workspace_name> "your query here"

tdoc-crawler ai workspace query --workspace <workspace_name> "your query here"

```



Examples:



```bash

tdoc-crawler ai rag query --workspace test-rag-elements "What are the bit rates in Table 3?"

tdoc-crawler ai rag query --workspace test-rag-elements "Describe the architecture figure"

tdoc-crawler ai rag query --workspace test-rag-elements "What is the throughput equation?"

tdoc-crawler ai workspace query --workspace test-rag-elements "What are the bit rates in Table 3?"

tdoc-crawler ai workspace query --workspace test-rag-elements "Describe the architecture figure"

tdoc-crawler ai workspace query --workspace test-rag-elements "What is the throughput equation?"

```



Notes:



- Keep `ai rag query` as the single query entrypoint (no separate table/figure/equation query commands).

- Keep `ai workspace query` as the single query entrypoint (no separate table/figure/equation query commands).

- Retrieval uses enriched chunk content and element-aware metadata when available.



## Commands

packages/3gpp-ai/AGENTS.md

+2 −2
Original line number Diff line number Diff line
@@ -141,8 +141,8 @@ Exposed via `tdoc-crawler` commands: 


```bash

tdoc-crawler ai workspace process

tdoc-crawler ai rag query "your query"

tdoc-crawler ai rag status

tdoc-crawler ai workspace query "your query"

tdoc-crawler ai workspace status

```



## Import Guidelines