pengjunjie/ragflow
1
0
Fork 1
mirror of https://github.com/infiniflow/ragflow.git synced 2025-12-08 20:42:30 +08:00
Code Issues Packages Projects Releases Wiki Activity

Refa: unify reference format of agent completion and OpenAI-compatible completion API (#9792)

Browse Source 
### What problem does this PR solve?

Unify reference format of agent completion and OpenAI-compatible
completion API.

### Type of change

- [x] Bug Fix (non-breaking change which fixes an issue)
- [x] Documentation Update
- [x] Refactoring
This commit is contained in:
Yongteng Lei
2025-08-28 16:55:28 +08:00
committed by GitHub
parent f89e55ec42
commit 0a954d720a
3 changed files with 326 additions and 86 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
api/apps/sdk/session.py
View File

@ -414,7 +414,7 @@ def agents_completion_openai_compatibility(tenant_id, agent_id):
tenant_id, tenant_id,
agent_id, agent_id,
question, question,
session_id=req.get("id", req.get("metadata", {}).get("id", "")), session_id=req.get("session_id", req.get("id", "") or req.get("metadata", {}).get("id", "")),
stream=True, stream=True,
**req, **req,
), ),
@ -432,7 +432,7 @@ def agents_completion_openai_compatibility(tenant_id, agent_id):
tenant_id, tenant_id,
agent_id, agent_id,
question, question,
session_id=req.get("id", req.get("metadata", {}).get("id", "")), session_id=req.get("session_id", req.get("id", "") or req.get("metadata", {}).get("id", "")),
stream=False, stream=False,
**req, **req,
) )
@ -445,7 +445,6 @@ def agents_completion_openai_compatibility(tenant_id, agent_id):
def agent_completions(tenant_id, agent_id): def agent_completions(tenant_id, agent_id):
req = request.json req = request.json
ans = {}
if req.get("stream", True): if req.get("stream", True):
def generate(): def generate():
@ -456,14 +455,13 @@ def agent_completions(tenant_id, agent_id):
except Exception: except Exception:
continue continue
if ans.get("event") != "message" or not ans.get("data", {}).get("reference", None): if ans.get("event") not in ["message", "message_end"]:
continue continue
yield answer yield answer
yield "data:[DONE]\n\n" yield "data:[DONE]\n\n"
if req.get("stream", True):
resp = Response(generate(), mimetype="text/event-stream") resp = Response(generate(), mimetype="text/event-stream")
resp.headers.add_header("Cache-control", "no-cache") resp.headers.add_header("Cache-control", "no-cache")
resp.headers.add_header("Connection", "keep-alive") resp.headers.add_header("Connection", "keep-alive")
@ -472,6 +470,8 @@ def agent_completions(tenant_id, agent_id):
return resp return resp
full_content = "" full_content = ""
reference = {}
final_ans = ""
for answer in agent_completion(tenant_id=tenant_id, agent_id=agent_id, **req): for answer in agent_completion(tenant_id=tenant_id, agent_id=agent_id, **req):
try: try:
ans = json.loads(answer[5:]) ans = json.loads(answer[5:])
@ -480,11 +480,14 @@ def agent_completions(tenant_id, agent_id):
full_content += ans["data"]["content"] full_content += ans["data"]["content"]
if ans.get("data", {}).get("reference", None): if ans.get("data", {}).get("reference", None):
ans["data"]["content"] = full_content reference.update(ans["data"]["reference"])
return get_result(data=ans)
final_ans = ans
except Exception as e: except Exception as e:
return get_result(data=f"**ERROR**: {str(e)}") return get_result(data=f"**ERROR**: {str(e)}")
return get_result(data=ans) final_ans["data"]["content"] = full_content
final_ans["data"]["reference"] = reference
return get_result(data=final_ans)
@manager.route("/chats/<chat_id>/sessions", methods=["GET"]) # noqa: F821 @manager.route("/chats/<chat_id>/sessions", methods=["GET"]) # noqa: F821

38
api/db/services/canvas_service.py
View File

