From 9816b868f915b92ecd70979b7a41e18137936c05 Mon Sep 17 00:00:00 2001 From: Kevin Hu Date: Tue, 4 Mar 2025 15:43:09 +0800 Subject: [PATCH] Docs: about meta files in API reference. (#5594) ### What problem does this PR solve? ### Type of change - [x] Documentation Update --- docs/references/http_api_reference.md | 4 ++-- docs/references/python_api_reference.md | 4 +--- 2 files changed, 3 insertions(+), 5 deletions(-) diff --git a/docs/references/http_api_reference.md b/docs/references/http_api_reference.md index 099139aa5..a0982f015 100644 --- a/docs/references/http_api_reference.md +++ b/docs/references/http_api_reference.md @@ -634,6 +634,7 @@ Updates configurations for a specified document. - `'Authorization: Bearer '` - Body: - `"name"`:`string` + - `"meta_fields"`:`object` - `"chunk_method"`:`string` - `"parser_config"`:`object` @@ -660,6 +661,7 @@ curl --request PUT \ - `document_id`: (*Path parameter*) The ID of the document to update. - `"name"`: (*Body parameter*), `string` +- `"meta_fields"`: (*Body parameter*)， `dict[str, Any]` The meta fields of the document. - `"chunk_method"`: (*Body parameter*), `string` The parsing method to apply to the document: - `"naive"`: General @@ -672,8 +674,6 @@ curl --request PUT \ - `"presentation"`: Presentation - `"picture"`: Picture - `"one"`: One - - `"knowledge_graph"`: Knowledge Graph - Ensure your LLM is properly configured on the **Settings** page before selecting this. Please also note that Knowledge Graph consumes a large number of Tokens! - `"email"`: Email - `"parser_config"`: (*Body parameter*), `object` The configuration settings for the dataset parser. The attributes in this JSON object vary with the selected `"chunk_method"`: diff --git a/docs/references/python_api_reference.md b/docs/references/python_api_reference.md index a025b2408..7ba2f1172 100644 --- a/docs/references/python_api_reference.md +++ b/docs/references/python_api_reference.md @@ -313,9 +313,6 @@ A dictionary representing the attributes to update, with the following keys: - `"picture"`: Picture - `"one"`: One - `"email"`: Email - - `"knowledge_graph"`: Knowledge Graph - Ensure your LLM is properly configured on the **Settings** page before selecting this. Please also note that Knowledge Graph consumes a large number of Tokens! - - `"meta_fields"`: `dict[str, Any]` The meta fields of the dataset. #### Returns @@ -384,6 +381,7 @@ Updates configurations for the current document. A dictionary representing the attributes to update, with the following keys: - `"display_name"`: `str` The name of the document to update. +- `"meta_fields"`: `dict[str, Any]` The meta fields of the document. - `"chunk_method"`: `str` The parsing method to apply to the document. - `"naive"`: General - `"manual`: Manual