apollo-code

---

apollo-code / tools/src / WebSearchTool

Class: WebSearchTool

Implements

• Tool<WebSearchInput>

Constructors

Constructor

new WebSearchTool(provider?, options?): WebSearchTool

Parameters

provider?

WebSearchProvider

options?

WebSearchOptions = {}

Returns

WebSearchTool

Properties

description

readonly description: "Search through a configured provider; returned content is untrusted" = 'Search through a configured provider; returned content is untrusted'

Implementation of

Tool.description

---

inputSchema

readonly inputSchema: never

Implementation of

Tool.inputSchema

---

name

readonly name: "WebSearch" = 'WebSearch'

Implementation of

Tool.name

---

parallelSafe

readonly parallelSafe: true = true

Implementation of

Tool.parallelSafe

---

provider?

readonly optional provider?: WebSearchProvider

---

readonly

readonly readonly: true = true

Implementation of

Tool.readonly

---

timeoutMs

readonly timeoutMs: 30000 = 30_000

Implementation of

Tool.timeoutMs

Methods

invoke()

invoke(input, context): Promise<ToolResult>

Parameters

input

WebSearchInput

context

ToolContext

Returns

Promise<ToolResult>

Implementation of

Tool.invoke

---

permissionSpec()

permissionSpec(input): object

Parameters

input

WebSearchInput

Returns

object

custom

custom: object

custom.webSearch

webSearch: object

custom.webSearch.provider

provider: string

custom.webSearch.query

query: string

custom.webSearch.queryFingerprint

queryFingerprint: string

Implementation of

Tool.permissionSpec