Files
deepseek-harness/packages/web/web-deepseek-api/src/index.ts
T
Turtle c03b1d247e feat(web): raise default web_search results to 10 and pace DeepSeek Search API requests
Default searchMaxResults rises to 10 so a full 10-query batch keeps one source per query. The Search API provider sends at most searchRequestsPerSecond (default 5) requests per second within one plugin instance, matching the account's 5 QPS limit. Adds an upgrade guide and Known Limitations entries.
2026-10-23 14:06:49 +08:00

107 lines
5.4 KiB
TypeScript

/**
* Register the DeepSeek Search and Fetch APIs in `ctx.web` as `deepseek-search-api`
* and `deepseek-fetch-api`. Each operation is one direct API request without an
* auxiliary model request; both providers read this section's credential and API
* base. `web.searchProvider` and `web.fetchProvider` select them. A Session on the
* DeepSeek account route authenticates with the account token when the account
* service allows the endpoint; every other request uses the configured key. Both
* providers report themselves not ready for a model request whose operation would
* have no credential.
* @module @deepseek-ai/dsh-web-deepseek-api
*/
import type { Context, Volatile } from '@deepseek-ai/cordis'
import z from '@deepseek-ai/schemastery'
import type {} from '@deepseek-ai/dsh-agent'
import type { Session } from '@deepseek-ai/dsh-session'
import type {} from '@deepseek-ai/dsh-web'
import { DeepSeekFetchApiProvider } from './fetch.ts'
import {
DEEPSEEK_DEFAULT_COUNT, DEEPSEEK_SEARCH_REQUESTS_PER_SECOND, DEEPSEEK_WEB_API_BASE_URL, DeepSeekSearchApiProvider,
} from './search.ts'
import { deepSeekWebAuth, deepSeekWebCredentialReady } from './transport.ts'
export { DEEPSEEK_FETCH_API_PROVIDER_ID, DeepSeekFetchApiProvider } from './fetch.ts'
export type { DeepSeekFetchApiOptions } from './fetch.ts'
export {
DEEPSEEK_DEFAULT_COUNT, DEEPSEEK_SEARCH_API_PROVIDER_ID, DEEPSEEK_SEARCH_REQUESTS_PER_SECOND, DEEPSEEK_WEB_API_BASE_URL,
DeepSeekSearchApiProvider, mapSearchResponse,
} from './search.ts'
export type { DeepSeekSearchApiOptions } from './search.ts'
/** Cordis plugin name used by loader diagnostics. */
export const name = 'web-deepseek-api'
/** The web seam both providers register into. */
export const inject = ['web']
/** Settings read by the next search or fetch without re-registering either provider. */
export interface Config {
/** Literal DeepSeek API key; prefer {@link apiKeyEnv} so no secret enters configuration files. */
apiKey: Volatile<string | undefined>
/** Credential reference resolved for each operation; defaults to `DEEPSEEK_API_KEY`. */
apiKeyEnv: Volatile<string>
/** API base including its path prefix; `/search` and `/fetch` are appended. */
baseURL: Volatile<string>
/** Search API results per search, from 1 through 50; a smaller request bound wins. Defaults to 10. */
count: Volatile<number>
/**
* Most Search requests this plugin instance sends in any one-second window; later searches wait,
* and the wait counts against the caller's timeout. Other processes and clients on the same account
* share the account limit without coordination. Defaults to 5.
*/
searchRequestsPerSecond: Volatile<number>
/** Send the triggering user question, bounded to 128 characters, as `ori_question`. Defaults to true. */
sendOriginalQuestion: Volatile<boolean>
}
export const Config = z.object({
apiKey: z.string().role('secret').volatile(),
apiKeyEnv: z.string().role('credential-ref').default('DEEPSEEK_API_KEY').volatile(),
baseURL: z.string().default(DEEPSEEK_WEB_API_BASE_URL).volatile(),
count: z.number().step(1).min(1).max(50).default(DEEPSEEK_DEFAULT_COUNT).volatile(),
searchRequestsPerSecond: z.number().step(1).min(1).default(DEEPSEEK_SEARCH_REQUESTS_PER_SECOND).volatile(),
sendOriginalQuestion: z.boolean().default(true).volatile(),
})
/**
* Read the text of the latest human prompt, the question that triggered the
* current turn. Injected user-role context carries another source kind.
* @param session - the initiating Session, when the search runs inside one.
* @returns the prompt's joined text blocks, or undefined without a prompt.
*/
function latestUserQuestion(session: Session | undefined): string | undefined {
const prompt = session?.deriveMessages().findLast(message => message.role === 'user' && message.source.kind === 'user')
if (prompt === undefined) return undefined
return prompt.content.flatMap(block => block.type === 'text' ? [block.text] : []).join('\n')
}
/**
* Register the Search API and Fetch API providers over one live settings section. Each provider's
* `ready()` answers whether an operation for a model request on the given route would have a
* credential to send.
* @param ctx - plugin context owning both registrations.
* @param config - live settings, read once per operation.
*/
export function apply(ctx: Context, config: Config): void {
const keyConfig = () => ({ apiKey: config.apiKey.get(), apiKeyEnv: config.apiKeyEnv.get() })
const auth = () => deepSeekWebAuth(ctx, keyConfig())
const ready = (llmProvider: string | undefined) =>
deepSeekWebCredentialReady(ctx, { ...keyConfig(), baseURL: config.baseURL.get() }, llmProvider)
const searchApi = new DeepSeekSearchApiProvider(() => ({
...auth(),
baseURL: config.baseURL.get(),
count: config.count.get(),
requestsPerSecond: config.searchRequestsPerSecond.get(),
...config.sendOriginalQuestion.get() ? {
originalQuestion: () => latestUserQuestion(ctx.get('agents')?.currentInitiator()?.session),
} : {},
}))
const fetchApi = new DeepSeekFetchApiProvider(() => ({ ...auth(), baseURL: config.baseURL.get() }))
ctx.web.registerSearchProvider({
id: searchApi.id, available: () => searchApi.available(), ready, search: (request, signal) => searchApi.search(request, signal),
})
ctx.web.registerFetchProvider({
id: fetchApi.id, available: () => fetchApi.available(), ready, fetch: (request, signal) => fetchApi.fetch(request, signal),
})
}