tccli-intl-en 3.0.1241.1__py2.py3-none-any.whl → 3.1.16.1__py2.py3-none-any.whl

tccli/services/lkeap/v20240522/examples.json

@@ -0,0 +1,92 @@
+{
+  "actions": {
+    "CreateReconstructDocumentFlow": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: lkeap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateReconstructDocumentFlow\n<Common request parameters>\n\n{\n    \"FileType\": \"PDF\",\n    \"FileUrl\": \"http://example.com/example.pdf\"\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"1d569fb4-4c9d-4141-bbd7-e1d8735bd1a9\",\n        \"TaskId\": \"123123123\"\n    }\n}",
+        "title": "Successful API Request Example"
+      }
+    ],
+    "CreateSplitDocumentFlow": [
+      {
+        "document": "Split the external online document.",
+        "input": "POST / HTTP/1.1\nHost: lkeap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateSplitDocumentFlow\n<Common request parameters>\n\n{\n    \"FileType\": \"PDF\",\n    \"FileName\": \"example.pdf\",\n    \"FileUrl\": \"https://qidian-qbot-1251316161.cos.ap-guangzhou.myqcloud.com/public/example/example.pdf\",\n    \"FileStartPageNumber\": 1,\n    \"FileEndPageNumber\": 2,\n    \"Config\": {\n        \"EnableMllm\": true\n    }\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"5e148c27-9c21-43cd-992c-799117bb4216\",\n        \"TaskId\": \"236e51fd-827b-41cb-b303-56003a817ce5\"\n    }\n}",
+        "title": "PDF Splitting Task Creation"
+      }
+    ],
+    "GetEmbedding": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: lkeap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: GetEmbedding\n<Common request parameters>\n\n{\n    \"Model\": \"adp-text-embedding-0.5b\",\n    \"Inputs\": [\n        \"Hello.\"\n    ]\n}",
+        "output": "{\n    \"Response\": {\n        \"Data\": [\n            {\n                \"Embedding\": [\n                    0\n                ]\n            }\n        ],\n        \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\",\n        \"Usage\": {\n            \"TotalTokens\": 3\n        }\n    }\n}",
+        "title": "Obtain The Embeddings"
+      },
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: lkeap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: GetEmbedding\n<Common request parameters>\n\n{\n    \"Model\": \"adp-text-embedding-0.5b\",\n    \"Inputs\": [\n        \"Hello\",\n        \"Word\"\n    ]\n}",
+        "output": "{\n    \"Response\": {\n        \"Data\": [\n            {\n                \"Embedding\": [\n                    0\n                ]\n            },\n            {\n                \"Embedding\": [\n                    0\n                ]\n            }\n        ],\n        \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\",\n        \"Usage\": {\n            \"TotalTokens\": 3\n        }\n    }\n}",
+        "title": "Obtain The Embeddings1"
+      },
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: lkeap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: GetEmbedding\n<Common request parameters>\n\n{\n    \"Model\": \"adp-text-embedding-0.5b\",\n    \"Inputs\": [\n        \"Hello\",\n        \"Word\"\n    ]\n}",
+        "output": "{\n    \"Response\": {\n        \"Data\": [\n            {\n                \"Embedding\": [\n                    0\n                ]\n            },\n            {\n                \"Embedding\": [\n                    0\n                ]\n            }\n        ],\n        \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\",\n        \"Usage\": {\n            \"TotalTokens\": 3\n        }\n    }\n}",
+        "title": "Obtain The Embeddings2"
+      }
+    ],
+    "GetReconstructDocumentResult": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: lkeap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: GetReconstructDocumentResult\n<Common request parameters>\n\n{\n    \"TaskId\": \"123123123\"\n}",
+        "output": "{\n    \"Response\": {\n        \"DocumentRecognizeResultUrl\": \"https://document-restruction-1258344699.cos.ap-guangzhou.myqcloud.com/doc_parse/output_files/a9c6a9482c72412fa84445a44ss125531.zip?q-sign-algorithm=sha1&q-ak=AKIDlWFaadfHLNbidLwPqOrAKGzXrx40scL7l&q-sign-time=1715503711%3B1718804311&q-key-time=1718855711%3B1718804311&q-header-list=host&q-url-param-list=&q-signature=71b568b8632d7e45gertdc3d235ef68d41fdfe7f8\",\n        \"FailedPages\": [],\n        \"RequestId\": \"a37b0d0b-c3af-44bd-iuiu-632442644a80\",\n        \"Status\": \"Success\"\n    }\n}",
+        "title": "Successful API Call Example"
+      },
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: lkeap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: GetReconstructDocumentResult\n<common request parameters>\n\n{\n    \"TaskId\": \"25adcef61750343903609\"\n}",
+        "output": "{\n    \"Response\": {\n        \"FailedPages\": [],\n        \"RequestId\": \"a37b0d0b-c3af-44bd-iuiu-632442644a80\",\n        \"Status\": \"Failed\",\n        \"Error\": {\n            \"Code\": \"InvalidParameter.FileURLInvalid\",\n            \"Message\": \"url download failed\"\n        }\n    }\n}",
+        "title": ""
+      }
+    ],
+    "GetSplitDocumentResult": [
+      {
+        "document": "Query document segmentation results",
+        "input": "POST / HTTP/1.1\nHost: lkeap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: GetSplitDocumentResult\n<Common request parameters>\n\n{\n    \"TaskId\": \"236e51fd-827b-41cb-b303-56003a817ce5\"\n}",
+        "output": "{\n    \"Response\": {\n        \"DocumentRecognizeResultUrl\": \"https://qidian-qbot-1251316161.cos.ap-guangzhou.myqcloud.com/public/example/example.zip\",\n        \"RequestId\": \"ffe23ed8-2b64-4835-aedc-ca9a5b5a7384\",\n        \"Status\": \"Success\",\n        \"Usage\": {\n            \"PageNumber\": 10,\n            \"TotalTokens\": 2048\n        }\n    }\n}",
+        "title": "Query Document Segmentation Results"
+      }
+    ],
+    "QueryRewrite": [
+      {
+        "document": "Multi-round rewriting.",
+        "input": "POST / HTTP/1.1\nHost: lkeap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: QueryRewrite\n<Common request parameters>\n\n{\n    \"Messages\": [\n        {\n            \"Role\": \"user\",\n            \"Content\": \"Where is your home\"\n        },\n        {\n            \"Role\": \"assistant\",\n            \"Content\": \"My home is in China\"\n        },\n        {\n            \"Role\": \"user\",\n            \"Content\": \"Where in the country\"\n        }\n    ]\n}",
+        "output": "{\n    \"Response\": {\n        \"Content\": \"Where is your home in the country? \",\n        \"RequestId\": \"4de60215-13cd-4f90-afc4-9fe4ef63e245\",\n        \"Usage\": {\n            \"InputTokens\": 45,\n            \"OutputTokens\": 6,\n            \"TotalTokens\": 51\n        }\n    }\n}",
+        "title": "Multi-round Rewriting"
+      }
+    ],
+    "ReconstructDocumentSSE": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: lkeap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ReconstructDocumentSSE\n<Common request parameters>\n\n{}",
+        "output": "{\n  \"RequestId\": \"0c7bbfbc-641a-4321-bee2-56b1e1e046e9\",\n  \"TaskId\": \"0c7bbfbc-641a-4321-bee2-56b1e1e046e9\",\n  \"ResponseType\": \"PROGRESS\",\n  \"Progress\": \"0\",\n  \"ProgressMessage\": \"Start document parsing\",\n  \"DocumentRecognizeResultUrl\": \"\",\n  \"FailedPages\": []\n}",
+        "title": "ReconstructDocumentSSE in Processing Response Sample"
+      },
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: lkeap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ReconstructDocumentSSE\n<Common request parameters>\n\n{}",
+        "output": "{\n  \"RequestId\": \"0c7cabfbc-641a-4321-bee2-56b1e1adwq6e9\",\n  \"TaskId\": \"0c7bbfbc-641a-4321-bee2-5dds1e1e04fe9\",\n  \"ResponseType\": \"TASK_RSP\",\n  \"Progress\": \"100\",\n\"ProgressMessage\": \"Document parsing completed\"\n  \"DocumentRecognizeResultUrl\": \"https://lkeap-reconstruct-sse-prod-intl-1251316161.cos.ap-jakarta.myqcloud.com/output_files/atom_v3/2025-10-21/200042064731_200042064731/64873e5b-082b-482c-9d98-42c4994696c9_parse.zip?q-sign-algorithm=sha1&q-ak=XXXXXXX&q-sign-time=1761035122%3B1761036922&q-key-time=1761035122%3B1761036922&q-header-list=host&q-url-param-list=&q-signature=XXXXXXX\",\n  \"FailedPages\": []\n}",
+        "title": "ReconstructDocumentSSE Processing Completed Response Example"
+      }
+    ],
+    "RunRerank": [
+      {
+        "document": "Reorder.",
+        "input": "POST / HTTP/1.1\nHost: lkeap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: RunRerank\n<Common request parameters>\n\n{\n    \"Query\": \"Knowledge Engine Large Model\",\n    \"Docs\": [\n        \"Hunyuan Large Model\",\n        \"Tencent Knowledge Engine\"\n    ]\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"766383fd-5219-4d13-aa1a-7ae00766640c\",\n        \"ScoreList\": [\n            -9.006162,\n            2.8577538\n        ],\n        \"Usage\": {\n            \"TotalTokens\": 27\n        }\n    }\n}",
+        "title": "Reorder"
+      }
+    ]
+  }
+}