Files
ragflow/web/src/components/ui/audio-button.tsx
Ahmad Intisar e994051eb9 Feature/generic api connector (#13545)
# feat: Add Generic REST API Connector

## What problem does this PR solve?

RAGFlow supports many specific data source connectors (MySQL, Slack,
Google Drive, etc.), but there was no way to connect an arbitrary REST
API as a data source. Users with custom or third-party APIs had to write
a new connector class for each one.

This PR adds a **generic, configuration-driven REST API connector** that
lets users connect any REST API as a data source entirely through the UI
— no code changes needed per API.

---

## Features

### Core Connector (`common/data_source/rest_api_connector.py`)

- Implements `LoadConnector` and `PollConnector` interfaces for full and
incremental sync
- **Configurable authentication:** None, API Key (custom header), Bearer
Token, Basic Auth
- **Pluggable pagination:** Page-based, Offset-based, Cursor-based, or
None
- Smart page-size inference from user's query parameters to avoid
duplicate/conflicting params
- Configurable request delay between pages to prevent API rate limiting
- Auto-detection of the items array in JSON responses (`items`,
`results`, `data`, `records`, or first list found)
- **Advanced field mapping** with dot-notation (`country.name`), array
wildcards (`newsType[*].name`), type hints, and default values
- Optional content template rendering (`"Title: {title}\nBody: {body}"`)
- HTML stripping for content fields
- Stable document IDs via `hash128` from a configurable ID field or
auto-generated from item content
- Pydantic configuration schema with automatic coercion of UI string
inputs to dicts/lists

### Backend Registration (`rag/svr/sync_data_source.py`,
`common/constants.py`, `common/data_source/config.py`)

- `REST_API` sync class wired into RAGFlow's `func_factory`
- Full sync (`load_from_state`) and incremental polling (`poll_source`)
support
- Credentials and config passed from task to connector following
existing patterns (MySQL, SeaFile, etc.)

### Test Connection Endpoint (`api/apps/connector_app.py`)

- `POST /v1/connector/<id>/test` validates config schema,
authentication, and API connectivity without triggering a sync
- Clear error messages for auth failures vs. config issues

### Frontend UI (`web/src/pages/user-setting/data-source/constant/`)

- **Postman-style configuration:** Base URL, Query Parameters (key=value
per line), Auth, Content Fields, Metadata Fields, Pagination Type
- Auth-type-aware form: fields for API key header/value, Bearer token,
or Basic username/password appear only when relevant
- **Advanced Settings** toggle for: Custom Headers, Max Pages, Request
Delay, Poll Timestamp Field, Request Body (POST)
- Connector icon (SVG) and i18n strings (English)
- **"Test Connection"** button to validate before syncing

---

## Controls & Safety

- Configurable max pages safety cap (default: 1000, adjustable in UI)
- Configurable request delay between pages (default: 0.5s, adjustable in
UI)
- Auth errors (401/403) fail immediately without retries; transient
errors retry with exponential backoff
- Diagnostic logging: auth setup confirmation, request details on
failure, content field extraction status

---

## Type of change

- [x] New Feature (non-breaking change which adds functionality)


##Visual Screenshots of Features
<img width="482" height="510" alt="Screenshot 2026-03-11 at 5 19 52 PM"
src="https://github.com/user-attachments/assets/dcb7ab4a-1622-44f3-bb02-d6f0527314c4"
/>
(Connector can be configured within the external data sources tab)

Configuration Parameters:
<img width="661" height="682" alt="Screenshot 2026-03-11 at 5 20 46 PM"
src="https://github.com/user-attachments/assets/5e154e71-4ab5-4872-bfb2-04f02b73c18a"
/>
<img width="661" height="682" alt="Screenshot 2026-03-11 at 5 20 54 PM"
src="https://github.com/user-attachments/assets/00cb14b7-0bcf-4b94-9d71-34e93369ecb2"
/>

Connection can be tested before attaching to dataset:
<img width="981" height="681" alt="Screenshot 2026-03-11 at 5 21 40 PM"
src="https://github.com/user-attachments/assets/aaa6eeeb-89a7-4349-bc34-2423bf8be9ee"
/>

