Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Contributing to HugeGraph-AI

Thank you for your interest in contributing! Before submitting a pull request, please run the end-to-end integration tests locally to make sure nothing is broken.

## Prerequisites

1. **HugeGraph Server** running on `localhost:8080` (see [README.md](./README.md) for setup)
2. **Python 3.10+** with dependencies installed via `uv sync --extra llm`
3. **Proxy users**: If you have `http_proxy`/`https_proxy` set, make sure to exclude localhost:
```bash
export no_proxy=localhost,127.0.0.1
export NO_PROXY=localhost,127.0.0.1
```

## Running Integration Tests

```bash
# Activate the virtual environment
source .venv/bin/activate

# Run the end-to-end integration tests
cd hugegraph-llm
python -m pytest src/tests/integration/test_flows_integration.py -v
```

All 6 tests must pass before you submit your code:

| Test | What it verifies |
|------|-----------------|
| `test_build_knowledge_graph` | Vector index building, graph extraction, data import, and VID embedding update |
| `test_schema_generator` | Schema generation from text |
| `test_graph_extract_prompt` | Graph extraction prompt generation |
| `test_rag` | All RAG modes (raw, vector-only, graph-only, graph+vector) |
| `test_build_example_index` | Example vector index building for Text2Gremlin |
| `test_text_2_gremlin` | Natural language to Gremlin query translation |

## Submission Checklist

- [ ] Integration tests pass locally (`6 passed`)
- [ ] Code is formatted with `ruff format .`
- [ ] Linting passes with `ruff check .`
3 changes: 2 additions & 1 deletion hugegraph-llm/src/hugegraph_llm/utils/vector_index_utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
import gradio as gr

from hugegraph_llm.config import huge_settings, index_settings
from hugegraph_llm.flows import FlowName
from hugegraph_llm.flows.scheduler import SchedulerSingleton
from hugegraph_llm.indices.vector_index.base import VectorStoreBase
from hugegraph_llm.indices.vector_index.faiss_vector_store import FaissVectorIndex
Expand Down Expand Up @@ -83,7 +84,7 @@ def build_vector_index(input_file, input_text):
raise gr.Error("Please only choose one between file and text.")
texts = read_documents(input_file, input_text)
scheduler = SchedulerSingleton.get_instance()
return scheduler.schedule_flow("build_vector_index", texts)
return scheduler.schedule_flow(FlowName.BUILD_VECTOR_INDEX, texts)


def get_vector_index_class(vector_index_str: str) -> Type[VectorStoreBase]:
Expand Down
329 changes: 329 additions & 0 deletions hugegraph-llm/src/tests/integration/test_flows_integration.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,329 @@
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you 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 pytest
Comment thread
weijinglin marked this conversation as resolved.

from hugegraph_llm.config.prompt_config import PromptConfig
from hugegraph_llm.demo.rag_demo.rag_block import update_ui_configs
from hugegraph_llm.demo.rag_demo.text2gremlin_block import build_example_vector_index
from hugegraph_llm.demo.rag_demo.vector_graph_block import load_query_examples
from hugegraph_llm.flows import FlowName
from hugegraph_llm.flows.scheduler import SchedulerSingleton
from hugegraph_llm.utils.log import log


class TestFlowsIntegration:
"""Flow集成测试 - 验证各个Flow能正常执行不抛异常"""

@pytest.fixture(autouse=True)
def setup(self):
self.index_text = """
梁漱溟年轻时,一日,他与父亲梁济讨论当时一战欧洲的时局,梁济突然问道:“这个世界会好吗?”梁漱溟答:“我相信世界是一天一天往好里去的。”梁济叹道:“能好就好啊!”然后离家,三日后,梁济投湖自尽。晚年梁漱溟回忆自己的一生和跌宕起伏的近代社会,总结了一本书,书名就叫《这个世界会好吗?》。梁漱溟的回答与年轻时一致。但很多人特别是遗老遗少们总在回忆往日的时光,仿佛那是人类的黄金时代。如同鲁迅笔下的九斤老太,整日里念叨着“一代不如一代”。或者极端如梁济,对世界未来充满悲观,一死了之。在今天的时代,很多人认为“世界正变得越来越糟”,这其中不乏知名的知识分子。平克将这种情况称之为「进步恐惧症」,并总结为「认知偏差」。因为每天的新闻报道里总是充斥着战争、恐怖主义、犯罪、污染等坏消息,不是因为这些事情是主流,而是因为它们是热点,导致给人们的印象是世界越来越糟。所谓“好事不出门,坏事传千里”,而在互联网时代,发达的信息传播让坏事传播的更快更广。要纠正这种「可得性偏差」的方法是用数据说话。数字是最能反应趋势,看战争的比例、犯罪死亡人数在总人数的占比,就能看出犯罪是增加了,还是减少了。实际上,从各种数字显示,人类暴力事件在历史呈明显的下降趋势,这在平克之前发表的另一大部头著作《人性中的善良天使:暴力为什么会减少》中详细阐述过。世界变得更好了,说到底就是进步。
"""
self.scheduler = SchedulerSingleton.get_instance()

