Skip to content

RAGFlow is an agent-native database: a Retrieval-Augmented Generation (RAG) engine that grew into context infrastructure.

4.2 KB
Raw Blame
export interface IAddLlmRequestBody {
  llm_factory: string; // Ollama
  // model_name: string;
  // model_type: string | string[];
  base_url?: string; // chat|embedding|speech2text|image2text
  api_key?: string | Record<string, any>;
  max_tokens: number;
  is_tools?: boolean;
  region?: string;
  model_info: IModelInfo[];
}

export interface IModelInfo {
  model_name: string;
  model_type: string | string[];
  max_tokens: number;
  /**
   * Per-model extras (e.g. `is_tools` derived from the model descriptor's
   * `features`). Optional for backward compatibility with legacy
   * single-model payloads.
   */
  extra?: Record<string, any>;
}

export interface IDeleteLlmRequestBody {
  llm_factory: string; // Ollama
  llm_name?: string;
}

export interface IListProvidersRequestParams {
  available?: boolean;
}

export interface IAddProviderRequestBody {
  provider_name: string;
}

export type IAddProviderInstanceRequestBody = IAddLlmRequestBody & {
  instance_name: string;
  region?: string;
};

export interface IDeleteProviderInstanceRequestBody {
  provider_name: string;
  instances: string[];
}

export interface IShowProviderInstanceRequestParams {
  provider_name: string;
  id: string;
}

export interface IAddInstanceModelRequestBody {
  model_name: string;
  model_type: string[];
  max_tokens: number;
  extra?: Record<string, any>;
}

export interface IEditInstanceModelRequestBody {
  model_name: string[];
  model_type: string[];
}

export interface IListAllModelsRequestParams {
  type?: string;
  tenant_id?: string;
}

export interface IUpdateModelStatusRequestBody {
  provider_name: string;
  instance_name: string;
  model_name: string;
  status: 'active' | 'inactive';
}

/**
 * Body shape for PATCH `/providers/{name}/instances/{name}/models/{model_name}`.
 * All fields are optional; only the supplied keys are updated server-side.
 */
export interface IPatchInstanceModelRequestBody {
  provider_name: string;
  instance_name: string;
  model_name: string;
  status?: 'active' | 'inactive';
  max_tokens?: number;
  model_type?: string[];
  extra?: Record<string, any>;
}

export interface IDeleteInstanceModelsRequestBody {
  provider_name: string;
  instance_name: string;
  model_name: string[];
}

export interface IUpdateProviderInstanceRequestBody {
  provider_name: string;
  instance_name: string;
  id: string;
  /** Plain API key or a provider credential/configuration object. Blank
   * credential values keep the saved value; use clear_api_key to remove it. */
  api_key?: string | Record<string, any>;
  clear_api_key?: boolean;
  base_url?: string;
  region?: string;
  model_info?: IModelInfo[];
  verify?: boolean;
}

export type ISetDefaultModelRequestBody =
  | {
      model_type: string;
      model_id: string;
    }
  | {
      model_type: string;
      model_provider: string;
      model_instance: string;
      model_name: string;
    };

/**
 * Item shape returned by the list-provider-models endpoint.
 * Fields match the backend's available-model descriptor.
 */
export interface IProviderModelItem {
  name: string;
  max_tokens: number;
  model_types: string[];
  features: string[] | null;
  /**
   * Per-model extra config forwarded through `model_info[].extra`
   * (e.g. SoMark's element-format / feature-config fields).
   * Catalog models typically omit this; it is populated by the
   * edit dialog and the `useModelsDerived` echo path.
   */
  extra?: Record<string, any>;
}

/**
 * Request payload for the list-provider-models endpoint.
 * Mirrors the verifyProviderConnection payload so the same form
 * fields (api_key, base_url, region, model_info) can be reused.
 */
export interface IListProviderModelsRequestBody {
  provider_name: string;
  api_key?: string | object;
  base_url?: string;
  region?: string;
  model_info?: IModelInfo[];
  use_saved_credentials?: boolean;
  api_key_config?: Record<string, unknown>;
  /**
   * Identifies the saved instance whose credentials should be used while the
   * server applies the current form's non-secret configuration and endpoint.
   */
  instance_name?: string;
  /**
   * Returns failures to the caller instead of raising the global notification,
   * so they can be explained next to the form.
   */
  skipGlobalErrorNotification?: boolean;
}