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

tccli/services/hunyuan/v20230901/api.json

@@ -0,0 +1,270 @@
+{
+  "actions": {
+    "QueryHunyuanTo3DProJob": {
+      "document": "This API is used to intelligently generate 3D content based on the HunYuan Large Model and input text descriptions/images.\nThis API is used to provide 3 concurrent tasks by default, which can process 3 submitted tasks simultaneously. The next task can be processed only after the previous task is completed.",
+      "input": "QueryHunyuanTo3DProJobRequest",
+      "name": "Query a hunyuan 3D pro edition task",
+      "output": "QueryHunyuanTo3DProJobResponse",
+      "status": "online"
+    },
+    "SubmitHunyuanTo3DProJob": {
+      "document": "This API is used to intelligently generate 3D content based on the HunYuan Large Model and input text descriptions/images.\nThis API is used to provide 3 concurrent tasks by default. Up to 3 submitted tasks can be processed simultaneously. A new task can be processed only after the previous one is completed.",
+      "input": "SubmitHunyuanTo3DProJobRequest",
+      "name": "Submit hunyuan 3D pro edition task",
+      "output": "SubmitHunyuanTo3DProJobResponse",
+      "status": "online"
+    }
+  },
+  "metadata": {
+    "apiVersion": "2023-09-01",
+    "serviceNameCN": "腾讯混元大模型",
+    "serviceShortName": "hunyuan"
+  },
+  "objects": {
+    "File3D": {
+      "document": "3D file.",
+      "members": [
+        {
+          "disabled": false,
+          "document": "3D file format. valid values: GIF, OBJ.",
+          "example": "GIF",
+          "member": "string",
+          "name": "Type",
+          "output_required": false,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Specifies the file Url (valid for 24 hours).",
+          "example": "https://cos.ap-guangzhou.myqcloud.com/gif.gif",
+          "member": "string",
+          "name": "Url",
+          "output_required": false,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Preview image Url.",
+          "example": "https://cos.ap-guangzhou.myqcloud.com/image.png",
+          "member": "string",
+          "name": "PreviewImageUrl",
+          "output_required": false,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": false
+        }
+      ],
+      "usage": "both"
+    },
+    "QueryHunyuanTo3DProJobRequest": {
+      "document": "QueryHunyuanTo3DProJob request structure.",
+      "members": [
+        {
+          "disabled": false,
+          "document": "Task ID.",
+          "example": "1357237233311637504",
+          "member": "string",
+          "name": "JobId",
+          "required": true,
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "QueryHunyuanTo3DProJobResponse": {
+      "document": "QueryHunyuanTo3DProJob response structure.",
+      "members": [
+        {
+          "disabled": false,
+          "document": "Task status. WAIT: waiting; RUN: running; FAIL: failed; DONE: successful.",
+          "example": "DONE",
+          "member": "string",
+          "name": "Status",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Error code",
+          "example": "InvalidParameter",
+          "member": "string",
+          "name": "ErrorCode",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Error message",
+          "example": "参数错误。",
+          "member": "string",
+          "name": "ErrorMessage",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Describes the generated 3d file array.",
+          "example": "无",
+          "member": "File3D",
+          "name": "ResultFile3Ds",
+          "output_required": false,
+          "type": "list",
+          "value_allowed_null": false
+        },
+        {
+          "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "SubmitHunyuanTo3DProJobRequest": {
+      "document": "SubmitHunyuanTo3DProJob request structure.",
+      "members": [
+        {
+          "disabled": false,
+          "document": "Generates 3D content, describes 3D content.\nSupports up to 1024 utf-8 characters.\nText-To-3D. Specifies either ImageBase64/ImageUrl or Prompt is required. Prompt and ImageBase64/ImageUrl cannot coexist.",
+          "example": "1",
+          "member": "string",
+          "name": "Prompt",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "Enter the Base64 code of the image.\nSize: specifies the unilateral resolution requirement, not less than 128 and not greater than 5000. size should not exceed 8m (after encoding, it increases by about 30%, recommend actual input image size no more than 6m).\nInput image suggestion:\n1.Simple background (solid-color background) \n2.No text or blended colors\n3.Single object\n4.The object occupies over 50% of the frame\nValid values: jpg, png, jpeg, webp.\nSpecifies either ImageBase64/ImageUrl or Prompt is required. Prompt and ImageBase64/ImageUrl cannot coexist.",
+          "example": "1",
+          "member": "string",
+          "name": "ImageBase64",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "Input image Url.\nSize: specifies the unilateral resolution requirement, not less than 128 and not greater than 5000. size should not exceed 8m (after encoding, it increases by about 30%, recommend actual input image size no more than 6m).\nInput image suggestion:\n1.Simple background (solid-color background) \n2.No text or blended colors\n3.Single object\n4.The object occupies over 50% of the frame\nValid values: jpg, png, jpeg, webp.\nSpecifies either ImageBase64/ImageUrl or Prompt is required. Prompt and ImageBase64/ImageUrl cannot coexist.",
+          "example": "1",
+          "member": "string",
+          "name": "ImageUrl",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "Multi-Perspective model image. reference value for viewing angle:.\nleft view.\nright view.\nback view.\n\nEach perspective is limited to one image.\nImage size limit. the value must not exceed 8 mb after encoding.\nImage resolution limitation: the unilateral resolution should be less than 5000 and greater than 128.\nSupported image format: JPG or PNG",
+          "example": "无",
+          "member": "ViewImage",
+          "name": "MultiViewImages",
+          "required": false,
+          "type": "list"
+        },
+        {
+          "disabled": false,
+          "document": "Specifies whether PBR material generation is enabled. default false.",
+          "example": "true",
+          "member": "bool",
+          "name": "EnablePBR",
+          "required": false,
+          "type": "bool"
+        },
+        {
+          "disabled": false,
+          "document": "Specifies the face count for 3D model generation. default value is 500000.\nSpecifies the supported face count generation range. value range: 40000-1500000.",
+          "example": "400000",
+          "member": "int64",
+          "name": "FaceCount",
+          "required": false,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "Generation task type. default: Normal. valid values:.\nNormal: generates a geometric model with textures.\nLowPoly: specifies the model generated after intelligent polygon reduction.\nGeometry: specifies whether to generate a Geometry model without textures (white model). when this task is selected, the EnablePBR parameter does not take effect.\nSpecifies the Sketch for the generative model, allowing input of a Sketch or line drawing. in this mode, both prompt and ImageUrl/ImageBase64 can be entered together.",
+          "example": "Normal",
+          "member": "string",
+          "name": "GenerateType",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "This parameter only takes effect when LowPoly mode is selected from GenerateType.\n\nPolygon type, indicates the number of sides in the model's surface grid, defaults to triangle. valid values:.\ntriangle. specifies the triangular face.\nquadrilateral: mix quadrangle and triangle faces to generate.",
+          "example": "triangle",
+          "member": "string",
+          "name": "PolygonType",
+          "required": false,
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "SubmitHunyuanTo3DProJobResponse": {
+      "document": "SubmitHunyuanTo3DProJob response structure.",
+      "members": [
+        {
+          "disabled": false,
+          "document": "Task ID (valid period: 24 hours).",
+          "example": "1357237233311637504",
+          "member": "string",
+          "name": "JobId",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "ViewImage": {
+      "document": "Multi-Perspective images.",
+      "members": [
+        {
+          "disabled": false,
+          "document": "Specifies the viewing angle type.\nValid values: back, left, right.",
+          "example": "back",
+          "member": "string",
+          "name": "ViewType",
+          "output_required": false,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Image Url.",
+          "example": "https://cos.ap-guangzhou.myqcloud.com/image.jpg",
+          "member": "string",
+          "name": "ViewImageUrl",
+          "output_required": false,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "base64 address of the image.",
+          "example": "/9j/4QlQaHR0c...N6a2M5ZCI",
+          "member": "string",
+          "name": "ViewImageBase64",
+          "output_required": false,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": false
+        }
+      ],
+      "usage": "both"
+    }
+  }
+}

tccli/services/hunyuan/v20230901/examples.json

@@ -0,0 +1,20 @@
+{
+  "actions": {
+    "QueryHunyuanTo3DProJob": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: hunyuan.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: QueryHunyuanTo3DProJob\n<Common request parameters>\n\n{\n    \"JobId\": \"1375367755519696896\"\n}",
+        "output": "{\n    \"Response\": {\n        \"ErrorCode\": \"\",\n        \"ErrorMessage\": \"\",\n        \"RequestId\": \"e7c1aa24-7bcc-405e-9dce-c6047b9f6688\",\n        \"ResultFile3Ds\": [],\n        \"Status\": \"RUN\"\n    }\n}",
+        "title": "Querying a 3D Task"
+      }
+    ],
+    "SubmitHunyuanTo3DProJob": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: hunyuan.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: SubmitHunyuanTo3DProJob\n<Common request parameters>\n\n{\n    \"Prompt\": \"A cat\"\n}",
+        "output": "{\n    \"Response\": {\n        \"JobId\": \"1375367755519696896\",\n        \"RequestId\": \"13f47dd0-1af9-4383-b401-dae18d6e99fc\"\n    }\n}",
+        "title": "Submitting a 3D Task"
+      }
+    ]
+  }
+}