HunyuanClient (tencentcloud-sdk-java 3.1.1121 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractClient
- - com.tencentcloudapi.hunyuan.v20230901.HunyuanClient

public class HunyuanClient
extends AbstractClient

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

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ActivateServiceResponse`	`ActivateService(ActivateServiceRequest req)` 开通服务
`ChatCompletionsResponse`	`ChatCompletions(ChatCompletionsRequest req)` 腾讯混元大模型是由腾讯研发的大语言模型，具备强大的中文创作能力，复杂语境下的逻辑推理能力，以及可靠的任务执行能力。本接口支持流式或非流式调用，当使用流式调用时为 SSE 协议。 1.
`GetEmbeddingResponse`	`GetEmbedding(GetEmbeddingRequest req)` 腾讯混元 Embedding 接口，可以将文本转化为高质量的向量数据。向量维度为1024维。
`GetTokenCountResponse`	`GetTokenCount(GetTokenCountRequest req)` 该接口用于计算文本对应Token数、字符数。
`QueryHunyuanImageChatJobResponse`	`QueryHunyuanImageChatJob(QueryHunyuanImageChatJobRequest req)` 混元生图（多轮对话）接口基于混元大模型，将根据输入的文本描述生成图像，支持通过多轮对话的方式不断调整图像内容。分为提交任务和查询任务2个接口。提交任务：输入文本和前置对话 ID 等，提交一个混元生图多轮对话异步任务，获得任务 ID。查询任务：根据任务 ID 查询任务的处理状态、处理结果，任务处理完成后可获得在上一轮对话基础上继续生成的图像结果。混元生图（多轮对话）默认提供1个并发任务数，代表最多能同时处理1个已提交的任务，上一个任务处理完毕后才能开始处理下一个任务。
`QueryHunyuanImageJobResponse`	`QueryHunyuanImageJob(QueryHunyuanImageJobRequest req)` 混元生图接口基于混元大模型，将根据输入的文本描述，智能生成与之相关的结果图。分为提交任务和查询任务2个接口。提交任务：输入文本等，提交一个混元生图异步任务，获得任务 ID。查询任务：根据任务 ID 查询任务的处理状态、处理结果，任务处理完成后可获得生成图像结果。并发任务数（并发）说明：并发任务数指能同时处理的任务数量。混元生图默认提供1个并发任务数，代表最多能同时处理1个已提交的任务，上一个任务处理完毕后才能开始处理下一个任务。
`SetPayModeResponse`	`SetPayMode(SetPayModeRequest req)` 设置付费模式
`SubmitHunyuanImageChatJobResponse`	`SubmitHunyuanImageChatJob(SubmitHunyuanImageChatJobRequest req)` 混元生图（多轮对话）接口基于混元大模型，将根据输入的文本描述生成图像，支持通过多轮对话的方式不断调整图像内容。分为提交任务和查询任务2个接口。提交任务：输入文本和前置对话 ID 等，提交一个混元生图多轮对话异步任务，获得任务 ID。查询任务：根据任务 ID 查询任务的处理状态、处理结果，任务处理完成后可获得在上一轮对话基础上继续生成的图像结果。混元生图（多轮对话）默认提供1个并发任务数，代表最多能同时处理1个已提交的任务，上一个任务处理完毕后才能开始处理下一个任务。
`SubmitHunyuanImageJobResponse`	`SubmitHunyuanImageJob(SubmitHunyuanImageJobRequest req)` 混元生图接口基于混元大模型，将根据输入的文本描述，智能生成与之相关的结果图。分为提交任务和查询任务2个接口。提交任务：输入文本等，提交一个混元生图异步任务，获得任务 ID。查询任务：根据任务 ID 查询任务的处理状态、处理结果，任务处理完成后可获得生成图像结果。并发任务数（并发）说明：并发任务数指能同时处理的任务数量。混元生图默认提供1个并发任务数，代表最多能同时处理1个已提交的任务，上一个任务处理完毕后才能开始处理下一个任务。
`TextToImageLiteResponse`	`TextToImageLite(TextToImageLiteRequest req)` 文生图轻量版接口根据输入的文本描述，智能生成与之相关的结果图。文生图轻量版默认提供3个并发任务数，代表最多能同时处理3个已提交的任务，上一个任务处理完毕后才能开始处理下一个任务。

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

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

- Constructor Detail
  - HunyuanClient
```
public HunyuanClient(Credential credential,
                     String region)
```
  - HunyuanClient
```
public HunyuanClient(Credential credential,
                     String region,
                     ClientProfile profile)
```
- Method Detail
  - ActivateService
```
public ActivateServiceResponse ActivateService(ActivateServiceRequest req)
                                        throws TencentCloudSDKException
```
    开通服务
    
    Parameters:
    
    req - ActivateServiceRequest
    
    Returns:
    
    ActivateServiceResponse
    
    Throws:
    
    TencentCloudSDKException
  - ChatCompletions
```
public ChatCompletionsResponse ChatCompletions(ChatCompletionsRequest req)
                                        throws TencentCloudSDKException
```
    腾讯混元大模型是由腾讯研发的大语言模型，具备强大的中文创作能力，复杂语境下的逻辑推理能力，以及可靠的任务执行能力。本接口支持流式或非流式调用，当使用流式调用时为 SSE 协议。 1. 本接口暂不支持返回图片内容。 2. 默认该接口下单账号限制并发数为 5 路，如您有提高并发限制的需求请 [购买](https://buy.cloud.tencent.com/hunyuan) 。 3. 请使用 SDK 调用本接口，每种开发语言的 SDK Git 仓库 examples/hunyuan/v20230901/ 目录下有提供示例供参考。SDK 链接在文档下方 “**开发者资源 - SDK**” 部分提供。 4. 我们推荐您使用 API Explorer，方便快速地在线调试接口和下载各语言的示例代码，[点击打开](https://console.cloud.tencent.com/api/explorer?Product=hunyuan&Version=2023-09-01&Action=ChatCompletions)。
    
    Parameters:
    
    req - ChatCompletionsRequest
    
    Returns:
    
    ChatCompletionsResponse
    
    Throws:
    
    TencentCloudSDKException
  - GetEmbedding
```
public GetEmbeddingResponse GetEmbedding(GetEmbeddingRequest req)
                                  throws TencentCloudSDKException
```
    腾讯混元 Embedding 接口，可以将文本转化为高质量的向量数据。向量维度为1024维。
    
    Parameters:
    
    req - GetEmbeddingRequest
    
    Returns:
    
    GetEmbeddingResponse
    
    Throws:
    
    TencentCloudSDKException
  - GetTokenCount
```
public GetTokenCountResponse GetTokenCount(GetTokenCountRequest req)
                                    throws TencentCloudSDKException
```
    该接口用于计算文本对应Token数、字符数。
    
    Parameters:
    
    req - GetTokenCountRequest
    
    Returns:
    
    GetTokenCountResponse
    
    Throws:
    
    TencentCloudSDKException
  - QueryHunyuanImageChatJob
```
public QueryHunyuanImageChatJobResponse QueryHunyuanImageChatJob(QueryHunyuanImageChatJobRequest req)
                                                          throws TencentCloudSDKException
```
    混元生图（多轮对话）接口基于混元大模型，将根据输入的文本描述生成图像，支持通过多轮对话的方式不断调整图像内容。分为提交任务和查询任务2个接口。提交任务：输入文本和前置对话 ID 等，提交一个混元生图多轮对话异步任务，获得任务 ID。查询任务：根据任务 ID 查询任务的处理状态、处理结果，任务处理完成后可获得在上一轮对话基础上继续生成的图像结果。混元生图（多轮对话）默认提供1个并发任务数，代表最多能同时处理1个已提交的任务，上一个任务处理完毕后才能开始处理下一个任务。
    
    Parameters:
    
    req - QueryHunyuanImageChatJobRequest
    
    Returns:
    
    QueryHunyuanImageChatJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - QueryHunyuanImageJob
```
public QueryHunyuanImageJobResponse QueryHunyuanImageJob(QueryHunyuanImageJobRequest req)
                                                  throws TencentCloudSDKException
```
    混元生图接口基于混元大模型，将根据输入的文本描述，智能生成与之相关的结果图。分为提交任务和查询任务2个接口。提交任务：输入文本等，提交一个混元生图异步任务，获得任务 ID。查询任务：根据任务 ID 查询任务的处理状态、处理结果，任务处理完成后可获得生成图像结果。并发任务数（并发）说明：并发任务数指能同时处理的任务数量。混元生图默认提供1个并发任务数，代表最多能同时处理1个已提交的任务，上一个任务处理完毕后才能开始处理下一个任务。
    
    Parameters:
    
    req - QueryHunyuanImageJobRequest
    
    Returns:
    
    QueryHunyuanImageJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - SetPayMode
```
public SetPayModeResponse SetPayMode(SetPayModeRequest req)
                              throws TencentCloudSDKException
```
    设置付费模式
    
    Parameters:
    
    req - SetPayModeRequest
    
    Returns:
    
    SetPayModeResponse
    
    Throws:
    
    TencentCloudSDKException
  - SubmitHunyuanImageChatJob
```
public SubmitHunyuanImageChatJobResponse SubmitHunyuanImageChatJob(SubmitHunyuanImageChatJobRequest req)
                                                            throws TencentCloudSDKException
```
    混元生图（多轮对话）接口基于混元大模型，将根据输入的文本描述生成图像，支持通过多轮对话的方式不断调整图像内容。分为提交任务和查询任务2个接口。提交任务：输入文本和前置对话 ID 等，提交一个混元生图多轮对话异步任务，获得任务 ID。查询任务：根据任务 ID 查询任务的处理状态、处理结果，任务处理完成后可获得在上一轮对话基础上继续生成的图像结果。混元生图（多轮对话）默认提供1个并发任务数，代表最多能同时处理1个已提交的任务，上一个任务处理完毕后才能开始处理下一个任务。
    
    Parameters:
    
    req - SubmitHunyuanImageChatJobRequest
    
    Returns:
    
    SubmitHunyuanImageChatJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - SubmitHunyuanImageJob
```
public SubmitHunyuanImageJobResponse SubmitHunyuanImageJob(SubmitHunyuanImageJobRequest req)
                                                    throws TencentCloudSDKException
```
    混元生图接口基于混元大模型，将根据输入的文本描述，智能生成与之相关的结果图。分为提交任务和查询任务2个接口。提交任务：输入文本等，提交一个混元生图异步任务，获得任务 ID。查询任务：根据任务 ID 查询任务的处理状态、处理结果，任务处理完成后可获得生成图像结果。并发任务数（并发）说明：并发任务数指能同时处理的任务数量。混元生图默认提供1个并发任务数，代表最多能同时处理1个已提交的任务，上一个任务处理完毕后才能开始处理下一个任务。
    
    Parameters:
    
    req - SubmitHunyuanImageJobRequest
    
    Returns:
    
    SubmitHunyuanImageJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - TextToImageLite
```
public TextToImageLiteResponse TextToImageLite(TextToImageLiteRequest req)
                                        throws TencentCloudSDKException
```
    文生图轻量版接口根据输入的文本描述，智能生成与之相关的结果图。文生图轻量版默认提供3个并发任务数，代表最多能同时处理3个已提交的任务，上一个任务处理完毕后才能开始处理下一个任务。
    
    Parameters:
    
    req - TextToImageLiteRequest
    
    Returns:
    
    TextToImageLiteResponse
    
    Throws:
    
    TencentCloudSDKException

Class HunyuanClient

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

HunyuanClient

HunyuanClient

Method Detail

ActivateService

ChatCompletions

GetEmbedding

GetTokenCount

QueryHunyuanImageChatJob

QueryHunyuanImageJob

SetPayMode

SubmitHunyuanImageChatJob

SubmitHunyuanImageJob

TextToImageLite