fix(docs): update API documentation to replace 'Params' with 'Path' (#18004)

2025-12-09 02:46:52 +08:00 · 2025-04-14 17:25:41 +08:00
parent 4c99e9dc73
commit f40e22dda6
3 changed files with 52 additions and 48 deletions
--- a/web/app/(commonLayout)/datasets/template/template.en.mdx
+++ b/web/app/(commonLayout)/datasets/template/template.en.mdx
@@ -37,7 +37,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, PropertyInstructi
  <Col>
    This API is based on an existing knowledge and creates a new document through text based on this knowledge.

-    ### Params
+    ### Path
    <Properties>
      <Property name='dataset_id' type='string' key='dataset_id'>
        Knowledge ID
@@ -175,7 +175,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, PropertyInstructi
  <Col>
    This API is based on an existing knowledge and creates a new document through a file based on this knowledge.

-    ### Params
+    ### Path
    <Properties>
      <Property name='dataset_id' type='string' key='dataset_id'>
        Knowledge ID
@@ -482,7 +482,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, PropertyInstructi
 />
 <Row>
  <Col>
-    ### Query
+    ### Path
    <Properties>
      <Property name='dataset_id' type='string' key='dataset_id'>
        Knowledge Base ID
@@ -563,7 +563,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, PropertyInstructi
 />
 <Row>
  <Col>
-    ### Query
+    ### Path
    <Properties>
      <Property name='dataset_id' type='string' key='dataset_id'>
        Knowledge Base ID
@@ -671,7 +671,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, PropertyInstructi
 />
 <Row>
  <Col>
-    ### Params
+    ### Path
    <Properties>
      <Property name='dataset_id' type='string' key='dataset_id'>
        Knowledge ID
@@ -710,7 +710,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, PropertyInstructi
  <Col>
    This API is based on an existing knowledge and updates the document through text based on this knowledge.

-    ### Params
+    ### Path
    <Properties>
      <Property name='dataset_id' type='string' key='dataset_id'>
        Knowledge ID
@@ -812,7 +812,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, PropertyInstructi
  <Col>
    This API is based on an existing knowledge, and updates documents through files based on this knowledge

-    ### Params
+    ### Path
    <Properties>
      <Property name='dataset_id' type='string' key='dataset_id'>
        Knowledge ID
@@ -909,7 +909,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, PropertyInstructi
 />
 <Row>
  <Col>
-    ### Params
+    ### Path
    <Properties>
      <Property name='dataset_id' type='string' key='dataset_id'>
        Knowledge ID
@@ -964,7 +964,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, PropertyInstructi
 />
 <Row>
  <Col>
-    ### Params
+    ### Path
    <Properties>
      <Property name='dataset_id' type='string' key='dataset_id'>
        Knowledge ID
@@ -1006,7 +1006,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, PropertyInstructi
 />
 <Row>
  <Col>
-    ### Params
+    ### Path
    <Properties>
      <Property name='dataset_id' type='string' key='dataset_id'>
        Knowledge ID
@@ -1081,7 +1081,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, PropertyInstructi
 />
 <Row>
  <Col>
-    ### Params
+    ### Path
    <Properties>
      <Property name='dataset_id' type='string' key='dataset_id'>
        Knowledge ID
@@ -1273,10 +1273,10 @@ import { Row, Col, Properties, Property, Heading, SubProperty, PropertyInstructi
      title="Request"
      tag="DELETE"
      label="/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}"
-      targetCode={`curl --location --request DELETE '${props.apiBaseUrl}/datasets/{dataset_id}/segments/{segment_id}' \\\n--header 'Authorization: Bearer {api_key}' \\\n--header 'Content-Type: application/json'`}
+      targetCode={`curl --location --request DELETE '${props.apiBaseUrl}/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}' \\\n--header 'Authorization: Bearer {api_key}' \\\n--header 'Content-Type: application/json'`}
    >
    ```bash {{ title: 'cURL' }}
-    curl --location --request DELETE '${props.apiBaseUrl}/datasets/{dataset_id}/segments/{segment_id}' \
+    curl --location --request DELETE '${props.apiBaseUrl}/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}' \
    --header 'Authorization: Bearer {api_key}' \
    --header 'Content-Type: application/json'
    ```
@@ -1390,7 +1390,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, PropertyInstructi
 />
 <Row>
  <Col>
-    ### Params
+    ### Path
    <Properties>
      <Property name='dataset_id' type='string' key='dataset_id'>
        Knowledge ID
@@ -1461,7 +1461,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, PropertyInstructi
 />
 <Row>
  <Col>
-    ### Params
+    ### Path
    <Properties>
      <Property name='dataset_id' type='string' key='dataset_id'>
        Knowledge ID
@@ -1538,7 +1538,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, PropertyInstructi
 />
 <Row>
  <Col>
-    ### Params
+    ### Path
    <Properties>
      <Property name='dataset_id' type='string' key='dataset_id'>
        Knowledge ID
@@ -1586,7 +1586,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, PropertyInstructi
 />
 <Row>
  <Col>
-    ### Params
+    ### Path
    <Properties>
      <Property name='dataset_id' type='string' key='dataset_id'>
        Knowledge ID
@@ -1855,7 +1855,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, PropertyInstructi
 />
 <Row>
  <Col>
-    ### Params
+    ### Path
    <Properties>
      <Property name='dataset_id' type='string' key='dataset_id'>
        Knowledge ID
@@ -1902,7 +1902,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, PropertyInstructi
 />
 <Row>
  <Col>
-    ### Params
+    ### Path
    <Properties>
      <Property name='dataset_id' type='string' key='dataset_id'>
        Knowledge ID
@@ -1951,7 +1951,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, PropertyInstructi
 />
 <Row>
  <Col>
-    ### Params
+    ### Path
    <Properties>
      <Property name='dataset_id' type='string' key='dataset_id'>
        Knowledge ID
@@ -1984,7 +1984,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, PropertyInstructi
 />
 <Row>
  <Col>
-    ### Params
+    ### Path
    <Properties>
      <Property name='dataset_id' type='string' key='dataset_id'>
        Knowledge ID
@@ -2017,7 +2017,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, PropertyInstructi
 />
 <Row>
  <Col>
-    ### Params
+    ### Path
    <Properties>
      <Property name='dataset_id' type='string' key='dataset_id'>
        Knowledge ID
--- a/web/app/(commonLayout)/datasets/template/template.ja.mdx
+++ b/web/app/(commonLayout)/datasets/template/template.ja.mdx
@@ -37,7 +37,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, PropertyInstructi
  <Col>
    この API は既存のナレッジに基づいており、このナレッジを基にテキストを使用して新しいドキュメントを作成します。

-    ### パラメータ
+    ### パス
    <Properties>
      <Property name='dataset_id' type='string' key='dataset_id'>
        ナレッジ ID
@@ -175,7 +175,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, PropertyInstructi
  <Col>
    この API は既存のナレッジに基づいており、このナレッジを基にファイルを使用して新しいドキュメントを作成します。

-    ### パラメータ
+    ### パス
    <Properties>
      <Property name='dataset_id' type='string' key='dataset_id'>
        ナレッジ ID
@@ -520,7 +520,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, PropertyInstructi
  <Col>
    この API は既存のナレッジに基づいており、このナレッジを基にテキストを使用してドキュメントを更新します。

-    ### パラメータ
+    ### パス
    <Properties>
      <Property name='dataset_id' type='string' key='dataset_id'>
        ナレッジ ID
@@ -622,7 +622,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, PropertyInstructi
  <Col>
    この API は既存のナレッジに基づいており、このナレッジを基にファイルを使用してドキュメントを更新します。

-    ### パラメータ
+    ### パス
    <Properties>
      <Property name='dataset_id' type='string' key='dataset_id'>
        ナレッジ ID
@@ -774,7 +774,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, PropertyInstructi
 />
 <Row>
  <Col>
-    ### パラメータ
+    ### パス
    <Properties>
      <Property name='dataset_id' type='string' key='dataset_id'>
        ナレッジ ID
@@ -816,7 +816,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, PropertyInstructi
 />
 <Row>
  <Col>
-    ### パラメータ
+    ### パス
    <Properties>
      <Property name='dataset_id' type='string' key='dataset_id'>
        ナレッジ ID
@@ -891,7 +891,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, PropertyInstructi
 />
 <Row>
  <Col>
-    ### パラメータ
+    ### パス
    <Properties>
      <Property name='dataset_id' type='string' key='dataset_id'>
        ナレッジ ID
@@ -1083,10 +1083,10 @@ import { Row, Col, Properties, Property, Heading, SubProperty, PropertyInstructi
      title="リクエスト"
      tag="DELETE"
      label="/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}"
-      targetCode={`curl --location --request DELETE '${props.apiBaseUrl}/datasets/{dataset_id}/segments/{segment_id}' \\\n--header 'Authorization: Bearer {api_key}' \\\n--header 'Content-Type: application/json'`}
+      targetCode={`curl --location --request DELETE '${props.apiBaseUrl}/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}' \\\n--header 'Authorization: Bearer {api_key}' \\\n--header 'Content-Type: application/json'`}
    >
    ```bash {{ title: 'cURL' }}
-    curl --location --request DELETE '${props.apiBaseUrl}/datasets/{dataset_id}/segments/{segment_id}' \
+    curl --location --request DELETE '${props.apiBaseUrl}/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}' \
    --header 'Authorization: Bearer {api_key}' \
    --header 'Content-Type: application/json'
    ```
@@ -1200,7 +1200,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, PropertyInstructi
 />
 <Row>
  <Col>
-    ### パラメータ
+    ### パス
    <Properties>
      <Property name='dataset_id' type='string' key='dataset_id'>
        ナレッジ ID
@@ -1271,7 +1271,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, PropertyInstructi
 />
 <Row>
  <Col>
-    ### パラメータ
+    ### パス
    <Properties>
      <Property name='dataset_id' type='string' key='dataset_id'>
        ナレッジ ID
@@ -1348,7 +1348,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, PropertyInstructi
 />
 <Row>
  <Col>
-    ### パラメータ
+    ### パス
    <Properties>
      <Property name='dataset_id' type='string' key='dataset_id'>
        ナレッジ ID
@@ -1396,7 +1396,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, PropertyInstructi
 />
 <Row>
  <Col>
-    ### パラメータ
+    ### パス
    <Properties>
      <Property name='dataset_id' type='string' key='dataset_id'>
        ナレッジ ID
@@ -1665,7 +1665,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, PropertyInstructi
 />
 <Row>
  <Col>
-    ### パラメータ
+    ### パス
    <Properties>
      <Property name='dataset_id' type='string' key='dataset_id'>
        ナレッジ ID
@@ -1712,7 +1712,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, PropertyInstructi
 />
 <Row>
  <Col>
-    ### パラメータ
+    ### パス
    <Properties>
      <Property name='dataset_id' type='string' key='dataset_id'>
        ナレッジ ID
@@ -1761,7 +1761,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, PropertyInstructi
 />
 <Row>
  <Col>
-    ### パラメータ
+    ### パス
    <Properties>
      <Property name='dataset_id' type='string' key='dataset_id'>
        ナレッジ ID
@@ -1794,7 +1794,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, PropertyInstructi
 />
 <Row>
  <Col>
-    ### パラメータ
+    ### パス
    <Properties>
      <Property name='dataset_id' type='string' key='dataset_id'>
        ナレッジ ID
@@ -1827,7 +1827,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, PropertyInstructi
 />
 <Row>
  <Col>
-    ### パラメータ
+    ### パス
    <Properties>
      <Property name='dataset_id' type='string' key='dataset_id'>
        ナレッジ ID
@@ -1868,7 +1868,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, PropertyInstructi
 />
 <Row>
  <Col>
-    ### パラメータ
+    ### パス
    <Properties>
      <Property name='dataset_id' type='string' key='dataset_id'>
        ナレッジ ID
--- a/web/app/(commonLayout)/datasets/template/template.zh.mdx
+++ b/web/app/(commonLayout)/datasets/template/template.zh.mdx
@@ -482,7 +482,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, PropertyInstructi
 />
 <Row>
  <Col>
-    ### Query
+    ### Path
    <Properties>
      <Property name='dataset_id' type='string' key='dataset_id'>
        知识库 ID
@@ -563,11 +563,15 @@ import { Row, Col, Properties, Property, Heading, SubProperty, PropertyInstructi
 />
 <Row>
  <Col>
-    ### Query
+    ### Path
    <Properties>
      <Property name='dataset_id' type='string' key='dataset_id'>
        知识库 ID
      </Property>
+    </Properties>
+
+    ### Request Body
+    <Properties>
      <Property name='indexing_technique' type='string' key='indexing_technique'>
        索引模式（选填，建议填写）
          - <code>high_quality</code> 高质量
@@ -1937,7 +1941,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, PropertyInstructi
 />
 <Row>
  <Col>
-    ### Params
+    ### Path
    <Properties>
      <Property name='dataset_id' type='string' key='dataset_id'>
        知识库 ID
@@ -1986,7 +1990,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, PropertyInstructi
 />
 <Row>
  <Col>
-    ### Params
+    ### Path
    <Properties>
      <Property name='dataset_id' type='string' key='dataset_id'>
        知识库 ID
@@ -2019,7 +2023,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, PropertyInstructi
 />
 <Row>
  <Col>
-    ### Params
+    ### Path
    <Properties>
      <Property name='dataset_id' type='string' key='dataset_id'>
        知识库 ID
@@ -2052,7 +2056,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, PropertyInstructi
 />
 <Row>
  <Col>
-    ### Params
+    ### Path
    <Properties>
      <Property name='dataset_id' type='string' key='dataset_id'>
        知识库 ID
@@ -2093,7 +2097,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, PropertyInstructi
 />
 <Row>
  <Col>
-    ### Query
+    ### Path
    <Properties>
      <Property name='dataset_id' type='string' key='dataset_id'>
        知识库 ID