SDK 接入指引

最近更新时间:2024-09-10 14:22:11

我的收藏
推荐使用腾讯云 API 配套的 7 种常见的编程语言 SDK,已经封装了签名和请求过程,开发时只关注产品提供的具体接口即可。

API文档

参考 文本内容安全 接口文档,了解需要使用的参数。

SDK使用说明

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,均已开源,能更方便的调用 API,支持 PythonJavaPHPGoNodeJS.NETC++。 各语言SDK使用说明可参考 文档,介绍依赖版本以及安装过程等。

建议安装最新版本的SDK,即可调用接口,腾讯云提供了 API Explorer 可在线调用,并且可以快速生成 SDK 调用示例代码,以下Java、python、Golang示例均从 API Explorer 生成,其他语言可自行调试获取。

在线调用示例



代码生成示例


Java
Go
Python
import com.tencentcloudapi.common.Credential;
import com.tencentcloudapi.common.profile.ClientProfile;
import com.tencentcloudapi.common.profile.HttpProfile;
import com.tencentcloudapi.common.exception.TencentCloudSDKException;
import com.tencentcloudapi.tms.v20201229.TmsClient;
import com.tencentcloudapi.tms.v20201229.models.*;

public class TextModeration
{
public static void main(String [] args) {
try{
// 实例化一个认证对象,入参需要传入腾讯云账户 SecretId 和 SecretKey,此处还需注意密钥对的保密
// 代码泄露可能会导致 SecretId 和 SecretKey 泄露,并威胁账号下所有资源的安全性。以下代码示例仅供参考,建议采用更安全的方式来使用密钥,请参见:https://cloud.tencent.com/document/product/1278/85305
// 密钥可前往官网控制台 https://console.cloud.tencent.com/cam/capi 进行获取
Credential cred = new Credential("SecretId", "SecretKey");
// 实例化一个http选项,可选的,没有特殊需求可以跳过
HttpProfile httpProfile = new HttpProfile();
httpProfile.setEndpoint("tms.tencentcloudapi.com");
// 实例化一个client选项,可选的,没有特殊需求可以跳过
ClientProfile clientProfile = new ClientProfile();
clientProfile.setHttpProfile(httpProfile);
// 实例化要请求产品的client对象,clientProfile是可选的
TmsClient client = new TmsClient(cred, "ap-guangzhou", clientProfile);
// 实例化一个请求对象,每个接口都会对应一个request对象
TextModerationRequest req = new TextModerationRequest();
req.setContent("5Yqg5b6u5L+h");
req.setBizType("default");
// 返回的resp是一个TextModerationResponse的实例,与请求对象对应
TextModerationResponse resp = client.TextModeration(req);
// 输出json格式的字符串回包
System.out.println(TextModerationResponse.toJsonString(resp));
} catch (TencentCloudSDKException e) {
System.out.println(e.toString());
}
}
}
package main

import (
"fmt"

"github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common"
"github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common/errors"
"github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common/profile"
tms "github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/tms/v20201229"
)

func main() {
// 实例化一个认证对象,入参需要传入腾讯云账户 SecretId 和 SecretKey,此处还需注意密钥对的保密
// 代码泄露可能会导致 SecretId 和 SecretKey 泄露,并威胁账号下所有资源的安全性。以下代码示例仅供参考,建议采用更安全的方式来使用密钥,请参见:https://cloud.tencent.com/document/product/1278/85305
// 密钥可前往官网控制台 https://console.cloud.tencent.com/cam/capi 进行获取
credential := common.NewCredential(
"SecretId",
"SecretKey",
)
// 实例化一个client选项,可选的,没有特殊需求可以跳过
cpf := profile.NewClientProfile()
cpf.HttpProfile.Endpoint = "tms.tencentcloudapi.com"
// 实例化要请求产品的client对象,clientProfile是可选的
client, _ := tms.NewClient(credential, "ap-guangzhou", cpf)

// 实例化一个请求对象,每个接口都会对应一个request对象
request := tms.NewTextModerationRequest()
request.Content = common.StringPtr("5Yqg5b6u5L+h")
request.BizType = common.StringPtr("default")

// 返回的resp是一个TextModerationResponse的实例,与请求对象对应
response, err := client.TextModeration(request)
if _, ok := err.(*errors.TencentCloudSDKError); ok {
fmt.Printf("An API error has returned: %s", err)
return
}
if err != nil {
panic(err)
}
// 输出json格式的字符串回包
fmt.Printf("%s", response.ToJsonString())
}
import json
from tencentcloud.common import credential
from tencentcloud.common.profile.client_profile import ClientProfile
from tencentcloud.common.profile.http_profile import HttpProfile
from tencentcloud.common.exception.tencent_cloud_sdk_exception import TencentCloudSDKException
from tencentcloud.tms.v20201229 import tms_client, models
try:
# 实例化一个认证对象,入参需要传入腾讯云账户 SecretId 和 SecretKey,此处还需注意密钥对的保密
# 代码泄露可能会导致 SecretId 和 SecretKey 泄露,并威胁账号下所有资源的安全性。以下代码示例仅供参考,建议采用更安全的方式来使用密钥,请参见:https://cloud.tencent.com/document/product/1278/85305
# 密钥可前往官网控制台 https://console.cloud.tencent.com/cam/capi 进行获取
cred = credential.Credential("SecretId", "SecretKey")
# 实例化一个http选项,可选的,没有特殊需求可以跳过
httpProfile = HttpProfile()
httpProfile.endpoint = "tms.tencentcloudapi.com"

# 实例化一个client选项,可选的,没有特殊需求可以跳过
clientProfile = ClientProfile()
clientProfile.httpProfile = httpProfile
# 实例化要请求产品的client对象,clientProfile是可选的
client = tms_client.TmsClient(cred, "ap-guangzhou", clientProfile)

# 实例化一个请求对象,每个接口都会对应一个request对象
req = models.TextModerationRequest()
params = {
"Content": "5Yqg5b6u5L+h",
"BizType": "default"
}
req.from_json_string(json.dumps(params))

# 返回的resp是一个TextModerationResponse的实例,与请求对象对应
resp = client.TextModeration(req)
# 输出json格式的字符串回包
print(resp.to_json_string())

except TencentCloudSDKException as err:
print(err)

热点问题

SDK 是否支持设置超时时间?

SDK 具有默认的超时时间,除非必要,请勿更改默认设置。如果需要修改,可以 参考 SDK仓库 的详细版示例。


多线程是否可以共用一个 Client?

SDK 目前不支持线程安全,因此需要在每个线程中创建一个 Client 来进行请求。

同时连接数量是否有限制?

目前没有限制,但是接口会限制每秒请求数(QPS)的并发数,文本接口默认为100QPS。建议客户端也控制并发数,因为太多线程可能超出用户机器的处理能力,导致连接失败。