diff --git a/cspell.config.yaml b/cspell.config.yaml index d176b04..4456aa2 100644 --- a/cspell.config.yaml +++ b/cspell.config.yaml @@ -18,6 +18,7 @@ words: - eslintcache - fishaudio - fumadocs + - ggml - Groq - Hunyuan - importantimport diff --git a/docs/content/docs/packages/generate/speech.mdx b/docs/content/docs/packages/generate/speech.mdx index 89a34cd..e088185 100644 --- a/docs/content/docs/packages/generate/speech.mdx +++ b/docs/content/docs/packages/generate/speech.mdx @@ -1,6 +1,6 @@ --- title: Speech (WIP) -# description: +description: Generates audio from the input text. --- import { PkgSizeBadge } from '@/components/pkg-size-badge' @@ -10,3 +10,19 @@ import { PkgSizeBadge } from '@/components/pkg-size-badge' ```package-install npm i @xsai/generate-speech ``` + +## Examples + +```ts twoslash +import { generateSpeech } from '@xsai/generate-speech' +import { Buffer } from 'node:buffer' + +const speech = await generateSpeech({ + baseURL: 'http://localhost:5050', + input: 'Hello, I am your AI assistant! Just let me know how I can help bring your ideas to life.', + model: 'tts-1', + voice: 'en-US-AnaNeural', +}) + +const audio = Buffer.from(speech) +``` \ No newline at end of file diff --git a/docs/content/docs/packages/generate/text.mdx b/docs/content/docs/packages/generate/text.mdx index 37a4725..dbd7121 100644 --- a/docs/content/docs/packages/generate/text.mdx +++ b/docs/content/docs/packages/generate/text.mdx @@ -11,6 +11,8 @@ import { PkgSizeBadge } from '@/components/pkg-size-badge' npm i @xsai/generate-text ``` +## Examples + ```ts twoslash import { generateText } from '@xsai/generate-text' import { env } from 'node:process' diff --git a/docs/content/docs/packages/generate/transcription.mdx b/docs/content/docs/packages/generate/transcription.mdx index f3728e4..9a07734 100644 --- a/docs/content/docs/packages/generate/transcription.mdx +++ b/docs/content/docs/packages/generate/transcription.mdx @@ -1,6 +1,6 @@ --- title: Transcription (WIP) -# description: +description: Transcribes audio into the input language. --- import { PkgSizeBadge } from '@/components/pkg-size-badge' @@ -10,3 +10,19 @@ import { PkgSizeBadge } from '@/components/pkg-size-badge' ```package-install npm i @xsai/generate-transcription ``` + +## Examples + +```ts twoslash +import { generateTranscription } from '@xsai/generate-transcription' +import { openAsBlob } from 'node:fs' + +const { text } = await generateTranscription({ + apiKey: '', + baseURL: 'http://localhost:9010', + file: await openAsBlob('./test/fixtures/basic.wav', { type: 'audio/wav' }), + fileName: 'basic.wav', + language: 'en-US', + model: 'ggml-large-v3-turbo-q5_0.bin', +}) +``` diff --git a/docs/content/docs/packages/stream/text.mdx b/docs/content/docs/packages/stream/text.mdx index c4bf51f..0f72857 100644 --- a/docs/content/docs/packages/stream/text.mdx +++ b/docs/content/docs/packages/stream/text.mdx @@ -11,6 +11,8 @@ import { PkgSizeBadge } from '@/components/pkg-size-badge' npm i @xsai/stream-text ``` +## Examples + ```ts twoslash import { streamText } from '@xsai/stream-text' import { env } from 'node:process'