def test_build_knowledge_graph(self):
try:
res = self.scheduler.schedule_flow(FlowName.BUILD_VECTOR_INDEX, [self.index_text])
assert "chunks" in res, "The result of BUILD_VECTOR_INDEX flow should contain 'chunks' field"
log.info("✓ BUILD_VECTOR_INDEX flow executed successfully")

schema = """
{
"vertexlabels": [
{
"id": 1,
"name": "Person",
"id_strategy": "PRIMARY_KEY",
"primary_keys": [
"name"
],
"properties": [
"name",
"age",
"occupation"
]
},
{
"id": 2,
"name": "Book",
"id_strategy": "PRIMARY_KEY",
"primary_keys": [
"title"
],
"properties": [
"title",
"author",
"year"
]
},
{
"id": 3,
"name": "Concept",
"id_strategy": "PRIMARY_KEY",
"primary_keys": [
"name"
],
"properties": [
"name",
"description"
]
}
],
"edgelabels": [
{
"id": 1,
"name": "Wrote",
"source_label": "Person",
"target_label": "Book",
"properties": []
},
{
"id": 2,
"name": "Discussed",
"source_label": "Person",
"target_label": "Concept",
"properties": []
},
{
"id": 3,
"name": "Believes",
"source_label": "Person",
"target_label": "Concept",
"properties": []
}
]
}
"""

data = self.scheduler.schedule_flow(
FlowName.GRAPH_EXTRACT,
schema,
[self.index_text],
PromptConfig.extract_graph_prompt_EN,
"property_graph",
)
assert "vertices" in data, "The result of GRAPH_EXTRACT flow should contain 'vertices' field"
assert "edges" in data, "The result of GRAPH_EXTRACT flow should contain 'edges' field"
log.info("✓ GRAPH_EXTRACT flow executed successfully")

res = self.scheduler.schedule_flow(FlowName.IMPORT_GRAPH_DATA, data, schema)
assert res is not None, "The result of IMPORT_GRAPH_DATA flow should not be None"
log.info("✓ IMPORT_GRAPH_DATA flow executed successfully")

self.scheduler.schedule_flow(FlowName.UPDATE_VID_EMBEDDINGS)
log.info("✓ UPDATE_VID_EMBEDDING flow executed successfully")
except Exception as e:
pytest.fail(f"BUILD_VECTOR_INDEX flow failed: {e}")

def test_schema_generator(self):
try:
query_examples = load_query_examples()

few_shot = """
{
"vertexlabels": [
{
"id": 1,
"name": "person",
"id_strategy": "PRIMARY_KEY",
"primary_keys": [
"name"
],
"properties": [
"name",
"age",
"occupation"
]
},
{
"id": 2,
"name": "webpage",
"id_strategy": "PRIMARY_KEY",
"primary_keys": [
"name"
],
"properties": [
"name",
"url"
]
}
],
"edgelabels": [
{
"id": 1,
"name": "roommate",
"source_label": "person",
"target_label": "person",
"properties": [
Comment on lines +171 to +172

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

This try...except block should be removed for the same reasons as in test_build_knowledge_graph. It hinders debugging. Additionally, the error message is a copy-paste error and is incorrect. It should refer to the BUILD_SCHEMA flow, not BUILD_VECTOR_INDEX.

"date"
]
},
{
"id": 2,
"name": "link",
"source_label": "webpage",
"target_label": "person",
"properties": []
}
Comment on lines +181 to +182

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

This try...except block should also be removed. It hides valuable debugging information. The error message is another copy-paste error from test_build_knowledge_graph.

]
}
"""

self.scheduler.schedule_flow(FlowName.BUILD_SCHEMA, [self.index_text], query_examples, few_shot)
except Exception as e:
pytest.fail(f"BUILD_VECTOR_INDEX flow failed: {e}")
Comment thread
coderabbitai[bot] marked this conversation as resolved.

def test_graph_extract_prompt(self):
try:
scenario = "social relationships"
example_name = "Official Person-Relationship Extraction"

res = self.scheduler.schedule_flow(FlowName.PROMPT_GENERATE, self.index_text, scenario, example_name)
assert res is not None, "The result of PROMPT_GENERATE flow should not be None"
except Exception as e:
pytest.fail(f"BUILD_VECTOR_INDEX flow failed: {e}")
Comment thread
coderabbitai[bot] marked this conversation as resolved.

def test_rag(self):
query = "梁漱溟和梁济的关系是什么?"

