tencentcloud-sdk-nodejs-ai3d 4.1.73
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/README.md +203 -0
- package/es/index.js +1 -0
- package/es/services/ai3d/index.js +4 -0
- package/es/services/ai3d/v20250513/ai3d_client.js +12 -0
- package/es/services/ai3d/v20250513/ai3d_models.js +0 -0
- package/es/services/ai3d/v20250513/index.js +6 -0
- package/es/services/index.js +1 -0
- package/package.json +66 -0
- package/tencentcloud/index.d.ts +1 -0
- package/tencentcloud/index.js +4 -0
- package/tencentcloud/services/ai3d/index.d.ts +6 -0
- package/tencentcloud/services/ai3d/index.js +7 -0
- package/tencentcloud/services/ai3d/v20250513/ai3d_client.d.ts +19 -0
- package/tencentcloud/services/ai3d/v20250513/ai3d_client.js +46 -0
- package/tencentcloud/services/ai3d/v20250513/ai3d_models.d.ts +125 -0
- package/tencentcloud/services/ai3d/v20250513/ai3d_models.js +18 -0
- package/tencentcloud/services/ai3d/v20250513/index.d.ts +6 -0
- package/tencentcloud/services/ai3d/v20250513/index.js +10 -0
- package/tencentcloud/services/index.d.ts +1 -0
- package/tencentcloud/services/index.js +4 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,203 @@
|
|
|
1
|
+
# 简介
|
|
2
|
+
|
|
3
|
+
欢迎使用腾讯云开发者工具套件(SDK),Node.js SDK 4.0 是云 API 3.0 平台的配套工具。
|
|
4
|
+
为方便 Node.js 开发者调试和接入腾讯云产品 API,这里向您介绍适用于 Node.js 的腾讯云开发工具包,并提供首次使用开发工具包的简单示例。让您快速获取腾讯云 Node.js SDK 并开始调用。
|
|
5
|
+
|
|
6
|
+
# 依赖环境
|
|
7
|
+
|
|
8
|
+
1. Node.js 10.0.0 版本及以上。
|
|
9
|
+
2. 注意:部分产品需在 [腾讯云控制台](https://console.cloud.tencent.com/) 开通服务后才能使用。
|
|
10
|
+
|
|
11
|
+
# 获取安装
|
|
12
|
+
|
|
13
|
+
使用 SDK 需要 API 密钥,可前往 [腾讯云控制台 - 访问密钥](https://console.cloud.tencent.com/cam/capi) 页面申请,API 密钥包括 SecretID 和 SecretKey,密钥须严格保管,避免泄露。
|
|
14
|
+
|
|
15
|
+
## 通过 npm 安装
|
|
16
|
+
|
|
17
|
+
通过 npm 获取安装是使用 Node.js SDK 的推荐方法,关于 npm 详细可参考 [NPM 官网](https://www.npmjs.com/) 。
|
|
18
|
+
|
|
19
|
+
### 安装指定产品 SDK(推荐)
|
|
20
|
+
|
|
21
|
+
安装 CVM SDK:
|
|
22
|
+
|
|
23
|
+
```
|
|
24
|
+
npm install tencentcloud-sdk-nodejs-cvm --save
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
安装 VPC SDK:
|
|
28
|
+
|
|
29
|
+
```
|
|
30
|
+
npm install tencentcloud-sdk-nodejs-vpc --save
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
具体产品的缩写表请参考 [products.md](./products.md) 中的包名字段。
|
|
34
|
+
|
|
35
|
+
安装指定产品 SDK 后,注意修改引入的包名:
|
|
36
|
+
|
|
37
|
+
```diff
|
|
38
|
+
- const tencentcloud = require("tencentcloud-sdk-nodejs")
|
|
39
|
+
+ const { cvm } = require("tencentcloud-sdk-nodejs-cvm")
|
|
40
|
+
|
|
41
|
+
- const CvmClient = tencentcloud.cvm.v20170312.Client
|
|
42
|
+
+ const CvmClient = cvm.v20170312.Client
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
### 安装全产品 SDK
|
|
46
|
+
|
|
47
|
+
如果项目依赖的云产品较多,可以引入全产品 SDK。
|
|
48
|
+
|
|
49
|
+
```
|
|
50
|
+
npm install tencentcloud-sdk-nodejs --save
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
全产品 SDK 包含所有云产品调用代码和 TypeScript 类型文件,体积偏大。对于体积敏感的场景,推荐安装指定产品 SDK。
|
|
54
|
+
|
|
55
|
+
如果既希望全产品调用,又对包体积比较敏感,可以使用 Slim 版本 SDK。Slim SDK 移除类型文件,并进行了代码压缩,适合体积敏感场景使用:
|
|
56
|
+
|
|
57
|
+
```
|
|
58
|
+
npm install tencentcloud-sdk-slim-nodejs --save
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
## 通过源码包安装
|
|
62
|
+
|
|
63
|
+
1. clone 代码到本地:
|
|
64
|
+
```
|
|
65
|
+
git clone https://github.com/tencentcloud/tencentcloud-sdk-nodejs
|
|
66
|
+
# 或者
|
|
67
|
+
git clone https://gitee.com/tencentcloud/tencentcloud-sdk-nodejs
|
|
68
|
+
```
|
|
69
|
+
2. 在项目根目录执行以下命令完成构建:
|
|
70
|
+
```
|
|
71
|
+
npm install && npm run build
|
|
72
|
+
```
|
|
73
|
+
3. 打包 NPM 压缩文件,例如 `tencentcloud-sdk-nodejs-4.0.0.tgz`
|
|
74
|
+
```
|
|
75
|
+
npm pack
|
|
76
|
+
```
|
|
77
|
+
4. 安装包到你的项目里:
|
|
78
|
+
```
|
|
79
|
+
npm install /path/to/tencentcloud-sdk-nodejs/tencentcloud-sdk-nodejs-4.0.0.tgz
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
# 示例
|
|
83
|
+
|
|
84
|
+
以云服务器产品查询可用区列表接口为例。
|
|
85
|
+
|
|
86
|
+
```js
|
|
87
|
+
const tencentcloud = require("tencentcloud-sdk-nodejs")
|
|
88
|
+
|
|
89
|
+
// 导入对应产品模块的client models。
|
|
90
|
+
const CvmClient = tencentcloud.cvm.v20170312.Client
|
|
91
|
+
|
|
92
|
+
// 实例化要请求产品(以cvm为例)的client对象
|
|
93
|
+
const client = new CvmClient({
|
|
94
|
+
// 为了保护密钥安全,建议将密钥设置在环境变量中或者配置文件中,请参考本文凭证管理章节。
|
|
95
|
+
// 硬编码密钥到代码中有可能随代码泄露而暴露,有安全隐患,并不推荐。
|
|
96
|
+
credential: {
|
|
97
|
+
secretId: process.env.TENCENTCLOUD_SECRET_ID,
|
|
98
|
+
secretKey: process.env.TENCENTCLOUD_SECRET_KEY,
|
|
99
|
+
},
|
|
100
|
+
// 产品地域
|
|
101
|
+
region: "ap-shanghai",
|
|
102
|
+
// 可选配置实例
|
|
103
|
+
profile: {
|
|
104
|
+
signMethod: "TC3-HMAC-SHA256", // 签名方法
|
|
105
|
+
httpProfile: {
|
|
106
|
+
reqMethod: "POST", // 请求方法
|
|
107
|
+
reqTimeout: 30, // 请求超时时间,默认60s
|
|
108
|
+
headers: {
|
|
109
|
+
// 自定义 header
|
|
110
|
+
},
|
|
111
|
+
// proxy: "http://127.0.0.1:8899" // http请求代理
|
|
112
|
+
},
|
|
113
|
+
},
|
|
114
|
+
})
|
|
115
|
+
// 通过client对象调用想要访问的接口(Action),需要传入请求对象(Params)以及响应回调函数
|
|
116
|
+
// 即:client.Action(Params).then(res => console.log(res), err => console.error(err))
|
|
117
|
+
// 如:查询云服务器可用区列表
|
|
118
|
+
client.DescribeZones().then(
|
|
119
|
+
(data) => {
|
|
120
|
+
console.log(data)
|
|
121
|
+
},
|
|
122
|
+
(err) => {
|
|
123
|
+
console.error("error", err)
|
|
124
|
+
}
|
|
125
|
+
)
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
在支持 TypeScript 项目中,采用如下方式调用
|
|
129
|
+
|
|
130
|
+
```js
|
|
131
|
+
import * as tencentcloud from "tencentcloud-sdk-nodejs"
|
|
132
|
+
|
|
133
|
+
const CvmClient = tencentcloud.cvm.v20170312.Client
|
|
134
|
+
|
|
135
|
+
// ...
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
实例化 `Client` 的入参支持 `clientConfig`,数据结构和说明详见 [ClientConfig](https://github.com/TencentCloud/tencentcloud-sdk-nodejs/blob/master/src/common/interface.ts)。
|
|
139
|
+
|
|
140
|
+
## Common Client
|
|
141
|
+
|
|
142
|
+
从 4.0.714 版本开始,腾讯云 Node.js SDK 支持使用泛用性的 API 调用方式(Common Client)进行请求。您只需要安装 tencentcloud-sdk-nodejs-common 包,即可向任何产品发起调用。
|
|
143
|
+
|
|
144
|
+
**注意,您必须明确知道您调用的接口所需参数,否则可能会调用失败。**
|
|
145
|
+
|
|
146
|
+
详细使用请参阅示例:[使用 Common Client 进行调用](https://github.com/TencentCloud/tencentcloud-sdk-nodejs/tree/master/examples/common)
|
|
147
|
+
|
|
148
|
+
## 更多示例
|
|
149
|
+
|
|
150
|
+
请参考 [examples](https://github.com/TencentCloud/tencentcloud-sdk-nodejs/tree/master/examples) 目录。
|
|
151
|
+
|
|
152
|
+
# 相关配置
|
|
153
|
+
|
|
154
|
+
## 代理
|
|
155
|
+
|
|
156
|
+
如果是有代理的环境下,需要配置代理,请在创建 Client 时传入 [profile.httpProfile.proxy](https://github.com/TencentCloud/tencentcloud-sdk-nodejs/blob/master/src/common/interface.ts#L78) 参数,或设置系统环境变量 `http_proxy` ,否则可能无法正常调用,抛出连接超时的异常。
|
|
157
|
+
|
|
158
|
+
# 凭证管理
|
|
159
|
+
|
|
160
|
+
除显式传入凭证外,从 `v4.0.506` 起支持 [腾讯云实例角色](https://cloud.tencent.com/document/product/213/47668)
|
|
161
|
+
|
|
162
|
+
在您为实例绑定角色后,您可以在实例中访问相关元数据接口获取临时凭证。用法可参考 [js 示例代码](./examples/cvm_role.js) 或 [ts 示例代码](./examples/cvm_role.ts)
|
|
163
|
+
```javascript
|
|
164
|
+
// ...
|
|
165
|
+
const CvmRoleCredential = require("tencentcloud-sdk-nodejs/tencentcloud/common/cvm_role_credential").default
|
|
166
|
+
|
|
167
|
+
new XxxClient({
|
|
168
|
+
// ...
|
|
169
|
+
credential: new CvmRoleCredential(),
|
|
170
|
+
// ...
|
|
171
|
+
})
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
# 常见问题
|
|
175
|
+
- webpack 打包出错/浏览器报错
|
|
176
|
+
|
|
177
|
+
请**务必不要**将此 SDK 直接用于 Web 前端(包括小程序等),暴露密钥在这些环境非常不安全。
|
|
178
|
+
|
|
179
|
+
正确的做法是在自己的服务端引用此 SDK,并保存好密钥,做好请求鉴权,前端再调用服务端执行业务流程。
|
|
180
|
+
|
|
181
|
+
- `The "original" argument must be of type Function.`
|
|
182
|
+
|
|
183
|
+
通常是因为 Node.js 版本低于 `v10` ,或处于非 Node.js 环境,请再次确认执行环境。
|
|
184
|
+
|
|
185
|
+
- 请求不通
|
|
186
|
+
|
|
187
|
+
设置环境变量 `NODE_DEBUG=http` 来开启请求日志输出来定位问题,例如:
|
|
188
|
+
```sh
|
|
189
|
+
# MacOS
|
|
190
|
+
NODE_DEBUG=http node app.js
|
|
191
|
+
# windows cmd
|
|
192
|
+
set NODE_DEBUG=http & node app.js
|
|
193
|
+
# windows powershell
|
|
194
|
+
$env:NODE_DEBUG='http' ; node app.js
|
|
195
|
+
```
|
|
196
|
+
如需要配置代理,请查阅 [代理](#代理),或设置环境变量 `http_proxy`,例如:
|
|
197
|
+
```sh
|
|
198
|
+
# MacOS
|
|
199
|
+
http_proxy=http://代理地址:代理端口 node app.js
|
|
200
|
+
```
|
|
201
|
+
|
|
202
|
+
- 整数类型值超出 JavaScript 最大安全整数
|
|
203
|
+
使用新的数据类型 `BigInt`
|
package/es/index.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./services";
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common";
|
|
2
|
+
export class Client extends TencentCloudCommon.AbstractClient {
|
|
3
|
+
constructor(clientConfig) {
|
|
4
|
+
super("ai3d.tencentcloudapi.com", "2025-05-13", clientConfig);
|
|
5
|
+
}
|
|
6
|
+
async SubmitHunyuanTo3DJob(req, cb) {
|
|
7
|
+
return this.request("SubmitHunyuanTo3DJob", req, cb);
|
|
8
|
+
}
|
|
9
|
+
async QueryHunyuanTo3DJob(req, cb) {
|
|
10
|
+
return this.request("QueryHunyuanTo3DJob", req, cb);
|
|
11
|
+
}
|
|
12
|
+
}
|
|
File without changes
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { ai3d } from "./ai3d";
|
package/package.json
ADDED
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "tencentcloud-sdk-nodejs-ai3d",
|
|
3
|
+
"version": "4.1.73",
|
|
4
|
+
"description": "腾讯云 API NODEJS SDK",
|
|
5
|
+
"main": "./tencentcloud/index.js",
|
|
6
|
+
"module": "./es/index.js",
|
|
7
|
+
"types": "./tencentcloud/index.d.ts",
|
|
8
|
+
"scripts": {
|
|
9
|
+
"test": "mocha -t 10000",
|
|
10
|
+
"build": "concurrently 'npm:build:cjs' 'npm:build:es'",
|
|
11
|
+
"build:cjs": "tsc -p tsconfig.json",
|
|
12
|
+
"build:es": "tsc -p tsconfig.es.json",
|
|
13
|
+
"build:slim": "node ./scripts/build_slim.js",
|
|
14
|
+
"prettier": "prettier --config prettier.config.js --write 'src/**/*.{tsx,ts,jsx,js,css,json,vue}'",
|
|
15
|
+
"clean": "rimraf tencentcloud es"
|
|
16
|
+
},
|
|
17
|
+
"engines": {
|
|
18
|
+
"node": ">=10"
|
|
19
|
+
},
|
|
20
|
+
"files": [
|
|
21
|
+
"tencentcloud",
|
|
22
|
+
"es"
|
|
23
|
+
],
|
|
24
|
+
"keywords": [
|
|
25
|
+
"tencentcloudapi",
|
|
26
|
+
"tencentcloud",
|
|
27
|
+
"qcloud",
|
|
28
|
+
"sdk",
|
|
29
|
+
"js",
|
|
30
|
+
"nodejs"
|
|
31
|
+
],
|
|
32
|
+
"author": "tencentcloudapi",
|
|
33
|
+
"license": "Apache-2.0",
|
|
34
|
+
"dependencies": {
|
|
35
|
+
"tencentcloud-sdk-nodejs-common": "*",
|
|
36
|
+
"tslib": "1.13.0"
|
|
37
|
+
},
|
|
38
|
+
"directories": {
|
|
39
|
+
"example": "examples",
|
|
40
|
+
"lib": "lib"
|
|
41
|
+
},
|
|
42
|
+
"repository": {
|
|
43
|
+
"type": "git",
|
|
44
|
+
"url": "https://github.com/tencentcloud/tencentcloud-sdk-nodejs"
|
|
45
|
+
},
|
|
46
|
+
"devDependencies": {
|
|
47
|
+
"@types/form-data": "^2.5.0",
|
|
48
|
+
"@types/json-bigint": "^1.0.1",
|
|
49
|
+
"@types/node": "^14.0.26",
|
|
50
|
+
"@types/node-fetch": "^2.5.7",
|
|
51
|
+
"@types/uuid": "^9.0.8",
|
|
52
|
+
"@typescript-eslint/eslint-plugin": "^2.34.0",
|
|
53
|
+
"@typescript-eslint/parser": "^2.34.0",
|
|
54
|
+
"babel-eslint": "^10.0.2",
|
|
55
|
+
"chai": "^4.2.0",
|
|
56
|
+
"concurrently": "^6.5.1",
|
|
57
|
+
"esbuild": "^0.25.0",
|
|
58
|
+
"eslint": "^6.8.0",
|
|
59
|
+
"eslint-plugin-react": "^7.17.0",
|
|
60
|
+
"mocha": "^8.4.0",
|
|
61
|
+
"prettier": "^2.3.0",
|
|
62
|
+
"rimraf": "^5.0.10",
|
|
63
|
+
"ts-node": "^8.10.2",
|
|
64
|
+
"typescript": "^3.9.7"
|
|
65
|
+
}
|
|
66
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./services";
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common";
|
|
2
|
+
import { QueryHunyuanTo3DJobRequest, SubmitHunyuanTo3DJobResponse, QueryHunyuanTo3DJobResponse, SubmitHunyuanTo3DJobRequest } from "./ai3d_models";
|
|
3
|
+
/**
|
|
4
|
+
* ai3d client
|
|
5
|
+
* @class
|
|
6
|
+
*/
|
|
7
|
+
export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
8
|
+
constructor(clientConfig: TencentCloudCommon.ClientConfig);
|
|
9
|
+
/**
|
|
10
|
+
* 混元生3D接口,基于混元大模型,根据输入的文本描述/图片智能生成3D。
|
|
11
|
+
默认提供1个并发,代表最多能同时处理1个已提交的任务,上一个任务处理完毕后,才能开始处理下一个任务。
|
|
12
|
+
*/
|
|
13
|
+
SubmitHunyuanTo3DJob(req: SubmitHunyuanTo3DJobRequest, cb?: (error: string, rep: SubmitHunyuanTo3DJobResponse) => void): Promise<SubmitHunyuanTo3DJobResponse>;
|
|
14
|
+
/**
|
|
15
|
+
* 混元生3D接口,基于混元大模型,根据输入的文本描述/图片智能生成3D。
|
|
16
|
+
默认提供1个并发,代表最多能同时处理1个已提交的任务,上一个任务处理完毕后,才能开始处理下一个任务。
|
|
17
|
+
*/
|
|
18
|
+
QueryHunyuanTo3DJob(req: QueryHunyuanTo3DJobRequest, cb?: (error: string, rep: QueryHunyuanTo3DJobResponse) => void): Promise<QueryHunyuanTo3DJobResponse>;
|
|
19
|
+
}
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.Client = void 0;
|
|
4
|
+
const tslib_1 = require("tslib");
|
|
5
|
+
/* eslint-disable @typescript-eslint/no-unused-vars */
|
|
6
|
+
/*
|
|
7
|
+
* Copyright (c) 2018 Tencent. All Rights Reserved.
|
|
8
|
+
*
|
|
9
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
10
|
+
* you may not use this file except in compliance with the License.
|
|
11
|
+
* You may obtain a copy of the License at
|
|
12
|
+
*
|
|
13
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
14
|
+
*
|
|
15
|
+
* Unless required by applicable law or agreed to in writing,
|
|
16
|
+
* software distributed under the License is distributed on an
|
|
17
|
+
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
18
|
+
* KIND, either express or implied. See the License for the
|
|
19
|
+
* specific language governing permissions and limitations
|
|
20
|
+
* under the License.
|
|
21
|
+
*/
|
|
22
|
+
const TencentCloudCommon = tslib_1.__importStar(require("tencentcloud-sdk-nodejs-common"));
|
|
23
|
+
/**
|
|
24
|
+
* ai3d client
|
|
25
|
+
* @class
|
|
26
|
+
*/
|
|
27
|
+
class Client extends TencentCloudCommon.AbstractClient {
|
|
28
|
+
constructor(clientConfig) {
|
|
29
|
+
super("ai3d.tencentcloudapi.com", "2025-05-13", clientConfig);
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* 混元生3D接口,基于混元大模型,根据输入的文本描述/图片智能生成3D。
|
|
33
|
+
默认提供1个并发,代表最多能同时处理1个已提交的任务,上一个任务处理完毕后,才能开始处理下一个任务。
|
|
34
|
+
*/
|
|
35
|
+
async SubmitHunyuanTo3DJob(req, cb) {
|
|
36
|
+
return this.request("SubmitHunyuanTo3DJob", req, cb);
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* 混元生3D接口,基于混元大模型,根据输入的文本描述/图片智能生成3D。
|
|
40
|
+
默认提供1个并发,代表最多能同时处理1个已提交的任务,上一个任务处理完毕后,才能开始处理下一个任务。
|
|
41
|
+
*/
|
|
42
|
+
async QueryHunyuanTo3DJob(req, cb) {
|
|
43
|
+
return this.request("QueryHunyuanTo3DJob", req, cb);
|
|
44
|
+
}
|
|
45
|
+
}
|
|
46
|
+
exports.Client = Client;
|
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* QueryHunyuanTo3DJob请求参数结构体
|
|
3
|
+
*/
|
|
4
|
+
export interface QueryHunyuanTo3DJobRequest {
|
|
5
|
+
/**
|
|
6
|
+
* 任务ID。
|
|
7
|
+
*/
|
|
8
|
+
JobId?: string;
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* 多视角图片
|
|
12
|
+
*/
|
|
13
|
+
export interface ViewImage {
|
|
14
|
+
/**
|
|
15
|
+
* 视角类型。
|
|
16
|
+
取值:back、left、right
|
|
17
|
+
*/
|
|
18
|
+
ViewType?: string;
|
|
19
|
+
/**
|
|
20
|
+
* 图片Url地址
|
|
21
|
+
*/
|
|
22
|
+
ViewImageUrl?: string;
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* SubmitHunyuanTo3DJob返回参数结构体
|
|
26
|
+
*/
|
|
27
|
+
export interface SubmitHunyuanTo3DJobResponse {
|
|
28
|
+
/**
|
|
29
|
+
* 任务ID(有效期24小时)
|
|
30
|
+
*/
|
|
31
|
+
JobId?: string;
|
|
32
|
+
/**
|
|
33
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
34
|
+
*/
|
|
35
|
+
RequestId?: string;
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* 3D文件
|
|
39
|
+
*/
|
|
40
|
+
export interface File3D {
|
|
41
|
+
/**
|
|
42
|
+
* 3D文件的格式。取值范围:OBJ
|
|
43
|
+
*/
|
|
44
|
+
Type?: string;
|
|
45
|
+
/**
|
|
46
|
+
* 文件的Url(有效期24小时)
|
|
47
|
+
*/
|
|
48
|
+
Url?: string;
|
|
49
|
+
/**
|
|
50
|
+
* 预览图片Url
|
|
51
|
+
*/
|
|
52
|
+
PreviewImageUrl?: string;
|
|
53
|
+
}
|
|
54
|
+
/**
|
|
55
|
+
* QueryHunyuanTo3DJob返回参数结构体
|
|
56
|
+
*/
|
|
57
|
+
export interface QueryHunyuanTo3DJobResponse {
|
|
58
|
+
/**
|
|
59
|
+
* 任务状态。WAIT:等待中,RUN:执行中,FAIL:任务失败,DONE:任务成功
|
|
60
|
+
*/
|
|
61
|
+
Status?: string;
|
|
62
|
+
/**
|
|
63
|
+
* 错误码
|
|
64
|
+
*/
|
|
65
|
+
ErrorCode?: string;
|
|
66
|
+
/**
|
|
67
|
+
* 错误信息
|
|
68
|
+
*/
|
|
69
|
+
ErrorMessage?: string;
|
|
70
|
+
/**
|
|
71
|
+
* 生成的3D文件数组。
|
|
72
|
+
*/
|
|
73
|
+
ResultFile3Ds?: Array<File3D>;
|
|
74
|
+
/**
|
|
75
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
76
|
+
*/
|
|
77
|
+
RequestId?: string;
|
|
78
|
+
}
|
|
79
|
+
/**
|
|
80
|
+
* SubmitHunyuanTo3DJob请求参数结构体
|
|
81
|
+
*/
|
|
82
|
+
export interface SubmitHunyuanTo3DJobRequest {
|
|
83
|
+
/**
|
|
84
|
+
* 文生3D,3D内容的描述,中文正向提示词。
|
|
85
|
+
最多支持200个 utf-8 字符。
|
|
86
|
+
文生3D, image、image_url和 prompt必填其一,且prompt和image/image_url不能同时存在。
|
|
87
|
+
*/
|
|
88
|
+
Prompt?: string;
|
|
89
|
+
/**
|
|
90
|
+
* 输入图 Base64 数据。
|
|
91
|
+
大小:单边分辨率要求不小于128,不大于5000。大小不超过8m(base64编码后会大30%左右,建议实际输入图片不超过6m)
|
|
92
|
+
格式:jpg,png,jpeg,webp。
|
|
93
|
+
ImageBase64、ImageUrl和 Prompt必填其一,且Prompt和ImageBase64/ImageUrl不能同时存在。
|
|
94
|
+
*/
|
|
95
|
+
ImageBase64?: string;
|
|
96
|
+
/**
|
|
97
|
+
* 输入图Url。
|
|
98
|
+
大小:单边分辨率要求不小于128,不大于5000。大小不超过8m(base64编码后会大30%左右,建议实际输入图片不超过6m)
|
|
99
|
+
格式:jpg,png,jpeg,webp。
|
|
100
|
+
ImageBase64/ImageUrl和 Prompt必填其一,且Prompt和ImageBase64/ImageUrl不能同时存在。
|
|
101
|
+
*/
|
|
102
|
+
ImageUrl?: string;
|
|
103
|
+
/**
|
|
104
|
+
* 多视角的模型图片,视角参考值:
|
|
105
|
+
left:左视图;
|
|
106
|
+
right:右视图;
|
|
107
|
+
back:后视图;
|
|
108
|
+
|
|
109
|
+
每个视角仅限制一张图片。
|
|
110
|
+
●图片大小限制:编码后大小不可超过8M。
|
|
111
|
+
●图片分辨率限制:单边分辨率小于5000且大于128。
|
|
112
|
+
●支持图片格式:支持jpg或png
|
|
113
|
+
*/
|
|
114
|
+
MultiViewImages?: Array<ViewImage>;
|
|
115
|
+
/**
|
|
116
|
+
* 生成模型的格式,仅限制生成一种格式。
|
|
117
|
+
生成模型文件组默认返回obj格式。
|
|
118
|
+
可选值:OBJ,GLB,STL,USDZ,FBX,MP4。
|
|
119
|
+
*/
|
|
120
|
+
ResultFormat?: string;
|
|
121
|
+
/**
|
|
122
|
+
* 是否开启 PBR材质生成,默认 false。
|
|
123
|
+
*/
|
|
124
|
+
EnablePBR?: boolean;
|
|
125
|
+
}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/*
|
|
3
|
+
* Copyright (c) 2018 Tencent. All Rights Reserved.
|
|
4
|
+
*
|
|
5
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
* you may not use this file except in compliance with the License.
|
|
7
|
+
* You may obtain a copy of the License at
|
|
8
|
+
*
|
|
9
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
*
|
|
11
|
+
* Unless required by applicable law or agreed to in writing,
|
|
12
|
+
* software distributed under the License is distributed on an
|
|
13
|
+
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
14
|
+
* KIND, either express or implied. See the License for the
|
|
15
|
+
* specific language governing permissions and limitations
|
|
16
|
+
* under the License.
|
|
17
|
+
*/
|
|
18
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.v20250513 = void 0;
|
|
4
|
+
const tslib_1 = require("tslib");
|
|
5
|
+
const Models = tslib_1.__importStar(require("./ai3d_models"));
|
|
6
|
+
const ai3d_client_1 = require("./ai3d_client");
|
|
7
|
+
exports.v20250513 = {
|
|
8
|
+
Client: ai3d_client_1.Client,
|
|
9
|
+
Models: Models,
|
|
10
|
+
};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { ai3d } from "./ai3d";
|