Files
deepseek-harness/packages/vision/image-recognition-http/README.md
T
Pine f5f114dfb8 docs(vision): package READMEs, Model Experience, and the capability Agent Note
Document the four image-recognition packages and the vision group, register
the vision domain in the package index, add the capability decision as an
Agent Note, declare the invariants peer dep, and drop the unused agents
injection from the consumer.

Co-Authored-By: Claude <noreply@anthropic.com>
2026-08-14 11:15:59 +08:00

30 lines
1.4 KiB
Markdown

# @deepseek-ai/dsh-image-recognition-http
A user-configurable HTTP vision provider for `ctx.imageRecognition`. It calls an
OpenAI-compatible `/chat/completions` endpoint with the image encoded as a data
URL and returns the recognized text.
## Config
| Key | Type | Meaning |
|---|---|---|
| `baseURL` | string | Endpoint base; `/chat/completions` is appended. Blank inherits `$DSH_IMAGE_RECOGNITION_BASE_URL`, else unavailable. |
| `apiKey` | string (secret) | Literal key; prefer `apiKeyEnv`. |
| `apiKeyEnv` | string (credential-ref) | Credential reference resolved per recognition; defaults to `DEEPSEEK_API_KEY`. |
| `model` | string | Vision model name; defaults to `deepseek-v4-flash`. |
| `maxTokens` | number | Generated-token bound; defaults to 2048. |
The endpoint and key are editable live through the `image-recognition-http`
settings section. The key never rides a response: it is resolved per recognition
from the credentials domain, falling back to the launch environment.
A recognition under an initiating Agent appends the log-only
`image-recognition/llm-request` session event carrying the secret-free request
body before dispatch.
## Known Limitations and Deferred Work
- The provider assumes an OpenAI-compatible vision endpoint; non-standard
endpoints must be adapted via `baseURL`/`model` (or a new provider).
- `file-path` inputs require an inferable media type from the extension.