Skip to content

Update docs for search UX changes #1159

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Parent: Release/1.8
merged 3 commits into from
Oct 6, 2025
+12 −12
Merged

Update docs for search UX changes #1159

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3569318
update docs for search UX changes
Jeadie Sep 23, 2025
5143887
Merge branch 'trunk' into jeadie/25-09-23/search-ux
lukekim Sep 29, 2025
e91f1a1
Merge branch 'release/1.8' into jeadie/25-09-23/search-ux
ewgenius Oct 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions website/docs/api/odbc/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Spice supports ODBC clients through an ODBC driver implementation based on the [

</TabItem>
<TabItem value="macos" label="macOS">

- Ensure that [ODBC Manager](http://www.odbcmanager.net/) is installed.
- Launch **ODBC Manager** -> **System DSN** page, select **Arrow Flight SQL ODBC DSN** and click **Configure**.
- Specify Spice.ai OSS runtime `HOST`, `PORT`, in the `UseEncryption` field, specify one of these values:
Expand Down Expand Up @@ -108,7 +108,7 @@ spiced --flight 0.0.0.0:50051
2024-10-06T20:06:50.084015Z INFO runtime::flight: Spice Runtime Flight listening on 0.0.0.0:50051
2024-10-06T20:06:50.086948Z INFO runtime::http: Spice Runtime HTTP listening on 127.0.0.1:8090
2024-10-06T20:06:50.297512Z INFO runtime: Initialized results cache; max size: 128.00 MiB, item ttl: 1s
2024-10-06T20:06:50.308775Z INFO runtime: Tool [document_similarity] ready to use
2024-10-06T20:06:50.308775Z INFO runtime: Tool [search] ready to use
2024-10-06T20:06:50.308803Z INFO runtime: Tool [table_schema] ready to use
2024-10-06T20:06:50.308814Z INFO runtime: Tool [sql] ready to use
2024-10-06T20:06:50.308829Z INFO runtime: Tool [list_datasets] ready to use
Expand Down
6 changes: 3 additions & 3 deletions website/docs/cli/reference/trace.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,14 @@ spice trace [task] [flags]
- `ai_completion`
- `sql_query`
- `nsql`
- `tool_use::document_similarity`
- `tool_use::search`
- `tool_use::list_datasets`
- `tool_use::sql`
- `tool_use::table_schema`
- `tool_use::sample_data`
- `tool_use::sql_query`
- `tool_use::memory`
- `vector_search`
- `search`
- `scheduled_worker`

These tasks are from the `task` column in the Spice SQL `runtime.task_history` table.
Expand Down Expand Up @@ -78,5 +78,5 @@ This output represents a structured trace of executed tasks.
TREE STATUS DURATION TASK OUTPUT
a97f52ccd7687e64 ✅ 673.14ms ai_chat The capital of New York is Albany.
├── 4eebde7b04321803 ✅ 0.04ms tool_use::list_datasets []
└── 4c9049e1bf1c3500 ✅ 671.91ms ai_completion [{"content":"The capital of New York is Albany.","refusal":null,"tool_calls":null,"role":"assistant","function_call":null,"audio":null}]
└── 4c9049e1bf1c3500 ✅ 671.91ms ai_completion [{"content":"The capital of New York is Albany.","refusal":null,"tool_calls":null,"role":"assistant","function_call":null,"audio":null}]
```
2 changes: 1 addition & 1 deletion website/docs/components/tools/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ For details on tool specifications, see the [Tools Spicepod Reference](/docs/ref
| `list_datasets` | List all available datasets in the runtime. | `auto` |
| `sql` | Execute SQL queries on the runtime. | `auto` |
| `table_schema` | Get the schema of a specific SQL table. | `auto` |
| `document_similarity` | Retrieve documents based on an input query. | `auto` |
| `search` | Searches a configured dataset based on an input query. | `auto` |
| `sample_distinct_columns` | Generate a synthetic sample of data with distinct values. | `auto` |
| `random_sample` | Sample random rows from a table. | `auto` |
| `top_n_sample` | Sample the top N rows from a table based on a specified ordering. | `auto` |
Expand Down
12 changes: 6 additions & 6 deletions website/docs/reference/task_history.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,8 +144,8 @@ Example output:
| tool_use::list_datasets | 4 | 0.16899999999999998 |
| text_embed | 4 | 3341.08975 |
| ai_chat | 4 | 7151.03675 |
| vector_search | 3 | 384.376 |
| tool_use::document_similarity | 3 | 385.0406666666667 |
| search | 3 | 384.376 |
| tool_use::search | 3 | 385.0406666666667 |
| tool_use::get_readiness | 1 | 0.12999999999999998 |
| tool_use::sample_data | 1 | 2.275 |
| health | 1 | 661.0169999999999 |
Expand Down Expand Up @@ -214,8 +214,8 @@ Example output:
| ai_chat | b2a69503a1b83215603ead321eea6f61 | | 95411c59fc9c8cb8 | 6445.162 | 2024-11-25T06:03:31.197980 | 2024-11-25T06:03:37.643142 | {"messages":[{"role":"user","content":"how to install react"},{"role":"user","content":"top 3 recent | It seems that the dataset containing the recent React issues is currently being refreshed and is not | | {model: gpt-4o} |
| tool_use::list_datasets | b2a69503a1b83215603ead321eea6f61 | 95411c59fc9c8cb8 | aa5ba649da3f0581 | 0.367 | 2024-11-25T06:03:31.198139 | 2024-11-25T06:03:31.198506 | | [{"can_search_documents":true,"description":"React.js documentation and reference, from https://reac | | {tool: list_datasets} |
| ai_completion | b2a69503a1b83215603ead321eea6f61 | 95411c59fc9c8cb8 | 8bd67a43da1b4312 | 6444.1990000000005 | 2024-11-25T06:03:31.198906 | 2024-11-25T06:03:37.643105 | {"messages":[{"role":"assistant","tool_calls":[{"id":"initial_list_datasets","type":"function","func | | | {prompt_tokens: 1454, stream: true, total_tokens: 1484, model: gpt-4o, completion_tokens: 30} |
| tool_use::document_similarity | b2a69503a1b83215603ead321eea6f61 | 95411c59fc9c8cb8 | 49b25ff51580d4fa | 140.337 | 2024-11-25T06:03:31.893913 | 2024-11-25T06:03:32.034250 | {"text":"how to install react","datasets":["spice.react.issues"],"limit":3} | | Error occurred interacting with datafusion: Failed to execute query: External error: Acceleration not ready; loading initial data for react.issues | {tool: document_similarity} |
| vector_search | b2a69503a1b83215603ead321eea6f61 | 49b25ff51580d4fa | 9feb8c9a54079cbd | 140.24200000000002 | 2024-11-25T06:03:31.894 | 2024-11-25T06:03:32.034242 | how to install react | | Error occurred interacting with datafusion: Failed to execute query: External error: Acceleration not ready; loading initial data for react.issues | {limit: 3, tables: spice.react.issues} |
| tool_use::search | b2a69503a1b83215603ead321eea6f61 | 95411c59fc9c8cb8 | 49b25ff51580d4fa | 140.337 | 2024-11-25T06:03:31.893913 | 2024-11-25T06:03:32.034250 | {"text":"how to install react","datasets":["spice.react.issues"],"limit":3} | | Error occurred interacting with datafusion: Failed to execute query: External error: Acceleration not ready; loading initial data for react.issues | {tool: search} |
| search | b2a69503a1b83215603ead321eea6f61 | 49b25ff51580d4fa | 9feb8c9a54079cbd | 140.24200000000002 | 2024-11-25T06:03:31.894 | 2024-11-25T06:03:32.034242 | how to install react | | Error occurred interacting with datafusion: Failed to execute query: External error: Acceleration not ready; loading initial data for react.issues | {limit: 3, tables: spice.react.issues} |
| text_embed | b2a69503a1b83215603ead321eea6f61 | 9feb8c9a54079cbd | 7f18fd8d96a1baeb | 122.771 | 2024-11-25T06:03:31.894072 | 2024-11-25T06:03:32.016843 | "how to install react" | | | {outputs_produced: 1} |
| sql_query | b2a69503a1b83215603ead321eea6f61 | 9feb8c9a54079cbd | 025f6b1e5cd502a6 | 16.892 | 2024-11-25T06:03:32.017320 | 2024-11-25T06:03:32.034212 | WITH ranked_docs as ( | | Failed to execute query: External error: Acceleration not ready; loading initial data for react.issues | {error_code: QueryExecutionError, protocol: Internal, query_execution_duration_ms: 8.20325, datasets: spice.react.issues, rows_produced: 0} |
| | | | | | | | SELECT id, dist, offset FROM ( | | | |
Expand Down Expand Up @@ -262,8 +262,8 @@ ORDER BY start_time;
| | | | | | 1. ** | | |
| tool_use::list_datasets | bb2de94b6f575b6c001f39cfded8bff4 | 0.157 | 2024-11-25T07:02:43.240048 | | [{"can_search_documents":true,"description":"React.js documentation and reference, from https://reac | | {tool: list_datasets} |
| ai_completion | bb2de94b6f575b6c001f39cfded8bff4 | 5664.964 | 2024-11-25T07:02:43.240416 | {"messages":[{"role":"assistant","tool_calls":[{"id":"initial_list_datasets","type":"function","func | | | {prompt_tokens: 2688, total_tokens: 2716, completion_tokens: 28, model: gpt-4o, stream: true} |
| tool_use::document_similarity | bb2de94b6f575b6c001f39cfded8bff4 | 710.9609999999999 | 2024-11-25T07:02:44.344935 | {"text":"recent issues","datasets":["spice.react.issues"],"limit":3} | | | {tool: document_similarity} |
| vector_search | bb2de94b6f575b6c001f39cfded8bff4 | 710.842 | 2024-11-25T07:02:44.345018 | recent issues | {Full { catalog: "spice", schema: "react", table: "issues" }: VectorSearchTableResult { data: [Recor | | {limit: 3, tables: spice.react.issues} |
| tool_use::search | bb2de94b6f575b6c001f39cfded8bff4 | 710.9609999999999 | 2024-11-25T07:02:44.344935 | {"text":"recent issues","datasets":["spice.react.issues"],"limit":3} | | | {tool: search} |
| search | bb2de94b6f575b6c001f39cfded8bff4 | 710.842 | 2024-11-25T07:02:44.345018 | recent issues | {Full { catalog: "spice", schema: "react", table: "issues" }: VectorSearchTableResult { data: [Recor | | {limit: 3, tables: spice.react.issues} |
| text_embed | bb2de94b6f575b6c001f39cfded8bff4 | 562.453 | 2024-11-25T07:02:44.345072 | "recent issues" | | | {outputs_produced: 1} |
| sql_query | bb2de94b6f575b6c001f39cfded8bff4 | 147.672 | 2024-11-25T07:02:44.908148 | WITH ranked_docs as ( | [{"title_chunk":"app:lintVitalReleaseBug issu","id":"I_kwDOAJy2Ks47fqsI","title":"app:lintVitalRelea | | {datasets: spice.react.issues, protocol: Internal, query_execution_duration_ms: 139.69496, rows_produced: 3} |
| | | | | SELECT id, dist, offset FROM ( | | | |
Expand Down