@@ -65,6 +66,7 @@ ## 🎮 Demo Coba demo kami di [https://demo.ragflow.io](https://demo.ragflow.io). +
@@ -30,7 +31,6 @@
-
Document |
Roadmap |
@@ -46,12 +46,12 @@
## 🎮 Demo
デモをお試しください：[https://demo.ragflow.io](https://demo.ragflow.io)。
+
-
## 🔥 最新情報
- 2024-12-18 Deepdoc のドキュメント レイアウト分析モデルをアップグレードします。
@@ -62,7 +62,9 @@
- 2024-08-02 [graphrag](https://github.com/microsoft/graphrag) からインスピレーションを得た GraphRAG とマインド マップをサポートします。
## 🎉 続きを楽しみに
+
⭐️ リポジトリをスター登録して、エキサイティングな新機能やアップデートを最新の状態に保ちましょう！すべての新しいリリースに関する即時通知を受け取れます！ 🌟
+
@@ -142,7 +144,7 @@
3. ビルド済みの Docker イメージをビルドし、サーバーを起動する:
- > 以下のコマンドは、RAGFlow Dockerイメージの v0.15.1-slim エディションをダウンロードします。異なる RAGFlow エディションの説明については、以下の表を参照してください。v0.15.1-slim とは異なるエディションをダウンロードするには、docker/.env ファイルの RAGFLOW_IMAGE 変数を適宜更新し、docker compose を使用してサーバーを起動してください。例えば、完全版 v0.15.1 をダウンロードするには、RAGFLOW_IMAGE=infiniflow/ragflow:v0.15.1 と設定します。
+ > 以下のコマンドは、RAGFlow Docker イメージの v0.15.1-slim エディションをダウンロードします。異なる RAGFlow エディションの説明については、以下の表を参照してください。v0.15.1-slim とは異なるエディションをダウンロードするには、docker/.env ファイルの RAGFLOW_IMAGE 変数を適宜更新し、docker compose を使用してサーバーを起動してください。例えば、完全版 v0.15.1 をダウンロードするには、RAGFLOW_IMAGE=infiniflow/ragflow:v0.15.1 と設定します。
```bash
$ cd ragflow
@@ -151,10 +153,10 @@
| RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? |
| ----------------- | --------------- | --------------------- | ------------------------ |
- | v0.15.1 | ≈9 | :heavy_check_mark: | Stable release |
+ | v0.15.1 | ≈9 | :heavy_check_mark: | Stable release |
| v0.15.1-slim | ≈2 | ❌ | Stable release |
- | nightly | ≈9 | :heavy_check_mark: | *Unstable* nightly build |
- | nightly-slim | ≈2 | ❌ | *Unstable* nightly build |
+ | nightly | ≈9 | :heavy_check_mark: | _Unstable_ nightly build |
+ | nightly-slim | ≈2 | ❌ | _Unstable_ nightly build |
4. サーバーを立ち上げた後、サーバーの状態を確認する:
@@ -165,17 +167,18 @@
_以下の出力は、システムが正常に起動したことを確認するものです:_
```bash
- ____ ___ ______ ______ __
+ ____ ___ ______ ______ __
/ __ \ / | / ____// ____// /____ _ __
/ /_/ // /| | / / __ / /_ / // __ \| | /| / /
- / _, _// ___ |/ /_/ // __/ / // /_/ /| |/ |/ /
- /_/ |_|/_/ |_|\____//_/ /_/ \____/ |__/|__/
+ / _, _// ___ |/ /_/ // __/ / // /_/ /| |/ |/ /
+ /_/ |_|/_/ |_|\____//_/ /_/ \____/ |__/|__/
* Running on all addresses (0.0.0.0)
* Running on http://127.0.0.1:9380
* Running on http://x.x.x.x:9380
INFO:werkzeug:Press CTRL+C to quit
```
+
> もし確認ステップをスキップして直接 RAGFlow にログインした場合、その時点で RAGFlow が完全に初期化されていない可能性があるため、ブラウザーがネットワーク異常エラーを表示するかもしれません。
5. ウェブブラウザで、プロンプトに従ってサーバーの IP アドレスを入力し、RAGFlow にログインします。
@@ -214,16 +217,16 @@ RAGFlow はデフォルトで Elasticsearch を使用して全文とベクトル
```bash
$ docker compose -f docker/docker-compose.yml down -v
```
-2. **docker/.env** の「DOC _ ENGINE」を「infinity」に設定します。
+2. **docker/.env** の「DOC \_ ENGINE」を「infinity」に設定します。
3. 起動コンテナ：
```bash
$ docker compose -f docker/docker-compose.yml up -d
```
-> [!WARNING]
-> Linux/arm64 マシンでの Infinity への切り替えは正式にサポートされていません。
+ > [!WARNING]
+ > Linux/arm64 マシンでの Infinity への切り替えは正式にサポートされていません。
-## 🔧 ソースコードでDockerイメージを作成（埋め込みモデルなし）
+## 🔧 ソースコードで Docker イメージを作成（埋め込みモデルなし）
この Docker イメージのサイズは約 1GB で、外部の大モデルと埋め込みサービスに依存しています。
@@ -233,7 +236,7 @@ cd ragflow/
docker build --build-arg LIGHTEN=1 -f Dockerfile -t infiniflow/ragflow:nightly-slim .
```
-## 🔧 ソースコードをコンパイルしたDockerイメージ（埋め込みモデルを含む）
+## 🔧 ソースコードをコンパイルした Docker イメージ（埋め込みモデルを含む）
この Docker のサイズは約 9GB で、埋め込みモデルを含むため、外部の大モデルサービスのみが必要です。
@@ -246,11 +249,13 @@ docker build -f Dockerfile -t infiniflow/ragflow:nightly .
## 🔨 ソースコードからサービスを起動する方法
1. uv をインストールする。すでにインストールされている場合は、このステップをスキップしてください:
+
```bash
pipx install uv
```
2. ソースコードをクローンし、Python の依存関係をインストールする:
+
```bash
git clone https://github.com/infiniflow/ragflow.git
cd ragflow/
@@ -258,39 +263,43 @@ docker build -f Dockerfile -t infiniflow/ragflow:nightly .
```
3. Docker Compose を使用して依存サービス（MinIO、Elasticsearch、Redis、MySQL）を起動する:
+
```bash
docker compose -f docker/docker-compose-base.yml up -d
```
- `/etc/hosts` に以下の行を追加して、**conf/service_conf.yaml** に指定されたすべてのホストを `127.0.0.1` に解決します:
+ `/etc/hosts` に以下の行を追加して、**conf/service_conf.yaml** に指定されたすべてのホストを `127.0.0.1` に解決します:
+
```
127.0.0.1 es01 infinity mysql minio redis
- ```
+ ```
4. HuggingFace にアクセスできない場合は、`HF_ENDPOINT` 環境変数を設定してミラーサイトを使用してください:
-
+
```bash
export HF_ENDPOINT=https://hf-mirror.com
```
5. バックエンドサービスを起動する:
+
```bash
source .venv/bin/activate
export PYTHONPATH=$(pwd)
bash docker/launch_backend_service.sh
```
-6. フロントエンドの依存関係をインストールする:
+6. フロントエンドの依存関係をインストールする:
```bash
cd web
npm install
- ```
-7. フロントエンドサービスを起動する:
+ ```
+7. フロントエンドサービスを起動する:
+
```bash
- npm run dev
+ npm run dev
```
- _以下の画面で、システムが正常に起動したことを示します:_
+ _以下の画面で、システムが正常に起動したことを示します:_
diff --git a/README_ko.md b/README_ko.md
index faad27bc3e3..91baac64221 100644
--- a/README_ko.md
+++ b/README_ko.md
@@ -9,7 +9,8 @@
简体中文 |
日本語 |
한국어 |
- Bahasa Indonesia
+ Bahasa Indonesia |
+ Português (Brasil)
@@ -30,7 +31,6 @@
-Document | Roadmap | @@ -39,69 +39,65 @@ Demo
- ## 💡 RAGFlow란? [RAGFlow](https://ragflow.io/)는 심층 문서 이해에 기반한 오픈소스 RAG (Retrieval-Augmented Generation) 엔진입니다. 이 엔진은 대규모 언어 모델(LLM)과 결합하여 정확한 질문 응답 기능을 제공하며, 다양한 복잡한 형식의 데이터에서 신뢰할 수 있는 출처를 바탕으로 한 인용을 통해 이를 뒷받침합니다. RAGFlow는 규모에 상관없이 모든 기업에 최적화된 RAG 워크플로우를 제공합니다. - - ## 🎮 데모 + 데모를 [https://demo.ragflow.io](https://demo.ragflow.io)에서 실행해 보세요. +
@@ -109,17 +105,19 @@
## 🎬 시작하기
+
### 📝 사전 준비 사항
+
- CPU >= 4 cores
- RAM >= 16 GB
- Disk >= 50 GB
- Docker >= 24.0.0 & Docker Compose >= v2.26.1
- > 로컬 머신(Windows, Mac, Linux)에 Docker가 설치되지 않은 경우, [Docker 엔진 설치]((https://docs.docker.com/engine/install/))를 참조하세요.
-
+ > 로컬 머신(Windows, Mac, Linux)에 Docker가 설치되지 않은 경우, [Docker 엔진 설치](<(https://docs.docker.com/engine/install/)>)를 참조하세요.
### 🚀 서버 시작하기
1. `vm.max_map_count`가 262144 이상인지 확인하세요:
+
> `vm.max_map_count`의 값을 아래 명령어를 통해 확인하세요:
>
> ```bash
@@ -158,8 +156,8 @@
| ----------------- | --------------- | --------------------- | ------------------------ |
| v0.15.1 | ≈9 | :heavy_check_mark: | Stable release |
| v0.15.1-slim | ≈2 | ❌ | Stable release |
- | nightly | ≈9 | :heavy_check_mark: | *Unstable* nightly build |
- | nightly-slim | ≈2 | ❌ | *Unstable* nightly build |
+ | nightly | ≈9 | :heavy_check_mark: | _Unstable_ nightly build |
+ | nightly-slim | ≈2 | ❌ | _Unstable_ nightly build |
4. 서버가 시작된 후 서버 상태를 확인하세요:
@@ -170,22 +168,24 @@
_다음 출력 결과로 시스템이 성공적으로 시작되었음을 확인합니다:_
```bash
- ____ ___ ______ ______ __
+ ____ ___ ______ ______ __
/ __ \ / | / ____// ____// /____ _ __
/ /_/ // /| | / / __ / /_ / // __ \| | /| / /
- / _, _// ___ |/ /_/ // __/ / // /_/ /| |/ |/ /
- /_/ |_|/_/ |_|\____//_/ /_/ \____/ |__/|__/
+ / _, _// ___ |/ /_/ // __/ / // /_/ /| |/ |/ /
+ /_/ |_|/_/ |_|\____//_/ /_/ \____/ |__/|__/
* Running on all addresses (0.0.0.0)
* Running on http://127.0.0.1:9380
* Running on http://x.x.x.x:9380
INFO:werkzeug:Press CTRL+C to quit
```
+
> 만약 확인 단계를 건너뛰고 바로 RAGFlow에 로그인하면, RAGFlow가 완전히 초기화되지 않았기 때문에 브라우저에서 `network anormal` 오류가 발생할 수 있습니다.
5. 웹 브라우저에 서버의 IP 주소를 입력하고 RAGFlow에 로그인하세요.
> 기본 설정을 사용할 경우, `http://IP_OF_YOUR_MACHINE`만 입력하면 됩니다 (포트 번호는 제외). 기본 HTTP 서비스 포트 `80`은 기본 구성으로 사용할 때 생략할 수 있습니다.
6. [service_conf.yaml.template](./docker/service_conf.yaml.template) 파일에서 원하는 LLM 팩토리를 `user_default_llm`에 선택하고, `API_KEY` 필드를 해당 API 키로 업데이트하세요.
+
> 자세한 내용은 [llm_api_key_setup](https://ragflow.io/docs/dev/llm_api_key_setup)를 참조하세요.
_이제 쇼가 시작됩니다!_
@@ -213,6 +213,7 @@
### Elasticsearch 에서 Infinity 로 문서 엔진 전환
RAGFlow 는 기본적으로 Elasticsearch 를 사용하여 전체 텍스트 및 벡터를 저장합니다. [Infinity]로 전환(https://github.com/infiniflow/infinity/), 다음 절차를 따르십시오.
+
1. 실행 중인 모든 컨테이너를 중지합니다.
```bash
$docker compose-f docker/docker-compose.yml down -v
@@ -221,10 +222,10 @@ RAGFlow 는 기본적으로 Elasticsearch 를 사용하여 전체 텍스트 및
3. 컨테이너 부팅:
```bash
$docker compose-f docker/docker-compose.yml up -d
- ```
-> [!WARNING]
-> Linux/arm64 시스템에서 Infinity로 전환하는 것은 공식적으로 지원되지 않습니다.
-
+ ```
+ > [!WARNING]
+ > Linux/arm64 시스템에서 Infinity로 전환하는 것은 공식적으로 지원되지 않습니다.
+
## 🔧 소스 코드로 Docker 이미지를 컴파일합니다(임베딩 모델 포함하지 않음)
이 Docker 이미지의 크기는 약 1GB이며, 외부 대형 모델과 임베딩 서비스에 의존합니다.
@@ -248,11 +249,13 @@ docker build -f Dockerfile -t infiniflow/ragflow:nightly .
## 🔨 소스 코드로 서비스를 시작합니다.
1. uv를 설치하거나 이미 설치된 경우 이 단계를 건너뜁니다:
+
```bash
pipx install uv
```
2. 소스 코드를 클론하고 Python 의존성을 설치합니다:
+
```bash
git clone https://github.com/infiniflow/ragflow.git
cd ragflow/
@@ -260,39 +263,43 @@ docker build -f Dockerfile -t infiniflow/ragflow:nightly .
```
3. Docker Compose를 사용하여 의존 서비스(MinIO, Elasticsearch, Redis 및 MySQL)를 시작합니다:
+
```bash
docker compose -f docker/docker-compose-base.yml up -d
```
- `/etc/hosts` 에 다음 줄을 추가하여 **conf/service_conf.yaml** 에 지정된 모든 호스트를 `127.0.0.1` 로 해결합니다:
+ `/etc/hosts` 에 다음 줄을 추가하여 **conf/service_conf.yaml** 에 지정된 모든 호스트를 `127.0.0.1` 로 해결합니다:
+
```
127.0.0.1 es01 infinity mysql minio redis
- ```
+ ```
4. HuggingFace에 접근할 수 없는 경우, `HF_ENDPOINT` 환경 변수를 설정하여 미러 사이트를 사용하세요:
-
+
```bash
export HF_ENDPOINT=https://hf-mirror.com
```
5. 백엔드 서비스를 시작합니다:
+
```bash
source .venv/bin/activate
export PYTHONPATH=$(pwd)
bash docker/launch_backend_service.sh
```
-6. 프론트엔드 의존성을 설치합니다:
+6. 프론트엔드 의존성을 설치합니다:
```bash
cd web
npm install
- ```
-7. 프론트엔드 서비스를 시작합니다:
+ ```
+7. 프론트엔드 서비스를 시작합니다:
+
```bash
- npm run dev
+ npm run dev
```
- _다음 인터페이스는 시스템이 성공적으로 시작되었음을 나타냅니다:_
+ _다음 인터페이스는 시스템이 성공적으로 시작되었음을 나타냅니다:_
diff --git a/README_pt_br.md b/README_pt_br.md
new file mode 100644
index 00000000000..d44f810d9be
--- /dev/null
+++ b/README_pt_br.md
@@ -0,0 +1,352 @@
+
+
+
+
+
+
+
+
++ English | + 简体中文 | + 日本語 | + 한국어 | + Bahasa Indonesia | + Português (Brasil) +
+ +
+
+ 
+ Documentação | + Roadmap | + Twitter | + Discord | + Demo +
+ +
+
+
+## 💡 O que é o RAGFlow?
+
+[RAGFlow](https://ragflow.io/) é um mecanismo RAG (Geração Aumentada por Recuperação) de código aberto baseado em entendimento profundo de documentos. Ele oferece um fluxo de trabalho RAG simplificado para empresas de qualquer porte, combinando LLMs (Modelos de Linguagem de Grande Escala) para fornecer capacidades de perguntas e respostas verídicas, respaldadas por citações bem fundamentadas de diversos dados complexos formatados.
+
+## 🎮 Demo
+
+Experimente nossa demo em [https://demo.ragflow.io](https://demo.ragflow.io).
+
+📕 Índice
+ +- 💡 [O que é o RAGFlow?](#-o-que-é-o-ragflow) +- 🎮 [Demo](#-demo) +- 📌 [Últimas Atualizações](#-últimas-atualizações) +- 🌟 [Principais Funcionalidades](#-principais-funcionalidades) +- 🔎 [Arquitetura do Sistema](#-arquitetura-do-sistema) +- 🎬 [Primeiros Passos](#-primeiros-passos) +- 🔧 [Configurações](#-configurações) +- 🔧 [Construir uma imagem docker sem incorporar modelos](#-construir-uma-imagem-docker-sem-incorporar-modelos) +- 🔧 [Construir uma imagem docker incluindo modelos](#-construir-uma-imagem-docker-incluindo-modelos) +- 🔨 [Lançar serviço a partir do código-fonte para desenvolvimento](#-lançar-serviço-a-partir-do-código-fonte-para-desenvolvimento) +- 📚 [Documentação](#-documentação) +- 📜 [Roadmap](#-roadmap) +- 🏄 [Comunidade](#-comunidade) +- 🙌 [Contribuindo](#-contribuindo) + +
+
+
+
+
+## 🔥 Últimas Atualizações
+
+- 18-12-2024 Atualiza o modelo de Análise de Layout de Documentos no Deepdoc.
+- 04-12-2024 Adiciona suporte para pontuação de pagerank na base de conhecimento.
+- 22-11-2024 Adiciona mais variáveis para o Agente.
+- 01-11-2024 Adiciona extração de palavras-chave e geração de perguntas relacionadas aos blocos analisados para melhorar a precisão da recuperação.
+- 22-08-2024 Suporta conversão de texto para comandos SQL via RAG.
+- 02-08-2024 Suporta GraphRAG inspirado pelo [graphrag](https://github.com/microsoft/graphrag) e mapa mental.
+
+## 🎉 Fique Ligado
+
+⭐️ Dê uma estrela no nosso repositório para se manter atualizado com novas funcionalidades e melhorias empolgantes! Receba notificações instantâneas sobre novos lançamentos! 🌟
+
+
+
+
+
+## 🌟 Principais Funcionalidades
+
+### 🍭 **"Qualidade entra, qualidade sai"**
+
+- Extração de conhecimento baseada em [entendimento profundo de documentos](./deepdoc/README.md) a partir de dados não estruturados com formatos complicados.
+- Encontra a "agulha no palheiro de dados" de literalmente tokens ilimitados.
+
+### 🍱 **Fragmentação baseada em templates**
+
+- Inteligente e explicável.
+- Muitas opções de templates para escolher.
+
+### 🌱 **Citações fundamentadas com menos alucinações**
+
+- Visualização da fragmentação de texto para permitir intervenção humana.
+- Visualização rápida das referências chave e citações rastreáveis para apoiar respostas fundamentadas.
+
+### 🍔 **Compatibilidade com fontes de dados heterogêneas**
+
+- Suporta Word, apresentações, excel, txt, imagens, cópias digitalizadas, dados estruturados, páginas da web e mais.
+
+### 🛀 **Fluxo de trabalho RAG automatizado e sem esforço**
+
+- Orquestração RAG simplificada voltada tanto para negócios pessoais quanto grandes empresas.
+- Modelos LLM e de incorporação configuráveis.
+- Múltiplas recuperações emparelhadas com reclassificação fundida.
+- APIs intuitivas para integração sem problemas com os negócios.
+
+## 🔎 Arquitetura do Sistema
+
+
+
+
+
+## 🎬 Primeiros Passos
+
+### 📝 Pré-requisitos
+
+- CPU >= 4 núcleos
+- RAM >= 16 GB
+- Disco >= 50 GB
+- Docker >= 24.0.0 & Docker Compose >= v2.26.1
+ > Se você não instalou o Docker na sua máquina local (Windows, Mac ou Linux), veja [Instalar Docker Engine](https://docs.docker.com/engine/install/).
+
+### 🚀 Iniciar o servidor
+
+1. Certifique-se de que `vm.max_map_count` >= 262144:
+
+ > Para verificar o valor de `vm.max_map_count`:
+ >
+ > ```bash
+ > $ sysctl vm.max_map_count
+ > ```
+ >
+ > Se necessário, redefina `vm.max_map_count` para um valor de pelo menos 262144:
+ >
+ > ```bash
+ > # Neste caso, defina para 262144:
+ > $ sudo sysctl -w vm.max_map_count=262144
+ > ```
+ >
+ > Essa mudança será resetada após a reinicialização do sistema. Para garantir que a alteração permaneça permanente, adicione ou atualize o valor de `vm.max_map_count` em **/etc/sysctl.conf**:
+ >
+ > ```bash
+ > vm.max_map_count=262144
+ > ```
+
+2. Clone o repositório:
+
+ ```bash
+ $ git clone https://github.com/infiniflow/ragflow.git
+ ```
+
+3. Inicie o servidor usando as imagens Docker pré-compiladas:
+
+ > O comando abaixo baixa a edição `v0.15.1-slim` da imagem Docker do RAGFlow. Consulte a tabela a seguir para descrições de diferentes edições do RAGFlow. Para baixar uma edição do RAGFlow diferente da `v0.15.1-slim`, atualize a variável `RAGFLOW_IMAGE` conforme necessário no **docker/.env** antes de usar `docker compose` para iniciar o servidor. Por exemplo: defina `RAGFLOW_IMAGE=infiniflow/ragflow:v0.15.1` para a edição completa `v0.15.1`.
+
+ ```bash
+ $ cd ragflow
+ $ docker compose -f docker/docker-compose.yml up -d
+ ```
+
+ | Tag da imagem RAGFlow | Tamanho da imagem (GB) | Possui modelos de incorporação? | Estável? |
+ | --------------------- | ---------------------- | ------------------------------- | ------------------------ |
+ | v0.15.1 | ~9 | :heavy_check_mark: | Lançamento estável |
+ | v0.15.1-slim | ~2 | ❌ | Lançamento estável |
+ | nightly | ~9 | :heavy_check_mark: | _Instável_ build noturno |
+ | nightly-slim | ~2 | ❌ | _Instável_ build noturno |
+
+4. Verifique o status do servidor após tê-lo iniciado:
+
+ ```bash
+ $ docker logs -f ragflow-server
+ ```
+
+ _O seguinte resultado confirma o lançamento bem-sucedido do sistema:_
+
+ ```bash
+ ____ ___ ______ ______ __
+ / __ \ / | / ____// ____// /____ _ __
+ / /_/ // /| | / / __ / /_ / // __ \| | /| / /
+ / _, _// ___ |/ /_/ // __/ / // /_/ /| |/ |/ /
+ /_/ |_|/_/ |_|\____//_/ /_/ \____/ |__/|__/
+
+ * Rodando em todos os endereços (0.0.0.0)
+ * Rodando em http://127.0.0.1:9380
+ * Rodando em http://x.x.x.x:9380
+ INFO:werkzeug:Pressione CTRL+C para sair
+ ```
+
+ > Se você pular essa etapa de confirmação e acessar diretamente o RAGFlow, seu navegador pode exibir um erro `network anormal`, pois, nesse momento, seu RAGFlow pode não estar totalmente inicializado.
+
+5. No seu navegador, insira o endereço IP do seu servidor e faça login no RAGFlow.
+
+ > Com as configurações padrão, você só precisa digitar `http://IP_DO_SEU_MÁQUINA` (**sem** o número da porta), pois a porta HTTP padrão `80` pode ser omitida ao usar as configurações padrão.
+
+6. Em [service_conf.yaml.template](./docker/service_conf.yaml.template), selecione a fábrica LLM desejada em `user_default_llm` e atualize o campo `API_KEY` com a chave de API correspondente.
+
+ > Consulte [llm_api_key_setup](https://ragflow.io/docs/dev/llm_api_key_setup) para mais informações.
+
+_O show está no ar!_
+
+## 🔧 Configurações
+
+Quando se trata de configurações do sistema, você precisará gerenciar os seguintes arquivos:
+
+- [.env](./docker/.env): Contém as configurações fundamentais para o sistema, como `SVR_HTTP_PORT`, `MYSQL_PASSWORD` e `MINIO_PASSWORD`.
+- [service_conf.yaml.template](./docker/service_conf.yaml.template): Configura os serviços de back-end. As variáveis de ambiente neste arquivo serão automaticamente preenchidas quando o contêiner Docker for iniciado. Quaisquer variáveis de ambiente definidas dentro do contêiner Docker estarão disponíveis para uso, permitindo personalizar o comportamento do serviço com base no ambiente de implantação.
+- [docker-compose.yml](./docker/docker-compose.yml): O sistema depende do [docker-compose.yml](./docker/docker-compose.yml) para iniciar.
+
+> O arquivo [./docker/README](./docker/README.md) fornece uma descrição detalhada das configurações do ambiente e dos serviços, que podem ser usadas como `${ENV_VARS}` no arquivo [service_conf.yaml.template](./docker/service_conf.yaml.template).
+
+Para atualizar a porta HTTP de serviço padrão (80), vá até [docker-compose.yml](./docker/docker-compose.yml) e altere `80:80` para `@@ -30,7 +31,6 @@
-
Document |
Roadmap |
@@ -45,13 +45,13 @@
## 🎮 Demo 試用
-請登入網址 [https://demo.ragflow.io](https://demo.ragflow.io) 試用 demo。
+請登入網址 [https://demo.ragflow.io](https://demo.ragflow.io) 試用 demo。
+
-
## 🔥 近期更新
- 2024-12-18 升級了 Deepdoc 的文檔佈局分析模型。
@@ -62,12 +62,13 @@
- 2024-08-02 支持 GraphRAG 啟發於 [graphrag](https://github.com/microsoft/graphrag) 和心智圖。
## 🎉 關注項目
-⭐️點擊右上角的 Star 追蹤RAGFlow，可以取得最新發布的即時通知 !🌟
+
+⭐️ 點擊右上角的 Star 追蹤 RAGFlow，可以取得最新發布的即時通知 !🌟
+
-
## 🌟 主要功能
### 🍭 **"Quality in, quality out"**
@@ -102,7 +103,7 @@
@@ -30,7 +31,6 @@
-
Document |
Roadmap |
@@ -46,12 +46,12 @@
## 🎮 Demo 试用
请登录网址 [https://demo.ragflow.io](https://demo.ragflow.io) 试用 demo。
+
-
## 🔥 近期更新
- 2024-12-18 升级了 Deepdoc 的文档布局分析模型。
@@ -62,12 +62,13 @@
- 2024-08-02 支持 GraphRAG 启发于 [graphrag](https://github.com/microsoft/graphrag) 和思维导图。
## 🎉 关注项目
-⭐️点击右上角的 Star 关注RAGFlow，可以获取最新发布的实时通知 !🌟
+
+⭐️ 点击右上角的 Star 关注 RAGFlow，可以获取最新发布的实时通知 !🌟
+
-
## 🌟 主要功能
### 🍭 **"Quality in, quality out"**
@@ -154,11 +155,12 @@
| ----------------- | --------------- | --------------------- | ------------------------ |
| v0.15.1 | ≈9 | :heavy_check_mark: | Stable release |
| v0.15.1-slim | ≈2 | ❌ | Stable release |
- | nightly | ≈9 | :heavy_check_mark: | *Unstable* nightly build |
- | nightly-slim | ≈2 | ❌ | *Unstable* nightly build |
+ | nightly | ≈9 | :heavy_check_mark: | _Unstable_ nightly build |
+ | nightly-slim | ≈2 | ❌ | _Unstable_ nightly build |
- > [!TIP]
+ > [!TIP]
> 如果你遇到 Docker 镜像拉不下来的问题，可以在 **docker/.env** 文件内根据变量 `RAGFLOW_IMAGE` 的注释提示选择华为云或者阿里云的相应镜像。
+ >
> - 华为云镜像名：`swr.cn-north-4.myhuaweicloud.com/infiniflow/ragflow`
> - 阿里云镜像名：`registry.cn-hangzhou.aliyuncs.com/infiniflow/ragflow`
@@ -171,17 +173,18 @@
_出现以下界面提示说明服务器启动成功：_
```bash
- ____ ___ ______ ______ __
+ ____ ___ ______ ______ __
/ __ \ / | / ____// ____// /____ _ __
/ /_/ // /| | / / __ / /_ / // __ \| | /| / /
- / _, _// ___ |/ /_/ // __/ / // /_/ /| |/ |/ /
- /_/ |_|/_/ |_|\____//_/ /_/ \____/ |__/|__/
+ / _, _// ___ |/ /_/ // __/ / // /_/ /| |/ |/ /
+ /_/ |_|/_/ |_|\____//_/ /_/ \____/ |__/|__/
* Running on all addresses (0.0.0.0)
* Running on http://127.0.0.1:9380
* Running on http://x.x.x.x:9380
INFO:werkzeug:Press CTRL+C to quit
```
+
> 如果您跳过这一步系统确认步骤就登录 RAGFlow，你的浏览器有可能会提示 `network anormal` 或 `网络异常`，因为 RAGFlow 可能并未完全启动成功。
5. 在你的浏览器中输入你的服务器对应的 IP 地址并登录 RAGFlow。
@@ -232,10 +235,9 @@ RAGFlow 默认使用 Elasticsearch 存储文本和向量数据. 如果要切换
$ docker compose -f docker/docker-compose.yml up -d
```
-> [!WARNING]
+> [!WARNING]
> Infinity 目前官方并未正式支持在 Linux/arm64 架构下的机器上运行.
-
## 🔧 源码编译 Docker 镜像（不含 embedding 模型）
本 Docker 镜像大小约 2 GB 左右并且依赖外部的大模型和 embedding 服务。
@@ -258,53 +260,59 @@ docker build --build-arg NEED_MIRROR=1 -f Dockerfile -t infiniflow/ragflow:night
## 🔨 以源代码启动服务
-1. 安装 uv。如已经安装，可跳过本步骤：
+1. 安装 uv。如已经安装，可跳过本步骤：
+
```bash
pipx install uv
export UV_INDEX=https://pypi.tuna.tsinghua.edu.cn/simple
```
-2. 下载源代码并安装 Python 依赖：
+2. 下载源代码并安装 Python 依赖：
+
```bash
git clone https://github.com/infiniflow/ragflow.git
cd ragflow/
uv sync --python 3.10 --all-extras # install RAGFlow dependent python modules
```
-3. 通过 Docker Compose 启动依赖的服务（MinIO, Elasticsearch, Redis, and MySQL）：
+3. 通过 Docker Compose 启动依赖的服务（MinIO, Elasticsearch, Redis, and MySQL）：
+
```bash
docker compose -f docker/docker-compose-base.yml up -d
```
- 在 `/etc/hosts` 中添加以下代码，将 **conf/service_conf.yaml** 文件中的所有 host 地址都解析为 `127.0.0.1`：
+ 在 `/etc/hosts` 中添加以下代码，将 **conf/service_conf.yaml** 文件中的所有 host 地址都解析为 `127.0.0.1`：
+
```
127.0.0.1 es01 infinity mysql minio redis
- ```
+ ```
+
+4. 如果无法访问 HuggingFace，可以把环境变量 `HF_ENDPOINT` 设成相应的镜像站点：
-4. 如果无法访问 HuggingFace，可以把环境变量 `HF_ENDPOINT` 设成相应的镜像站点：
-
```bash
export HF_ENDPOINT=https://hf-mirror.com
```
-5. 启动后端服务：
+5. 启动后端服务：
+
```bash
source .venv/bin/activate
export PYTHONPATH=$(pwd)
bash docker/launch_backend_service.sh
```
-6. 安装前端依赖：
+6. 安装前端依赖：
```bash
cd web
npm install
- ```
-7. 启动前端服务：
+ ```
+7. 启动前端服务：
+
```bash
- npm run dev
- ```
+ npm run dev
+ ```
- _以下界面说明系统已经成功启动：_
+ _以下界面说明系统已经成功启动：_
@@ -340,4 +348,3 @@ RAGFlow 只有通过开源协作才能蓬勃发展。秉持这一精神,我们
{content}
+```
+
+Where `{subtitle}` and `{content}` are defined keys.
+
+### Key
+
+A **Template** component relies on keys (variables) to specify its data or information sources. Its immediate upstream component is *not* necessarily its input, and the arrows in the workflow indicate *only* the processing sequence.
+
+Values of keys are categorized into two groups:
+
+- **Component Output**: The value of the key should be a component ID.
+- **Begin Input**: The value of the key should be the name of a global variable defined in the **Begin** component.
+
+## Examples
+
+Explore our research report generator agent template, where the **Template** component (component ID: **Article**) organizes user input and the outputs of the **Sections** component into HTML format:
+
+1. Click the **Agent** tab at the top center of the page to access the **Agent** page.
+2. Click **+ Create agent** on the top right of the page to open the **agent template** page.
+3. On the **agent template** page, hover over the **Research report generator** card and click **Use this template**.
+4. Name your new agent and click **OK** to enter the workflow editor.
+5. Click on the **Template** component to display its **Configuration** window
diff --git a/intergrations/chatgpt-on-wechat/plugins/__init__.py b/intergrations/chatgpt-on-wechat/plugins/__init__.py
index 28032b8b8e8..557f0d1f1ba 100644
--- a/intergrations/chatgpt-on-wechat/plugins/__init__.py
+++ b/intergrations/chatgpt-on-wechat/plugins/__init__.py
@@ -1,3 +1,19 @@
+#
+# Copyright 2025 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.
+#
+
from beartype.claw import beartype_this_package
beartype_this_package()
diff --git a/intergrations/chatgpt-on-wechat/plugins/ragflow_chat.py b/intergrations/chatgpt-on-wechat/plugins/ragflow_chat.py
index 5d5615eaa17..fe96f39a747 100644
--- a/intergrations/chatgpt-on-wechat/plugins/ragflow_chat.py
+++ b/intergrations/chatgpt-on-wechat/plugins/ragflow_chat.py
@@ -1,3 +1,19 @@
+#
+# Copyright 2025 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.
+#
+
import logging
import requests
from bridge.context import ContextType # Import Context, ContextType
diff --git a/rag/__init__.py b/rag/__init__.py
index 6bfdd33d0ba..643f79713c8 100644
--- a/rag/__init__.py
+++ b/rag/__init__.py
@@ -1,2 +1,18 @@
+#
+# Copyright 2025 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.
+#
+
from beartype.claw import beartype_this_package
beartype_this_package()
diff --git a/rag/app/__init__.py b/rag/app/__init__.py
index e69de29bb2d..e156bc93dde 100644
--- a/rag/app/__init__.py
+++ b/rag/app/__init__.py
@@ -0,0 +1,15 @@
+#
+# Copyright 2025 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.
+#
\ No newline at end of file
diff --git a/rag/app/audio.py b/rag/app/audio.py
index ec7ffeea3e4..95e552ae9f5 100644
--- a/rag/app/audio.py
+++ b/rag/app/audio.py
@@ -1,3 +1,6 @@
+#
+# Copyright 2025 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
@@ -10,6 +13,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.
#
+
import re
from api.db import LLMType
diff --git a/rag/app/book.py b/rag/app/book.py
index 763364778bc..fad526adcf2 100644
--- a/rag/app/book.py
+++ b/rag/app/book.py
@@ -1,3 +1,6 @@
+#
+# Copyright 2025 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
@@ -10,6 +13,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.
#
+
import logging
from tika import parser
import re
diff --git a/rag/app/email.py b/rag/app/email.py
index b14ee6d43e0..d1c98d5558c 100644
--- a/rag/app/email.py
+++ b/rag/app/email.py
@@ -1,3 +1,6 @@
+#
+# Copyright 2025 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
diff --git a/rag/app/knowledge_graph.py b/rag/app/knowledge_graph.py
index f4330f48286..030c9aaf24a 100644
--- a/rag/app/knowledge_graph.py
+++ b/rag/app/knowledge_graph.py
@@ -1,3 +1,19 @@
+#
+# Copyright 2025 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.
+#
+
import re
from graphrag.index import build_knowledge_graph_chunks
diff --git a/rag/app/laws.py b/rag/app/laws.py
index 7a32c827319..6ed1ccc7782 100644
--- a/rag/app/laws.py
+++ b/rag/app/laws.py
@@ -1,3 +1,6 @@
+#
+# Copyright 2025 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
@@ -10,6 +13,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.
#
+
import logging
from tika import parser
import re
diff --git a/rag/app/manual.py b/rag/app/manual.py
index 9018cb2a587..96693697078 100644
--- a/rag/app/manual.py
+++ b/rag/app/manual.py
@@ -1,5 +1,5 @@
#
-# Copyright 2024 The InfiniFlow Authors. All Rights Reserved.
+# Copyright 2025 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.
diff --git a/rag/app/naive.py b/rag/app/naive.py
index fac626ab00f..7dbde2bb4a7 100644
--- a/rag/app/naive.py
+++ b/rag/app/naive.py
@@ -1,3 +1,6 @@
+#
+# Copyright 2025 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
@@ -10,6 +13,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.
#
+
import logging
from tika import parser
from io import BytesIO
diff --git a/rag/app/one.py b/rag/app/one.py
index bd691f46c3e..616a87dbc19 100644
--- a/rag/app/one.py
+++ b/rag/app/one.py
@@ -1,3 +1,6 @@
+#
+# Copyright 2025 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
@@ -10,6 +13,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.
#
+
import logging
from tika import parser
from io import BytesIO
diff --git a/rag/app/paper.py b/rag/app/paper.py
index 89af09b9085..529d3a02de4 100644
--- a/rag/app/paper.py
+++ b/rag/app/paper.py
@@ -1,3 +1,6 @@
+#
+# Copyright 2025 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
@@ -10,6 +13,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.
#
+
import logging
import copy
import re
diff --git a/rag/app/picture.py b/rag/app/picture.py
index fb9b1e26952..578da79ffee 100644
--- a/rag/app/picture.py
+++ b/rag/app/picture.py
@@ -1,3 +1,6 @@
+#
+# Copyright 2025 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
@@ -10,6 +13,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.
#
+
import io
import numpy as np
diff --git a/rag/app/presentation.py b/rag/app/presentation.py
index a3305bdc116..09a8c3f461c 100644
--- a/rag/app/presentation.py
+++ b/rag/app/presentation.py
@@ -1,3 +1,6 @@
+#
+# Copyright 2025 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
@@ -10,6 +13,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.
#
+
import copy
import re
from io import BytesIO
diff --git a/rag/app/qa.py b/rag/app/qa.py
index 00cde2d64bf..a0c77c23833 100644
--- a/rag/app/qa.py
+++ b/rag/app/qa.py
@@ -1,3 +1,6 @@
+#
+# Copyright 2025 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
@@ -10,6 +13,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.
#
+
import logging
import re
import csv
diff --git a/rag/app/resume.py b/rag/app/resume.py
index da620cb38be..7c556e06ed9 100644
--- a/rag/app/resume.py
+++ b/rag/app/resume.py
@@ -1,3 +1,6 @@
+#
+# Copyright 2025 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
@@ -10,6 +13,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.
#
+
import logging
import base64
import datetime
diff --git a/rag/app/table.py b/rag/app/table.py
index 88fceef787d..542edec7a68 100644
--- a/rag/app/table.py
+++ b/rag/app/table.py
@@ -1,3 +1,6 @@
+#
+# Copyright 2025 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
@@ -10,6 +13,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.
#
+
import copy
import re
from io import BytesIO
diff --git a/rag/app/tag.py b/rag/app/tag.py
index c1a15fafa3c..f5c29f2a818 100644
--- a/rag/app/tag.py
+++ b/rag/app/tag.py
@@ -1,3 +1,6 @@
+#
+# Copyright 2025 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
@@ -10,6 +13,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.
#
+
import re
import csv
from copy import deepcopy
diff --git a/rag/svr/jina_server.py b/rag/svr/jina_server.py
index 9dba8b55eb9..60bd0c8d8c7 100644
--- a/rag/svr/jina_server.py
+++ b/rag/svr/jina_server.py
@@ -1,3 +1,19 @@
+#
+# Copyright 2025 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.
+#
+
from jina import Deployment
from docarray import BaseDoc
from jina import Executor, requests
diff --git a/rag/utils/azure_sas_conn.py b/rag/utils/azure_sas_conn.py
index 8c1be4cd057..48f9d0a64ee 100644
--- a/rag/utils/azure_sas_conn.py
+++ b/rag/utils/azure_sas_conn.py
@@ -1,3 +1,19 @@
+#
+# Copyright 2025 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.
+#
+
import logging
import os
import time
diff --git a/rag/utils/azure_spn_conn.py b/rag/utils/azure_spn_conn.py
index c45ceb79527..625ccc4b541 100644
--- a/rag/utils/azure_spn_conn.py
+++ b/rag/utils/azure_spn_conn.py
@@ -1,3 +1,19 @@
+#
+# Copyright 2025 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.
+#
+
import logging
import os
import time
diff --git a/rag/utils/doc_store_conn.py b/rag/utils/doc_store_conn.py
index b8a20884109..c3fa61b0cda 100644
--- a/rag/utils/doc_store_conn.py
+++ b/rag/utils/doc_store_conn.py
@@ -1,3 +1,19 @@
+#
+# Copyright 2025 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.
+#
+
from abc import ABC, abstractmethod
from dataclasses import dataclass
import numpy as np
diff --git a/rag/utils/es_conn.py b/rag/utils/es_conn.py
index 1f959004552..c2b5fc22b80 100644
--- a/rag/utils/es_conn.py
+++ b/rag/utils/es_conn.py
@@ -1,3 +1,19 @@
+#
+# Copyright 2025 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.
+#
+
import logging
import re
import json
diff --git a/rag/utils/infinity_conn.py b/rag/utils/infinity_conn.py
index dd11b9ece27..57cbc34b2de 100644
--- a/rag/utils/infinity_conn.py
+++ b/rag/utils/infinity_conn.py
@@ -1,3 +1,19 @@
+#
+# Copyright 2025 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.
+#
+
import logging
import os
import re
diff --git a/rag/utils/minio_conn.py b/rag/utils/minio_conn.py
index 4662c7c8340..48f02b69997 100644
--- a/rag/utils/minio_conn.py
+++ b/rag/utils/minio_conn.py
@@ -1,3 +1,19 @@
+#
+# Copyright 2025 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.
+#
+
import logging
import time
from minio import Minio
diff --git a/rag/utils/redis_conn.py b/rag/utils/redis_conn.py
index 660e518734b..40779aa27a5 100644
--- a/rag/utils/redis_conn.py
+++ b/rag/utils/redis_conn.py
@@ -1,3 +1,19 @@
+#
+# Copyright 2025 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.
+#
+
import logging
import json
diff --git a/rag/utils/s3_conn.py b/rag/utils/s3_conn.py
index 03690d8ad06..d1e7e72697e 100644
--- a/rag/utils/s3_conn.py
+++ b/rag/utils/s3_conn.py
@@ -1,3 +1,19 @@
+#
+# Copyright 2025 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.
+#
+
import logging
import boto3
from botocore.exceptions import ClientError
diff --git a/rag/utils/storage_factory.py b/rag/utils/storage_factory.py
index 7c7a4a71de2..a27fda91a09 100644
--- a/rag/utils/storage_factory.py
+++ b/rag/utils/storage_factory.py
@@ -1,3 +1,19 @@
+#
+# Copyright 2025 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.
+#
+
import os
from enum import Enum
diff --git a/sdk/python/hello_ragflow.py b/sdk/python/hello_ragflow.py
index d258943b304..5b73cb81ba9 100644
--- a/sdk/python/hello_ragflow.py
+++ b/sdk/python/hello_ragflow.py
@@ -1,3 +1,19 @@
+#
+# Copyright 2025 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.
+#
+
import ragflow_sdk
-print(ragflow_sdk.__version__)
\ No newline at end of file
+print(ragflow_sdk.__version__)
diff --git a/sdk/python/ragflow_sdk/__init__.py b/sdk/python/ragflow_sdk/__init__.py
index b7cf31e1235..7535aa4eda1 100644
--- a/sdk/python/ragflow_sdk/__init__.py
+++ b/sdk/python/ragflow_sdk/__init__.py
@@ -1,3 +1,19 @@
+#
+# Copyright 2025 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.
+#
+
from beartype.claw import beartype_this_package
beartype_this_package()
diff --git a/sdk/python/ragflow_sdk/modules/__init__.py b/sdk/python/ragflow_sdk/modules/__init__.py
index e69de29bb2d..e156bc93dde 100644
--- a/sdk/python/ragflow_sdk/modules/__init__.py
+++ b/sdk/python/ragflow_sdk/modules/__init__.py
@@ -0,0 +1,15 @@
+#
+# Copyright 2025 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.
+#
\ No newline at end of file
diff --git a/sdk/python/ragflow_sdk/modules/agent.py b/sdk/python/ragflow_sdk/modules/agent.py
index 9ca3141281b..5579af98dca 100644
--- a/sdk/python/ragflow_sdk/modules/agent.py
+++ b/sdk/python/ragflow_sdk/modules/agent.py
@@ -1,3 +1,19 @@
+#
+# Copyright 2025 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.
+#
+
from .base import Base
from .session import Session
import requests
diff --git a/sdk/python/ragflow_sdk/modules/base.py b/sdk/python/ragflow_sdk/modules/base.py
index 49aa18db37f..5a6264f7903 100644
--- a/sdk/python/ragflow_sdk/modules/base.py
+++ b/sdk/python/ragflow_sdk/modules/base.py
@@ -1,3 +1,19 @@
+#
+# Copyright 2025 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.
+#
+
class Base(object):
def __init__(self, rag, res_dict):
self.rag = rag
diff --git a/sdk/python/ragflow_sdk/modules/chat.py b/sdk/python/ragflow_sdk/modules/chat.py
index 013bddd7ef2..e85011504d3 100644
--- a/sdk/python/ragflow_sdk/modules/chat.py
+++ b/sdk/python/ragflow_sdk/modules/chat.py
@@ -1,3 +1,19 @@
+#
+# Copyright 2025 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.
+#
+
from .base import Base
from .session import Session
@@ -44,12 +60,11 @@ def __init__(self, rag, res_dict):
def update(self, update_message: dict):
res = self.put(f'/chats/{self.id}',
- update_message)
+ update_message)
res = res.json()
if res.get("code") != 0:
raise Exception(res["message"])
-
def create_session(self, name: str = "New session") -> Session:
res = self.post(f"/chats/{self.id}/sessions", {"name": name})
res = res.json()
@@ -57,9 +72,10 @@ def create_session(self, name: str = "New session") -> Session:
return Session(self.rag, res['data'])
raise Exception(res["message"])
- def list_sessions(self,page: int = 1, page_size: int = 30, orderby: str = "create_time", desc: bool = True,
+ def list_sessions(self, page: int = 1, page_size: int = 30, orderby: str = "create_time", desc: bool = True,
id: str = None, name: str = None) -> list[Session]:
- res = self.get(f'/chats/{self.id}/sessions',{"page": page, "page_size": page_size, "orderby": orderby, "desc": desc, "id": id, "name": name} )
+ res = self.get(f'/chats/{self.id}/sessions',
+ {"page": page, "page_size": page_size, "orderby": orderby, "desc": desc, "id": id, "name": name})
res = res.json()
if res.get("code") == 0:
result_list = []
@@ -68,7 +84,7 @@ def list_sessions(self,page: int = 1, page_size: int = 30, orderby: str = "creat
return result_list
raise Exception(res["message"])
- def delete_sessions(self,ids: list[str] | None = None):
+ def delete_sessions(self, ids: list[str] | None = None):
res = self.rm(f"/chats/{self.id}/sessions", {"ids": ids})
res = res.json()
if res.get("code") != 0:
diff --git a/sdk/python/ragflow_sdk/modules/chunk.py b/sdk/python/ragflow_sdk/modules/chunk.py
index 960c87df6fb..4471b58afd2 100644
--- a/sdk/python/ragflow_sdk/modules/chunk.py
+++ b/sdk/python/ragflow_sdk/modules/chunk.py
@@ -1,3 +1,19 @@
+#
+# Copyright 2025 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.
+#
+
from .base import Base
@@ -18,11 +34,8 @@ def __init__(self, rag, res_dict):
res_dict.pop(k)
super().__init__(rag, res_dict)
-
- def update(self,update_message:dict):
- res = self.put(f"/datasets/{self.dataset_id}/documents/{self.document_id}/chunks/{self.id}",update_message)
+ def update(self, update_message: dict):
+ res = self.put(f"/datasets/{self.dataset_id}/documents/{self.document_id}/chunks/{self.id}", update_message)
res = res.json()
- if res.get("code") != 0 :
+ if res.get("code") != 0:
raise Exception(res["message"])
-
-
diff --git a/sdk/python/ragflow_sdk/modules/dataset.py b/sdk/python/ragflow_sdk/modules/dataset.py
index 043a600ef06..57d76d3aefa 100644
--- a/sdk/python/ragflow_sdk/modules/dataset.py
+++ b/sdk/python/ragflow_sdk/modules/dataset.py
@@ -1,3 +1,19 @@
+#
+# Copyright 2025 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.
+#
+
from .document import Document
from .base import Base
@@ -29,48 +45,51 @@ def __init__(self, rag, res_dict):
def update(self, update_message: dict):
res = self.put(f'/datasets/{self.id}',
- update_message)
+ update_message)
res = res.json()
if res.get("code") != 0:
raise Exception(res["message"])
- def upload_documents(self,document_list: list[dict]):
+ def upload_documents(self, document_list: list[dict]):
url = f"/datasets/{self.id}/documents"
- files = [("file",(ele["display_name"],ele["blob"])) for ele in document_list]
- res = self.post(path=url,json=None,files=files)
+ files = [("file", (ele["display_name"], ele["blob"])) for ele in document_list]
+ res = self.post(path=url, json=None, files=files)
res = res.json()
if res.get("code") == 0:
- doc_list=[]
+ doc_list = []
for doc in res["data"]:
- document = Document(self.rag,doc)
+ document = Document(self.rag, doc)
doc_list.append(document)
return doc_list
raise Exception(res.get("message"))
- def list_documents(self, id: str | None = None, keywords: str | None = None, page: int = 1, page_size: int = 30, orderby: str = "create_time", desc: bool = True):
- res = self.get(f"/datasets/{self.id}/documents",params={"id": id,"keywords": keywords,"page": page,"page_size": page_size,"orderby": orderby,"desc": desc})
+ def list_documents(self, id: str | None = None, keywords: str | None = None, page: int = 1, page_size: int = 30,
+ orderby: str = "create_time", desc: bool = True):
+ res = self.get(f"/datasets/{self.id}/documents",
+ params={"id": id, "keywords": keywords, "page": page, "page_size": page_size, "orderby": orderby,
+ "desc": desc})
res = res.json()
documents = []
if res.get("code") == 0:
for document in res["data"].get("docs"):
- documents.append(Document(self.rag,document))
+ documents.append(Document(self.rag, document))
return documents
raise Exception(res["message"])
- def delete_documents(self,ids: list[str] | None = None):
- res = self.rm(f"/datasets/{self.id}/documents",{"ids":ids})
+ def delete_documents(self, ids: list[str] | None = None):
+ res = self.rm(f"/datasets/{self.id}/documents", {"ids": ids})
res = res.json()
if res.get("code") != 0:
raise Exception(res["message"])
- def async_parse_documents(self,document_ids):
- res = self.post(f"/datasets/{self.id}/chunks",{"document_ids":document_ids})
+ def async_parse_documents(self, document_ids):
+ res = self.post(f"/datasets/{self.id}/chunks", {"document_ids": document_ids})
res = res.json()
if res.get("code") != 0:
raise Exception(res.get("message"))
- def async_cancel_parse_documents(self,document_ids):
- res = self.rm(f"/datasets/{self.id}/chunks",{"document_ids":document_ids})
+ def async_cancel_parse_documents(self, document_ids):
+ res = self.rm(f"/datasets/{self.id}/chunks", {"document_ids": document_ids})
res = res.json()
if res.get("code") != 0:
raise Exception(res.get("message"))
diff --git a/sdk/python/ragflow_sdk/modules/document.py b/sdk/python/ragflow_sdk/modules/document.py
index 743016b2355..bb3211d2420 100644
--- a/sdk/python/ragflow_sdk/modules/document.py
+++ b/sdk/python/ragflow_sdk/modules/document.py
@@ -1,3 +1,19 @@
+#
+# Copyright 2025 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.
+#
+
import json
from .base import Base
from .chunk import Chunk
@@ -32,7 +48,6 @@ def __init__(self, rag, res_dict):
res_dict.pop(k)
super().__init__(rag, res_dict)
-
def update(self, update_message: dict):
res = self.put(f'/datasets/{self.dataset_id}/documents/{self.id}',
update_message)
@@ -48,29 +63,28 @@ def download(self):
except json.JSONDecodeError:
return res.content
-
- def list_chunks(self,page=1, page_size=30, keywords=""):
- data={"keywords": keywords,"page":page,"page_size":page_size}
+ def list_chunks(self, page=1, page_size=30, keywords=""):
+ data = {"keywords": keywords, "page": page, "page_size": page_size}
res = self.get(f'/datasets/{self.dataset_id}/documents/{self.id}/chunks', data)
res = res.json()
if res.get("code") == 0:
- chunks=[]
+ chunks = []
for data in res["data"].get("chunks"):
- chunk = Chunk(self.rag,data)
+ chunk = Chunk(self.rag, data)
chunks.append(chunk)
return chunks
raise Exception(res.get("message"))
def add_chunk(self, content: str, important_keywords: list[str] = [], questions: list[str] = []):
res = self.post(f'/datasets/{self.dataset_id}/documents/{self.id}/chunks',
- {"content":content,"important_keywords":important_keywords, "questions": questions})
+ {"content": content, "important_keywords": important_keywords, "questions": questions})
res = res.json()
if res.get("code") == 0:
- return Chunk(self.rag,res["data"].get("chunk"))
+ return Chunk(self.rag, res["data"].get("chunk"))
raise Exception(res.get("message"))
- def delete_chunks(self,ids:list[str] | None = None):
- res = self.rm(f"/datasets/{self.dataset_id}/documents/{self.id}/chunks",{"chunk_ids":ids})
+ def delete_chunks(self, ids: list[str] | None = None):
+ res = self.rm(f"/datasets/{self.dataset_id}/documents/{self.id}/chunks", {"chunk_ids": ids})
res = res.json()
- if res.get("code")!=0:
- raise Exception(res.get("message"))
\ No newline at end of file
+ if res.get("code") != 0:
+ raise Exception(res.get("message"))
diff --git a/sdk/python/ragflow_sdk/modules/session.py b/sdk/python/ragflow_sdk/modules/session.py
index dcfc3392be3..9a1a7fd3dbc 100644
--- a/sdk/python/ragflow_sdk/modules/session.py
+++ b/sdk/python/ragflow_sdk/modules/session.py
@@ -1,3 +1,19 @@
+#
+# Copyright 2025 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.
+#
+
import json
from .base import Base
@@ -8,8 +24,8 @@ def __init__(self, rag, res_dict):
self.id = None
self.name = "New session"
self.messages = [{"role": "assistant", "content": "Hi! I am your assistant，can I help you?"}]
- for key,value in res_dict.items():
- if key =="chat_id" and value is not None:
+ for key, value in res_dict.items():
+ if key == "chat_id" and value is not None:
self.chat_id = None
self.__session_type = "chat"
if key == "agent_id" and value is not None:
@@ -17,11 +33,11 @@ def __init__(self, rag, res_dict):
self.__session_type = "agent"
super().__init__(rag, res_dict)
- def ask(self, question="",stream=True,**kwargs):
+ def ask(self, question="", stream=True, **kwargs):
if self.__session_type == "agent":
- res=self._ask_agent(question,stream)
+ res = self._ask_agent(question, stream)
elif self.__session_type == "chat":
- res=self._ask_chat(question,stream,**kwargs)
+ res = self._ask_chat(question, stream, **kwargs)
for line in res.iter_lines():
line = line.decode("utf-8")
if line.startswith("{"):
@@ -44,25 +60,26 @@ def ask(self, question="",stream=True,**kwargs):
message = Message(self.rag, temp_dict)
yield message
- def _ask_chat(self, question: str, stream: bool,**kwargs):
- json_data={"question": question, "stream": True,"session_id":self.id}
+ def _ask_chat(self, question: str, stream: bool, **kwargs):
+ json_data = {"question": question, "stream": True, "session_id": self.id}
json_data.update(kwargs)
res = self.post(f"/chats/{self.chat_id}/completions",
json_data, stream=stream)
return res
- def _ask_agent(self,question:str,stream:bool):
+ def _ask_agent(self, question: str, stream: bool):
res = self.post(f"/agents/{self.agent_id}/completions",
- {"question": question, "stream": True,"session_id":self.id}, stream=stream)
+ {"question": question, "stream": True, "session_id": self.id}, stream=stream)
return res
- def update(self,update_message):
+ def update(self, update_message):
res = self.put(f"/chats/{self.chat_id}/sessions/{self.id}",
- update_message)
+ update_message)
res = res.json()
if res.get("code") != 0:
raise Exception(res.get("message"))
+
class Message(Base):
def __init__(self, rag, res_dict):
self.content = "Hi! I am your assistant，can I help you?"
diff --git a/sdk/python/test/conftest.py b/sdk/python/test/conftest.py
index 463d0a88133..423ee3d3198 100644
--- a/sdk/python/test/conftest.py
+++ b/sdk/python/test/conftest.py
@@ -1,41 +1,61 @@
+#
+# Copyright 2025 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.
+#
+
import os
import pytest
import requests
-
HOST_ADDRESS = os.getenv('HOST_ADDRESS', 'http://127.0.0.1:9380')
+
# def generate_random_email():
# return 'user_' + ''.join(random.choices(string.ascii_lowercase + string.digits, k=8))+'@1.com'
def generate_email():
return 'user_123@1.com'
+
EMAIL = generate_email()
# password is "123"
-PASSWORD='''ctAseGvejiaSWWZ88T/m4FQVOpQyUvP+x7sXtdv3feqZACiQleuewkUi35E16wSd5C5QcnkkcV9cYc8TKPTRZlxappDuirxghxoOvFcJxFU4ixLsD
+PASSWORD = '''ctAseGvejiaSWWZ88T/m4FQVOpQyUvP+x7sXtdv3feqZACiQleuewkUi35E16wSd5C5QcnkkcV9cYc8TKPTRZlxappDuirxghxoOvFcJxFU4ixLsD
fN33jCHRoDUW81IH9zjij/vaw8IbVyb6vuwg6MX6inOEBRRzVbRYxXOu1wkWY6SsI8X70oF9aeLFp/PzQpjoe/YbSqpTq8qqrmHzn9vO+yvyYyvmDsphXe
X8f7fp9c7vUsfOCkM+gHY3PadG+QHa7KI7mzTKgUTZImK6BZtfRBATDTthEUbbaTewY4H0MnWiCeeDhcbeQao6cFy1To8pE3RpmxnGnS8BsBn8w=='''
+
def register():
url = HOST_ADDRESS + "/v1/user/register"
name = "user"
- register_data = {"email":EMAIL,"nickname":name,"password":PASSWORD}
- res = requests.post(url=url,json=register_data)
+ register_data = {"email": EMAIL, "nickname": name, "password": PASSWORD}
+ res = requests.post(url=url, json=register_data)
res = res.json()
if res.get("code") != 0:
raise Exception(res.get("message"))
+
def login():
url = HOST_ADDRESS + "/v1/user/login"
- login_data = {"email":EMAIL,"password":PASSWORD}
- response=requests.post(url=url,json=login_data)
+ login_data = {"email": EMAIL, "password": PASSWORD}
+ response = requests.post(url=url, json=login_data)
res = response.json()
- if res.get("code")!=0:
+ if res.get("code") != 0:
raise Exception(res.get("message"))
auth = response.headers["Authorization"]
return auth
+
@pytest.fixture(scope="session")
def get_api_key_fixture():
try:
@@ -45,12 +65,13 @@ def get_api_key_fixture():
auth = login()
url = HOST_ADDRESS + "/v1/system/new_token"
auth = {"Authorization": auth}
- response = requests.post(url=url,headers=auth)
+ response = requests.post(url=url, headers=auth)
res = response.json()
if res.get("code") != 0:
raise Exception(res.get("message"))
return res["data"].get("token")
+
@pytest.fixture(scope="session")
def get_auth():
try:
@@ -60,6 +81,7 @@ def get_auth():
auth = login()
return auth
+
@pytest.fixture(scope="session")
def get_email():
return EMAIL
diff --git a/sdk/python/test/test_frontend_api/common.py b/sdk/python/test/test_frontend_api/common.py
index 1a8c174c53d..19aa6df456e 100644
--- a/sdk/python/test/test_frontend_api/common.py
+++ b/sdk/python/test/test_frontend_api/common.py
@@ -1,3 +1,19 @@
+#
+# Copyright 2025 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.
+#
+
import os
import requests
diff --git a/sdk/python/test/test_frontend_api/get_email.py b/sdk/python/test/test_frontend_api/get_email.py
index 923b82d2d21..181094f5add 100644
--- a/sdk/python/test/test_frontend_api/get_email.py
+++ b/sdk/python/test/test_frontend_api/get_email.py
@@ -1,3 +1,19 @@
+#
+# Copyright 2025 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.
+#
+
def test_get_email(get_email):
print("\nEmail account:",flush=True)
print(f"{get_email}\n",flush=True)
\ No newline at end of file
diff --git a/sdk/python/test/test_frontend_api/test_dataset.py b/sdk/python/test/test_frontend_api/test_dataset.py
index fe2de715a8c..3baaf4e8ca1 100644
--- a/sdk/python/test/test_frontend_api/test_dataset.py
+++ b/sdk/python/test/test_frontend_api/test_dataset.py
@@ -1,3 +1,19 @@
+#
+# Copyright 2025 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.
+#
+
from common import create_dataset, list_dataset, rm_dataset, update_dataset, DATASET_NAME_LIMIT
import re
import random
@@ -121,7 +137,8 @@ def test_update_different_params_dataset_success(get_auth):
print(f"found {len(dataset_list)} datasets")
dataset_id = dataset_list[0]
- json_req = {"kb_id": dataset_id, "name": "test_update_dataset", "description": "test", "permission": "me", "parser_id": "presentation",
+ json_req = {"kb_id": dataset_id, "name": "test_update_dataset", "description": "test", "permission": "me",
+ "parser_id": "presentation",
"language": "spanish"}
res = update_dataset(get_auth, json_req)
assert res.get("code") == 0, f"{res.get('message')}"
@@ -164,4 +181,3 @@ def test_update_different_params_dataset_fail(get_auth):
res = rm_dataset(get_auth, dataset_id)
assert res.get("code") == 0, f"{res.get('message')}"
print(f"{len(dataset_list)} datasets are deleted")
-
diff --git a/sdk/python/test/test_sdk_api/common.py b/sdk/python/test/test_sdk_api/common.py
index a5bc8ad32bc..fe6aa88b7b1 100644
--- a/sdk/python/test/test_sdk_api/common.py
+++ b/sdk/python/test/test_sdk_api/common.py
@@ -1,2 +1,19 @@
+#
+# Copyright 2025 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.
+#
+
import os
-HOST_ADDRESS=os.getenv('HOST_ADDRESS', 'http://127.0.0.1:9380')
\ No newline at end of file
+
+HOST_ADDRESS = os.getenv('HOST_ADDRESS', 'http://127.0.0.1:9380')
diff --git a/sdk/python/test/test_sdk_api/get_email.py b/sdk/python/test/test_sdk_api/get_email.py
index 923b82d2d21..7238922b703 100644
--- a/sdk/python/test/test_sdk_api/get_email.py
+++ b/sdk/python/test/test_sdk_api/get_email.py
@@ -1,3 +1,19 @@
+#
+# Copyright 2025 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.
+#
+
def test_get_email(get_email):
- print("\nEmail account:",flush=True)
- print(f"{get_email}\n",flush=True)
\ No newline at end of file
+ print("\nEmail account:", flush=True)
+ print(f"{get_email}\n", flush=True)
diff --git a/sdk/python/test/test_sdk_api/t_agent.py b/sdk/python/test/test_sdk_api/t_agent.py
index aa330e52bc9..2fcd0e535e7 100644
--- a/sdk/python/test/test_sdk_api/t_agent.py
+++ b/sdk/python/test/test_sdk_api/t_agent.py
@@ -1,11 +1,28 @@
-from ragflow_sdk import RAGFlow,Agent
+#
+# Copyright 2025 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.
+#
+
+from ragflow_sdk import RAGFlow, Agent
from common import HOST_ADDRESS
import pytest
+
@pytest.mark.skip(reason="")
def test_list_agents_with_success(get_api_key_fixture):
- API_KEY=get_api_key_fixture
- rag = RAGFlow(API_KEY,HOST_ADDRESS)
+ API_KEY = get_api_key_fixture
+ rag = RAGFlow(API_KEY, HOST_ADDRESS)
rag.list_agents()
@@ -13,7 +30,7 @@ def test_list_agents_with_success(get_api_key_fixture):
def test_converse_with_agent_with_success(get_api_key_fixture):
API_KEY = "ragflow-BkOGNhYjIyN2JiODExZWY5MzVhMDI0Mm"
agent_id = "ebfada2eb2bc11ef968a0242ac120006"
- rag = RAGFlow(API_KEY,HOST_ADDRESS)
+ rag = RAGFlow(API_KEY, HOST_ADDRESS)
lang = "Chinese"
file = "How is the weather tomorrow?"
- Agent.ask(agent_id=agent_id,rag=rag,lang=lang,file=file)
+ Agent.ask(agent_id=agent_id, rag=rag, lang=lang, file=file)
diff --git a/sdk/python/test/test_sdk_api/t_chat.py b/sdk/python/test/test_sdk_api/t_chat.py
index d1670ad8c0c..5b9ed4275a4 100644
--- a/sdk/python/test/test_sdk_api/t_chat.py
+++ b/sdk/python/test/test_sdk_api/t_chat.py
@@ -1,6 +1,23 @@
+#
+# Copyright 2025 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.
+#
+
from ragflow_sdk import RAGFlow
from common import HOST_ADDRESS
+
def test_create_chat_with_name(get_api_key_fixture):
API_KEY = get_api_key_fixture
rag = RAGFlow(API_KEY, HOST_ADDRESS)
@@ -8,10 +25,10 @@ def test_create_chat_with_name(get_api_key_fixture):
display_name = "ragflow.txt"
with open("test_data/ragflow.txt", "rb") as file:
blob = file.read()
- document = {"display_name":display_name,"blob":blob}
+ document = {"display_name": display_name, "blob": blob}
documents = []
documents.append(document)
- docs= kb.upload_documents(documents)
+ docs = kb.upload_documents(documents)
for doc in docs:
doc.add_chunk("This is a test to add chunk")
rag.create_chat("test_create_chat", dataset_ids=[kb.id])
@@ -50,6 +67,7 @@ def test_delete_chats_with_success(get_api_key_fixture):
chat = rag.create_chat("test_delete_chat", dataset_ids=[kb.id])
rag.delete_chats(ids=[chat.id])
+
def test_list_chats_with_success(get_api_key_fixture):
API_KEY = get_api_key_fixture
rag = RAGFlow(API_KEY, HOST_ADDRESS)
@@ -66,5 +84,3 @@ def test_list_chats_with_success(get_api_key_fixture):
rag.create_chat("test_list_1", dataset_ids=[kb.id])
rag.create_chat("test_list_2", dataset_ids=[kb.id])
rag.list_chats()
-
-
diff --git a/sdk/python/test/test_sdk_api/t_chunk.py b/sdk/python/test/test_sdk_api/t_chunk.py
index a07e682e9cc..df2bfcad315 100644
--- a/sdk/python/test/test_sdk_api/t_chunk.py
+++ b/sdk/python/test/test_sdk_api/t_chunk.py
@@ -1,13 +1,30 @@
+#
+# Copyright 2025 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.
+#
+
from ragflow_sdk import RAGFlow
from common import HOST_ADDRESS
from time import sleep
+
def test_parse_document_with_txt(get_api_key_fixture):
API_KEY = get_api_key_fixture
rag = RAGFlow(API_KEY, HOST_ADDRESS)
ds = rag.create_dataset(name="test_parse_document")
name = 'ragflow_test.txt'
- with open("test_data/ragflow_test.txt", "rb") as file :
+ with open("test_data/ragflow_test.txt", "rb") as file:
blob = file.read()
docs = ds.upload_documents([{"display_name": name, "blob": blob}])
doc = docs[0]
@@ -21,14 +38,15 @@ def test_parse_document_with_txt(get_api_key_fixture):
raise Exception("Run time ERROR: Document parsing did not complete in time.")
'''
+
def test_parse_and_cancel_document(get_api_key_fixture):
API_KEY = get_api_key_fixture
rag = RAGFlow(API_KEY, HOST_ADDRESS)
ds = rag.create_dataset(name="test_parse_and_cancel_document")
name = 'ragflow_test.txt'
- with open("test_data/ragflow_test.txt", "rb") as file :
+ with open("test_data/ragflow_test.txt", "rb") as file:
blob = file.read()
- docs=ds.upload_documents([{"display_name": name, "blob": blob}])
+ docs = ds.upload_documents([{"display_name": name, "blob": blob}])
doc = docs[0]
ds.async_parse_documents(document_ids=[doc.id])
sleep(1)
@@ -60,6 +78,7 @@ def test_bulk_parse_documents(get_api_key_fixture):
raise Exception("Run time ERROR: Bulk document parsing did not complete in time.")
'''
+
def test_list_chunks_with_success(get_api_key_fixture):
API_KEY = get_api_key_fixture
rag = RAGFlow(API_KEY, HOST_ADDRESS)
@@ -73,7 +92,7 @@ def test_list_chunks_with_success(get_api_key_fixture):
{'display_name': f'chunk_{i}.txt', 'blob': chunk} for i, chunk in enumerate(chunks)
]
'''
- documents =[{"display_name":"test_list_chunks_with_success.txt","blob":blob}]
+ documents = [{"display_name": "test_list_chunks_with_success.txt", "blob": blob}]
docs = ds.upload_documents(documents)
ids = [doc.id for doc in docs]
ds.async_parse_documents(ids)
@@ -103,7 +122,7 @@ def test_add_chunk_with_success(get_api_key_fixture):
{'display_name': f'chunk_{i}.txt', 'blob': chunk} for i, chunk in enumerate(chunks)
]
'''
- documents =[{"display_name":"test_list_chunks_with_success.txt","blob":blob}]
+ documents = [{"display_name": "test_list_chunks_with_success.txt", "blob": blob}]
docs = ds.upload_documents(documents)
doc = docs[0]
doc.add_chunk(content="This is a chunk addition test")
@@ -122,7 +141,7 @@ def test_delete_chunk_with_success(get_api_key_fixture):
{'display_name': f'chunk_{i}.txt', 'blob': chunk} for i, chunk in enumerate(chunks)
]
'''
- documents =[{"display_name":"test_delete_chunk_with_success.txt","blob":blob}]
+ documents = [{"display_name": "test_delete_chunk_with_success.txt", "blob": blob}]
docs = ds.upload_documents(documents)
doc = docs[0]
chunk = doc.add_chunk(content="This is a chunk addition test")
@@ -143,13 +162,14 @@ def test_update_chunk_content(get_api_key_fixture):
{'display_name': f'chunk_{i}.txt', 'blob': chunk} for i, chunk in enumerate(chunks)
]
'''
- documents =[{"display_name":"test_update_chunk_content_with_success.txt","blob":blob}]
+ documents = [{"display_name": "test_update_chunk_content_with_success.txt", "blob": blob}]
docs = ds.upload_documents(documents)
doc = docs[0]
chunk = doc.add_chunk(content="This is a chunk addition test")
# For Elasticsearch, the chunk is not searchable in shot time (~2s).
sleep(3)
- chunk.update({"content":"This is a updated content"})
+ chunk.update({"content": "This is a updated content"})
+
def test_update_chunk_available(get_api_key_fixture):
API_KEY = get_api_key_fixture
@@ -164,13 +184,13 @@ def test_update_chunk_available(get_api_key_fixture):
{'display_name': f'chunk_{i}.txt', 'blob': chunk} for i, chunk in enumerate(chunks)
]
'''
- documents =[{"display_name":"test_update_chunk_available_with_success.txt","blob":blob}]
+ documents = [{"display_name": "test_update_chunk_available_with_success.txt", "blob": blob}]
docs = ds.upload_documents(documents)
doc = docs[0]
chunk = doc.add_chunk(content="This is a chunk addition test")
# For Elasticsearch, the chunk is not searchable in shot time (~2s).
sleep(3)
- chunk.update({"available":0})
+ chunk.update({"available": 0})
def test_retrieve_chunks(get_api_key_fixture):
@@ -186,11 +206,11 @@ def test_retrieve_chunks(get_api_key_fixture):
{'display_name': f'chunk_{i}.txt', 'blob': chunk} for i, chunk in enumerate(chunks)
]
'''
- documents =[{"display_name":"test_retrieve_chunks.txt","blob":blob}]
+ documents = [{"display_name": "test_retrieve_chunks.txt", "blob": blob}]
docs = ds.upload_documents(documents)
doc = docs[0]
doc.add_chunk(content="This is a chunk addition test")
- rag.retrieve(dataset_ids=[ds.id],document_ids=[doc.id])
+ rag.retrieve(dataset_ids=[ds.id], document_ids=[doc.id])
rag.delete_datasets(ids=[ds.id])
# test different parameters for the retrieval
diff --git a/sdk/python/test/test_sdk_api/t_dataset.py b/sdk/python/test/test_sdk_api/t_dataset.py
index 288474409f8..7163e445cad 100644
--- a/sdk/python/test/test_sdk_api/t_dataset.py
+++ b/sdk/python/test/test_sdk_api/t_dataset.py
@@ -1,13 +1,31 @@
+#
+# Copyright 2025 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.
+#
+
from ragflow_sdk import RAGFlow
import random
import pytest
from common import HOST_ADDRESS
+
def test_create_dataset_with_name(get_api_key_fixture):
API_KEY = get_api_key_fixture
rag = RAGFlow(API_KEY, HOST_ADDRESS)
rag.create_dataset("test_create_dataset_with_name")
+
def test_create_dataset_with_duplicated_name(get_api_key_fixture):
API_KEY = get_api_key_fixture
rag = RAGFlow(API_KEY, HOST_ADDRESS)
@@ -16,12 +34,15 @@ def test_create_dataset_with_duplicated_name(get_api_key_fixture):
rag.create_dataset("test_create_dataset_with_duplicated_name")
assert str(exc_info.value) == "Duplicated dataset name in creating dataset."
+
def test_create_dataset_with_random_chunk_method(get_api_key_fixture):
API_KEY = get_api_key_fixture
rag = RAGFlow(API_KEY, HOST_ADDRESS)
- valid_chunk_methods = ["naive","manual","qa","table","paper","book","laws","presentation","picture","one","knowledge_graph","email"]
+ valid_chunk_methods = ["naive", "manual", "qa", "table", "paper", "book", "laws", "presentation", "picture", "one",
+ "knowledge_graph", "email"]
random_chunk_method = random.choice(valid_chunk_methods)
- rag.create_dataset("test_create_dataset_with_random_chunk_method",chunk_method=random_chunk_method)
+ rag.create_dataset("test_create_dataset_with_random_chunk_method", chunk_method=random_chunk_method)
+
def test_create_dataset_with_invalid_parameter(get_api_key_fixture):
API_KEY = get_api_key_fixture
@@ -30,7 +51,7 @@ def test_create_dataset_with_invalid_parameter(get_api_key_fixture):
"knowledge_graph", "email", "tag"]
chunk_method = "invalid_chunk_method"
with pytest.raises(Exception) as exc_info:
- rag.create_dataset("test_create_dataset_with_invalid_chunk_method",chunk_method=chunk_method)
+ rag.create_dataset("test_create_dataset_with_invalid_chunk_method", chunk_method=chunk_method)
assert str(exc_info.value) == f"'{chunk_method}' is not in {valid_chunk_methods}"
diff --git a/sdk/python/test/test_sdk_api/t_document.py b/sdk/python/test/test_sdk_api/t_document.py
index 056963aa0fd..733b9bb5a5b 100644
--- a/sdk/python/test/test_sdk_api/t_document.py
+++ b/sdk/python/test/test_sdk_api/t_document.py
@@ -1,17 +1,34 @@
+#
+# Copyright 2025 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.
+#
+
from ragflow_sdk import RAGFlow
from common import HOST_ADDRESS
import pytest
+
def test_upload_document_with_success(get_api_key_fixture):
API_KEY = get_api_key_fixture
rag = RAGFlow(API_KEY, HOST_ADDRESS)
ds = rag.create_dataset(name="test_upload_document")
blob = b"Sample document content for test."
with open("test_data/ragflow.txt", "rb") as file:
- blob_2=file.read()
+ blob_2 = file.read()
document_infos = []
- document_infos.append({"display_name": "test_1.txt","blob": blob})
- document_infos.append({"display_name": "test_2.txt","blob": blob_2})
+ document_infos.append({"display_name": "test_1.txt", "blob": blob})
+ document_infos.append({"display_name": "test_2.txt", "blob": blob_2})
ds.upload_documents(document_infos)
@@ -20,8 +37,8 @@ def test_update_document_with_success(get_api_key_fixture):
rag = RAGFlow(API_KEY, HOST_ADDRESS)
ds = rag.create_dataset(name="test_update_document")
blob = b"Sample document content for test."
- document_infos=[{"display_name":"test.txt","blob":blob}]
- docs=ds.upload_documents(document_infos)
+ document_infos = [{"display_name": "test.txt", "blob": blob}]
+ docs = ds.upload_documents(document_infos)
doc = docs[0]
doc.update({"chunk_method": "manual", "name": "manual.txt"})
@@ -31,10 +48,10 @@ def test_download_document_with_success(get_api_key_fixture):
rag = RAGFlow(API_KEY, HOST_ADDRESS)
ds = rag.create_dataset(name="test_download_document")
blob = b"Sample document content for test."
- document_infos=[{"display_name": "test_1.txt","blob": blob}]
- docs=ds.upload_documents(document_infos)
+ document_infos = [{"display_name": "test_1.txt", "blob": blob}]
+ docs = ds.upload_documents(document_infos)
doc = docs[0]
- with open("test_download.txt","wb+") as file:
+ with open("test_download.txt", "wb+") as file:
file.write(doc.download())
@@ -43,7 +60,7 @@ def test_list_documents_in_dataset_with_success(get_api_key_fixture):
rag = RAGFlow(API_KEY, HOST_ADDRESS)
ds = rag.create_dataset(name="test_list_documents")
blob = b"Sample document content for test."
- document_infos = [{"display_name": "test.txt","blob":blob}]
+ document_infos = [{"display_name": "test.txt", "blob": blob}]
ds.upload_documents(document_infos)
ds.list_documents(keywords="test", page=1, page_size=12)
@@ -54,113 +71,128 @@ def test_delete_documents_in_dataset_with_success(get_api_key_fixture):
ds = rag.create_dataset(name="test_delete_documents")
name = "test_delete_documents.txt"
blob = b"Sample document content for test."
- document_infos=[{"display_name": name, "blob": blob}]
+ document_infos = [{"display_name": name, "blob": blob}]
docs = ds.upload_documents(document_infos)
ds.delete_documents([docs[0].id])
+
# upload and parse the document with different in different parse method.
def test_upload_and_parse_pdf_documents_with_general_parse_method(get_api_key_fixture):
API_KEY = get_api_key_fixture
rag = RAGFlow(API_KEY, HOST_ADDRESS)
ds = rag.create_dataset(name="test_pdf_document")
with open("test_data/test.pdf", "rb") as file:
- blob=file.read()
- document_infos = [{"display_name": "test.pdf","blob": blob}]
- docs=ds.upload_documents(document_infos)
+ blob = file.read()
+ document_infos = [{"display_name": "test.pdf", "blob": blob}]
+ docs = ds.upload_documents(document_infos)
doc = docs[0]
ds.async_parse_documents([doc.id])
+
def test_upload_and_parse_docx_documents_with_general_parse_method(get_api_key_fixture):
API_KEY = get_api_key_fixture
rag = RAGFlow(API_KEY, HOST_ADDRESS)
ds = rag.create_dataset(name="test_docx_document")
with open("test_data/test.docx", "rb") as file:
- blob=file.read()
- document_infos = [{"display_name": "test.docx","blob": blob}]
- docs=ds.upload_documents(document_infos)
+ blob = file.read()
+ document_infos = [{"display_name": "test.docx", "blob": blob}]
+ docs = ds.upload_documents(document_infos)
doc = docs[0]
ds.async_parse_documents([doc.id])
+
+
def test_upload_and_parse_excel_documents_with_general_parse_method(get_api_key_fixture):
API_KEY = get_api_key_fixture
rag = RAGFlow(API_KEY, HOST_ADDRESS)
ds = rag.create_dataset(name="test_excel_document")
with open("test_data/test.xlsx", "rb") as file:
- blob=file.read()
- document_infos = [{"display_name": "test.xlsx","blob": blob}]
- docs=ds.upload_documents(document_infos)
+ blob = file.read()
+ document_infos = [{"display_name": "test.xlsx", "blob": blob}]
+ docs = ds.upload_documents(document_infos)
doc = docs[0]
ds.async_parse_documents([doc.id])
+
+
def test_upload_and_parse_ppt_documents_with_general_parse_method(get_api_key_fixture):
API_KEY = get_api_key_fixture
rag = RAGFlow(API_KEY, HOST_ADDRESS)
ds = rag.create_dataset(name="test_ppt_document")
with open("test_data/test.ppt", "rb") as file:
- blob=file.read()
- document_infos = [{"display_name": "test.ppt","blob": blob}]
- docs=ds.upload_documents(document_infos)
+ blob = file.read()
+ document_infos = [{"display_name": "test.ppt", "blob": blob}]
+ docs = ds.upload_documents(document_infos)
doc = docs[0]
ds.async_parse_documents([doc.id])
+
+
def test_upload_and_parse_image_documents_with_general_parse_method(get_api_key_fixture):
API_KEY = get_api_key_fixture
rag = RAGFlow(API_KEY, HOST_ADDRESS)
ds = rag.create_dataset(name="test_image_document")
with open("test_data/test.jpg", "rb") as file:
- blob=file.read()
- document_infos = [{"display_name": "test.jpg","blob": blob}]
- docs=ds.upload_documents(document_infos)
+ blob = file.read()
+ document_infos = [{"display_name": "test.jpg", "blob": blob}]
+ docs = ds.upload_documents(document_infos)
doc = docs[0]
ds.async_parse_documents([doc.id])
+
+
def test_upload_and_parse_txt_documents_with_general_parse_method(get_api_key_fixture):
API_KEY = get_api_key_fixture
rag = RAGFlow(API_KEY, HOST_ADDRESS)
ds = rag.create_dataset(name="test_txt_document")
with open("test_data/test.txt", "rb") as file:
- blob=file.read()
- document_infos = [{"display_name": "test.txt","blob": blob}]
- docs=ds.upload_documents(document_infos)
+ blob = file.read()
+ document_infos = [{"display_name": "test.txt", "blob": blob}]
+ docs = ds.upload_documents(document_infos)
doc = docs[0]
ds.async_parse_documents([doc.id])
+
+
def test_upload_and_parse_md_documents_with_general_parse_method(get_api_key_fixture):
API_KEY = get_api_key_fixture
rag = RAGFlow(API_KEY, HOST_ADDRESS)
ds = rag.create_dataset(name="test_md_document")
with open("test_data/test.md", "rb") as file:
- blob=file.read()
- document_infos = [{"display_name": "test.md","blob": blob}]
- docs=ds.upload_documents(document_infos)
+ blob = file.read()
+ document_infos = [{"display_name": "test.md", "blob": blob}]
+ docs = ds.upload_documents(document_infos)
doc = docs[0]
ds.async_parse_documents([doc.id])
+
def test_upload_and_parse_json_documents_with_general_parse_method(get_api_key_fixture):
API_KEY = get_api_key_fixture
rag = RAGFlow(API_KEY, HOST_ADDRESS)
ds = rag.create_dataset(name="test_json_document")
with open("test_data/test.json", "rb") as file:
- blob=file.read()
- document_infos = [{"display_name": "test.json","blob": blob}]
- docs=ds.upload_documents(document_infos)
+ blob = file.read()
+ document_infos = [{"display_name": "test.json", "blob": blob}]
+ docs = ds.upload_documents(document_infos)
doc = docs[0]
ds.async_parse_documents([doc.id])
+
@pytest.mark.skip(reason="")
def test_upload_and_parse_eml_documents_with_general_parse_method(get_api_key_fixture):
API_KEY = get_api_key_fixture
rag = RAGFlow(API_KEY, HOST_ADDRESS)
ds = rag.create_dataset(name="test_eml_document")
with open("test_data/test.eml", "rb") as file:
- blob=file.read()
- document_infos = [{"display_name": "test.eml","blob": blob}]
- docs=ds.upload_documents(document_infos)
+ blob = file.read()
+ document_infos = [{"display_name": "test.eml", "blob": blob}]
+ docs = ds.upload_documents(document_infos)
doc = docs[0]
ds.async_parse_documents([doc.id])
+
def test_upload_and_parse_html_documents_with_general_parse_method(get_api_key_fixture):
API_KEY = get_api_key_fixture
rag = RAGFlow(API_KEY, HOST_ADDRESS)
ds = rag.create_dataset(name="test_html_document")
with open("test_data/test.html", "rb") as file:
- blob=file.read()
- document_infos = [{"display_name": "test.html","blob": blob}]
- docs=ds.upload_documents(document_infos)
+ blob = file.read()
+ document_infos = [{"display_name": "test.html", "blob": blob}]
+ docs = ds.upload_documents(document_infos)
doc = docs[0]
- ds.async_parse_documents([doc.id])
\ No newline at end of file
+ ds.async_parse_documents([doc.id])
diff --git a/sdk/python/test/test_sdk_api/t_session.py b/sdk/python/test/test_sdk_api/t_session.py
index c4c064b84f4..40932fdad08 100644
--- a/sdk/python/test/test_sdk_api/t_session.py
+++ b/sdk/python/test/test_sdk_api/t_session.py
@@ -1,4 +1,20 @@
-from ragflow_sdk import RAGFlow,Agent
+#
+# Copyright 2025 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.
+#
+
+from ragflow_sdk import RAGFlow, Agent
from common import HOST_ADDRESS
import pytest
@@ -10,13 +26,13 @@ def test_create_session_with_success(get_api_key_fixture):
display_name = "ragflow.txt"
with open("test_data/ragflow.txt", "rb") as file:
blob = file.read()
- document = {"display_name":display_name,"blob":blob}
+ document = {"display_name": display_name, "blob": blob}
documents = []
documents.append(document)
- docs= kb.upload_documents(documents)
+ docs = kb.upload_documents(documents)
for doc in docs:
doc.add_chunk("This is a test to add chunk")
- assistant=rag.create_chat("test_create_session", dataset_ids=[kb.id])
+ assistant = rag.create_chat("test_create_session", dataset_ids=[kb.id])
assistant.create_session()
@@ -38,7 +54,7 @@ def test_create_conversation_with_success(get_api_key_fixture):
question = "What is AI"
for ans in session.ask(question):
pass
-
+
# assert not ans.content.startswith("**ERROR**"), "Please check this error."
@@ -49,13 +65,13 @@ def test_delete_sessions_with_success(get_api_key_fixture):
display_name = "ragflow.txt"
with open("test_data/ragflow.txt", "rb") as file:
blob = file.read()
- document = {"display_name":display_name,"blob":blob}
+ document = {"display_name": display_name, "blob": blob}
documents = []
documents.append(document)
- docs= kb.upload_documents(documents)
+ docs = kb.upload_documents(documents)
for doc in docs:
doc.add_chunk("This is a test to add chunk")
- assistant=rag.create_chat("test_delete_session", dataset_ids=[kb.id])
+ assistant = rag.create_chat("test_delete_session", dataset_ids=[kb.id])
session = assistant.create_session()
assistant.delete_sessions(ids=[session.id])
@@ -85,33 +101,36 @@ def test_list_sessions_with_success(get_api_key_fixture):
display_name = "ragflow.txt"
with open("test_data/ragflow.txt", "rb") as file:
blob = file.read()
- document = {"display_name":display_name,"blob":blob}
+ document = {"display_name": display_name, "blob": blob}
documents = []
documents.append(document)
- docs= kb.upload_documents(documents)
+ docs = kb.upload_documents(documents)
for doc in docs:
doc.add_chunk("This is a test to add chunk")
- assistant=rag.create_chat("test_list_session", dataset_ids=[kb.id])
+ assistant = rag.create_chat("test_list_session", dataset_ids=[kb.id])
assistant.create_session("test_1")
assistant.create_session("test_2")
assistant.list_sessions()
+
@pytest.mark.skip(reason="")
def test_create_agent_session_with_success(get_api_key_fixture):
API_KEY = "ragflow-BkOGNhYjIyN2JiODExZWY5MzVhMDI0Mm"
- rag = RAGFlow(API_KEY,HOST_ADDRESS)
+ rag = RAGFlow(API_KEY, HOST_ADDRESS)
Agent.create_session("2e45b5209c1011efa3e90242ac120006", rag)
+
@pytest.mark.skip(reason="")
def test_create_agent_conversation_with_success(get_api_key_fixture):
API_KEY = "ragflow-BkOGNhYjIyN2JiODExZWY5MzVhMDI0Mm"
- rag = RAGFlow(API_KEY,HOST_ADDRESS)
+ rag = RAGFlow(API_KEY, HOST_ADDRESS)
session = Agent.create_session("2e45b5209c1011efa3e90242ac120006", rag)
session.ask("What is this job")
+
@pytest.mark.skip(reason="")
def test_list_agent_sessions_with_success(get_api_key_fixture):
API_KEY = "ragflow-BkOGNhYjIyN2JiODExZWY5MzVhMDI0Mm"
agent_id = "2710f2269b4611ef8fdf0242ac120006"
- rag = RAGFlow(API_KEY,HOST_ADDRESS)
- Agent.list_sessions(agent_id,rag)
+ rag = RAGFlow(API_KEY, HOST_ADDRESS)
+ Agent.list_sessions(agent_id, rag)
diff --git a/web/src/components/rename-dialog/index.tsx b/web/src/components/rename-dialog/index.tsx
index 369b726fa87..97c48f0e685 100644
--- a/web/src/components/rename-dialog/index.tsx
+++ b/web/src/components/rename-dialog/index.tsx
@@ -1,49 +1,39 @@
-import { Button } from '@/components/ui/button';
import {
Dialog,
DialogContent,
DialogFooter,
DialogHeader,
DialogTitle,
- DialogTrigger,
} from '@/components/ui/dialog';
-import { Input } from '@/components/ui/input';
-import { Label } from '@/components/ui/label';
+import { LoadingButton } from '@/components/ui/loading-button';
+import { IModalProps } from '@/interfaces/common';
+import { TagRenameId } from '@/pages/add-knowledge/constant';
+import { useTranslation } from 'react-i18next';
+import { RenameForm } from './rename-form';
+
+export function RenameDialog({
+ hideModal,
+ initialName,
+ onOk,
+ loading,
+}: IModalProps