lintianle
efba9fab0a
scripts/gen-website-api.ts renders website/zh-CN/api/{cordis,harness}/* and the
api-sidebar.json fragment the VitePress config imports, so pages and navigation
can never drift from the code: signatures, @param/@returns prose, dispatch
modes, and GitHub source links are extracted, never transcribed, and the
generator hard-errors on any rendered member missing docs. verify-website-api
(doc-sync + run-gates) is the freshness gate.
Replaces the hand-written zh api pages (7 pages covering 7 of 15 services,
with phantom APIs: Context.current/Context.events, agent/post-step, tool/call,
compact/*, llm/pre-request none of which exist) with generated English
references: 5 cordis pages, 15 per-service pages, and a 35-event catalog
grouped by scope. The hand-written hub api/index.md stays and now indexes the
full surface; zh for these pages arrives with the unified translation flow.
3.3 KiB
ctx.web
WebService — provided by @deepseek-ai/dsh-web.
The web access service. Registered as ctx.web (one instance per context).
Selection semantics (resolved at execution time, never order-dependent):
- A configured id that is registered and
status().available→ that provider. - A configured id not registered →
WEB_PROVIDER_CONFIGURED_MISSING. - A configured id registered but unavailable →
WEB_PROVIDER_CONFIGURED_UNAVAILABLE. - No id configured, exactly one registered usable provider → that provider.
- No id configured, multiple usable providers →
WEB_PROVIDER_AMBIGUOUS. - No id configured, no usable provider →
WEB_PROVIDER_UNAVAILABLE.
ctx.web.registerSearchProvider(provider)
registerSearchProvider(provider: WebSearchProvider): () => void
Register a search provider. Throws WebError WEB_DUPLICATE_PROVIDER if its id is already registered for search. Returns a disposer; disposed with the calling fiber.
provider— the provider; itsidis the registry key.
Returns the disposer that unregisters the provider.
ctx.web.registerFetchProvider(provider)
registerFetchProvider(provider: WebFetchProvider): () => void
Register a fetch provider. Throws WebError WEB_DUPLICATE_PROVIDER if its id is already registered for fetch. Returns a disposer; disposed with the calling fiber.
provider— the provider; itsidis the registry key.
Returns the disposer that unregisters the provider.
ctx.web.search(request, exec?)
async search(request: WebSearchRequest, exec?: WebExecContext): Promise<WebSearchResult>
Run one search through the selected provider. Resolves the provider at call time with the selection rules above; throws WebError when the capability cannot run. The seam enforces request.maxResults on the result: if the provider over-returns, sources[] is truncated and truncated set.
request— the query plus result-shaping options.exec— the tool-execution context, forwarded to the provider.
Returns the provider's results, capped to request.maxResults.
ctx.web.fetch(request, exec?)
async fetch(request: WebFetchRequest, exec?: WebExecContext): Promise<WebFetchResult>
Retrieve one URL through the selected provider. Resolves the provider at call time with the selection rules above; throws WebError when the capability cannot run. A non-2xx response is a result, not a throw.
request— the URL plus retrieval options.exec— the tool-execution context, forwarded to the provider.
Returns the retrieval outcome; non-2xx responses resolve descriptively.