@nocobase/plugin-verification/dist/node_modules/tencentcloud-sdk-nodejs/tencentcloud/services/hunyuan/v20230901/hunyuan_models.d.ts

User identity verification management, including SMS, TOTP authenticator, with extensibility.

/**
 * GetTokenCount返回参数结构体
 */
export interface GetTokenCountResponse {
    /**
     * token计数
     */
    TokenCount?: number;
    /**
     * 字符计数
     */
    CharacterCount?: number;
    /**
     * 切分后的列表
     */
    Tokens?: Array<string>;
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 运行时异常信息。
 */
export interface ErrorMsg {
    /**
     * 错误提示信息。
     */
    Msg?: string;
    /**
     * 错误码。
  4000 服务内部异常。
  4001 请求模型超时。
  
     */
    Code?: number;
}
/**
 * ChatStd返回参数结构体
 */
export interface ChatStdResponse {
    /**
     * unix 时间戳，单位为秒。
     */
    Created?: number;
    /**
     * token统计信息。
  按照总token数量计费。
     */
    Usage?: Usage;
    /**
     * 免责声明。
     */
    Note?: string;
    /**
     * 本轮对话的id。
     */
    Id?: string;
    /**
     * 回复内容。
     */
    Choices?: Array<Choice>;
    /**
     * 错误信息。
  如果流式返回中服务处理异常，返回该错误信息。
  注意：此字段可能返回 null，表示取不到有效值。
     */
    ErrorMsg?: ErrorMsg;
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口，当请求成功时，RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
     */
    RequestId?: string;
}
/**
 * ChatPro返回参数结构体
 */
export interface ChatProResponse {
    /**
     * unix 时间戳，单位为秒。
     */
    Created?: number;
    /**
     * token统计信息。
  按照总token数量计费。
     */
    Usage?: Usage;
    /**
     * 免责声明。
     */
    Note?: string;
    /**
     * 本轮对话的id。
     */
    Id?: string;
    /**
     * 回复内容。
     */
    Choices?: Array<Choice>;
    /**
     * 错误信息。
  如果流式返回中服务处理异常，返回该错误信息。
  注意：此字段可能返回 null，表示取不到有效值。
     */
    ErrorMsg?: ErrorMsg;
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口，当请求成功时，RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
     */
    RequestId?: string;
}
/**
 * 返回的回复, 支持多个
 */
export interface Choice {
    /**
     * 流式结束标志位，为 stop 则表示尾包。
     */
    FinishReason?: string;
    /**
     * 返回值。
     */
    Delta?: Delta;
}
/**
 * ChatPro请求参数结构体
 */
export interface ChatProRequest {
    /**
     * 聊天上下文信息。
  说明：
  1.长度最多为40, 按对话时间从旧到新在数组中排列。
  2.Message的Role当前可选值：user、assistant，其中，user和assistant需要交替出现(一问一答)，最后一个为user提问, 且Content不能为空。
  3.Messages中Content总长度不超过16000 token，超过则会截断最前面的内容，只保留尾部内容。建议不超过4000 token。
     */
    Messages: Array<Message>;
    /**
     * 说明：
  1.影响输出文本的多样性，取值越大，生成文本的多样性越强。
  2.默认1.0，取值区间为[0.0, 1.0]。
  3.非必要不建议使用, 不合理的取值会影响效果。
     */
    TopP?: number;
    /**
     * 说明：
  1.较高的数值会使输出更加随机，而较低的数值会使其更加集中和确定。
  2.默认1.0，取值区间为[0.0，2.0]。
  3.非必要不建议使用,不合理的取值会影响效果。
     */
    Temperature?: number;
}
/**
 * 返回的内容（流式返回）
 */
export interface Delta {
    /**
     * 角色名称。
     */
    Role?: string;
    /**
     * 内容详情。
     */
    Content?: string;
}
/**
 * token 数量
 */
export interface Usage {
    /**
     * 输入 token 数量。
     */
    PromptTokens?: number;
    /**
     * 输出 token 数量。
     */
    CompletionTokens?: number;
    /**
     * 总 token 数量。
     */
    TotalTokens?: number;
}
/**
 * 会话内容,  按对话时间序排列，长度最多为40
 */
export interface Message {
    /**
     * 角色
     */
    Role: string;
    /**
     * 消息的内容
     */
    Content: string;
}
/**
 * GetTokenCount请求参数结构体
 */
export interface GetTokenCountRequest {
    /**
     * 输入文本
     */
    Prompt: string;
}
/**
 * ChatStd请求参数结构体
 */
export interface ChatStdRequest {
    /**
     * 聊天上下文信息。
  说明：
  1.长度最多为40, 按对话时间从旧到新在数组中排列。
  2.Message的Role当前可选值：user、assistant，其中，user和assistant需要交替出现(一问一答)，最后一个为user提问, 且Content不能为空。
  3.Messages中Content总长度不超过16000 token，超过则会截断最前面的内容，只保留尾部内容。建议不超过4000 token。
     */
    Messages: Array<Message>;
    /**
     * 说明：
  1.影响输出文本的多样性，取值越大，生成文本的多样性越强。
  2.默认1.0，取值区间为[0.0, 1.0]。
  3.非必要不建议使用, 不合理的取值会影响效果。
     */
    TopP?: number;
    /**
     * 说明：
  1.较高的数值会使输出更加随机，而较低的数值会使其更加集中和确定。
  2.默认1.0，取值区间为[0.0，2.0]。
  3.非必要不建议使用,不合理的取值会影响效果。
     */
    Temperature?: number;
}