mirror of
https://github.com/infiniflow/ragflow.git
synced 2026-08-15 05:04:27 +08:00
### What problem does this PR solve? Enable reading Tag Set tags via API (expose tag_kwd field). The result of the queried list chunks is as shown below: <img width="1422" height="818" alt="image" src="https://github.com/user-attachments/assets/abd1960a-fe34-489e-9d72-525f8e574938" /> ### Type of change - [x] New Feature (non-breaking change which adds functionality) Co-authored-by: heyang.why <heyang.why@alibaba-inc.com>
This commit is contained in:
@@ -2005,6 +2005,7 @@ Adds a chunk to a specified document in a specified dataset.
|
||||
- Body:
|
||||
- `"content"`: `string`
|
||||
- `"important_keywords"`: `list[string]`
|
||||
- `"tag_kwd"`: `list[string]`
|
||||
- `"image_base64"`: `string`
|
||||
|
||||
##### Request example
|
||||
@@ -2031,6 +2032,8 @@ curl --request POST \
|
||||
The text content of the chunk.
|
||||
- `"important_keywords`(*Body parameter*), `list[string]`
|
||||
The key terms or phrases to tag with the chunk.
|
||||
- `"tag_kwd"`: (*Body parameter*), `list[string]`
|
||||
Tag keywords to associate with the chunk.
|
||||
- `"questions"`(*Body parameter*), `list[string]`
|
||||
If there is a given question, the embedded chunks will be based on them
|
||||
- `"image_base64"`: (*Body parameter*), `string`
|
||||
@@ -2053,6 +2056,7 @@ Success:
|
||||
"id": "12ccdc56e59837e5",
|
||||
"image_id": "",
|
||||
"important_keywords": [],
|
||||
"tag_kwd": [],
|
||||
"questions": []
|
||||
}
|
||||
}
|
||||
@@ -2123,6 +2127,7 @@ Success:
|
||||
"id": "b48c170e90f70af998485c1065490726",
|
||||
"image_id": "",
|
||||
"important_keywords": "",
|
||||
"tag_kwd": [],
|
||||
"positions": [
|
||||
""
|
||||
]
|
||||
@@ -2267,6 +2272,7 @@ Updates content or configurations for a specified chunk.
|
||||
- Body:
|
||||
- `"content"`: `string`
|
||||
- `"important_keywords"`: `list[string]`
|
||||
- `"tag_kwd"`: `list[string]`
|
||||
- `"available"`: `boolean`
|
||||
|
||||
##### Request example
|
||||
@@ -2295,6 +2301,8 @@ curl --request PUT \
|
||||
The text content of the chunk.
|
||||
- `"important_keywords"`: (*Body parameter*), `list[string]`
|
||||
A list of key terms or phrases to tag with the chunk.
|
||||
- `"tag_kwd"`: (*Body parameter*), `list[string]`
|
||||
Updated tag keywords.
|
||||
- `"available"`: (*Body parameter*) `boolean`
|
||||
The chunk's availability status in the dataset. Value options:
|
||||
- `true`: Available (default)
|
||||
@@ -2696,6 +2704,7 @@ Success:
|
||||
"important_keywords": [
|
||||
""
|
||||
],
|
||||
"tag_kwd": [],
|
||||
"kb_id": "c7ee74067a2c11efb21c0242ac120006",
|
||||
"positions": [
|
||||
""
|
||||
|
||||
@@ -855,7 +855,7 @@ print("Async bulk parsing cancelled.")
|
||||
### Add chunk
|
||||
|
||||
```python
|
||||
Document.add_chunk(content:str, important_keywords:list[str] = [], image_base64:str = None) -> Chunk
|
||||
Document.add_chunk(content:str, important_keywords:list[str] = [], image_base64:str = None, *, tag_kwd:list[str] = []) -> Chunk
|
||||
```
|
||||
|
||||
Adds a chunk to the current document.
|
||||
@@ -874,6 +874,10 @@ The key terms or phrases to tag with the chunk.
|
||||
|
||||
A base64-encoded image to associate with the chunk. If the chunk already has an image, the new image will be vertically concatenated below the existing one.
|
||||
|
||||
##### tag_kwd: `list[str]`
|
||||
|
||||
Tag keywords to associate with the chunk.
|
||||
|
||||
#### Returns
|
||||
|
||||
- Success: A `Chunk` object.
|
||||
@@ -884,6 +888,7 @@ A `Chunk` object contains the following attributes:
|
||||
- `id`: `str`: The chunk ID.
|
||||
- `content`: `str` The text content of the chunk.
|
||||
- `important_keywords`: `list[str]` A list of key terms or phrases tagged with the chunk.
|
||||
- `tag_kwd`: `list[str]` A list of tag keywords associated with the chunk.
|
||||
- `image_id`: `str` The image ID associated with the chunk (empty string if no image).
|
||||
- `create_time`: `str` The time when the chunk was created (added to the document).
|
||||
- `create_timestamp`: `float` The timestamp representing the creation time of the chunk, expressed in seconds since January 1, 1970.
|
||||
@@ -1024,6 +1029,7 @@ A dictionary representing the attributes to update, with the following keys:
|
||||
|
||||
- `"content"`: `str` The text content of the chunk.
|
||||
- `"important_keywords"`: `list[str]` A list of key terms or phrases to tag with the chunk.
|
||||
- `"tag_kwd"`: `list[str]` A list of tag keywords to associate with the chunk.
|
||||
- `"available"`: `bool` The chunk's availability status in the dataset. Value options:
|
||||
- `False`: Unavailable
|
||||
- `True`: Available (default)
|
||||
|
||||
Reference in New Issue
Block a user