@mdgate/ai
v0.6.26
Published
Optional AI helper for mdgate: ai({ baseURL, apiKey, model }).convertImage / convertAudio / convertVideo
Maintainers
Readme
@mdgate/ai
Optional multimodal callbacks for mdgate image, audio, and video conversion.
@mdgate/ai talks to an OpenAI-compatible chat/completions endpoint. There is no default provider. You pass baseURL, apiKey, and model.
Works in Node.js, Cloudflare Workers, Edge runtimes, and browsers.
npm install @mdgate/aiWhy @mdgate/ai
Raster images, audio, and video are not deterministic document formats. mdgate does not pick an OCR or speech vendor.
This package is a thin adapter so the model you already use can plug into @mdgate/image, @mdgate/audio, and @mdgate/video.
- No default endpoint
- No Python runtime
- No native addons
- No WASM runtime
- The prompt is built in
SVG still converts locally in @mdgate/image. You do not need this package for SVG.
Usage
import { create } from '@mdgate/core';
import { ai } from '@mdgate/ai';
import { image } from '@mdgate/image';
import { audio } from '@mdgate/audio';
import { video } from '@mdgate/video';
import { pdf } from '@mdgate/pdf';
const media = ai({
baseURL: 'https://api.example.com/v1',
apiKey: process.env.API_KEY!,
model: 'your-model',
});
const read = create([
pdf(),
image(media.convertImage),
audio(media.convertAudio),
video(media.convertVideo),
]);baseURL is the OpenAI-compatible API root (the same value the OpenAI SDK uses). Requests go to {baseURL}/chat/completions.
Audio and video are sent as data URLs.
These callbacks are not registered by all(). Compose them yourself.
What it covers
Raster images: JPEG, PNG, WebP, GIF, TIFF, HEIC, BMP.
Audio: MP3, WAV, M4A, AAC, Ogg, FLAC, WebM audio.
Video: MP4, MOV, WebM, Matroska, AVI.
You can also call the helpers directly:
await media.convertImage({ bytes, mime: 'image/png' });
await media.convertAudio({ bytes, mime: 'audio/mpeg' });
await media.convertVideo({ bytes, mime: 'video/mp4' });Need a complete reader?
npm install @mdgate/convertersThen add image(), audio(), and video() on top of all().
@mdgate/ai is part of the open-source mdgate/converters project.
For AI agents, the same converter architecture can be used to extend read_file from text files to real-world document formats.
License
MIT
