RAGFlow is an agent-native database: a Retrieval-Augmented Generation (RAG) engine that grew into context infrastructure.
Go agent-harnessagent-native-databaseagentic-aiagentic-retrievalagentic-searchaiai-agentscontext-enginecontext-engineeringcontext-managementharness-engineeringknowledge-compilationragretrieval-augmented-generationretrieval-harnesssearch-harness
/*
* Copyright 2026 The InfiniFlow Authors. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
declare namespace AdminService {
export type LoginData = {
access_token: string;
avatar: unknown;
color_schema: 'Bright' | 'Dark';
create_date: string;
create_time: number;
email: string;
id: string;
is_active: '0' | '1';
is_anonymous: '0' | '1';
is_authenticated: '0' | '1';
is_superuser: boolean;
language: string;
last_login_time: string;
login_channel: unknown;
nickname: string;
password: string;
status: '0' | '1';
timezone: string;
update_date: [string];
update_time: [number];
};
export type ListUsersItem = {
create_date: number;
email: string;
is_active: '0' | '1';
is_superuser: boolean;
nickname: string;
role?: string;
ldap_server?: string;
last_login_time?: string;
plan?: string;
};
export type UserDetail = {
avatar?: string;
create_date: string;
email: string;
is_active: '0' | '1';
is_anonymous: '0' | '1';
is_superuser: boolean;
language: string;
last_login_time: string;
login_channel: unknown;
status: '0' | '1';
update_date: string;
role: string;
};
export type ListUserDatasetItem = {
avatar?: string;
chunk_num: number;
create_date: string;
doc_num: number;
language: string;
name: string;
permission: string;
status: '0' | '1';
token_num: number;
update_date: string;
};
export type ListUserAgentItem = {
avatar?: string;
canvas_category: 'agent';
permission: 'string';
title: string;
};
export type TaskExecutorHeartbeatItem = {
name: string;
boot_at: string;
now: string;
ip_address: string;
current: Record<string, object>;
done: number;
failed: number;
lag: number;
pending: number;
pid: number;
};
export type TaskExecutorInfo = Record<string, TaskExecutorHeartbeatItem[]>;
export type ListServicesItem = {
extra: Record<string, unknown>;
host: string;
id: number | string;
name: string;
port: number | string;
service_type: string;
status: string;
};
export type ServiceDetail =
| {
service_name: string;
status: string;
message: string | Record<string, any> | Record<string, any>[];
}
| {
service_name: 'task_executor';
status: 'alive' | 'timeout';
message: AdminService.TaskExecutorInfo;
};
export type PermissionData = {
enable: boolean;
read: boolean;
write: boolean;
share: boolean;
};
export type ListRoleItem = {
id: string;
role_name: string;
description: string;
create_date: string;
update_date: string;
};
export type ListRoleItemWithPermission = ListRoleItem & {
permissions: Record<string, PermissionData>;
};
export type RoleDetailWithPermission = {
role: {
id: string;
name: string;
description: string;
};
permissions: Record<string, PermissionData>;
};
export type RoleDetail = {
id: string;
name: string;
description: string;
create_date: string;
update_date: string;
};
export type AssignRolePermissionsInput = Record<
string,
Partial<PermissionData>
>;
export type RevokeRolePermissionInput = AssignRolePermissionsInput;
export type UserDetailWithPermission = {
user: {
id: string;
username: string;
role: string;
};
role_permissions: Record<string, PermissionData>;
};
export type ResourceType = {
resource_types: string[];
};
export type ListWhitelistItem = {
id: number;
email: string;
create_date: string;
create_time: number;
update_date: string;
update_time: number;
};
// Sandbox settings types
export type SandboxProvider = {
id: string;
name: string;
description: string;
tags: string[];
};
export type SandboxConfigFieldBase = {
required?: boolean;
label?: string;
placeholder?: string;
description?: string;
multiline?: boolean;
readonly?: boolean;
scope?: 'runtime' | 'deployment';
};
export type SandboxConfigStringField = SandboxConfigFieldBase & {
type: 'string';
default?: string;
secret?: boolean;
};
export type SandboxConfigIntegerField = SandboxConfigFieldBase & {
type: 'integer';
default?: number;
min?: number;
max?: number;
};
export type SandboxConfigBooleanField = SandboxConfigFieldBase & {
type: 'boolean';
default?: boolean;
};
export type SandboxConfigJsonField = SandboxConfigFieldBase & {
type: 'json';
default?: unknown;
};
export type SandboxConfigField =
| SandboxConfigStringField
| SandboxConfigIntegerField
| SandboxConfigBooleanField
| SandboxConfigJsonField;
export type SandboxConfig = {
provider_type: string;
config: Record<string, unknown>;
};
}