Skip to content

Commit 1c26d2f

Browse files
sgrebnovJeadie
andauthored
Document search CLI command (#415)
* Document search CLI command * Update search.md --------- Co-authored-by: Jack Eadie <jack@spice.ai>
1 parent 92bd13a commit 1c26d2f

2 files changed

Lines changed: 47 additions & 0 deletions

File tree

spiceaidocs/docs/cli/reference/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ spice [command] [--help]
2929
| [pods](/cli/reference/pods) | Lists Spicepods loaded by the Spice runtime |
3030
| [refresh](/cli/reference/refresh) | Refreshes an accelerated dataset loaded by the Spice runtime |
3131
| [run](/cli/reference/run) | Run Spice - starts the Spice runtime, installing if necessary |
32+
| [search](/cli/reference/search) | Perform embeddings-based searches across |
3233
| [sql](/cli/reference/sql) | Start an interactive SQL query session against the Spice runtime |
3334
| [status](/cli/reference/status) | Spice runtime status |
3435
| [upgrade](/cli/reference/upgrade) | Upgrades the Spice CLI to the latest release |
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
title: "search"
3+
sidebar_label: "search"
4+
pagination_prev: null
5+
pagination_next: null
6+
---
7+
8+
Performs embeddings-based searches across search configured datasets. Note: Search requires the `ai` feature to be installed.
9+
10+
### Usage
11+
12+
```shell
13+
spice search [query] [flags]
14+
```
15+
16+
`query` - a search query
17+
18+
#### Flags
19+
20+
- `--cloud` Whether to use cloud instance for search (default: false)
21+
- `--limit` Limit number of search results
22+
- `--model` Model to use for search
23+
- `--http-endpoint` HTTP endpoint for search (default: http://localhost:8090).
24+
25+
### Examples
26+
27+
```shell
28+
>>> spice search --limit 2
29+
```
30+
31+
```shell
32+
search> artificial intelligence
33+
34+
35+
Rank 1, Score: 20.6, Datasets [pdf]
36+
Undergraduate Texts in Mathematics Editors: F. W. Gehring P. R.
37+
Halmos ·
38+
Advisory Board: C. DePrima
39+
I. Herstein J. Kiefer W. LeVeque Kai Lai Chung
40+
Elementary Probability
41+
Theory with Stochastic Processes Springer Science+Business Media, LLC
42+
...
43+
44+
Rank 2, Score: 17.8, Datasets [pdf]
45+
Forecasting at Scale Sean J. Taylor y Facebook, Menlo Park, California, United States sjt@fb.com and Benjamin Letham y Facebook, Menlo Park, California, United States bletham@fb.com Abstract Forecasting is a common data science...
46+
```

0 commit comments

Comments
 (0)