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

Updated descriptions of agent APIs (#3407)

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


### Type of change


- [x] Documentation Update
This commit is contained in:
writinwaters
2024-11-14 18:44:37 +08:00
committed by GitHub
parent 30c1f7ee29
commit df9d054551
2 changed files with 92 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files

55
docs/references/python_api_reference.md
View File

@ -63,7 +63,10 @@ The language setting of the dataset to create. Available options:
#### permission
Specifies who can access the dataset to create. You can set it only to `"me"` for now.
Specifies who can access the dataset to create. Available options:
- `"me"`: (Default) Only you can manage the dataset.
- `"team"`: All team members can manage the dataset.
#### chunk_method, `str`
@ -819,7 +822,7 @@ Retrieves chunks from specified datasets.
### Parameters
#### question: `str` *Required*
#### question: `str`, *Required*
The user query or query keywords. Defaults to `""`.
@ -1141,13 +1144,13 @@ Chat Session APIs
---
## Create session
## Create session with chat assistant
```python
Chat.create_session(name: str = "New session") -> Session
```
Creates a chat session.
Creates a session with the current chat assistant.
### Parameters
@ -1177,13 +1180,13 @@ session = assistant.create_session()
---
## Update session
## Update chat assistant's session
```python
Session.update(update_message: dict)
```
Updates the current session.
Updates the current session of the current chat assistant.
### Parameters
@ -1212,7 +1215,7 @@ session.update({"name": "updated_name"})
---
## List sessions
## List chat assistant's sessions
```python
Chat.list_sessions(
@ -1275,13 +1278,13 @@ for session in assistant.list_sessions():
---
## Delete sessions
## Delete chat assistant's sessions
```python
Chat.delete_sessions(ids:list[str] = None)
```
Deletes sessions by ID.
Deletes sessions of the current chat assistant by ID.
### Parameters
@ -1307,17 +1310,21 @@ assistant.delete_sessions(ids=["id_1","id_2"])
---
## Converse
## Converse with chat assistant
```python
Session.ask(question: str, stream: bool = False) -> Optional[Message, iter[Message]]
```
Asks a question to start an AI-powered conversation.
Asks a specified chat assistant a question to start an AI-powered conversation.
:::tip NOTE
In streaming mode, not all responses include a reference, as this depends on the system's judgement.
:::
### Parameters
#### question: `str` *Required*
#### question: `str`, *Required*
The question to start an AI-powered conversation.
@ -1390,22 +1397,23 @@ while True:
print(ans.content[len(cont):], end='', flush=True)
cont = ans.content
```
---
## Create agent session
## Create session with agent
```python
Agent.create_session(id,rag) -> Session
```
Creates a agemt session.
Creates a session with the current agent.
### Returns
- Success: A `Session` object containing the following attributes:
- `id`: `str` The auto-generated unique identifier of the created session.
- `message`: `list[Message]` The messages of the created session assistant. Default: `[{"role": "assistant", "content": "Hi! I am your assistant，can I help you?"}]`
- `agnet_id`: `str` The ID of the associated agent assistant.
- `agent_id`: `str` The ID of the associated agent assistant.
- Failure: `Exception`
### Examples
@ -1417,19 +1425,24 @@ rag_object = RAGFlow(api_key="<YOUR_API_KEY>", base_url="http://<YOUR_BASE_URL>:
AGENT_ID = "AGENT_ID"
session = create_session(AGENT_ID,rag_object)
```
---
## Converse through agent
## Converse with agent
```python
Session.ask(question: str, stream: bool = False) -> Optional[Message, iter[Message]]
```
Asks a question to start an AI-powered conversation.
Asks a specified agent a question to start an AI-powered conversation.
:::tip NOTE
In streaming mode, not all responses include a reference, as this depends on the system's judgement.
:::
### Parameters
#### question: `str` *Required*
#### question: `str`, *Required*
The question to start an AI-powered conversation.
@ -1489,12 +1502,12 @@ rag_object = RAGFlow(api_key="<YOUR_API_KEY>", base_url="http://<YOUR_BASE_URL>:
AGENT_id = "AGENT_ID"
session = Agent.create_session(AGENT_id,rag_object)
print("\n==================== Miss R =====================\n")
print("\n===== Miss R ====\n")
print("Hello. What can I do for you?")
while True:
question = input("\n==================== User =====================\n> ")
print("\n==================== Miss R =====================\n")
question = input("\n===== User ====\n> ")
print("\n==== Miss R ====\n")
cont = ""
for ans in session.ask(question, stream=True):