doc(ai): sync hugegraph-llm with main - #481
Open
bitflicker64 wants to merge 1 commit into
Open
Conversation
Align the hugegraph-ai overview, HugeGraph-LLM, workflow, REST API and configuration pages with the code on hugegraph-ai main (1.7.0): correct Python and HugeGraph Server ranges, document the uv extras, container images and Helm chart, add CUR_VECTOR_INDEX and HUGEGRAPH_LLM_ENV_PATH, fix the Template Num semantics, and fill in missing request fields, status codes and UI features.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Syncs all five HugeGraph-LLM doc pages (en and cn) with
apache/hugegraph-ai@mainat version 1.7.0. Every change below traces to a file onmain. Paths underhugegraph-llm/src/hugegraph_llm/are abbreviated after the first use._index.mdhugegraph-llmandhugegraph-python-client;hugegraph-mlandvermeer-python-clientare editable path depspyproject.toml:87-97_index.md1.7.0pyproject.toml:20_index.mdhugegraph-ml/pyproject.toml:32,hugegraph-python-client/pyproject.toml:27,vermeer-python-client/pyproject.toml:27_index.md,hugegraph-llm.mdhugegraph-llm/README.md:22_index.mdllmandmlextras mentionedllm,ml,python-client,vermeer,dev,nk-llm,all, plus the module-levelvectordbpyproject.toml:37-54,hugegraph-llm/pyproject.toml:69-73_index.md,hugegraph-llm.mdquick_start.mdwas not linked from anywhere on the sitehugegraph-llm/quick_start.mdhugegraph-llm.md>=3.10,<3.12made explicithugegraph-llm/pyproject.toml:30hugegraph-llm.md.envbind mount${PROJECT_PATH}/hugegraph-llm/.envto/home/work/hugegraph-llm/.envmount and the optional resources mountdocker/docker-compose-network.yml:32-36hugegraph-llm.mdhugegraph/rag(Dockerfile.llm) andhugegraph/rag-bin(Dockerfile.nk, Nuitka), ports, non-root user, volume, health checkdocker/Dockerfile.llm:37-47,docker/Dockerfile.nk:17-49,hugegraph-llm/README.md:69-70hugegraph-llm.mdscripts/build_llm_image.shbuilds and tagshugegraph/graphrag:1.7.0scripts/build_llm_image.sh:21-29hugegraph-llm.mdhugegraph/graphragimage, NodePort 8039 / service 8080 / target 8001, fixed namehg-llm-service, disabled ingress and HPA, config-map instructions, and the staleimage.tagdefaultv0.0.1docker/charts/hg-llm/values.yaml:9-14,20,34-45,79-85,88-89,128-132hugegraph-llm.mdHG_DEV_RELOADundocumenteddemo/rag_demo/app.py:208hugegraph-llm.md,config-reference.md.envpath presented as fixed athugegraph-llm/.envHUGEGRAPH_LLM_ENV_PATHconfig/models/base_config.py:28,41-50hugegraph-llm.md,quick_start.md.txt,.docx,.pdf, multi-select; encrypted and OCR-less PDFs rejectedutils/vector_index_utils.py:33-56,66-81hugegraph-llm.md,quick_start.mddemo/rag_demo/vector_graph_block.py:269-295,413-433hugegraph-llm.md,quick_start.mdGraph Extraction Split Typecontrol missingdocument/paragraph/sentence)demo/rag_demo/vector_graph_block.py:403-407hugegraph-llm.md,quick_start.md.xlsx/.csvupload,Max Lines To Show, template download, downloadable answersdemo/rag_demo/rag_block.py:440-463hugegraph-llm.md,quick_start.md.json/.csvpairs file, defaultresources/demo/text2gremlin.csvdemo/rag_demo/text2gremlin_block.py:90,107-110,247-249hugegraph-llm.md,quick_start.mddemo/rag_demo/other_block.py:31-50,demo/rag_demo/admin_block.py:73-107,131-146hugegraph-llm.md,quick_start.mddemo/rag_demo/other_block.py:53-72hugegraph-llm.md,config-reference.mdCUR_VECTOR_INDEX=Faiss/Milvus/Qdrant, defaultFaiss, also exposed in UI panel 5config/index_config.py:36,utils/vector_index_utils.py:118-140,demo/rag_demo/configs_block.py:710-717hugegraph-llm.mdSchedulerSingleton.schedule_flowexample, all 13 flow names, andschedule_stream_flowflows/scheduler.py:106,143,188-198,flows/__init__.py:21-34,hugegraph-llm/README.md:186-251hugegraph-llm.md./style/code_format_and_analysis.sh(runsblack, which is not in thedevextra) and barepytestuv sync --extra llm --extra dev,uv run ruff format --check .andruff check ., and the twoSKIP_EXTERNAL_SERVICES=truepytest splits; added pre-commitstyle/code_format_and_analysis.sh:44-56,pyproject.toml:42-51,hugegraph-llm/AGENTS.md:32,38-43,README.md:26-33quick_start.mddemo/rag_demo/configs_block.py:319,353,588,659,710quick_start.md< 0skips Text2Gremlin entirely and goes to the predefined traversal;0is zero-shot;> 0uses templates, clamped to 0-10nodes/hugegraph_node/graph_query_node.py:146-149,441-445,nodes/index_node/gremlin_example_index_query.py:41-47,demo/rag_demo/rag_block.py:306-309quick_start.mdLoad into GraphDBandUpdate Vid Embeddingrelationship unclearLoad into GraphDB (2)chainsupdate_vid_embeddingautomaticallydemo/rag_demo/vector_graph_block.py:521-523quick_start.mddemo/rag_demo/text2gremlin_block.py:264-283quick_start.md,rest-api.mdragwithUSER_TOKENas the password; the API uses Bearer and returns 401 withWWW-Authenticatedemo/rag_demo/app.py:53-62,165-191rest-api.mdapi/rag_api.py:136,179,235,242,265,280,297,api/admin_api.py:53,api/graph_extract_api.py:67rest-api.md/rag,/rag/graphand/text2gremlinreturn 400 on an empty query;/rag/graphreturns 400 on TypeError and 500 otherwiseapi/rag_api.py:140-144,184-188,223-233,302-306,320-327rest-api.mdgraph_ratio,rerank_method,near_neighbor_firstlisted without defaults0.5,bleu,falseadded; prompt fields named individuallyapi/models/rag_requests.py:44-46,64-73rest-api.md/rag/graphresponse keys incompletequeryandgraph_result_flag; noted thatget_vertex_onlyswapsmatch_vidsfor full vertex detailsapi/rag_api.py:204-220rest-api.md/graph/extractfieldsexample_prompt,extract_type,include_metamissing; no schema validation rulesapi/models/graph_extract_requests.py:34-104rest-api.md/graph/extractclient_configshape unstatedgraph,user,pwd,gs; extra fields forbidden; nourlfieldapi/models/graph_extract_requests.py:25-31rest-api.mdmeta"statusis alwayssucceeded;metastays empty unlessinclude_metais trueapi/models/graph_extract_responses.py:23-27,api/graph_extract_api.py:47-55rest-api.md/text2gremlinexample_numdefault unstated0, clamped 0-10; missing prompt placeholders fail validation and are namedapi/models/rag_requests.py:146,161-169,nodes/index_node/gremlin_example_index_query.py:41-45rest-api.md/config/graphfield defaults unstateduserandpwddefault to empty strings,gsis optionalapi/models/rag_requests.py:30-35rest-api.md/config/llmscope unstatedapi/rag_api.py:246-248rest-api.md/config/graphdoes notapi/rag_api.py:235-295rest-api.mdclient_configoverride behaviour vagueapi/rag_api.py:129-131rest-api.md/logsdescribed only as "must be a file name underlogs/"log_filedefault, the full rejection rules, the two distinct 403 paths, and that the response is atext/plaintail -fstream replaying the last 125 linesapi/admin_api.py:30-49,55-70,api/models/rag_requests.py:131-133,demo/rag_demo/admin_block.py:28-42config-reference.mdgenerate --updatebehaviour unstated--updatedefaults to true; writes HugeGraph, admin, LLM and index settings plus the prompt YAML; prompts before overwriting an existing.envconfig/generate.py:31-38,config/models/base_config.py:63-82config-reference.mdconfig/models/base_config.py:56-61config-reference.mdconfig/index_config.pyandconfig/models/base_config.pyconfig/index_config.py,config/models/base_config.py