tccli-intl-en 3.0.1248.1__py2.py3-none-any.whl → 3.1.33.1__py2.py3-none-any.whl

tccli/services/hunyuan/v20230901/api.json

@@ -0,0 +1,628 @@
+{
+  "actions": {
+    "Convert3DFormat": {
+      "document": "After inputting a 3D model file, the 3D model file format can be switched.",
+      "input": "Convert3DFormatRequest",
+      "name": "Switch the model format",
+      "output": "Convert3DFormatResponse",
+      "status": "online"
+    },
+    "QueryHunyuan3DPartJob": {
+      "document": "This API is used to query the generation task of a component.",
+      "input": "QueryHunyuan3DPartJobRequest",
+      "name": "Queries a component generation task",
+      "output": "QueryHunyuan3DPartJobResponse",
+      "status": "online"
+    },
+    "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"
+    },
+    "QueryHunyuanTo3DRapidJob": {
+      "document": "This API is used to intelligently generate 3D content based on the HunYuan Large Model with input text descriptions or images.\nThis API is used to provide 1 concurrent task by default, which means only 1 submitted task can be processed simultaneously. The next task can be processed only after the previous task is completed.",
+      "input": "QueryHunyuanTo3DRapidJobRequest",
+      "name": "Query a hunyuan 3D ultra-fast version task",
+      "output": "QueryHunyuanTo3DRapidJobResponse",
+      "status": "online"
+    },
+    "SubmitHunyuan3DPartJob": {
+      "document": "This API is used to automatically perform component identification and generation based on the model structure after inputting a 3D model file.",
+      "input": "SubmitHunyuan3DPartJobRequest",
+      "name": "Submit component generation task",
+      "output": "SubmitHunyuan3DPartJobResponse",
+      "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"
+    },
+    "SubmitHunyuanTo3DRapidJob": {
+      "document": "This API is used to intelligently generate 3D content based on the HunYuan Large Model with input text descriptions or images.\nThis API is used to provide 1 concurrent task by default, which means only 1 submitted task can be processed simultaneously. The next task can be processed only after the previous task is completed.",
+      "input": "SubmitHunyuanTo3DRapidJobRequest",
+      "name": "Submit hunyuan 3D ultra-fast version task",
+      "output": "SubmitHunyuanTo3DRapidJobResponse",
+      "status": "online"
+    }
+  },
+  "metadata": {
+    "apiVersion": "2023-09-01",
+    "serviceNameCN": "腾讯混元大模型",
+    "serviceShortName": "hunyuan"
+  },
+  "objects": {
+    "Convert3DFormatRequest": {
+      "document": "Convert3DFormat request structure.",
+      "members": [
+        {
+          "disabled": false,
+          "document": "3D file url address. model file size ≤60 mb. supports fbx, obj, and glb format 3d file input.",
+          "example": "url",
+          "member": "string",
+          "name": "File3D",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "Returns the 3D file format. valid values: STL, USDZ, FBX, MP4, GIF.\nRecommended input models below 50W, may timeout when selecting USDZ, MP4, or GIF format.\nExample value: STL.",
+          "example": "STL",
+          "member": "string",
+          "name": "Format",
+          "required": true,
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "Convert3DFormatResponse": {
+      "document": "Convert3DFormat response structure.",
+      "members": [
+        {
+          "disabled": false,
+          "document": "3D file address.",
+          "example": "url",
+          "member": "string",
+          "name": "ResultFile3D",
+          "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"
+    },
+    "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"
+    },
+    "InputFile3D": {
+      "document": "3D file.",
+      "members": [
+        {
+          "disabled": false,
+          "document": "Specifies the file Url with a valid period of 24 hours.\t",
+          "example": "https://cos.ap-guangzhou.myqcloud.com/obj.obj\t",
+          "member": "string",
+          "name": "Url",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "Specifies the file format.\t",
+          "example": "OBJ",
+          "member": "string",
+          "name": "Type",
+          "required": true,
+          "type": "string"
+        }
+      ],
+      "usage": "in"
+    },
+    "QueryHunyuan3DPartJobRequest": {
+      "document": "QueryHunyuan3DPartJob request structure.",
+      "members": [
+        {
+          "disabled": false,
+          "document": "Task ID.\t",
+          "example": "1376862528873414656",
+          "member": "string",
+          "name": "JobId",
+          "required": true,
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "QueryHunyuan3DPartJobResponse": {
+      "document": "QueryHunyuan3DPartJob response structure.",
+      "members": [
+        {
+          "disabled": false,
+          "document": "Task status. WAIT: waiting; RUN: running; FAIL: failed; DONE: successful. example value: RUN.\t",
+          "example": "WAIT",
+          "member": "string",
+          "name": "Status",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Error code.\t",
+          "example": "InvalidParameter",
+          "member": "string",
+          "name": "ErrorCode",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Error message.\t",
+          "example": "参数错误。\t",
+          "member": "string",
+          "name": "ErrorMessage",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Generates the file URL with a valid period of 1 day.\t",
+          "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"
+    },
+    "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"
+    },
+    "QueryHunyuanTo3DRapidJobRequest": {
+      "document": "QueryHunyuanTo3DRapidJob request structure.",
+      "members": [
+        {
+          "disabled": false,
+          "document": "Task ID.\t",
+          "example": "1315932989749215232",
+          "member": "string",
+          "name": "JobId",
+          "required": false,
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "QueryHunyuanTo3DRapidJobResponse": {
+      "document": "QueryHunyuanTo3DRapidJob response structure.",
+      "members": [
+        {
+          "disabled": false,
+          "document": "Task status. WAIT: waiting; RUN: running; FAIL: failed; DONE: successful.\t",
+          "example": "RUN",
+          "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\t",
+          "example": "参数错误\t",
+          "member": "string",
+          "name": "ErrorMessage",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Specifies the generated 3D file array.\t",
+          "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"
+    },
+    "SubmitHunyuan3DPartJobRequest": {
+      "document": "SubmitHunyuan3DPartJob request structure.",
+      "members": [
+        {
+          "disabled": false,
+          "document": "Recommends inputting 3D models generated by AIGC. recommended file size ≤100MB. face count ≤1,500,000. only supports FBX format.",
+          "example": "无",
+          "member": "InputFile3D",
+          "name": "File",
+          "required": false,
+          "type": "object"
+        }
+      ],
+      "type": "object"
+    },
+    "SubmitHunyuan3DPartJobResponse": {
+      "document": "SubmitHunyuan3DPartJob response structure.",
+      "members": [
+        {
+          "disabled": false,
+          "document": "Task id (valid period: 24 hours).",
+          "example": "1384898587778465792",
+          "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"
+    },
+    "SubmitHunyuanTo3DProJobRequest": {
+      "document": "SubmitHunyuanTo3DProJob request structure.",
+      "members": [
+        {
+          "disabled": false,
+          "document": "Tencent HY 3D Global model version\nDefaults to 3.0, with optional choices: 3.0, 3.1\nWhen selecting version 3.1, the LowPoly parameter is unavailable\nExample value:3.0",
+          "example": "3.0",
+          "member": "string",
+          "name": "Model",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "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: Left view;\nright: Right view;\nback: Rear view;\ntop: Top view (only supported in Model 3.1);\nbottom: Bottom view (only supported in Model 3.1);\nleft_front: Left front 45 degree view (only supported in Model 3.1);\nright_front: Right front 45 degree view (only supported in Model 3.1);\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"
+    },
+    "SubmitHunyuanTo3DRapidJobRequest": {
+      "document": "SubmitHunyuanTo3DRapidJob request structure.",
+      "members": [
+        {
+          "disabled": false,
+          "document": "Text-To-3D, description of 3D content, forward Prompt content. supports up to 200 utf-8 characters. either ImageBase64, ImageUrl, or Prompt is required, and Prompt cannot coexist with ImageBase64/ImageUrl.\t",
+          "example": "一只小猫",
+          "member": "string",
+          "name": "Prompt",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "Input image Base64 data. size: unilateral resolution requirement not less than 128, not greater than 5000, size ≤6m (after encoding, size increases by approximately 30%). format: jpg, png, jpeg, webp. imagebase64, imageurl, and Prompt are required, but Prompt and imagebase64/imageurl cannot coexist.\t",
+          "example": "/9j/4QlQaHR0c...N6a2M5ZCI\t",
+          "member": "string",
+          "name": "ImageBase64",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "Input image Url. size: unilateral resolution requirement not less than 128, not greater than 5000. size ≤8m. format: jpg, png, jpeg, webp. imagebase64, imageurl, and Prompt are required, and Prompt cannot coexist with imagebase64/imageurl.\t",
+          "example": "https://***.cos.ap-guangzhou.myqcloud.com/***.jpg\t",
+          "member": "string",
+          "name": "ImageUrl",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "Specifies whether PBR material generation is enabled, false by default.\t",
+          "example": "false",
+          "member": "bool",
+          "name": "EnablePBR",
+          "required": false,
+          "type": "bool"
+        },
+        {
+          "disabled": false,
+          "document": "Specifies whether to enable the single geometry generation option. when enabled, it generates a 3D model without textures (white model). enabled, the generative model does not support OBJ format. default model file format is GLB.\t",
+          "example": "false",
+          "member": "bool",
+          "name": "EnableGeometry",
+          "required": false,
+          "type": "bool"
+        }
+      ],
+      "type": "object"
+    },
+    "SubmitHunyuanTo3DRapidJobResponse": {
+      "document": "SubmitHunyuanTo3DRapidJob response structure.",
+      "members": [
+        {
+          "disabled": false,
+          "document": "Task ID (valid period: 24 hours).\t",
+          "example": "1315932989749215232",
+          "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"
+    }
+  }
+}