raw_answer = True
vector_only_answer = False
graph_only_answer = False
graph_vector_answer = False
graph_ratio = 0.6
rerank_method = "bleu"
near_neighbor_first = False
custom_related_information = ""

graph_search, gremlin_prompt, vector_search = update_ui_configs(
PromptConfig.answer_prompt_EN,
custom_related_information,
graph_only_answer,
graph_vector_answer,
None,
PromptConfig.keywords_extract_prompt_EN,
query,
vector_only_answer,
)

res = self.scheduler.schedule_flow(
FlowName.RAG_RAW,
query=query,
vector_search=vector_search,
graph_search=graph_search,
raw_answer=raw_answer,
vector_only_answer=vector_only_answer,
graph_only_answer=graph_only_answer,
graph_vector_answer=graph_vector_answer,
graph_ratio=graph_ratio,
rerank_method=rerank_method,
near_neighbor_first=near_neighbor_first,
custom_related_information=custom_related_information,
answer_prompt=PromptConfig.answer_prompt_EN,
keywords_extract_prompt=PromptConfig.keywords_extract_prompt_EN,
gremlin_tmpl_num=-1,
gremlin_prompt=gremlin_prompt,
)
assert res is not None, "The result of RAG flow should not be None"

raw_answer = False
vector_only_answer = True
graph_only_answer = False
graph_vector_answer = False
res = self.scheduler.schedule_flow(
FlowName.RAG_VECTOR_ONLY,
query=query,
vector_search=vector_search,
graph_search=graph_search,
raw_answer=raw_answer,
vector_only_answer=vector_only_answer,
graph_only_answer=graph_only_answer,
graph_vector_answer=graph_vector_answer,
graph_ratio=graph_ratio,
rerank_method=rerank_method,
near_neighbor_first=near_neighbor_first,
custom_related_information=custom_related_information,
answer_prompt=PromptConfig.answer_prompt_EN,
keywords_extract_prompt=PromptConfig.keywords_extract_prompt_EN,
gremlin_tmpl_num=-1,
gremlin_prompt=gremlin_prompt,
)
assert res is not None, "The result of RAG flow should not be None"

raw_answer = False
vector_only_answer = False
graph_only_answer = True
graph_vector_answer = False
res = self.scheduler.schedule_flow(
FlowName.RAG_GRAPH_ONLY,
query=query,
vector_search=vector_search,
graph_search=graph_search,
raw_answer=raw_answer,
vector_only_answer=vector_only_answer,
graph_only_answer=graph_only_answer,
graph_vector_answer=graph_vector_answer,
graph_ratio=graph_ratio,
rerank_method=rerank_method,
near_neighbor_first=near_neighbor_first,
custom_related_information=custom_related_information,
answer_prompt=PromptConfig.answer_prompt_EN,
keywords_extract_prompt=PromptConfig.keywords_extract_prompt_EN,
gremlin_tmpl_num=-1,
gremlin_prompt=gremlin_prompt,
)
assert res is not None, "The result of RAG flow should not be None"