Ingestion tested with API connector (works perfectly fine):
<img width="1062" height="705" alt="Screenshot 2026-03-11 at 5 22 30 PM"
src="https://github.com/user-attachments/assets/afcd0d58-cadd-4152-badc-d2f14d96fbec"
/>

Search & Retrieval works as well with metadata flow:
<img width="1062" height="705" alt="Screenshot 2026-03-11 at 5 23 05 PM"
src="https://github.com/user-attachments/assets/d41ee935-dcf7-4456-b317-22a76ca032c0"
/>

---------

Co-authored-by: Ahmad Intisar <ahmadintisar@Ahmads-MacBook-M4-Pro.local>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
2026-05-13 20:35:01 +08:00

440 lines
13 KiB
TypeScript

import { AudioRecorder, useAudioRecorder } from 'react-audio-voice-recorder';
import { Button } from '@/components/ui/button';
import { Authorization } from '@/constants/authorization';
import { cn } from '@/lib/utils';
import api from '@/utils/api';
import { getAuthorization } from '@/utils/authorization-util';
import { chain, sum } from 'lodash';
import { Loader2, Mic, Square } from 'lucide-react';
import { useCallback, useEffect, useRef, useState } from 'react';
import { Input } from './input';
import { Popover, PopoverContent, PopoverTrigger } from './popover';
const VoiceVisualizer = ({ isRecording }: { isRecording: boolean }) => {
const canvasRef = useRef<HTMLCanvasElement>(null);
const audioContextRef = useRef<AudioContext | null>(null);
const analyserRef = useRef<AnalyserNode | null>(null);
const animationFrameRef = useRef<number>(0);
const streamRef = useRef<MediaStream | null>(null);
const draw = useCallback(() => {
const canvas = canvasRef.current;
if (!canvas) return;
const ctx = canvas.getContext('2d');
if (!ctx) return;
const analyser = analyserRef.current;
if (!analyser) return;
// Set canvas dimensions
const width = canvas.clientWidth * window.devicePixelRatio;
const height = canvas.clientHeight * window.devicePixelRatio;
const centerY = height / 2;
if (canvas.width !== width || canvas.height !== height) {
canvas.width = width;
canvas.height = height;
}
// Clear canvas
ctx.clearRect(0, 0, width, height);
// Get frequency data
const bufferLength = analyser.frequencyBinCount;
const dataArray = new Uint8Array(bufferLength);
/**
* The frequencies are spread linearly from 0Hz to 1/2 of the sample rate
* @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
*/
analyser.getByteFrequencyData(dataArray);
const desiredBarCount = 6;
const freqSpanPerPole =
analyser.context.sampleRate / 2 / analyser.frequencyBinCount;
const freqMinIndex = Math.max(1, Math.floor(100 / freqSpanPerPole));
const freqMaxIndex =
Math.max(freqMinIndex, Math.ceil(3500 / freqSpanPerPole)) + 1;
const freqData = dataArray.slice(
freqMinIndex,
Math.max(freqMinIndex + desiredBarCount, freqMaxIndex),
);
const reducedFreqData = chain(freqData)
.chunk(Math.floor(freqData.length / desiredBarCount))
.take(desiredBarCount)
.map(sum)
.value();
// Draw waveform
const barGap = 1 * window.devicePixelRatio;
const barWidth = (width - barGap * (desiredBarCount - 1)) / desiredBarCount;
// Create gradient
const gradient = ctx.createLinearGradient(0, 0, 0, height);
gradient.addColorStop(0, '#3ba05c'); // Blue
gradient.addColorStop(1, '#3ba05c'); // Light blue
// gradient.addColorStop(0, isDark ? '#fff' : '#000'); // Blue
// gradient.addColorStop(1, isDark ? '#eee' : '#eee'); // Light blue
for (let i = 0, x = 0; i < desiredBarCount; i++, x += barWidth + barGap) {
const barHeight = (reducedFreqData[i] / 255) * centerY;
ctx.fillStyle = gradient;
ctx.fillRect(x, centerY - barHeight, barWidth, barHeight * 2);
}
animationFrameRef.current = requestAnimationFrame(draw);
}, []);
const startVisualization = useCallback(async () => {
try {
// Check if the browser supports getUserMedia
if (!navigator.mediaDevices || !navigator.mediaDevices.getUserMedia) {
console.error('Browser does not support getUserMedia API');
return;
}
// Request microphone permission
const stream = await navigator.mediaDevices.getUserMedia({ audio: true });
streamRef.current = stream;
// Create audio context and analyzer
const audioContext = new (
window.AudioContext || (window as any).webkitAudioContext
)();
audioContextRef.current = audioContext;
const analyser = audioContext.createAnalyser();
analyserRef.current = analyser;
analyser.fftSize = 256;
// Connect audio nodes
const source = audioContext.createMediaStreamSource(stream);
source.connect(analyser);
// Start drawing
draw();
} catch (error) {
console.error(
'Unable to access microphone for voice visualization:',
error,
);
}
}, [draw]);
const stopVisualization = useCallback(() => {
// Stop animation frame
if (animationFrameRef.current) {
cancelAnimationFrame(animationFrameRef.current);
}
// Stop audio stream
if (streamRef.current) {
streamRef.current.getTracks().forEach((track) => track.stop());
}
// Close audio context
if (audioContextRef.current && audioContextRef.current.state !== 'closed') {
audioContextRef.current.close();
}
// Clear canvas
const canvas = canvasRef.current;
if (canvas) {
const ctx = canvas.getContext('2d');
if (ctx) {
ctx.clearRect(0, 0, canvas.width, canvas.height);
}
}
}, []);
useEffect(() => {
if (isRecording) {
startVisualization();
} else {
stopVisualization();
}
return () => {
stopVisualization();
};
}, [isRecording, startVisualization, stopVisualization]);
return <canvas ref={canvasRef} className="block size-full" />;
};
const VoiceInputBox = ({
isRecording,
onStop,
recordingTime,
value,
}: {
value: string;
isRecording: boolean;
onStop: () => void;
recordingTime: number;
}) => {
// Format recording time
const formatTime = (seconds: number) => {
const mins = Math.floor(seconds / 60);
const secs = seconds % 60;
return `${mins.toString().padStart(2, '0')}:${secs.toString().padStart(2, '0')}`;
};
return (
<div className="w-full">
<div className=" absolute w-full h-6 translate-y-full">
<VoiceVisualizer isRecording={isRecording} />
</div>
<Input
rootClassName="w-full"
className="flex-1 "
readOnly
value={value}
suffix={
<div className="flex justify-end px-1 items-center gap-1 w-20">
<Button
variant={'ghost'}
size="sm"
className="text-text-primary p-1 border-none hover:bg-transparent"
onClick={onStop}
>
<Square className="text-text-primary" size={12} />
</Button>
<span className="text-xs text-text-secondary">
{formatTime(recordingTime)}
</span>
</div>
}
/>
</div>
);
};
export const AudioButton = ({
onOk,
testId,
}: {
onOk?: (transcript: string) => void;
testId?: string;
}) => {
// const [showInputBox, setShowInputBox] = useState(false);
const [isRecording, setIsRecording] = useState(false);
const [isProcessing, setIsProcessing] = useState(false);
const [recordingTime, setRecordingTime] = useState(0);
const [transcript, setTranscript] = useState('');
const [popoverOpen, setPopoverOpen] = useState(false);
const recorderControls = useAudioRecorder();
const intervalRef = useRef<NodeJS.Timeout | null>(null);
// Handle logic after recording is complete
const handleRecordingComplete = async (blob: Blob) => {
setIsRecording(false);
// const url = URL.createObjectURL(blob);
// const a = document.createElement('a');
// a.href = url;
// a.download = 'recording.webm';
// document.body.appendChild(a);
// a.click();
setIsProcessing(true);
if (intervalRef.current) {
clearInterval(intervalRef.current);
intervalRef.current = null;
}
try {
const audioFile = new File([blob], 'recording.webm', {
type: blob.type || 'audio/webm',
// type: 'audio/mpeg',
});
const formData = new FormData();
formData.append('file', audioFile);
formData.append('stream', 'false');
const response = await fetch(api.chatsTranscriptions, {
method: 'POST',
headers: {
[Authorization]: getAuthorization(),
// 'Content-Type': blob.type || 'audio/webm',
},
body: formData,
});
// if (!response.ok) {
// throw new Error(`HTTP error! status: ${response.status}`);
// }
// if (!response.body) {
// throw new Error('ReadableStream not supported in this browser');
// }
const { data, code } = await response.json();
if (code === 0 && data && data.text) {
setTranscript(data.text);
onOk?.(data.text);
}
setPopoverOpen(false);
} catch (error) {
console.error('Failed to process audio:', error);
// setTranscript(t('voiceRecorder.processingError'));
} finally {
setIsProcessing(false);
}
};
// Start recording
const startRecording = () => {
recorderControls.startRecording();
setIsRecording(true);
// setShowInputBox(true);
setPopoverOpen(true);
setRecordingTime(0);
// Start timing
if (intervalRef.current) {
clearInterval(intervalRef.current);
}
intervalRef.current = setInterval(() => {
setRecordingTime((prev) => prev + 1);
}, 1000);
};
// Stop recording
const stopRecording = () => {
recorderControls.stopRecording();
setIsRecording(false);
// setShowInputBox(false);
setPopoverOpen(false);
setRecordingTime(0);
// Clear timer
if (intervalRef.current) {
clearInterval(intervalRef.current);
intervalRef.current = null;
}
};
// Clear transcription content
// const clearTranscript = () => {
// setTranscript('');
// };
useEffect(() => {
return () => {
if (intervalRef.current) {
clearInterval(intervalRef.current);
}
};
}, []);
return (
<div>
{false && (
<div className="flex flex-col items-center space-y-4">
<div className="relative">
<Popover
open={popoverOpen}
onOpenChange={(open) => {
setPopoverOpen(open);
}}
>
<PopoverTrigger asChild>
<Button
variant="outline"
size="sm"
onClick={() => {
if (isRecording) {
stopRecording();
} else {
startRecording();
}
}}
className={`w-6 h-6 p-2 rounded-full border-none bg-transparent hover:bg-transparent ${
isRecording ? 'animate-pulse' : ''
}`}
disabled={isProcessing}
>
<Mic size={16} className="text-text-primary" />
</Button>
</PopoverTrigger>
<PopoverContent
align="end"
sideOffset={-20}
className="p-0 border-none"
>
<VoiceInputBox
isRecording={isRecording}
value={transcript}
onStop={stopRecording}
recordingTime={recordingTime}
/>
</PopoverContent>
</Popover>
</div>
</div>
)}
<div className=" relative w-6 h-6 flex items-center justify-center">
{isRecording && (
<div className="absolute inset-0 size-full overflow-hidden flex items-center justify-center p-1">
<VoiceVisualizer isRecording={isRecording} />
</div>
)}
{isRecording && (
<div
className="
absolute inset-0 rounded-full border-2 border-state-success
animate-ping opacity-75 pointer-events-none"
/>
)}
<Button
variant="transparent"
size="icon-xs"
// onMouseDown={() => {
// startRecording();
// }}
// onMouseUp={() => {
// stopRecording();
// }}
onClick={() => {
if (isRecording) {
stopRecording();
} else {
startRecording();
}
}}
className={cn(
'border-0 p-2 rounded-md border-none bg-transparent hover:bg-state-success-5',
isRecording &&
'animate-pulse !bg-state-success/20 text-state-success rounded-full',
)}
disabled={isProcessing}
data-testid={testId}
>
{isProcessing ? (
<Loader2 size={16} className=" animate-spin" />
) : isRecording ? (
<></>
) : (
// <Mic size={16} className="text-text-primary" />
// <Square size={12} className="text-text-primary" />
<Mic size={16} />
)}
</Button>
</div>
{/* Hide original component */}
<div className="hidden">
<AudioRecorder
onRecordingComplete={handleRecordingComplete}
recorderControls={recorderControls}
/>
</div>
</div>
);
};