fengming 0.3.10 → 0.3.11

package/docs/providers/deepgram.md

@@ -1,184 +0,0 @@
----
-summary: "Deepgram transcription for inbound voice notes"
-read_when:
-  - You want Deepgram speech-to-text for audio attachments
-  - You want Deepgram streaming transcription for Voice Call
-  - You need a quick Deepgram config example
-title: "Deepgram"
----
-
-Deepgram is a speech-to-text API. In FengMing it is used for inbound
-audio/voice-note transcription through `tools.media.audio` and for Voice Call
-streaming STT through `plugins.entries.voice-call.config.streaming`.
-
-For batch transcription, FengMing uploads the complete audio file to Deepgram
-and injects the transcript into the reply pipeline (`{{Transcript}}` +
-`[Audio]` block). For Voice Call streaming, FengMing forwards live G.711
-u-law frames over Deepgram's WebSocket `listen` endpoint and emits partial or
-final transcripts as Deepgram returns them.
-
-| Detail        | Value                                                      |
-| ------------- | ---------------------------------------------------------- |
-| Website       | [deepgram.com](https://deepgram.com)                       |
-| Docs          | [developers.deepgram.com](https://developers.deepgram.com) |
-| Auth          | `DEEPGRAM_API_KEY`                                         |
-| Default model | `nova-3`                                                   |
-
-## Getting started
-
-<Steps>
-  <Step title="Set your API key">
-    Add your Deepgram API key to the environment:
-
-    ```
-    DEEPGRAM_API_KEY=dg_...
-    ```
-
-  </Step>
-  <Step title="Enable the audio provider">
-    ```json5
-    {
-      tools: {
-        media: {
-          audio: {
-            enabled: true,
-            models: [{ provider: "deepgram", model: "nova-3" }],
-          },
-        },
-      },
-    }
-    ```
-  </Step>
-  <Step title="Send a voice note">
-    Send an audio message through any connected channel. FengMing transcribes it
-    via Deepgram and injects the transcript into the reply pipeline.
-  </Step>
-</Steps>
-
-## Configuration options
-
-| Option            | Path                                                         | Description                           |
-| ----------------- | ------------------------------------------------------------ | ------------------------------------- |
-| `model`           | `tools.media.audio.models[].model`                           | Deepgram model id (default: `nova-3`) |
-| `language`        | `tools.media.audio.models[].language`                        | Language hint (optional)              |
-| `detect_language` | `tools.media.audio.providerOptions.deepgram.detect_language` | Enable language detection (optional)  |
-| `punctuate`       | `tools.media.audio.providerOptions.deepgram.punctuate`       | Enable punctuation (optional)         |
-| `smart_format`    | `tools.media.audio.providerOptions.deepgram.smart_format`    | Enable smart formatting (optional)    |
-
-<Tabs>
-  <Tab title="With language hint">
-    ```json5
-    {
-      tools: {
-        media: {
-          audio: {
-            enabled: true,
-            models: [{ provider: "deepgram", model: "nova-3", language: "en" }],
-          },
-        },
-      },
-    }
-    ```
-  </Tab>
-  <Tab title="With Deepgram options">
-    ```json5
-    {
-      tools: {
-        media: {
-          audio: {
-            enabled: true,
-            providerOptions: {
-              deepgram: {
-                detect_language: true,
-                punctuate: true,
-                smart_format: true,
-              },
-            },
-            models: [{ provider: "deepgram", model: "nova-3" }],
-          },
-        },
-      },
-    }
-    ```
-  </Tab>
-</Tabs>
-
-## Voice Call streaming STT
-
-The bundled `deepgram` plugin also registers a realtime transcription provider
-for the Voice Call plugin.
-
-| Setting         | Config path                                                             | Default                          |
-| --------------- | ----------------------------------------------------------------------- | -------------------------------- |
-| API key         | `plugins.entries.voice-call.config.streaming.providers.deepgram.apiKey` | Falls back to `DEEPGRAM_API_KEY` |
-| Model           | `...deepgram.model`                                                     | `nova-3`                         |
-| Language        | `...deepgram.language`                                                  | (unset)                          |
-| Encoding        | `...deepgram.encoding`                                                  | `mulaw`                          |
-| Sample rate     | `...deepgram.sampleRate`                                                | `8000`                           |
-| Endpointing     | `...deepgram.endpointingMs`                                             | `800`                            |
-| Interim results | `...deepgram.interimResults`                                            | `true`                           |
-
-```json5
-{
-  plugins: {
-    entries: {
-      "voice-call": {
-        config: {
-          streaming: {
-            enabled: true,
-            provider: "deepgram",
-            providers: {
-              deepgram: {
-                apiKey: "${DEEPGRAM_API_KEY}",
-                model: "nova-3",
-                endpointingMs: 800,
-                language: "en-US",
-              },
-            },
-          },
-        },
-      },
-    },
-  },
-}
-```
-
-<Note>
-Voice Call receives telephony audio as 8 kHz G.711 u-law. The Deepgram
-streaming provider defaults to `encoding: "mulaw"` and `sampleRate: 8000`, so
-Twilio media frames can be forwarded directly.
-</Note>
-
-## Notes
-
-<AccordionGroup>
-  <Accordion title="Authentication">
-    Authentication follows the standard provider auth order. `DEEPGRAM_API_KEY` is
-    the simplest path.
-  </Accordion>
-  <Accordion title="Proxy and custom endpoints">
-    Override endpoints or headers with `tools.media.audio.baseUrl` and
-    `tools.media.audio.headers` when using a proxy.
-  </Accordion>
-  <Accordion title="Output behavior">
-    Output follows the same audio rules as other providers (size caps, timeouts,
-    transcript injection).
-  </Accordion>
-</AccordionGroup>
-
-## Related
-
-<CardGroup cols={2}>
-  <Card title="Media tools" href="/tools/media-overview" icon="photo-film">
-    Audio, image, and video processing pipeline overview.
-  </Card>
-  <Card title="Configuration" href="/gateway/configuration" icon="gear">
-    Full config reference including media tool settings.
-  </Card>
-  <Card title="Troubleshooting" href="/help/troubleshooting" icon="wrench">
-    Common issues and debugging steps.
-  </Card>
-  <Card title="FAQ" href="/help/faq" icon="circle-question">
-    Frequently asked questions about FengMing setup.
-  </Card>
-</CardGroup>

package/docs/providers/deepinfra.md

@@ -1,92 +0,0 @@
----
-summary: "Use DeepInfra's unified API to access the most popular open source and frontier models in FengMing"
-read_when:
-  - You want a single API key for the top open source LLMs
-  - You want to run models via DeepInfra's API in FengMing
-title: "DeepInfra"
----
-
-DeepInfra provides a **unified API** that routes requests to the most popular open source and frontier models behind a single
-endpoint and API key. It is OpenAI-compatible, so most OpenAI SDKs work by switching the base URL.
-
-## Getting an API key
-
-1. Go to [https://deepinfra.com/](https://deepinfra.com/)
-2. Sign in or create an account
-3. Navigate to Dashboard / Keys and generate a new API key or use the auto created one
-
-## CLI setup
-
-```bash
-fengming onboard --deepinfra-api-key <key>
-```
-
-Or set the environment variable:
-
-```bash
-export DEEPINFRA_API_KEY="<your-deepinfra-api-key>" # pragma: allowlist secret
-```
-
-## Config snippet
-
-```json5
-{
-  env: { DEEPINFRA_API_KEY: "<your-deepinfra-api-key>" }, // pragma: allowlist secret
-  agents: {
-    defaults: {
-      model: { primary: "deepinfra/deepseek-ai/DeepSeek-V4-Flash" },
-    },
-  },
-}
-```
-
-## Supported FengMing surfaces
-
-The bundled plugin registers all DeepInfra surfaces that match current
-FengMing provider contracts. Chat, image generation, and video generation
-refresh their model catalogues live from `/v1/openai/models?sort_by=fengming&filter=with_meta`
-when `DEEPINFRA_API_KEY` is configured; the other surfaces use the curated
-static defaults below.
-
-| Surface                  | Default model                                                                                         | FengMing config/tool                                     |
-| ------------------------ | ----------------------------------------------------------------------------------------------------- | -------------------------------------------------------- |
-| Chat / model provider    | first chat-tagged entry from live catalog (manifest fallback `deepseek-ai/DeepSeek-V4-Flash`)         | `agents.defaults.model`                                  |
-| Image generation/editing | first `image-gen`-tagged entry from live catalog (static fallback `black-forest-labs/FLUX-1-schnell`) | `image_generate`, `agents.defaults.imageGenerationModel` |
-| Media understanding      | `moonshotai/Kimi-K2.5` for images                                                                     | inbound image understanding                              |
-| Speech-to-text           | `openai/whisper-large-v3-turbo`                                                                       | inbound audio transcription                              |
-| Text-to-speech           | `hexgrad/Kokoro-82M`                                                                                  | `messages.tts.provider: "deepinfra"`                     |
-| Video generation         | first `video-gen`-tagged entry from live catalog (static fallback `Pixverse/Pixverse-T2V`)            | `video_generate`, `agents.defaults.videoGenerationModel` |
-| Memory embeddings        | `BAAI/bge-m3`                                                                                         | `agents.defaults.memorySearch.provider: "deepinfra"`     |
-
-DeepInfra also exposes reranking, classification, object-detection, and other
-native model types. FengMing does not currently have first-class provider
-contracts for those categories, so this plugin does not register them yet.
-
-## Available models
-
-FengMing dynamically discovers available DeepInfra models at startup. Use
-`/models deepinfra` to see the full list of models available.
-
-Any model available on [DeepInfra.com](https://deepinfra.com/) can be used with the `deepinfra/` prefix:
-
-```
-deepinfra/deepseek-ai/DeepSeek-V4-Flash
-deepinfra/deepseek-ai/DeepSeek-V3.2
-deepinfra/MiniMaxAI/MiniMax-M2.5
-deepinfra/moonshotai/Kimi-K2.5
-deepinfra/nvidia/NVIDIA-Nemotron-3-Super-120B-A12B
-deepinfra/zai-org/GLM-5.1
-...and many more
-```
-
-## Notes
-
-- Model refs are `deepinfra/<provider>/<model>` (e.g., `deepinfra/Qwen/Qwen3-Max`).
-- Default model: `deepinfra/deepseek-ai/DeepSeek-V4-Flash`
-- Base URL: `https://api.deepinfra.com/v1/openai`
-- Native video generation uses `https://api.deepinfra.com/v1/inference/<model>`.
-
-## Related
-
-- [Model providers](/concepts/model-providers)
-- [All providers](/providers/index)

package/docs/providers/deepseek.md

@@ -1,146 +0,0 @@
----
-summary: "DeepSeek setup (auth + model selection)"
-title: "DeepSeek"
-read_when:
-  - You want to use DeepSeek with FengMing
-  - You need the API key env var or CLI auth choice
----
-
-[DeepSeek](https://www.deepseek.com) provides powerful AI models with an OpenAI-compatible API.
-
-| Property | Value                      |
-| -------- | -------------------------- |
-| Provider | `deepseek`                 |
-| Auth     | `DEEPSEEK_API_KEY`         |
-| API      | OpenAI-compatible          |
-| Base URL | `https://api.deepseek.com` |
-
-## Getting started
-
-<Steps>
-  <Step title="Get your API key">
-    Create an API key at [platform.deepseek.com](https://platform.deepseek.com/api_keys).
-  </Step>
-  <Step title="Run onboarding">
-    ```bash
-    fengming onboard --auth-choice deepseek-api-key
-    ```
-
-    This will prompt for your API key and set `deepseek/deepseek-v4-flash` as the default model.
-
-  </Step>
-  <Step title="Verify models are available">
-    ```bash
-    fengming models list --provider deepseek
-    ```
-
-    To inspect the bundled static catalog without requiring a running Gateway,
-    use:
-
-    ```bash
-    fengming models list --all --provider deepseek
-    ```
-
-  </Step>
-</Steps>
-
-<AccordionGroup>
-  <Accordion title="Non-interactive setup">
-    For scripted or headless installations, pass all flags directly:
-
-    ```bash
-    fengming onboard --non-interactive \
-      --mode local \
-      --auth-choice deepseek-api-key \
-      --deepseek-api-key "$DEEPSEEK_API_KEY" \
-      --skip-health \
-      --accept-risk
-    ```
-
-  </Accordion>
-</AccordionGroup>
-
-<Warning>
-If the Gateway runs as a daemon (launchd/systemd), make sure `DEEPSEEK_API_KEY`
-is available to that process (for example, in `~/.fengming/.env` or via
-`env.shellEnv`).
-</Warning>
-
-## Built-in catalog
-
-| Model ref                    | Name              | Input | Context   | Max output | Notes                                      |
-| ---------------------------- | ----------------- | ----- | --------- | ---------- | ------------------------------------------ |
-| `deepseek/deepseek-v4-flash` | DeepSeek V4 Flash | text  | 1,000,000 | 384,000    | Default model; V4 thinking-capable surface |
-| `deepseek/deepseek-v4-pro`   | DeepSeek V4 Pro   | text  | 1,000,000 | 384,000    | V4 thinking-capable surface                |
-| `deepseek/deepseek-chat`     | DeepSeek Chat     | text  | 131,072   | 8,192      | DeepSeek V3.2 non-thinking surface         |
-| `deepseek/deepseek-reasoner` | DeepSeek Reasoner | text  | 131,072   | 65,536     | Reasoning-enabled V3.2 surface             |
-
-<Tip>
-V4 models support DeepSeek's `thinking` control. FengMing also replays
-DeepSeek `reasoning_content` on follow-up turns so thinking sessions with tool
-calls can continue.
-Use `/think xhigh` or `/think max` with DeepSeek V4 models to request DeepSeek's
-maximum `reasoning_effort`.
-</Tip>
-
-## Thinking and tools
-
-DeepSeek V4 thinking sessions have a stricter replay contract than most
-OpenAI-compatible providers: after a thinking-enabled turn uses tools, DeepSeek
-expects replayed assistant messages from that turn to include
-`reasoning_content` on follow-up requests. FengMing handles this inside the
-DeepSeek plugin, so normal multi-turn tool use works with
-`deepseek/deepseek-v4-flash` and `deepseek/deepseek-v4-pro`.
-
-If you switch an existing session from another OpenAI-compatible provider to a
-DeepSeek V4 model, older assistant tool-call turns may not have native
-DeepSeek `reasoning_content`. FengMing fills that missing field on replayed
-assistant messages for DeepSeek V4 thinking requests so the provider can accept
-the history without requiring `/new`.
-
-When thinking is disabled in FengMing (including the UI **None** selection),
-FengMing sends DeepSeek `thinking: { type: "disabled" }` and strips replayed
-`reasoning_content` from the outgoing history. This keeps disabled-thinking
-sessions on the non-thinking DeepSeek path.
-
-Use `deepseek/deepseek-v4-flash` for the default fast path. Use
-`deepseek/deepseek-v4-pro` when you want the stronger V4 model and can accept
-higher cost or latency.
-
-## Live testing
-
-The direct live model suite includes DeepSeek V4 in the modern model set. To
-run only the DeepSeek V4 direct-model checks:
-
-```bash
-FENGMING_LIVE_PROVIDERS=deepseek \
-FENGMING_LIVE_MODELS="deepseek/deepseek-v4-flash,deepseek/deepseek-v4-pro" \
-pnpm test:live src/agents/models.profiles.live.test.ts
-```
-
-That live check verifies both V4 models can complete and that thinking/tool
-follow-up turns preserve the replay payload DeepSeek requires.
-
-## Config example
-
-```json5
-{
-  env: { DEEPSEEK_API_KEY: "sk-..." },
-  agents: {
-    defaults: {
-      model: { primary: "deepseek/deepseek-v4-flash" },
-    },
-  },
-}
-```
-
-## Related
-
-<CardGroup cols={2}>
-  <Card title="Model selection" href="/concepts/model-providers" icon="layers">
-    Choosing providers, model refs, and failover behavior.
-  </Card>
-  <Card title="Configuration reference" href="/gateway/configuration-reference" icon="gear">
-    Full config reference for agents, models, and providers.
-  </Card>
-</CardGroup>