raw_answer = False
vector_only_answer = False
graph_only_answer = False
graph_vector_answer = True
res = self.scheduler.schedule_flow(
FlowName.RAG_GRAPH_VECTOR,
Comment on lines +184 to +297

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

This test can be significantly improved by using pytest.mark.parametrize to reduce code duplication. Currently, it repeats the call to schedule_flow four times with minor variations.

There's also a bug: update_ui_configs is called only once with initial boolean flags, so vector_search and graph_search are always False. This means the RAG flows are not being tested with the correct search modes.

The suggested refactoring uses parameterization to create a cleaner, more maintainable test and fixes the bug by ensuring update_ui_configs is called with the correct parameters for each test case.

    @pytest.mark.parametrize(
        "flow_name, raw_answer, vector_only_answer, graph_only_answer, graph_vector_answer",
        [
            (FlowName.RAG_RAW, True, False, False, False),
            (FlowName.RAG_VECTOR_ONLY, False, True, False, False),
            (FlowName.RAG_GRAPH_ONLY, False, False, True, False),
            (FlowName.RAG_GRAPH_VECTOR, False, False, False, True),
        ],
    )
    def test_rag(
        self,
        flow_name,
        raw_answer,
        vector_only_answer,
        graph_only_answer,
        graph_vector_answer,
    ):
        answer_prompt = """
        You are an expert in the fields of knowledge graphs and natural language processing.

        Please provide precise and accurate answers based on the following context information, which is sorted in order of importance from high to low, without using any fabricated knowledge.

        Given the context information and without using fictive knowledge,
        answer the following query in a concise and professional manner.
        Please write your answer using Markdown with MathJax syntax, where inline math is wrapped with `$...$`

        Context information is below.
        ---------------------
        {context_str}
        ---------------------
        Query: {query_str}
        Answer:

        """

        keywords_extract_prompt = """
        Instructions:
        Please perform the following tasks on the text below:
        1. Extract, evaluate, and rank keywords from the text:
        - Minimum 0, maximum MAX_KEYWORDS keywords.
        - Keywords should be complete semantic words or phrases, ensuring information completeness, without any changes to the English capitalization.
        - Assign an importance score to each keyword, as a float between 0.0 and 1.0. A higher score indicates a greater contribution to the core idea of the text.
        - Keywords may contain spaces, but must not contain commas or colons.
        - The final list of keywords must be sorted in descending order based on their importance score.
        2. Identify keywords that need rewriting:
        - From the extracted keywords, identify those that are ambiguous or lack information in the original context.
        3. Generate synonyms:
        - For these keywords that need rewriting, generate synonyms or similar terms in the given context.
        - Replace the corresponding keywords in the original text with generated synonyms.
        - If no suitable synonym exists for a keyword, keep the original keyword unchanged.

        Requirements:
        - Keywords should be meaningful and specific entities; avoid meaningless or overly broad terms, or single-character words (e.g., "items", "actions", "effects", "functions", "the", "he").
        - Prioritize extracting subjects, verbs, and objects; avoid function words or auxiliary words.
        - Maintain semantic integrity: Extracted keywords should preserve their semantic and informational completeness in the original context (e.g., "Apple computer" should be extracted as a whole, not split into "Apple" and "computer").
        - Avoid generalization: Do not expand into unrelated generalized categories.

        Notes:
        - Only consider context-relevant synonyms: Only consider semantic synonyms and words with similar meanings in the given context.
        - Adjust keyword length: If keywords are relatively broad, you can appropriately increase individual keyword length based on context (e.g., "illegal behavior" can be extracted as a single keyword, or as "illegal", but should not be split into "illegal" and "behavior").

        Output Format:
        - Output only one line, prefixed with KEYWORDS:, followed by a comma-separated list of items. Each item should be in the format keyword:importance_score(round to two decimal places). If a keyword has been replaced by a synonym, use the synonym as the keyword in the output.
        - Format example:
        KEYWORDS:keyword1:score1,keyword2:score2,...,keywordN:scoreN

        MAX_KEYWORDS: {max_keywords}
        Text:
        {question}

        """

        query = "梁漱溟和梁济的关系是什么?"

        graph_ratio = 0.6
        rerank_method = "bleu"
        near_neighbor_first = False
        custom_related_information = ""

        graph_search, gremlin_prompt, vector_search = update_ui_configs(
            answer_prompt,
            custom_related_information,
            graph_only_answer,
            graph_vector_answer,
            None,
            keywords_extract_prompt,
            query,
            vector_only_answer,
        )

        res = self.scheduler.schedule_flow(
            flow_name,
            query=query,
            vector_search=vector_search,
            graph_search=graph_search,
            raw_answer=raw_answer,
            vector_only_answer=vector_only_answer,
            graph_only_answer=graph_only_answer,
            graph_vector_answer=graph_vector_answer,
            graph_ratio=graph_ratio,
            rerank_method=rerank_method,
            near_neighbor_first=near_neighbor_first,
            custom_related_information=custom_related_information,
            answer_prompt=answer_prompt,
            keywords_extract_prompt=keywords_extract_prompt,
            gremlin_tmpl_num=-1,
            gremlin_prompt=gremlin_prompt,
        )
        assert res is not None, f"The result of {flow_name.value} flow should not be None"

query=query,
vector_search=vector_search,
graph_search=graph_search,
raw_answer=raw_answer,
vector_only_answer=vector_only_answer,
graph_only_answer=graph_only_answer,
graph_vector_answer=graph_vector_answer,
graph_ratio=graph_ratio,
rerank_method=rerank_method,
near_neighbor_first=near_neighbor_first,
custom_related_information=custom_related_information,
answer_prompt=PromptConfig.answer_prompt_EN,
keywords_extract_prompt=PromptConfig.keywords_extract_prompt_EN,
gremlin_tmpl_num=-1,
gremlin_prompt=gremlin_prompt,
)
assert res is not None, "The result of RAG flow should not be None"

def test_build_example_index(self):
res = build_example_vector_index(None)
assert "embed_dim" in res, "The result of build_example_vector_index should contain embed_dim"

def test_text_2_gremlin(self):
query = "梁漱溟和梁济的关系是什么?"
schema = "hugegraph"
example_num = 2

res = self.scheduler.schedule_flow(
FlowName.TEXT2GREMLIN, query, example_num, schema, PromptConfig.gremlin_generate_prompt_EN, None
)

assert res is not None, "The result of TEXT2GREMLIN flow should not be None"
Loading