BdaClient (tencentcloud-sdk-java 3.1.353 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractClient
- - com.tencentcloudapi.bda.v20200324.BdaClient

public class BdaClient
extends AbstractClient

Field Summary
- Fields inherited from class com.tencentcloudapi.common.AbstractClient
  gson, HTTP_RSP_OK, SDK_VERSION

Constructor Summary

Constructors
Constructor and Description
`BdaClient(Credential credential, String region)`
`BdaClient(Credential credential, String region, ClientProfile profile)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateGroupResponse`	`CreateGroup(CreateGroupRequest req)` 用于创建一个空的人体库，如果人体库已存在返回错误。 1个APPID下最多有2000W个人体轨迹（Trace），最多1W个人体库（Group）。单个人体库（Group）最多10W个人体轨迹（Trace）。单个人员（Person）最多添加 5 个人体轨迹（Trace）。
`CreatePersonResponse`	`CreatePerson(CreatePersonRequest req)` 创建人员，添加对应人员的人体轨迹信息。请注意： - 我们希望您的输入为严格符合轨迹图片要求的图片。如果您输入的图片不符合轨迹图片要求，会对最终效果产生较大负面影响。请您尽量保证一个Trace中的图片人体清晰、无遮挡、连贯； - 一个人体轨迹（Trace）可以包含1-5张人体图片。提供越多质量高的人体图片有助于提升最终识别结果； - 无论您在单个Trace中提供了多少张人体图片，我们都将生成一个对应的轨迹（Trace）信息。即，Trace仅和本次输入的图片序列相关，和图片的个数无关； - 输入的图片组中，若有部分图片输入不合法（如图片大小过大、分辨率过大、无法解码等），我们将舍弃这部分图片，确保合法图片被正确搜索。即，我们将尽可能保证请求成功，去除不合法的输入； - 构成人体轨迹单张图片大小不得超过2M，分辨率不得超过1920*1080。
`CreateSegmentationTaskResponse`	`CreateSegmentationTask(CreateSegmentationTaskRequest req)` 本接口为离线人像分割处理接口组中的提交任务接口，可以对提交的资源进行处理视频流/图片流识别视频作品中的人像区域，进行一键抠像、背景替换、人像虚化等后期处理。
`CreateTraceResponse`	`CreateTrace(CreateTraceRequest req)` 将一个人体轨迹添加到一个人员中。一个人员最多允许包含 5 个人体轨迹。同一人的人体轨迹越多，搜索识别效果越好。 >请注意： - 我们希望您的输入为严格符合轨迹图片要求的图片。如果您输入的图片不符合轨迹图片要求，会对最终效果产生较大负面影响。请您尽量保证一个Trace中的图片人体清晰、无遮挡、连贯。 - 一个人体轨迹（Trace）可以包含1-5张人体图片。提供越多质量高的人体图片有助于提升最终识别结果。 - 无论您在单个Trace中提供了多少张人体图片，我们都将生成一个对应的轨迹（Trace）信息。即，Trace仅和本次输入的图片序列相关，和图片的个数无关。 - 输入的图片组中，若有部分图片输入不合法（如图片大小过大、分辨率过大、无法解码等），我们将舍弃这部分图片，确保合法图片被正确搜索。即，我们将尽可能保证请求成功，去除不合法的输入； - 构成人体轨迹单张图片大小限制为2M，分辨率限制为1920*1080。
`DeleteGroupResponse`	`DeleteGroup(DeleteGroupRequest req)` 删除该人体库及包含的所有的人员。
`DeletePersonResponse`	`DeletePerson(DeletePersonRequest req)` 删除人员。
`DescribeSegmentationTaskResponse`	`DescribeSegmentationTask(DescribeSegmentationTaskRequest req)` 可以查看单条任务的处理情况，包括处理状态，处理结果。
`DetectBodyResponse`	`DetectBody(DetectBodyRequest req)` 检测给定图片中的人体（Body）的位置信息及属性信息。
`DetectBodyJointsResponse`	`DetectBodyJoints(DetectBodyJointsRequest req)` 检测图片中人体的14个关键点。建议用于人体图像清晰、无遮挡的场景。支持一张图片中存在多个人体的识别。
`GetGroupListResponse`	`GetGroupList(GetGroupListRequest req)` 获取人体库列表。
`GetPersonListResponse`	`GetPersonList(GetPersonListRequest req)` 获取指定人体库中的人员列表。
`GetSummaryInfoResponse`	`GetSummaryInfo(GetSummaryInfoRequest req)` 获取人体库汇总信息。
`ModifyGroupResponse`	`ModifyGroup(ModifyGroupRequest req)` 修改人体库名称、备注。
`ModifyPersonInfoResponse`	`ModifyPersonInfo(ModifyPersonInfoRequest req)` 修改人员信息。
`SearchTraceResponse`	`SearchTrace(SearchTraceRequest req)` 本接口用于对一组待识别的人体轨迹（Trace）图片，在人体库中识别出最相似的 TopK 人体，按照相似度从大到小排列。人体轨迹（Trace）图片要求：图片中当且仅包含一个人体。人体完整、无遮挡。 > 请注意： - 我们希望您的输入为严格符合轨迹图片要求的图片。如果您输入的图片不符合轨迹图片要求，会对最终效果产生较大负面影响； - 人体轨迹，是一个包含1-5张图片的图片序列。您可以输入1张图片作为轨迹，也可以输入多张。单个轨迹中包含越多符合质量的图片，搜索效果越好。 - 构成人体轨迹单张图片大小不得超过2M，分辨率不得超过1920*1080。
`SegmentCustomizedPortraitPicResponse`	`SegmentCustomizedPortraitPic(SegmentCustomizedPortraitPicRequest req)` 在前后景分割的基础上优化多分类分割，支持对头发、五官等的分割，既作为换发型、挂件等底层技术，也可用于抠人头、抠人脸等玩法
`SegmentPortraitPicResponse`	`SegmentPortraitPic(SegmentPortraitPicRequest req)` 即二分类人像分割，识别传入图片中人体的完整轮廓，进行抠像。
`TerminateSegmentationTaskResponse`	`TerminateSegmentationTask(TerminateSegmentationTaskRequest req)` 终止指定视频人像分割处理任务

Methods inherited from class com.tencentcloudapi.common.AbstractClient
call, callOctetStream, getClientProfile, getCredential, getRegion, internalRequest, retry, setClientProfile, setCredential, setRegion

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BdaClient
```
public BdaClient(Credential credential,
                 String region)
```
  - BdaClient
```
public BdaClient(Credential credential,
                 String region,
                 ClientProfile profile)
```
- Method Detail
  - CreateGroup
```
public CreateGroupResponse CreateGroup(CreateGroupRequest req)
                                throws TencentCloudSDKException
```
    用于创建一个空的人体库，如果人体库已存在返回错误。 1个APPID下最多有2000W个人体轨迹（Trace），最多1W个人体库（Group）。单个人体库（Group）最多10W个人体轨迹（Trace）。单个人员（Person）最多添加 5 个人体轨迹（Trace）。
    
    Parameters:
    
    req - CreateGroupRequest
    
    Returns:
    
    CreateGroupResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreatePerson
```
public CreatePersonResponse CreatePerson(CreatePersonRequest req)
                                  throws TencentCloudSDKException
```
    创建人员，添加对应人员的人体轨迹信息。请注意： - 我们希望您的输入为严格符合轨迹图片要求的图片。如果您输入的图片不符合轨迹图片要求，会对最终效果产生较大负面影响。请您尽量保证一个Trace中的图片人体清晰、无遮挡、连贯； - 一个人体轨迹（Trace）可以包含1-5张人体图片。提供越多质量高的人体图片有助于提升最终识别结果； - 无论您在单个Trace中提供了多少张人体图片，我们都将生成一个对应的轨迹（Trace）信息。即，Trace仅和本次输入的图片序列相关，和图片的个数无关； - 输入的图片组中，若有部分图片输入不合法（如图片大小过大、分辨率过大、无法解码等），我们将舍弃这部分图片，确保合法图片被正确搜索。即，我们将尽可能保证请求成功，去除不合法的输入； - 构成人体轨迹单张图片大小不得超过2M，分辨率不得超过1920*1080。
    
    Parameters:
    
    req - CreatePersonRequest
    
    Returns:
    
    CreatePersonResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateSegmentationTask
```
public CreateSegmentationTaskResponse CreateSegmentationTask(CreateSegmentationTaskRequest req)
                                                      throws TencentCloudSDKException
```
    本接口为离线人像分割处理接口组中的提交任务接口，可以对提交的资源进行处理视频流/图片流识别视频作品中的人像区域，进行一键抠像、背景替换、人像虚化等后期处理。
    
    Parameters:
    
    req - CreateSegmentationTaskRequest
    
    Returns:
    
    CreateSegmentationTaskResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateTrace
```
public CreateTraceResponse CreateTrace(CreateTraceRequest req)
                                throws TencentCloudSDKException
```
    将一个人体轨迹添加到一个人员中。一个人员最多允许包含 5 个人体轨迹。同一人的人体轨迹越多，搜索识别效果越好。 >请注意： - 我们希望您的输入为严格符合轨迹图片要求的图片。如果您输入的图片不符合轨迹图片要求，会对最终效果产生较大负面影响。请您尽量保证一个Trace中的图片人体清晰、无遮挡、连贯。 - 一个人体轨迹（Trace）可以包含1-5张人体图片。提供越多质量高的人体图片有助于提升最终识别结果。 - 无论您在单个Trace中提供了多少张人体图片，我们都将生成一个对应的轨迹（Trace）信息。即，Trace仅和本次输入的图片序列相关，和图片的个数无关。 - 输入的图片组中，若有部分图片输入不合法（如图片大小过大、分辨率过大、无法解码等），我们将舍弃这部分图片，确保合法图片被正确搜索。即，我们将尽可能保证请求成功，去除不合法的输入； - 构成人体轨迹单张图片大小限制为2M，分辨率限制为1920*1080。
    
    Parameters:
    
    req - CreateTraceRequest
    
    Returns:
    
    CreateTraceResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteGroup
```
public DeleteGroupResponse DeleteGroup(DeleteGroupRequest req)
                                throws TencentCloudSDKException
```
    删除该人体库及包含的所有的人员。
    
    Parameters:
    
    req - DeleteGroupRequest
    
    Returns:
    
    DeleteGroupResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeletePerson
```
public DeletePersonResponse DeletePerson(DeletePersonRequest req)
                                  throws TencentCloudSDKException
```
    删除人员。
    
    Parameters:
    
    req - DeletePersonRequest
    
    Returns:
    
    DeletePersonResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeSegmentationTask
```
public DescribeSegmentationTaskResponse DescribeSegmentationTask(DescribeSegmentationTaskRequest req)
                                                          throws TencentCloudSDKException
```
    可以查看单条任务的处理情况，包括处理状态，处理结果。
    
    Parameters:
    
    req - DescribeSegmentationTaskRequest
    
    Returns:
    
    DescribeSegmentationTaskResponse
    
    Throws:
    
    TencentCloudSDKException
  - DetectBody
```
public DetectBodyResponse DetectBody(DetectBodyRequest req)
                              throws TencentCloudSDKException
```
    检测给定图片中的人体（Body）的位置信息及属性信息。
    
    Parameters:
    
    req - DetectBodyRequest
    
    Returns:
    
    DetectBodyResponse
    
    Throws:
    
    TencentCloudSDKException
  - DetectBodyJoints
```
public DetectBodyJointsResponse DetectBodyJoints(DetectBodyJointsRequest req)
                                          throws TencentCloudSDKException
```
    检测图片中人体的14个关键点。建议用于人体图像清晰、无遮挡的场景。支持一张图片中存在多个人体的识别。
    
    Parameters:
    
    req - DetectBodyJointsRequest
    
    Returns:
    
    DetectBodyJointsResponse
    
    Throws:
    
    TencentCloudSDKException
  - GetGroupList
```
public GetGroupListResponse GetGroupList(GetGroupListRequest req)
                                  throws TencentCloudSDKException
```
    获取人体库列表。
    
    Parameters:
    
    req - GetGroupListRequest
    
    Returns:
    
    GetGroupListResponse
    
    Throws:
    
    TencentCloudSDKException
  - GetPersonList
```
public GetPersonListResponse GetPersonList(GetPersonListRequest req)
                                    throws TencentCloudSDKException
```
    获取指定人体库中的人员列表。
    
    Parameters:
    
    req - GetPersonListRequest
    
    Returns:
    
    GetPersonListResponse
    
    Throws:
    
    TencentCloudSDKException
  - GetSummaryInfo
```
public GetSummaryInfoResponse GetSummaryInfo(GetSummaryInfoRequest req)
                                      throws TencentCloudSDKException
```
    获取人体库汇总信息。
    
    Parameters:
    
    req - GetSummaryInfoRequest
    
    Returns:
    
    GetSummaryInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyGroup
```
public ModifyGroupResponse ModifyGroup(ModifyGroupRequest req)
                                throws TencentCloudSDKException
```
    修改人体库名称、备注。
    
    Parameters:
    
    req - ModifyGroupRequest
    
    Returns:
    
    ModifyGroupResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyPersonInfo
```
public ModifyPersonInfoResponse ModifyPersonInfo(ModifyPersonInfoRequest req)
                                          throws TencentCloudSDKException
```
    修改人员信息。
    
    Parameters:
    
    req - ModifyPersonInfoRequest
    
    Returns:
    
    ModifyPersonInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - SearchTrace
```
public SearchTraceResponse SearchTrace(SearchTraceRequest req)
                                throws TencentCloudSDKException
```
    本接口用于对一组待识别的人体轨迹（Trace）图片，在人体库中识别出最相似的 TopK 人体，按照相似度从大到小排列。人体轨迹（Trace）图片要求：图片中当且仅包含一个人体。人体完整、无遮挡。 > 请注意： - 我们希望您的输入为严格符合轨迹图片要求的图片。如果您输入的图片不符合轨迹图片要求，会对最终效果产生较大负面影响； - 人体轨迹，是一个包含1-5张图片的图片序列。您可以输入1张图片作为轨迹，也可以输入多张。单个轨迹中包含越多符合质量的图片，搜索效果越好。 - 构成人体轨迹单张图片大小不得超过2M，分辨率不得超过1920*1080。
    
    Parameters:
    
    req - SearchTraceRequest
    
    Returns:
    
    SearchTraceResponse
    
    Throws:
    
    TencentCloudSDKException
  - SegmentCustomizedPortraitPic
```
public SegmentCustomizedPortraitPicResponse SegmentCustomizedPortraitPic(SegmentCustomizedPortraitPicRequest req)
                                                                  throws TencentCloudSDKException
```
    在前后景分割的基础上优化多分类分割，支持对头发、五官等的分割，既作为换发型、挂件等底层技术，也可用于抠人头、抠人脸等玩法
    
    Parameters:
    
    req - SegmentCustomizedPortraitPicRequest
    
    Returns:
    
    SegmentCustomizedPortraitPicResponse
    
    Throws:
    
    TencentCloudSDKException
  - SegmentPortraitPic
```
public SegmentPortraitPicResponse SegmentPortraitPic(SegmentPortraitPicRequest req)
                                              throws TencentCloudSDKException
```
    即二分类人像分割，识别传入图片中人体的完整轮廓，进行抠像。
    
    Parameters:
    
    req - SegmentPortraitPicRequest
    
    Returns:
    
    SegmentPortraitPicResponse
    
    Throws:
    
    TencentCloudSDKException
  - TerminateSegmentationTask
```
public TerminateSegmentationTaskResponse TerminateSegmentationTask(TerminateSegmentationTaskRequest req)
                                                            throws TencentCloudSDKException
```
    终止指定视频人像分割处理任务
    
    Parameters:
    
    req - TerminateSegmentationTaskRequest
    
    Returns:
    
    TerminateSegmentationTaskResponse
    
    Throws:
    
    TencentCloudSDKException

Class BdaClient

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractClient

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractClient

Methods inherited from class java.lang.Object

Constructor Detail

BdaClient

BdaClient

Method Detail

CreateGroup

CreatePerson

CreateSegmentationTask

CreateTrace

DeleteGroup

DeletePerson

DescribeSegmentationTask

DetectBody

DetectBodyJoints

GetGroupList

GetPersonList

GetSummaryInfo

ModifyGroup

ModifyPersonInfo

SearchTrace

SegmentCustomizedPortraitPic

SegmentPortraitPic

TerminateSegmentationTask