File size: 36,704 Bytes
979853c | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 | import axios, { AxiosError } from 'axios'
import { backendBaseUrl, popularLabelsDefaultLimit, searchLabelsDefaultLimit } from '@/lib/constants'
import { errorMessage } from '@/lib/utils'
import { useSettingsStore } from '@/stores/settings'
import { useAuthStore } from '@/stores/state'
import { navigationService } from '@/services/navigation'
// Types
export type LightragNodeType = {
id: string
labels: string[]
properties: Record<string, any>
}
export type LightragEdgeType = {
id: string
source: string
target: string
type: string
properties: Record<string, any>
}
export type LightragGraphType = {
nodes: LightragNodeType[]
edges: LightragEdgeType[]
}
export type LightragStatus = {
status: 'healthy'
working_directory: string
input_directory: string
configuration: {
llm_binding: string
llm_binding_host: string
llm_model: string
embedding_binding: string
embedding_binding_host: string
embedding_model: string
kv_storage: string
doc_status_storage: string
graph_storage: string
vector_storage: string
workspace?: string
max_graph_nodes?: string
enable_rerank?: boolean
rerank_binding?: string | null
rerank_model?: string | null
rerank_binding_host?: string | null
summary_language: string
force_llm_summary_on_merge: boolean
max_parallel_insert: number
max_async: number
embedding_func_max_async: number
embedding_batch_num: number
cosine_threshold: number
min_rerank_score: number
related_chunk_number: number
}
update_status?: Record<string, any>
core_version?: string
api_version?: string
auth_mode?: 'enabled' | 'disabled'
pipeline_busy: boolean
keyed_locks?: {
process_id: number
cleanup_performed: {
mp_cleaned: number
async_cleaned: number
}
current_status: {
total_mp_locks: number
pending_mp_cleanup: number
total_async_locks: number
pending_async_cleanup: number
}
}
webui_title?: string
webui_description?: string
}
export type LightragDocumentsScanProgress = {
is_scanning: boolean
current_file: string
indexed_count: number
total_files: number
progress: number
}
/**
* Specifies the retrieval mode:
* - "naive": Performs a basic search without advanced techniques.
* - "local": Focuses on context-dependent information.
* - "global": Utilizes global knowledge.
* - "hybrid": Combines local and global retrieval methods.
* - "mix": Integrates knowledge graph and vector retrieval.
* - "bypass": Bypasses knowledge retrieval and directly uses the LLM.
*/
export type QueryMode = 'naive' | 'local' | 'global' | 'hybrid' | 'mix' | 'bypass'
export type Message = {
role: 'user' | 'assistant' | 'system'
content: string
thinkingContent?: string
displayContent?: string
thinkingTime?: number | null
}
export type QueryRequest = {
query: string
/** Specifies the retrieval mode. */
mode: QueryMode
/** If True, only returns the retrieved context without generating a response. */
only_need_context?: boolean
/** If True, only returns the generated prompt without producing a response. */
only_need_prompt?: boolean
/** Defines the response format. Examples: 'Multiple Paragraphs', 'Single Paragraph', 'Bullet Points'. */
response_type?: string
/** If True, enables streaming output for real-time responses. */
stream?: boolean
/** Number of top items to retrieve. Represents entities in 'local' mode and relationships in 'global' mode. */
top_k?: number
/** Maximum number of text chunks to retrieve and keep after reranking. */
chunk_top_k?: number
/** Maximum number of tokens allocated for entity context in unified token control system. */
max_entity_tokens?: number
/** Maximum number of tokens allocated for relationship context in unified token control system. */
max_relation_tokens?: number
/** Maximum total tokens budget for the entire query context (entities + relations + chunks + system prompt). */
max_total_tokens?: number
/**
* Stores past conversation history to maintain context.
* Format: [{"role": "user/assistant", "content": "message"}].
*/
conversation_history?: Message[]
/** Number of complete conversation turns (user-assistant pairs) to consider in the response context. */
history_turns?: number
/** User-provided prompt for the query. If provided, this will be used instead of the default value from prompt template. */
user_prompt?: string
/** Enable reranking for retrieved text chunks. If True but no rerank model is configured, a warning will be issued. Default is True. */
enable_rerank?: boolean
}
export type QueryResponse = {
response: string
}
export type EntityUpdateResponse = {
status: string
message: string
data: Record<string, any>
operation_summary?: {
merged: boolean
merge_status: 'success' | 'failed' | 'not_attempted'
merge_error: string | null
operation_status: 'success' | 'partial_success' | 'failure'
target_entity: string | null
final_entity?: string | null
renamed?: boolean
}
}
export type DocActionResponse = {
status: 'success' | 'partial_success' | 'failure' | 'duplicated'
message: string
track_id?: string
}
export type ScanResponse = {
status: 'scanning_started'
message: string
track_id: string
}
export type ReprocessFailedResponse = {
status: 'reprocessing_started'
message: string
track_id: string
}
export type DeleteDocResponse = {
status: 'deletion_started' | 'busy' | 'not_allowed'
message: string
doc_id: string
}
export type DocStatus = 'pending' | 'processing' | 'preprocessed' | 'processed' | 'failed'
export type DocStatusResponse = {
id: string
content_summary: string
content_length: number
status: DocStatus
created_at: string
updated_at: string
track_id?: string
chunks_count?: number
error_msg?: string
metadata?: Record<string, any>
file_path: string
}
export type DocsStatusesResponse = {
statuses: Record<DocStatus, DocStatusResponse[]>
}
export type TrackStatusResponse = {
track_id: string
documents: DocStatusResponse[]
total_count: number
status_summary: Record<string, number>
}
export type DocumentsRequest = {
status_filter?: DocStatus | null
page: number
page_size: number
sort_field: 'created_at' | 'updated_at' | 'id' | 'file_path'
sort_direction: 'asc' | 'desc'
}
export type PaginationInfo = {
page: number
page_size: number
total_count: number
total_pages: number
has_next: boolean
has_prev: boolean
}
export type PaginatedDocsResponse = {
documents: DocStatusResponse[]
pagination: PaginationInfo
status_counts: Record<string, number>
}
export type StatusCountsResponse = {
status_counts: Record<string, number>
}
export type AuthStatusResponse = {
auth_configured: boolean
access_token?: string
token_type?: string
auth_mode?: 'enabled' | 'disabled'
message?: string
core_version?: string
api_version?: string
webui_title?: string
webui_description?: string
}
export type PipelineStatusResponse = {
autoscanned: boolean
busy: boolean
job_name: string
job_start?: string
docs: number
batchs: number
cur_batch: number
request_pending: boolean
cancellation_requested?: boolean
latest_message: string
history_messages?: string[]
update_status?: Record<string, any>
}
export type LoginResponse = {
access_token: string
token_type: string
auth_mode?: 'enabled' | 'disabled' // Authentication mode identifier
message?: string // Optional message
core_version?: string
api_version?: string
webui_title?: string
webui_description?: string
}
export const InvalidApiKeyError = 'Invalid API Key'
export const RequireApiKeError = 'API Key required'
// Axios instance
const axiosInstance = axios.create({
baseURL: backendBaseUrl,
headers: {
'Content-Type': 'application/json'
}
})
// ========== Token Management ==========
// Prevent multiple requests from triggering token refresh simultaneously
let isRefreshingGuestToken = false;
let refreshTokenPromise: Promise<string> | null = null;
// Silent refresh for guest token
const silentRefreshGuestToken = async (): Promise<string> => {
// If already refreshing, return the same Promise
if (isRefreshingGuestToken && refreshTokenPromise) {
return refreshTokenPromise;
}
isRefreshingGuestToken = true;
refreshTokenPromise = (async () => {
try {
// Call /auth-status to get new guest token
const response = await axios.get('/auth-status', {
baseURL: backendBaseUrl,
// This request must skip the interceptor to avoid adding expired token
headers: { 'X-Skip-Interceptor': 'true' }
});
if (response.data.access_token && !response.data.auth_configured) {
const newToken = response.data.access_token;
// Update localStorage
localStorage.setItem('LIGHTRAG-API-TOKEN', newToken);
// Update auth state
useAuthStore.getState().login(
newToken,
true,
response.data.core_version,
response.data.api_version,
response.data.webui_title || null,
response.data.webui_description || null
);
return newToken;
} else {
throw new Error('Failed to get guest token');
}
} finally {
isRefreshingGuestToken = false;
refreshTokenPromise = null;
}
})();
return refreshTokenPromise;
};
// Interceptor: add api key and check authentication
axiosInstance.interceptors.request.use((config) => {
// Skip interceptor for token refresh requests
if (config.headers['X-Skip-Interceptor']) {
delete config.headers['X-Skip-Interceptor'];
return config;
}
const apiKey = useSettingsStore.getState().apiKey
const token = localStorage.getItem('LIGHTRAG-API-TOKEN');
// Always include token if it exists, regardless of path
if (token) {
config.headers['Authorization'] = `Bearer ${token}`
}
if (apiKey) {
config.headers['X-API-Key'] = apiKey
}
return config
})
// Interceptor:handle token renewal and authentication errors
axiosInstance.interceptors.response.use(
(response) => {
// ========== Check for new token from backend ==========
const newToken = response.headers['x-new-token'];
if (newToken) {
localStorage.setItem('LIGHTRAG-API-TOKEN', newToken);
// Optional: log in development mode
if (import.meta.env.DEV) {
console.log('[Auth] Token auto-renewed by backend');
}
// Update auth state with renewal tracking
try {
const payload = JSON.parse(atob(newToken.split('.')[1]));
const authStore = useAuthStore.getState();
if (authStore.isAuthenticated) {
// Track token renewal time and expiration
const renewalTime = Date.now();
const expiresAt = payload.exp ? payload.exp * 1000 : 0;
authStore.setTokenRenewal(renewalTime, expiresAt);
// Update username (usually unchanged, but just in case)
const newUsername = payload.sub;
if (newUsername && newUsername !== authStore.username) {
// Need to add setUsername method or just update via login
// For now, we'll skip username update as it's rare
}
}
} catch (error) {
console.warn('[Auth] Failed to parse renewed token:', error);
}
}
// ========== End of token renewal check ==========
return response;
},
async (error: AxiosError) => {
if (error.response) {
if (error.response?.status === 401) {
const originalRequest = error.config;
// 1. For login API, throw error directly
if (originalRequest?.url?.includes('/login')) {
throw error;
}
// 2. Prevent infinite retry
if (originalRequest && (originalRequest as any)._retry) {
navigationService.navigateToLogin();
return Promise.reject(new Error('Authentication required'));
}
// 3. Check if in guest mode
const authStore = useAuthStore.getState();
const currentToken = localStorage.getItem('LIGHTRAG-API-TOKEN');
const isGuest = currentToken && authStore.isGuestMode;
// 4. Guest mode: silent refresh and retry
if (isGuest && originalRequest) {
try {
const newToken = await silentRefreshGuestToken();
// Mark as retried to prevent infinite loop
(originalRequest as any)._retry = true;
// Update token in request headers
originalRequest.headers['Authorization'] = `Bearer ${newToken}`;
// Retry original request
return axiosInstance(originalRequest);
} catch (refreshError) {
console.error('Failed to refresh guest token:', refreshError);
// Refresh failed, navigate to login
navigationService.navigateToLogin();
return Promise.reject(new Error('Failed to refresh authentication'));
}
}
// 5. Non-guest mode: navigate to login page
navigationService.navigateToLogin();
return Promise.reject(new Error('Authentication required'));
}
throw new Error(
`${error.response.status} ${error.response.statusText}\n${JSON.stringify(
error.response.data
)}\n${error.config?.url}`
)
}
throw error
}
)
// API methods
export const queryGraphs = async (
label: string,
maxDepth: number,
maxNodes: number
): Promise<LightragGraphType> => {
const response = await axiosInstance.get(`/graphs?label=${encodeURIComponent(label)}&max_depth=${maxDepth}&max_nodes=${maxNodes}`)
return response.data
}
export const getGraphLabels = async (): Promise<string[]> => {
const response = await axiosInstance.get('/graph/label/list')
return response.data
}
export const getPopularLabels = async (limit: number = popularLabelsDefaultLimit): Promise<string[]> => {
const response = await axiosInstance.get(`/graph/label/popular?limit=${limit}`)
return response.data
}
export const searchLabels = async (query: string, limit: number = searchLabelsDefaultLimit): Promise<string[]> => {
const response = await axiosInstance.get(`/graph/label/search?q=${encodeURIComponent(query)}&limit=${limit}`)
return response.data
}
export const checkHealth = async (): Promise<
LightragStatus | { status: 'error'; message: string }
> => {
try {
const response = await axiosInstance.get('/health')
return response.data
} catch (error) {
return {
status: 'error',
message: errorMessage(error)
}
}
}
export const getDocuments = async (): Promise<DocsStatusesResponse> => {
const response = await axiosInstance.get('/documents')
return response.data
}
export const scanNewDocuments = async (): Promise<ScanResponse> => {
const response = await axiosInstance.post('/documents/scan')
return response.data
}
export const reprocessFailedDocuments = async (): Promise<ReprocessFailedResponse> => {
const response = await axiosInstance.post('/documents/reprocess_failed')
return response.data
}
export const getDocumentsScanProgress = async (): Promise<LightragDocumentsScanProgress> => {
const response = await axiosInstance.get('/documents/scan-progress')
return response.data
}
export const queryText = async (request: QueryRequest): Promise<QueryResponse> => {
const response = await axiosInstance.post('/query', request)
return response.data
}
export const queryTextStream = async (
request: QueryRequest,
onChunk: (chunk: string) => void,
onError?: (error: string) => void
) => {
const apiKey = useSettingsStore.getState().apiKey;
const token = localStorage.getItem('LIGHTRAG-API-TOKEN');
const headers: HeadersInit = {
'Content-Type': 'application/json',
'Accept': 'application/x-ndjson',
};
if (token) {
headers['Authorization'] = `Bearer ${token}`;
}
if (apiKey) {
headers['X-API-Key'] = apiKey;
}
try {
const response = await fetch(`${backendBaseUrl}/query/stream`, {
method: 'POST',
headers: headers,
body: JSON.stringify(request),
});
if (!response.ok) {
// Handle 401 Unauthorized error specifically
if (response.status === 401) {
// Check if in guest mode
const authStore = useAuthStore.getState();
const currentToken = localStorage.getItem('LIGHTRAG-API-TOKEN');
const isGuest = currentToken && authStore.isGuestMode;
if (isGuest) {
try {
// Silent refresh token for guest mode
const newToken = await silentRefreshGuestToken();
// Retry stream request with new token
const retryHeaders = { ...headers };
retryHeaders['Authorization'] = `Bearer ${newToken}`;
const retryResponse = await fetch(`${backendBaseUrl}/query/stream`, {
method: 'POST',
headers: retryHeaders,
body: JSON.stringify(request),
});
if (!retryResponse.ok) {
throw new Error(`HTTP error! status: ${retryResponse.status}`);
}
// Retry successful, process stream response
// Re-execute the stream processing logic with retryResponse
if (!retryResponse.body) {
throw new Error('Response body is null');
}
const reader = retryResponse.body.getReader();
const decoder = new TextDecoder();
let buffer = '';
while (true) {
const { done, value } = await reader.read();
if (done) break;
buffer += decoder.decode(value, { stream: true });
const lines = buffer.split('\n');
buffer = lines.pop() || '';
for (const line of lines) {
if (line.trim()) {
try {
const parsed = JSON.parse(line);
if (parsed.response) {
onChunk(parsed.response);
} else if (parsed.error) {
onError?.(parsed.error);
}
} catch (parseError) {
console.error('Failed to parse JSON:', parseError, 'Line:', line);
onError?.(`JSON parse error: ${parseError}`);
}
}
}
}
// Process any remaining data in buffer
if (buffer.trim()) {
try {
const parsed = JSON.parse(buffer);
if (parsed.response) {
onChunk(parsed.response);
} else if (parsed.error) {
onError?.(parsed.error);
}
} catch (parseError) {
console.error('Failed to parse final buffer:', parseError);
}
}
return; // Successfully completed retry
} catch (refreshError) {
console.error('Failed to refresh guest token for streaming:', refreshError);
navigationService.navigateToLogin();
throw new Error('Failed to refresh authentication', { cause: refreshError });
}
}
// Non-guest mode: navigate to login page
navigationService.navigateToLogin();
// Create a specific authentication error
const authError = new Error('Authentication required');
throw authError;
}
// Handle other common HTTP errors with specific messages
let errorBody = 'Unknown error';
try {
errorBody = await response.text(); // Try to get error details from body
} catch { /* ignore */ }
// Format error message similar to axios interceptor for consistency
const url = `${backendBaseUrl}/query/stream`;
throw new Error(
`${response.status} ${response.statusText}\n${JSON.stringify(
{ error: errorBody }
)}\n${url}`
);
}
if (!response.body) {
throw new Error('Response body is null');
}
const reader = response.body.getReader();
const decoder = new TextDecoder();
let buffer = '';
while (true) {
const { done, value } = await reader.read();
if (done) {
break; // Stream finished
}
// Decode the chunk and add to buffer
buffer += decoder.decode(value, { stream: true }); // stream: true handles multi-byte chars split across chunks
// Process complete lines (NDJSON)
const lines = buffer.split('\n');
buffer = lines.pop() || ''; // Keep potentially incomplete line in buffer
for (const line of lines) {
if (line.trim()) {
try {
const parsed = JSON.parse(line);
if (parsed.response) {
onChunk(parsed.response);
} else if (parsed.error && onError) {
onError(parsed.error);
}
} catch (error) {
console.error('Error parsing stream chunk:', line, error);
if (onError) onError(`Error parsing server response: ${line}`);
}
}
}
}
// Process any remaining data in the buffer after the stream ends
if (buffer.trim()) {
try {
const parsed = JSON.parse(buffer);
if (parsed.response) {
onChunk(parsed.response);
} else if (parsed.error && onError) {
onError(parsed.error);
}
} catch (error) {
console.error('Error parsing final chunk:', buffer, error);
if (onError) onError(`Error parsing final server response: ${buffer}`);
}
}
} catch (error) {
const message = errorMessage(error);
// Check if this is an authentication error
if (message === 'Authentication required') {
// Already navigated to login page in the response.status === 401 block
console.error('Authentication required for stream request');
if (onError) {
onError('Authentication required');
}
return; // Exit early, no need for further error handling
}
// Check for specific HTTP error status codes in the error message
const statusCodeMatch = message.match(/^(\d{3})\s/);
if (statusCodeMatch) {
const statusCode = parseInt(statusCodeMatch[1], 10);
// Handle specific status codes with user-friendly messages
let userMessage = message;
switch (statusCode) {
case 403:
userMessage = 'You do not have permission to access this resource (403 Forbidden)';
console.error('Permission denied for stream request:', message);
break;
case 404:
userMessage = 'The requested resource does not exist (404 Not Found)';
console.error('Resource not found for stream request:', message);
break;
case 429:
userMessage = 'Too many requests, please try again later (429 Too Many Requests)';
console.error('Rate limited for stream request:', message);
break;
case 500:
case 502:
case 503:
case 504:
userMessage = `Server error, please try again later (${statusCode})`;
console.error('Server error for stream request:', message);
break;
default:
console.error('Stream request failed with status code:', statusCode, message);
}
if (onError) {
onError(userMessage);
}
return;
}
// Handle network errors (like connection refused, timeout, etc.)
if (message.includes('NetworkError') ||
message.includes('Failed to fetch') ||
message.includes('Network request failed')) {
console.error('Network error for stream request:', message);
if (onError) {
onError('Network connection error, please check your internet connection');
}
return;
}
// Handle JSON parsing errors during stream processing
if (message.includes('Error parsing') || message.includes('SyntaxError')) {
console.error('JSON parsing error in stream:', message);
if (onError) {
onError('Error processing response data');
}
return;
}
// Handle other errors
console.error('Unhandled stream error:', message);
if (onError) {
onError(message);
} else {
console.error('No error handler provided for stream error:', message);
}
}
};
export const insertText = async (text: string): Promise<DocActionResponse> => {
const response = await axiosInstance.post('/documents/text', { text })
return response.data
}
export const insertTexts = async (texts: string[]): Promise<DocActionResponse> => {
const response = await axiosInstance.post('/documents/texts', { texts })
return response.data
}
export const uploadDocument = async (
file: File,
onUploadProgress?: (percentCompleted: number) => void
): Promise<DocActionResponse> => {
const formData = new FormData()
formData.append('file', file)
const response = await axiosInstance.post('/documents/upload', formData, {
headers: {
'Content-Type': 'multipart/form-data'
},
// prettier-ignore
onUploadProgress:
onUploadProgress !== undefined
? (progressEvent) => {
const percentCompleted = Math.round((progressEvent.loaded * 100) / progressEvent.total!)
onUploadProgress(percentCompleted)
}
: undefined
})
return response.data
}
export const batchUploadDocuments = async (
files: File[],
onUploadProgress?: (fileName: string, percentCompleted: number) => void
): Promise<DocActionResponse[]> => {
return await Promise.all(
files.map(async (file) => {
return await uploadDocument(file, (percentCompleted) => {
onUploadProgress?.(file.name, percentCompleted)
})
})
)
}
export const clearDocuments = async (): Promise<DocActionResponse> => {
const response = await axiosInstance.delete('/documents')
return response.data
}
export const clearCache = async (): Promise<{
status: 'success' | 'fail'
message: string
}> => {
const response = await axiosInstance.post('/documents/clear_cache', {})
return response.data
}
export const deleteDocuments = async (
docIds: string[],
deleteFile: boolean = false,
deleteLLMCache: boolean = false
): Promise<DeleteDocResponse> => {
const response = await axiosInstance.delete('/documents/delete_document', {
data: { doc_ids: docIds, delete_file: deleteFile, delete_llm_cache: deleteLLMCache }
})
return response.data
}
export const getAuthStatus = async (): Promise<AuthStatusResponse> => {
try {
// Add a timeout to the request to prevent hanging
const response = await axiosInstance.get('/auth-status', {
timeout: 5000, // 5 second timeout
headers: {
'Accept': 'application/json' // Explicitly request JSON
}
});
// Check if response is HTML (which indicates a redirect or wrong endpoint)
const contentType = response.headers['content-type'] || '';
if (contentType.includes('text/html')) {
console.warn('Received HTML response instead of JSON for auth-status endpoint');
return {
auth_configured: true,
auth_mode: 'enabled'
};
}
// Strict validation of the response data
if (response.data &&
typeof response.data === 'object' &&
'auth_configured' in response.data &&
typeof response.data.auth_configured === 'boolean') {
// For unconfigured auth, ensure we have an access token
if (!response.data.auth_configured) {
if (response.data.access_token && typeof response.data.access_token === 'string') {
return response.data;
} else {
console.warn('Auth not configured but no valid access token provided');
}
} else {
// For configured auth, just return the data
return response.data;
}
}
// If response data is invalid but we got a response, log it
console.warn('Received invalid auth status response:', response.data);
// Default to auth configured if response is invalid
return {
auth_configured: true,
auth_mode: 'enabled'
};
} catch (error) {
// If the request fails, assume authentication is configured
console.error('Failed to get auth status:', errorMessage(error));
return {
auth_configured: true,
auth_mode: 'enabled'
};
}
}
export const getPipelineStatus = async (): Promise<PipelineStatusResponse> => {
const response = await axiosInstance.get('/documents/pipeline_status')
return response.data
}
export const cancelPipeline = async (): Promise<{
status: 'cancellation_requested' | 'not_busy'
message: string
}> => {
const response = await axiosInstance.post('/documents/cancel_pipeline')
return response.data
}
export const loginToServer = async (username: string, password: string): Promise<LoginResponse> => {
const formData = new URLSearchParams();
formData.append('username', username);
formData.append('password', password);
formData.append('grant_type', 'password');
const response = await axiosInstance.post('/login', formData, {
headers: { 'Content-Type': 'application/x-www-form-urlencoded' }
});
return response.data;
}
/**
* Updates an entity's properties in the knowledge graph
* @param entityName The name of the entity to update
* @param updatedData Dictionary containing updated attributes
* @param allowRename Whether to allow renaming the entity (default: false)
* @param allowMerge Whether to merge into an existing entity when renaming to a duplicate name
* @returns Promise with the updated entity information
*/
export const updateEntity = async (
entityName: string,
updatedData: Record<string, any>,
allowRename: boolean = false,
allowMerge: boolean = false
): Promise<EntityUpdateResponse> => {
const response = await axiosInstance.post('/graph/entity/edit', {
entity_name: entityName,
updated_data: updatedData,
allow_rename: allowRename,
allow_merge: allowMerge
})
return response.data
}
/**
* Updates a relation's properties in the knowledge graph
* @param sourceEntity The source entity name
* @param targetEntity The target entity name
* @param updatedData Dictionary containing updated attributes
* @returns Promise with the updated relation information
*/
export const updateRelation = async (
sourceEntity: string,
targetEntity: string,
updatedData: Record<string, any>
): Promise<DocActionResponse> => {
const response = await axiosInstance.post('/graph/relation/edit', {
source_id: sourceEntity,
target_id: targetEntity,
updated_data: updatedData
})
return response.data
}
/**
* Checks if an entity name already exists in the knowledge graph
* @param entityName The entity name to check
* @returns Promise with boolean indicating if the entity exists
*/
export const checkEntityNameExists = async (entityName: string): Promise<boolean> => {
try {
const response = await axiosInstance.get(`/graph/entity/exists?name=${encodeURIComponent(entityName)}`)
return response.data.exists
} catch (error) {
console.error('Error checking entity name:', error)
return false
}
}
/**
* Get the processing status of documents by tracking ID
* @param trackId The tracking ID returned from upload, text, or texts endpoints
* @returns Promise with the track status response containing documents and summary
*/
export const getTrackStatus = async (trackId: string): Promise<TrackStatusResponse> => {
const response = await axiosInstance.get(`/documents/track_status/${encodeURIComponent(trackId)}`)
return response.data
}
type InFlightPaginatedDocumentRequest = {
controller: AbortController
promise: Promise<PaginatedDocsResponse>
subscriberCount: number
}
const getPaginatedDocumentsRequestKey = (request: DocumentsRequest): string =>
JSON.stringify(request)
// Deduplicate in-flight paginated document requests with identical parameters.
// This prevents duplicate backend calls caused by overlapping timers/effects or
// React StrictMode double-mount behavior in development.
const inFlightPaginatedDocumentRequests = new Map<
string,
InFlightPaginatedDocumentRequest
>()
const releasePaginatedDocumentSubscriber = (
requestKey: string,
requestEntry: InFlightPaginatedDocumentRequest,
abortIfLastSubscriber: boolean
): void => {
requestEntry.subscriberCount = Math.max(0, requestEntry.subscriberCount - 1)
if (requestEntry.subscriberCount !== 0) {
return
}
if (inFlightPaginatedDocumentRequests.get(requestKey) === requestEntry) {
inFlightPaginatedDocumentRequests.delete(requestKey)
}
if (abortIfLastSubscriber) {
requestEntry.controller.abort()
}
}
const subscribeToPaginatedDocumentsRequest = (
request: DocumentsRequest
): {
requestKey: string
requestEntry: InFlightPaginatedDocumentRequest
release: (abortIfLastSubscriber: boolean) => void
} => {
const requestKey = getPaginatedDocumentsRequestKey(request)
let requestEntry = inFlightPaginatedDocumentRequests.get(requestKey)
if (!requestEntry) {
const controller = new AbortController()
requestEntry = {
controller,
subscriberCount: 0,
promise: paginatedDocumentsPost(request, controller)
.finally(() => {
if (inFlightPaginatedDocumentRequests.get(requestKey) === requestEntry) {
inFlightPaginatedDocumentRequests.delete(requestKey)
}
})
}
inFlightPaginatedDocumentRequests.set(requestKey, requestEntry)
}
requestEntry.subscriberCount += 1
let released = false
const release = (abortIfLastSubscriber: boolean): void => {
if (released) {
return
}
released = true
releasePaginatedDocumentSubscriber(
requestKey,
requestEntry,
abortIfLastSubscriber
)
}
return {
requestKey,
requestEntry,
release
}
}
const defaultPaginatedDocumentsPost = async (
request: DocumentsRequest,
controller: AbortController
): Promise<PaginatedDocsResponse> => {
const response = await axiosInstance.post('/documents/paginated', request, {
signal: controller.signal
})
return response.data
}
let paginatedDocumentsPost = defaultPaginatedDocumentsPost
export const abortDocumentsPaginated = (request: DocumentsRequest): void => {
const requestKey = getPaginatedDocumentsRequestKey(request)
const inFlightRequest = inFlightPaginatedDocumentRequests.get(requestKey)
if (!inFlightRequest) {
return
}
inFlightPaginatedDocumentRequests.delete(requestKey)
inFlightRequest.controller.abort()
}
export const __resetPaginatedDocumentRequestsForTests = (): void => {
for (const { controller } of inFlightPaginatedDocumentRequests.values()) {
controller.abort()
}
inFlightPaginatedDocumentRequests.clear()
paginatedDocumentsPost = defaultPaginatedDocumentsPost
}
export const __setPaginatedDocumentsPostForTests = (
post: typeof defaultPaginatedDocumentsPost
): void => {
paginatedDocumentsPost = post
}
/**
* Get documents with pagination support
* @param request The pagination request parameters
* @returns Promise with paginated documents response
*/
export const getDocumentsPaginated = async (request: DocumentsRequest): Promise<PaginatedDocsResponse> => {
const { requestEntry, release } = subscribeToPaginatedDocumentsRequest(request)
try {
return await requestEntry.promise
} finally {
release(false)
}
}
export const getDocumentsPaginatedWithTimeout = (
request: DocumentsRequest,
timeoutMs: number = 30000,
errorMsg: string = 'Document fetch timeout'
): Promise<PaginatedDocsResponse> => {
const { requestEntry, release } = subscribeToPaginatedDocumentsRequest(request)
return new Promise<PaginatedDocsResponse>((resolve, reject) => {
let timedOut = false
const timeoutId = setTimeout(() => {
timedOut = true
release(true)
reject(new Error(errorMsg))
}, timeoutMs)
requestEntry.promise
.then(response => {
if (timedOut) {
return
}
clearTimeout(timeoutId)
release(false)
resolve(response)
})
.catch(error => {
if (timedOut) {
return
}
clearTimeout(timeoutId)
release(false)
reject(error)
})
})
}
/**
* Get counts of documents by status
* @returns Promise with status counts response
*/
export const getDocumentStatusCounts = async (): Promise<StatusCountsResponse> => {
const response = await axiosInstance.get('/documents/status_counts')
return response.data
}
|