You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
| `perplexity_auth_token` | The Perplexity API authentication token. | - |
25
-
| `perplexity_*` | Additional, perplexity specific parameters to use on all requests. See [Perplexity API Reference](https://docs.perplexity.ai/api-reference/chat-completions) | - |
26
-
27
-
**Note:** Like other models in Spice, Perplexity can set default overrides for OpenAI parameters. See [Parameter Overrides](../../features/large-language-models/parameter_overrides).
Perplexity model support is no longer supported and was deprecated in [spiceai/spiceai#9910](https://github.com/spiceai/spiceai/pull/9910). For documentation on Perplexity models in previous versions, see the [v1.11.x Perplexity documentation](https://docs.spiceai.org/docs/1.11.x/components/models/perplexity).
description: 'Configure web search tools for LLMs to search the internet using Perplexity and other search engines.'
2
+
title: 'Web Search Tool (Deprecated)'
3
+
sidebar_label: 'Websearch (Deprecated)'
4
+
description: 'The websearch tool is no longer supported in Spice.'
5
5
---
6
6
7
-
The Web Search Tool enables Spice models to search the web for information. The tool is available through the `websearch` tool, and backed by different search engines.
7
+
:::warning Deprecated
8
+
The `websearch` tool is no longer supported and was deprecated in [spiceai/spiceai#9910](https://github.com/spiceai/spiceai/pull/9910). The tool was backed by Perplexity, which is no longer supported.
8
9
9
-
## Usage
10
+
For web search functionality, use [OpenAI's hosted web search tool](https://platform.openai.com/docs/guides/tools-web-search?api-mode=responses) via the [OpenAI Responses API](/docs/features/web-search#web-search-through-openai-hosted-tools).
The `from` field specifies the tool to use. For the Web Search Tool, use `websearch`.
26
-
27
-
### `name`
28
-
29
-
The `name` field specifies the name of the tool. This name is used:
30
-
31
-
- To reference the tool in the model's `params.tools` field
32
-
- To make HTTP requests to the tool via the [API](../../api/HTTP/post), i.e. `v1/tools/{name}`
33
-
- Provided to any language model that uses the tool
34
-
35
-
### `description`
36
-
37
-
The `description` field provides a description of the tool. This description is provided to any language model that uses the tool.
38
-
39
-
### `params`
40
-
41
-
The `params` field specifies configuration options for the tool. The following parameters are supported:
42
-
43
-
- `engine`: The search engine to use. Possible values:
44
-
- `perplexity`: Use the Perplexity search engine.
45
-
- `engine_*`: Each search engine has its own set of parameters. See the documentation for the specific search engine for more information.
46
-
47
-
## Search Engines
48
-
49
-
- [Perplexity](https://perplexity.com): Powered by Perplexity [Sonar](https://docs.perplexity.ai/).
50
-
51
-
### Perplexity
52
-
53
-
To define a Perplexity search engine, use the following parameters:
54
-
55
-
- `perplexity_auth_token` (required): The authentication token for the Perplexity API. Use the [secret replacement syntax](../secret-stores/) to reference a secret, e.g. `${secrets:my_perplexity_auth_token}`. To get an authentication token, see Perplexity's [Getting Started](https://docs.perplexity.ai/guides/getting-started).
56
-
- `perplexity_return_images` (default: false): Determines whether a request should return images.
57
-
- `perplexity_return_related_questions` (default: false): Determines whether a request should return related questions.
58
-
- `perplexity_search_domain_filter`: Given a list of domains, limit the citations used by the online model to URLs from the specified domains. Currently limited to only 3 domains for whitelisting and blacklisting. For blacklisting add a `-` to the beginning of the domain string. Example:
59
-
60
-
```yaml
61
-
perplexity_search_domain_filter:
62
-
- spice.ai
63
-
- docs.perplexity.ai
64
-
```
65
-
66
-
- `perplexity_search_recency_filter`: Returns search results within the specified time interval (does not apply to images). One of: `month`, `week`, `day`, `hour`.
12
+
For documentation on the websearch tool in previous versions, see the [v1.11.x websearch documentation](https://docs.spiceai.org/docs/1.11.x/components/tools/websearch).
Copy file name to clipboardExpand all lines: website/docs/features/web-search/index.md
+5-71Lines changed: 5 additions & 71 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,50 +8,15 @@ tags:
8
8
- models
9
9
---
10
10
11
-
Spice provides web search functionality through LLMs and tools, enabling access to recent information and relevant context. Spice supports two ways of using web search in the runtime, namely through tools and through specific model providers.
11
+
Spice provides web search functionality through OpenAI's hosted tools, enabling access to recent information and relevant context.
12
12
13
-
## Web Search Through LLM Tools
14
-
15
-
One way of using web search with Spice is through the dedicated web search tool configured to use Perplexity as the engine. Sample Spicepod configuration:
tools: websearch # configure the model to use the websearch tool.
42
-
43
-
- from: xai:grok4
44
-
name: xai
45
-
params:
46
-
xai_api_key: ${secrets:SPICE_GROK_API_KEY}
47
-
tools: websearch # configure the model to use the websearch tool.
48
-
```
49
-
50
-
These models can then be invoked via an interactive REPL through [`spice chat`](../../cli/reference/chat) or via the OpenAI-compatible `/v1/chat/completions` HTTP endpoint. To learn more about the `websearch` tool, refer to [the reference](../../components/tools/websearch).
13
+
:::note
14
+
The `websearch` tool (backed by Perplexity) is no longer supported and was deprecated in [spiceai/spiceai#9910](https://github.com/spiceai/spiceai/pull/9910). Use OpenAI's hosted web search tool as described below.
15
+
:::
51
16
52
17
## Web Search Through OpenAI Hosted Tools
53
18
54
-
Spice also supports web search using [OpenAI's hosted web search tool](https://platform.openai.com/docs/guides/tools-web-search?api-mode=responses) when using [OpenAI's Responses API](https://platform.openai.com/docs/api-reference/responses). Sample Spicepod configuration:
19
+
Spice supports web search using [OpenAI's hosted web search tool](https://platform.openai.com/docs/guides/tools-web-search?api-mode=responses) when using [OpenAI's Responses API](https://platform.openai.com/docs/api-reference/responses). Sample Spicepod configuration:
55
20
56
21
```yaml
57
22
models:
@@ -72,40 +37,9 @@ Start Spice with `spice run`. Then, execute the following command, which makes a
72
37
curl -s -H "Content-Type: application/json" -X POST "http://localhost:8090/v1/responses" -d '{"model": "openai_model", "input": "what is the latest news today? use the web search tool"}' | jq -r '.output[] | select(.type=="message") | .content[] | select(.type=="output_text") | .text'
73
38
```
74
39
75
-
Output:
76
-
77
-
```
78
-
Here are some of the latest news updates as of August 30, 2025:
79
-
80
-
**International Affairs**
81
-
82
-
-**Thailand's Prime Minister Removed from Office**: The Constitutional Court of Thailand has dismissed Prime Minister Paetongtarn Shinawatra from office due to ethical misconduct related to leaked phone calls with former Cambodian Prime Minister Hun Sen. ([en.wikipedia.org](https://en.wikipedia.org/wiki/2025?utm_source=openai))
83
-
84
-
-**Armenia and Azerbaijan Sign Peace Deal**: On August 8, Armenia and Azerbaijan signed a peace agreement mediated by the United States, ending 37 years of hostilities over the Nagorno-Karabakh region. ([en.wikipedia.org](https://en.wikipedia.org/wiki/2025?utm_source=openai))
85
-
86
-
**Science and Technology**
87
-
88
-
-**OpenAI Releases GPT-5**: OpenAI has unveiled GPT-5, an upgraded version of its language model, featuring "PhD-level intelligence." ([en.wikipedia.org](https://en.wikipedia.org/wiki/2025_in_science?utm_source=openai))
89
-
90
-
-**NASA-ISRO Synthetic Aperture Radar (NISAR) Satellite Launched**: A joint project between NASA and the Indian Space Research Organisation (ISRO), the NISAR satellite was launched on July 30, 2025. It is the first dual-band radar imaging satellite, designed for remote sensing of Earth's surface. ([en.wikipedia.org](https://en.wikipedia.org/wiki/2025_in_spaceflight?utm_source=openai))
91
-
92
-
**United States**
93
-
94
-
-**Federal Reserve Governor Lisa Cook Dismissed**: President Donald Trump has removed Federal Reserve Governor Lisa Cook from her position, citing "false statements" on "one or more mortgage agreements." This decision has led to a weakening of the U.S. dollar. ([cnbc.com](https://www.cnbc.com/2025/08/25/stock-market-today-live-updates.html?utm_source=openai))
95
-
96
-
-**Stock Market Performance**: On August 26, 2025, major U.S. stock indices closed with gains. The Nasdaq Composite advanced 0.44%, the S&P 500 gained 0.41%, and the Dow Jones Industrial Average climbed 0.30%. ([cnbc.com](https://www.cnbc.com/2025/08/25/stock-market-today-live-updates.html?utm_source=openai))
97
-
98
-
**Space Exploration**
99
-
100
-
-**SpaceX's Seventh Starship Test Flight**: On January 16, 2025, SpaceX launched its seventh test flight of the Starship launch vehicle from its Starbase site in Boca Chica, Texas. The first stage was successfully recovered, but the second stage broke up shortly before engine shutdown. ([en.wikipedia.org](https://en.wikipedia.org/wiki/2025_in_Texas?utm_source=openai))
101
-
102
-
Please note that news developments are ongoing, and it's advisable to consult multiple sources for the most current information.
103
-
```
104
-
105
40
To invoke this model, use [`spice chat --responses`](../../cli/reference/chat) for an interactive REPL or the OpenAI-compatible `/v1/responses` HTTP endpoint in the runtime. To learn more about configuring models provided by OpenAI, view [the reference](../../components/models/openai).
0 commit comments