fengming 0.3.10 → 0.3.12

package/docs/providers/azure-speech.md

@@ -1,119 +0,0 @@
----
-summary: "Azure AI Speech text-to-speech for FengMing replies"
-read_when:
-  - You want Azure Speech synthesis for outbound replies
-  - You need native Ogg Opus voice-note output from Azure Speech
-title: "Azure Speech"
----
-
-Azure Speech is an Azure AI Speech text-to-speech provider. In FengMing it
-synthesizes outbound reply audio as MP3 by default, native Ogg/Opus for voice
-notes, and 8 kHz mulaw audio for telephony channels such as Voice Call.
-
-FengMing uses the Azure Speech REST API directly with SSML and sends the
-provider-owned output format through `X-Microsoft-OutputFormat`.
-
-| Detail                  | Value                                                                                                          |
-| ----------------------- | -------------------------------------------------------------------------------------------------------------- |
-| Website                 | [Azure AI Speech](https://azure.microsoft.com/products/ai-services/ai-speech)                                  |
-| Docs                    | [Speech REST text-to-speech](https://learn.microsoft.com/azure/ai-services/speech-service/rest-text-to-speech) |
-| Auth                    | `AZURE_SPEECH_KEY` plus `AZURE_SPEECH_REGION`                                                                  |
-| Default voice           | `en-US-JennyNeural`                                                                                            |
-| Default file output     | `audio-24khz-48kbitrate-mono-mp3`                                                                              |
-| Default voice-note file | `ogg-24khz-16bit-mono-opus`                                                                                    |
-
-## Getting started
-
-<Steps>
-  <Step title="Create an Azure Speech resource">
-    In the Azure portal, create a Speech resource. Copy **KEY 1** from
-    Resource Management > Keys and Endpoint, and copy the resource location
-    such as `eastus`.
-
-    ```
-    AZURE_SPEECH_KEY=<speech-resource-key>
-    AZURE_SPEECH_REGION=eastus
-    ```
-
-  </Step>
-  <Step title="Select Azure Speech in messages.tts">
-    ```json5
-    {
-      messages: {
-        tts: {
-          auto: "always",
-          provider: "azure-speech",
-          providers: {
-            "azure-speech": {
-              speakerVoice: "en-US-JennyNeural",
-              lang: "en-US",
-            },
-          },
-        },
-      },
-    }
-    ```
-  </Step>
-  <Step title="Send a message">
-    Send a reply through any connected channel. FengMing synthesizes the audio
-    with Azure Speech and delivers MP3 for standard audio, or Ogg/Opus when
-    the channel expects a voice note.
-  </Step>
-</Steps>
-
-## Configuration options
-
-| Option                  | Path                                                        | Description                                                                                           |
-| ----------------------- | ----------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
-| `apiKey`                | `messages.tts.providers.azure-speech.apiKey`                | Azure Speech resource key. Falls back to `AZURE_SPEECH_KEY`, `AZURE_SPEECH_API_KEY`, or `SPEECH_KEY`. |
-| `region`                | `messages.tts.providers.azure-speech.region`                | Azure Speech resource region. Falls back to `AZURE_SPEECH_REGION` or `SPEECH_REGION`.                 |
-| `endpoint`              | `messages.tts.providers.azure-speech.endpoint`              | Optional Azure Speech endpoint/base URL override.                                                     |
-| `baseUrl`               | `messages.tts.providers.azure-speech.baseUrl`               | Optional Azure Speech base URL override.                                                              |
-| `speakerVoice`          | `messages.tts.providers.azure-speech.speakerVoice`          | Azure voice ShortName (default `en-US-JennyNeural`). Legacy alias: `voice`.                           |
-| `lang`                  | `messages.tts.providers.azure-speech.lang`                  | SSML language code (default `en-US`).                                                                 |
-| `outputFormat`          | `messages.tts.providers.azure-speech.outputFormat`          | Audio-file output format (default `audio-24khz-48kbitrate-mono-mp3`).                                 |
-| `voiceNoteOutputFormat` | `messages.tts.providers.azure-speech.voiceNoteOutputFormat` | Voice-note output format (default `ogg-24khz-16bit-mono-opus`).                                       |
-
-## Notes
-
-<AccordionGroup>
-  <Accordion title="Authentication">
-    Azure Speech uses a Speech resource key, not an Azure OpenAI key. The key
-    is sent as `Ocp-Apim-Subscription-Key`; FengMing derives
-    `https://<region>.tts.speech.microsoft.com` from `region` unless you
-    provide `endpoint` or `baseUrl`.
-  </Accordion>
-  <Accordion title="Voice names">
-    Use the Azure Speech voice `ShortName` value, for example
-    `en-US-JennyNeural`. The bundled provider can list voices through the
-    same Speech resource and filters voices marked deprecated or retired.
-  </Accordion>
-  <Accordion title="Audio outputs">
-    Azure accepts output formats such as `audio-24khz-48kbitrate-mono-mp3`,
-    `ogg-24khz-16bit-mono-opus`, and `riff-24khz-16bit-mono-pcm`. FengMing
-    requests Ogg/Opus for `voice-note` targets so channels can send native
-    voice bubbles without an extra MP3 conversion.
-  </Accordion>
-  <Accordion title="Alias">
-    `azure` is accepted as a provider alias for existing PRs and user config,
-    but new config should use `azure-speech` to avoid confusion with Azure
-    OpenAI model providers.
-  </Accordion>
-</AccordionGroup>
-
-## Related
-
-<CardGroup cols={2}>
-  <Card title="Text-to-speech" href="/tools/tts" icon="waveform-lines">
-    TTS overview, providers, and `messages.tts` config.
-  </Card>
-  <Card title="Configuration" href="/gateway/configuration" icon="gear">
-    Full config reference including `messages.tts` settings.
-  </Card>
-  <Card title="Providers" href="/providers" icon="grid">
-    All bundled FengMing providers.
-  </Card>
-  <Card title="Troubleshooting" href="/help/troubleshooting" icon="wrench">
-    Common issues and debugging steps.
-  </Card>
-</CardGroup>

package/docs/providers/bedrock-mantle.md

@@ -1,211 +0,0 @@
----
-summary: "Use Amazon Bedrock Mantle (OpenAI-compatible) models with FengMing"
-read_when:
-  - You want to use Bedrock Mantle hosted OSS models with FengMing
-  - You need the Mantle OpenAI-compatible endpoint for GPT-OSS, Qwen, Kimi, or GLM
-title: "Amazon Bedrock Mantle"
----
-
-FengMing includes a bundled **Amazon Bedrock Mantle** provider that connects to
-the Mantle OpenAI-compatible endpoint. Mantle hosts open-source and
-third-party models (GPT-OSS, Qwen, Kimi, GLM, and similar) through a standard
-`/v1/chat/completions` surface backed by Bedrock infrastructure.
-
-| Property       | Value                                                                                       |
-| -------------- | ------------------------------------------------------------------------------------------- |
-| Provider ID    | `amazon-bedrock-mantle`                                                                     |
-| API            | `openai-completions` (OpenAI-compatible) or `anthropic-messages` (Anthropic Messages route) |
-| Auth           | Explicit `AWS_BEARER_TOKEN_BEDROCK` or IAM credential-chain bearer-token generation         |
-| Default region | `us-east-1` (override with `AWS_REGION` or `AWS_DEFAULT_REGION`)                            |
-
-## Getting started
-
-Choose your preferred auth method and follow the setup steps.
-
-<Tabs>
-  <Tab title="Explicit bearer token">
-    **Best for:** environments where you already have a Mantle bearer token.
-
-    <Steps>
-      <Step title="Set the bearer token on the gateway host">
-        ```bash
-        export AWS_BEARER_TOKEN_BEDROCK="..."
-        ```
-
-        Optionally set a region (defaults to `us-east-1`):
-
-        ```bash
-        export AWS_REGION="us-west-2"
-        ```
-      </Step>
-      <Step title="Verify models are discovered">
-        ```bash
-        fengming models list
-        ```
-
-        Discovered models appear under the `amazon-bedrock-mantle` provider. No
-        additional config is required unless you want to override defaults.
-      </Step>
-    </Steps>
-
-  </Tab>
-
-  <Tab title="IAM credentials">
-    **Best for:** using AWS SDK-compatible credentials (shared config, SSO, web identity, instance or task roles).
-
-    <Steps>
-      <Step title="Configure AWS credentials on the gateway host">
-        Any AWS SDK-compatible auth source works:
-
-        ```bash
-        export AWS_PROFILE="default"
-        export AWS_REGION="us-west-2"
-        ```
-      </Step>
-      <Step title="Verify models are discovered">
-        ```bash
-        fengming models list
-        ```
-
-        FengMing generates a Mantle bearer token from the credential chain automatically.
-      </Step>
-    </Steps>
-
-    <Tip>
-    When `AWS_BEARER_TOKEN_BEDROCK` is not set, FengMing mints the bearer token for you from the AWS default credential chain, including shared credentials/config profiles, SSO, web identity, and instance or task roles.
-    </Tip>
-
-  </Tab>
-</Tabs>
-
-## Automatic model discovery
-
-When `AWS_BEARER_TOKEN_BEDROCK` is set, FengMing uses it directly. Otherwise,
-FengMing attempts to generate a Mantle bearer token from the AWS default
-credential chain. It then discovers available Mantle models by querying the
-region's `/v1/models` endpoint.
-
-| Behavior          | Detail                    |
-| ----------------- | ------------------------- |
-| Discovery cache   | Results cached for 1 hour |
-| IAM token refresh | Hourly                    |
-
-To keep the Mantle plugin enabled but suppress automatic discovery and IAM
-bearer-token generation, disable the plugin-owned discovery toggle:
-
-```bash
-fengming config set plugins.entries.amazon-bedrock-mantle.config.discovery.enabled false
-```
-
-<Note>
-The bearer token is the same `AWS_BEARER_TOKEN_BEDROCK` used by the standard [Amazon Bedrock](/providers/bedrock) provider.
-</Note>
-
-### Supported regions
-
-`us-east-1`, `us-east-2`, `us-west-2`, `ap-northeast-1`,
-`ap-south-1`, `ap-southeast-3`, `eu-central-1`, `eu-west-1`, `eu-west-2`,
-`eu-south-1`, `eu-north-1`, `sa-east-1`.
-
-## Manual configuration
-
-If you prefer explicit config instead of auto-discovery:
-
-```json5
-{
-  models: {
-    providers: {
-      "amazon-bedrock-mantle": {
-        baseUrl: "https://bedrock-mantle.us-east-1.api.aws/v1",
-        api: "openai-completions",
-        auth: "api-key",
-        apiKey: "env:AWS_BEARER_TOKEN_BEDROCK",
-        models: [
-          {
-            id: "gpt-oss-120b",
-            name: "GPT-OSS 120B",
-            reasoning: true,
-            input: ["text"],
-            cost: { input: 0, output: 0, cacheRead: 0, cacheWrite: 0 },
-            contextWindow: 32000,
-            maxTokens: 4096,
-          },
-        ],
-      },
-    },
-  },
-}
-```
-
-## Advanced configuration
-
-<AccordionGroup>
-  <Accordion title="Reasoning support">
-    Reasoning support is inferred from model IDs containing patterns like
-    `thinking`, `reasoner`, or `gpt-oss-120b`. FengMing sets `reasoning: true`
-    automatically for matching models during discovery.
-  </Accordion>
-
-  <Accordion title="Endpoint unavailability">
-    If the Mantle endpoint is unavailable or returns no models, the provider is
-    silently skipped. FengMing does not error; other configured providers
-    continue to work normally.
-  </Accordion>
-
-  <Accordion title="Claude Opus 4.7 via the Anthropic Messages route">
-    Mantle also exposes an Anthropic Messages route that carries Claude models through the same bearer-authenticated streaming path. Claude Opus 4.7 (`amazon-bedrock-mantle/claude-opus-4.7`) is callable through this route with provider-owned streaming, so AWS bearer tokens are not treated like Anthropic API keys.
-
-    When you pin an Anthropic Messages model on the Mantle provider, FengMing uses the `anthropic-messages` API surface instead of `openai-completions` for that model. Auth still comes from `AWS_BEARER_TOKEN_BEDROCK` (or the minted IAM bearer token).
-
-    ```json5
-    {
-      models: {
-        providers: {
-          "amazon-bedrock-mantle": {
-            models: [
-              {
-                id: "claude-opus-4.7",
-                name: "Claude Opus 4.7",
-                api: "anthropic-messages",
-                reasoning: true,
-                input: ["text", "image"],
-                contextWindow: 1000000,
-                maxTokens: 32000,
-              },
-            ],
-          },
-        },
-      },
-    }
-    ```
-
-  </Accordion>
-
-  <Accordion title="Relationship to Amazon Bedrock provider">
-    Bedrock Mantle is a separate provider from the standard
-    [Amazon Bedrock](/providers/bedrock) provider. Mantle uses an
-    OpenAI-compatible `/v1` surface, while the standard Bedrock provider uses
-    the native Bedrock API.
-
-    Both providers share the same `AWS_BEARER_TOKEN_BEDROCK` credential when
-    present.
-
-  </Accordion>
-</AccordionGroup>
-
-## Related
-
-<CardGroup cols={2}>
-  <Card title="Amazon Bedrock" href="/providers/bedrock" icon="cloud">
-    Native Bedrock provider for Anthropic Claude, Titan, and other models.
-  </Card>
-  <Card title="Model selection" href="/concepts/model-providers" icon="layers">
-    Choosing providers, model refs, and failover behavior.
-  </Card>
-  <Card title="OAuth and auth" href="/gateway/authentication" icon="key">
-    Auth details and credential reuse rules.
-  </Card>
-  <Card title="Troubleshooting" href="/help/troubleshooting" icon="wrench">
-    Common issues and how to resolve them.
-  </Card>
-</CardGroup>