Skip to content
1 min read · 231 words

Interface: SearxngToolConfig

Defined in: batteries/tools/searxng/index.ts:124

Configuration for createSearxngSearchTool.

Properties

PropertyTypeDescriptionDefined in
artifactConstructor?ArtifactConstructorResolverSpool artifact constructor for the tool's output. Default () => SpooledJsonArtifact. Pass () => SpooledMarkdownArtifact (paired with an output stage that renders markdown into ctx.output) or () => SpooledArtifact for plain text.batteries/tools/searxng/index.ts:145
description?stringTool description override.batteries/tools/searxng/index.ts:139
headers?| SearxngHeadersResolver | SearxngHeadersCustom request headers — a static object or a (sync/async) resolver for refreshable auth.batteries/tools/searxng/index.ts:128
inputPipeline?SearxngInputMiddlewareFn[]Stages run before the HTTP request. See SearxngRequestContext.batteries/tools/searxng/index.ts:147
instanceUrlstringBase URL of the SearXNG instance, e.g. https://searx.example.org. Required.batteries/tools/searxng/index.ts:126
name?stringTool name. Default searxng_search.batteries/tools/searxng/index.ts:137
outputPipeline?SearxngOutputMiddlewareFn[]Stages run after the response is parsed. See SearxngResponseContext.batteries/tools/searxng/index.ts:149
resultFormat?SearxngResultFormatOutput shape. normalized/raw pin the shape (the model cannot change it); either (default) exposes a format argument so the model chooses per call.batteries/tools/searxng/index.ts:135
timeout?numberRequest timeout in milliseconds. Default 10_000.batteries/tools/searxng/index.ts:130