@ -213,26 +213,33 @@ def completionOpenAI(tenant_id, agent_id, question, session_id=None, stream=True
except Exception as e: except Exception as e:
logging.exception(f"Agent OpenAI-Compatible completionOpenAI parse answer failed: {e}") logging.exception(f"Agent OpenAI-Compatible completionOpenAI parse answer failed: {e}")
continue continue
if ans.get("event") != "message" or not ans.get("data", {}).get("reference", None): if ans.get("event") not in ["message", "message_end"]:
continue continue
content_piece = ans["data"]["content"]
content_piece = ""
if ans["event"] == "message":
content_piece = ans["data"]["content"]
completion_tokens += len(tiktokenenc.encode(content_piece)) completion_tokens += len(tiktokenenc.encode(content_piece))
yield "data: " + json.dumps( openai_data = get_data_openai(
get_data_openai(
id=session_id or str(uuid4()), id=session_id or str(uuid4()),
model=agent_id, model=agent_id,
content=content_piece, content=content_piece,
prompt_tokens=prompt_tokens, prompt_tokens=prompt_tokens,
completion_tokens=completion_tokens, completion_tokens=completion_tokens,
stream=True stream=True
), )
ensure_ascii=False
) + "\n\n" if ans.get("data", {}).get("reference", None):
openai_data["choices"][0]["delta"]["reference"] = ans["data"]["reference"]
yield "data: " + json.dumps(openai_data, ensure_ascii=False) + "\n\n"
yield "data: [DONE]\n\n" yield "data: [DONE]\n\n"
except Exception as e: except Exception as e:
logging.exception(e)
yield "data: " + json.dumps( yield "data: " + json.dumps(
get_data_openai( get_data_openai(
id=session_id or str(uuid4()), id=session_id or str(uuid4()),
@ -250,6 +257,7 @@ def completionOpenAI(tenant_id, agent_id, question, session_id=None, stream=True
else: else:
try: try:
all_content = "" all_content = ""
reference = {}
for ans in completion( for ans in completion(
tenant_id=tenant_id, tenant_id=tenant_id,
agent_id=agent_id, agent_id=agent_id,
@ -260,13 +268,18 @@ def completionOpenAI(tenant_id, agent_id, question, session_id=None, stream=True
): ):
if isinstance(ans, str): if isinstance(ans, str):
ans = json.loads(ans[5:]) ans = json.loads(ans[5:])
if ans.get("event") != "message" or not ans.get("data", {}).get("reference", None): if ans.get("event") not in ["message", "message_end"]:
continue continue
all_content += ans["data"]["content"]
if ans["event"] == "message":
all_content += ans["data"]["content"]
if ans.get("data", {}).get("reference", None):
reference.update(ans["data"]["reference"])
completion_tokens = len(tiktokenenc.encode(all_content)) completion_tokens = len(tiktokenenc.encode(all_content))
yield get_data_openai( openai_data = get_data_openai(
id=session_id or str(uuid4()), id=session_id or str(uuid4()),
model=agent_id, model=agent_id,
prompt_tokens=prompt_tokens, prompt_tokens=prompt_tokens,
@ -276,7 +289,12 @@ def completionOpenAI(tenant_id, agent_id, question, session_id=None, stream=True
param=None param=None
) )
if reference:
openai_data["choices"][0]["message"]["reference"] = reference
yield openai_data
except Exception as e: except Exception as e:
logging.exception(e)
yield get_data_openai( yield get_data_openai(
id=session_id or str(uuid4()), id=session_id or str(uuid4()),
model=agent_id, model=agent_id,

355
docs/references/http_api_reference.md
View File

@ -143,7 +143,6 @@ Non-stream:
} }
``` ```
Failure: Failure:
```json ```json
@ -200,19 +199,24 @@ curl --request POST \
- `stream` (*Body parameter*) `boolean` - `stream` (*Body parameter*) `boolean`
Whether to receive the response as a stream. Set this to `false` explicitly if you prefer to receive the entire response in one go instead of as a stream. Whether to receive the response as a stream. Set this to `false` explicitly if you prefer to receive the entire response in one go instead of as a stream.
- `session_id` (*Body parameter*) `string`
Agent session id.
#### Response #### Response
Stream: Stream:
```json ```json
...
data: { data: {
"id": "5fa65c94-e316-4954-800a-06dfd5827052", "id": "c39f6f9c83d911f0858253708ecb6573",
"object": "chat.completion.chunk", "object": "chat.completion.chunk",
"model": "99ee29d6783511f09c921a6272e682d8", "model": "d1f79142831f11f09cc51795b9eb07c0",
"choices": [ "choices": [
{ {
"delta": { "delta": {
"content": "Hello" "content": " terminal"
}, },
"finish_reason": null, "finish_reason": null,
"index": 0 "index": 0
@ -220,21 +224,83 @@ data: {
] ]
} }
data: {"id": "518022d9-545b-4100-89ed-ecd9e46fa753", "object": "chat.completion.chunk", "model": "99ee29d6783511f09c921a6272e682d8", "choices": [{"delta": {"content": "!"}, "finish_reason": null, "index": 0}]} data: {
"id": "c39f6f9c83d911f0858253708ecb6573",
"object": "chat.completion.chunk",
"model": "d1f79142831f11f09cc51795b9eb07c0",
"choices": [
{
"delta": {
"content": "."
},
"finish_reason": null,
"index": 0
}
]
}
data: {"id": "f37c4af0-8187-4c86-8186-048c3c6ffe4e", "object": "chat.completion.chunk", "model": "99ee29d6783511f09c921a6272e682d8", "choices": [{"delta": {"content": " How"}, "finish_reason": null, "index": 0}]} data: {
"id": "c39f6f9c83d911f0858253708ecb6573",
data: {"id": "3ebc0fcb-0f85-4024-b4a5-3b03234a16df", "object": "chat.completion.chunk", "model": "99ee29d6783511f09c921a6272e682d8", "choices": [{"delta": {"content": " can"}, "finish_reason": null, "index": 0}]} "object": "chat.completion.chunk",
"model": "d1f79142831f11f09cc51795b9eb07c0",
data: {"id": "efa1f3cf-7bc4-47a4-8e53-cd696f290587", "object": "chat.completion.chunk", "model": "99ee29d6783511f09c921a6272e682d8", "choices": [{"delta": {"content": " I"}, "finish_reason": null, "index": 0}]} "choices": [
{
data: {"id": "2eb6f741-50a3-4d3d-8418-88be27895611", "object": "chat.completion.chunk", "model": "99ee29d6783511f09c921a6272e682d8", "choices": [{"delta": {"content": " assist"}, "finish_reason": null, "index": 0}]} "delta": {
"content": "",
data: {"id": "f1227e4f-bf8b-462c-8632-8f5269492ce9", "object": "chat.completion.chunk", "model": "99ee29d6783511f09c921a6272e682d8", "choices": [{"delta": {"content": " you"}, "finish_reason": null, "index": 0}]} "reference": {
"chunks": {
data: {"id": "35b669d0-b2be-4c0c-88d8-17ff98592b21", "object": "chat.completion.chunk", "model": "99ee29d6783511f09c921a6272e682d8", "choices": [{"delta": {"content": " today"}, "finish_reason": null, "index": 0}]} "20": {
"id": "4b8935ac0a22deb1",
data: {"id": "f00d8a39-af60-4f32-924f-d64106a7fdf1", "object": "chat.completion.chunk", "model": "99ee29d6783511f09c921a6272e682d8", "choices": [{"delta": {"content": "?"}, "finish_reason": null, "index": 0}]} "content": "```cd /usr/ports/editors/neovim/ && make install```## Android[Termux](https://github.com/termux/termux-app) offers a Neovim package.",
"document_id": "4bdd2ff65e1511f0907f09f583941b45",
"document_name": "INSTALL22.md",
"dataset_id": "456ce60c5e1511f0907f09f583941b45",
"image_id": "",
"positions": [
[
12,
11,
11,
11,
11
]
],
"url": null,
"similarity": 0.5697155305154673,
"vector_similarity": 0.7323851005515574,
"term_similarity": 0.5000000005,
"doc_type": ""
}
},
"doc_aggs": {
"INSTALL22.md": {
"doc_name": "INSTALL22.md",
"doc_id": "4bdd2ff65e1511f0907f09f583941b45",
"count": 3
},
"INSTALL.md": {
"doc_name": "INSTALL.md",
"doc_id": "4bd7fdd85e1511f0907f09f583941b45",
"count": 2
},
"INSTALL(1).md": {
"doc_name": "INSTALL(1).md",
"doc_id": "4bdfb42e5e1511f0907f09f583941b45",
"count": 2
},
"INSTALL3.md": {
"doc_name": "INSTALL3.md",
"doc_id": "4bdab5825e1511f0907f09f583941b45",
"count": 1
}
}
}
},
"finish_reason": null,
"index": 0
}
]
}
data: [DONE] data: [DONE]
``` ```
@ -249,30 +315,77 @@ Non-stream:
"index": 0, "index": 0,
"logprobs": null, "logprobs": null,
"message": { "message": {
"content": "Hello! How can I assist you today?", "content": "\nTo install Neovim, the process varies depending on your operating system:\n\n### For Windows:\n1. **Download from GitHub**: \n - Visit the [Neovim releases page](https://github.com/neovim/neovim/releases)\n - Download the latest Windows installer (nvim-win64.msi)\n - Run the installer and follow the prompts\n\n2. **Using winget** (Windows Package Manager):\n...",
"reference": {
"chunks": {
"20": {
"content": "```cd /usr/ports/editors/neovim/ && make install```## Android[Termux](https://github.com/termux/termux-app) offers a Neovim package.",
"dataset_id": "456ce60c5e1511f0907f09f583941b45",
"doc_type": "",
"document_id": "4bdd2ff65e1511f0907f09f583941b45",
"document_name": "INSTALL22.md",
"id": "4b8935ac0a22deb1",
"image_id": "",
"positions": [
[
12,
11,
11,
11,
11
]
],
"similarity": 0.5697155305154673,
"term_similarity": 0.5000000005,
"url": null,
"vector_similarity": 0.7323851005515574
}
},
"doc_aggs": {
"INSTALL(1).md": {
"count": 2,
"doc_id": "4bdfb42e5e1511f0907f09f583941b45",
"doc_name": "INSTALL(1).md"
},
"INSTALL.md": {
"count": 2,
"doc_id": "4bd7fdd85e1511f0907f09f583941b45",
"doc_name": "INSTALL.md"
},
"INSTALL22.md": {
"count": 3,
"doc_id": "4bdd2ff65e1511f0907f09f583941b45",
"doc_name": "INSTALL22.md"
},
"INSTALL3.md": {
"count": 1,
"doc_id": "4bdab5825e1511f0907f09f583941b45",
"doc_name": "INSTALL3.md"
}
}
},
"role": "assistant" "role": "assistant"
} }
} }
], ],
"created": null, "created": null,
"id": "17aa4ec5-6d36-40c6-9a96-1b069c216d59", "id": "c39f6f9c83d911f0858253708ecb6573",
"model": "99ee29d6783511f09c921a6272e682d8", "model": "d1f79142831f11f09cc51795b9eb07c0",
"object": "chat.completion", "object": "chat.completion",
"param": null, "param": null,
"usage": { "usage": {
"completion_tokens": 9, "completion_tokens": 415,
"completion_tokens_details": { "completion_tokens_details": {
"accepted_prediction_tokens": 0, "accepted_prediction_tokens": 0,
"reasoning_tokens": 0, "reasoning_tokens": 0,
"rejected_prediction_tokens": 0 "rejected_prediction_tokens": 0
}, },
"prompt_tokens": 1, "prompt_tokens": 6,
"total_tokens": 10 "total_tokens": 421
} }
} }
``` ```
Failure: Failure:
```json ```json
@ -729,6 +842,7 @@ Failure:
"message": "The dataset doesn't exist" "message": "The dataset doesn't exist"
} }
``` ```
--- ---
### Get knowledge graph ### Get knowledge graph
@ -808,6 +922,7 @@ Failure:
"message": "The dataset doesn't exist" "message": "The dataset doesn't exist"
} }
``` ```
--- ---
### Delete knowledge graph ### Delete knowledge graph
@ -855,6 +970,7 @@ Failure:
"message": "The dataset doesn't exist" "message": "The dataset doesn't exist"
} }
``` ```
--- ---
## FILE MANAGEMENT WITHIN DATASET ## FILE MANAGEMENT WITHIN DATASET
@ -3017,41 +3133,88 @@ success without `session_id` provided and with no variables specified in the **B
Stream: Stream:
```json ```json
data:{
"event": "message",
"message_id": "eb0c0a5e783511f0b9b61a6272e682d8",
"created_at": 1755083342,
"task_id": "99ee29d6783511f09c921a6272e682d8",
"data": {
"content": "Hello"
},
"session_id": "eaf19a8e783511f0b9b61a6272e682d8"
}
data:{
"event": "message",
"message_id": "eb0c0a5e783511f0b9b61a6272e682d8",
"created_at": 1755083342,
"task_id": "99ee29d6783511f09c921a6272e682d8",
"data": {
"content": "!"
},
"session_id": "eaf19a8e783511f0b9b61a6272e682d8"
}
data:{
"event": "message",
"message_id": "eb0c0a5e783511f0b9b61a6272e682d8",
"created_at": 1755083342,
"task_id": "99ee29d6783511f09c921a6272e682d8",
"data": {
"content": " How"
},
"session_id": "eaf19a8e783511f0b9b61a6272e682d8"
}
... ...
data: {
"event": "message",
"message_id": "cecdcb0e83dc11f0858253708ecb6573",
"created_at": 1756364483,
"task_id": "d1f79142831f11f09cc51795b9eb07c0",
"data": {
"content": " themes"
},
"session_id": "cd097ca083dc11f0858253708ecb6573"
}
data: {
"event": "message",
"message_id": "cecdcb0e83dc11f0858253708ecb6573",
"created_at": 1756364483,
"task_id": "d1f79142831f11f09cc51795b9eb07c0",
"data": {
"content": "."
},
"session_id": "cd097ca083dc11f0858253708ecb6573"
}
data: {
"event": "message_end",
"message_id": "cecdcb0e83dc11f0858253708ecb6573",
"created_at": 1756364483,
"task_id": "d1f79142831f11f09cc51795b9eb07c0",
"data": {
"reference": {
"chunks": {
"20": {
"id": "4b8935ac0a22deb1",
"content": "```cd /usr/ports/editors/neovim/ && make install```## Android[Termux](https://github.com/termux/termux-app) offers a Neovim package.",
"document_id": "4bdd2ff65e1511f0907f09f583941b45",
"document_name": "INSTALL22.md",
"dataset_id": "456ce60c5e1511f0907f09f583941b45",
"image_id": "",
"positions": [
[
12,
11,
11,
11,
11
]
],
"url": null,
"similarity": 0.5705525104787287,
"vector_similarity": 0.7351750337624289,
"term_similarity": 0.5000000005,
"doc_type": ""
}
},
"doc_aggs": {
"INSTALL22.md": {
"doc_name": "INSTALL22.md",
"doc_id": "4bdd2ff65e1511f0907f09f583941b45",
"count": 3
},
"INSTALL.md": {
"doc_name": "INSTALL.md",
"doc_id": "4bd7fdd85e1511f0907f09f583941b45",
"count": 2
},
"INSTALL(1).md": {
"doc_name": "INSTALL(1).md",
"doc_id": "4bdfb42e5e1511f0907f09f583941b45",
"count": 2
},
"INSTALL3.md": {
"doc_name": "INSTALL3.md",
"doc_id": "4bdab5825e1511f0907f09f583941b45",
"count": 1
}
}
}
},
"session_id": "cd097ca083dc11f0858253708ecb6573"
}
data:[DONE] data:[DONE]
``` ```
@ -3061,21 +3224,77 @@ Non-stream:
{ {
"code": 0, "code": 0,
"data": { "data": {
"created_at": 1755083440, "created_at": 1756363177,
"data": { "data": {
"created_at": 547061.147866385, "content": "\nTo install Neovim, the process varies depending on your operating system:\n\n### For macOS:\nUsing Homebrew:\n```bash\nbrew install neovim\n```\n\n### For Linux (Debian/Ubuntu):\n```bash\nsudo apt update\nsudo apt install neovim\n```\n\nFor other Linux distributions, you can use their respective package managers or build from source.\n\n### For Windows:\n1. Download the latest Windows installer from the official Neovim GitHub releases page\n2. Run the installer and follow the prompts\n3. Add Neovim to your PATH if not done automatically\n\n### From source (Unix-like systems):\n```bash\ngit clone https://github.com/neovim/neovim.git\ncd neovim\nmake CMAKE_BUILD_TYPE=Release\nsudo make install\n```\n\nAfter installation, you can verify it by running `nvim --version` in your terminal.",
"elapsed_time": 2.595433341921307, "created_at": 18129.044975627,
"inputs": {}, "elapsed_time": 10.0157331670016,
"inputs": {
"var1": {
"value": "I am var1"
},
"var2": {
"value": "I am var2"
}
},
"outputs": { "outputs": {
"_created_time": 547061.149137775, "_created_time": 18129.502422278,
"_elapsed_time": 8.720310870558023e-05, "_elapsed_time": 0.00013378599760471843,
"content": "Hello! How can I assist you today?" "content": "\nTo install Neovim, the process varies depending on your operating system:\n\n### For macOS:\nUsing Homebrew:\n```bash\nbrew install neovim\n```\n\n### For Linux (Debian/Ubuntu):\n```bash\nsudo apt update\nsudo apt install neovim\n```\n\nFor other Linux distributions, you can use their respective package managers or build from source.\n\n### For Windows:\n1. Download the latest Windows installer from the official Neovim GitHub releases page\n2. Run the installer and follow the prompts\n3. Add Neovim to your PATH if not done automatically\n\n### From source (Unix-like systems):\n```bash\ngit clone https://github.com/neovim/neovim.git\ncd neovim\nmake CMAKE_BUILD_TYPE=Release\nsudo make install\n```\n\nAfter installation, you can verify it by running `nvim --version` in your terminal."
},
"reference": {
"chunks": {
"20": {
"content": "```cd /usr/ports/editors/neovim/ && make install```## Android[Termux](https://github.com/termux/termux-app) offers a Neovim package.",
"dataset_id": "456ce60c5e1511f0907f09f583941b45",
"doc_type": "",
"document_id": "4bdd2ff65e1511f0907f09f583941b45",
"document_name": "INSTALL22.md",
"id": "4b8935ac0a22deb1",
"image_id": "",
"positions": [
[
12,
11,
11,
11,
11
]
],
"similarity": 0.5705525104787287,
"term_similarity": 0.5000000005,
"url": null,
"vector_similarity": 0.7351750337624289
}
},
"doc_aggs": {
"INSTALL(1).md": {
"count": 2,
"doc_id": "4bdfb42e5e1511f0907f09f583941b45",
"doc_name": "INSTALL(1).md"
},
"INSTALL.md": {
"count": 2,
"doc_id": "4bd7fdd85e1511f0907f09f583941b45",
"doc_name": "INSTALL.md"
},
"INSTALL22.md": {
"count": 3,
"doc_id": "4bdd2ff65e1511f0907f09f583941b45",
"doc_name": "INSTALL22.md"
},
"INSTALL3.md": {
"count": 1,
"doc_id": "4bdab5825e1511f0907f09f583941b45",
"doc_name": "INSTALL3.md"
}
}
} }
}, },
"event": "workflow_finished", "event": "workflow_finished",
"message_id": "25807f94783611f095171a6272e682d8", "message_id": "c4692a2683d911f0858253708ecb6573",
"session_id": "25663198783611f095171a6272e682d8", "session_id": "c39f6f9c83d911f0858253708ecb6573",
"task_id": "99ee29d6783511f09c921a6272e682d8" "task_id": "d1f79142831f11f09cc51795b9eb07c0"
} }
} }
``` ```