@sisu-ai/tool-web-search-openai 2.0.2 → 2.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -13
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,11 +1,12 @@
|
|
|
1
1
|
# @sisu-ai/tool-web-search-openai
|
|
2
|
+
|
|
3
|
+
Web search tool powered by OpenAI's Responses API `web_search` capability.
|
|
4
|
+
|
|
2
5
|
[](https://github.com/finger-gun/sisu/actions/workflows/tests.yml)
|
|
3
6
|
[](https://github.com/finger-gun/sisu/blob/main/LICENSE)
|
|
4
7
|
[](https://www.npmjs.com/package/@sisu-ai/tool-web-search-openai)
|
|
5
8
|
[](https://github.com/finger-gun/sisu/blob/main/CONTRIBUTING.md)
|
|
6
9
|
|
|
7
|
-
Web search tool powered by OpenAI's Responses API `web_search` capability.
|
|
8
|
-
|
|
9
10
|
Install
|
|
10
11
|
```bash
|
|
11
12
|
npm i @sisu-ai/tool-web-search-openai
|
|
@@ -18,17 +19,6 @@ Environment
|
|
|
18
19
|
- `OPENAI_RESPONSES_MODEL`: Model to use (default `gpt-4.1-mini`). If missing, the tool will try to infer from the adapter (`openai:<model>`), then fall back to default.
|
|
19
20
|
- `DEBUG_LLM=1`: Logs a redacted request preview and response summary.
|
|
20
21
|
|
|
21
|
-
CLI flags (example app)
|
|
22
|
-
- `--openai-api-key`, `--api-key`
|
|
23
|
-
- `--openai-responses-base-url`, `--openai-base-url`, `--base-url`
|
|
24
|
-
- `--openai-responses-model`, `--openai-model`
|
|
25
|
-
|
|
26
|
-
Precedence
|
|
27
|
-
1) CLI flags (when provided by your app in `ctx.state.openai`, or read by core helpers)
|
|
28
|
-
2) Env vars
|
|
29
|
-
3) Adapter hints/metadata (e.g., `openAIAdapter({ responseModel })` or adapter model name)
|
|
30
|
-
4) Defaults
|
|
31
|
-
|
|
32
22
|
Usage
|
|
33
23
|
```ts
|
|
34
24
|
import { Agent } from '@sisu-ai/core';
|
|
@@ -48,8 +38,13 @@ Notes
|
|
|
48
38
|
- On provider/tool mismatch, the tool retries once with a safe default model (`gpt-4.1-mini`).
|
|
49
39
|
|
|
50
40
|
# Community & Support
|
|
41
|
+
|
|
42
|
+
Discover what you can do through examples or documentation. Check it out at https://github.com/finger-gun/sisu. Example projects live under [`examples/`](https://github.com/finger-gun/sisu/tree/main/examples) in the repo.
|
|
43
|
+
|
|
44
|
+
|
|
51
45
|
- [Code of Conduct](https://github.com/finger-gun/sisu/blob/main/CODE_OF_CONDUCT.md)
|
|
52
46
|
- [Contributing Guide](https://github.com/finger-gun/sisu/blob/main/CONTRIBUTING.md)
|
|
53
47
|
- [License](https://github.com/finger-gun/sisu/blob/main/LICENSE)
|
|
54
48
|
- [Report a Bug](https://github.com/finger-gun/sisu/issues/new?template=bug_report.md)
|
|
55
49
|
- [Request a Feature](https://github.com/finger-gun/sisu/issues/new?template=feature_request.md)
|
|
50
|
+
|