tencentcloud-sdk-nodejs
Version:
2,675 lines (2,665 loc) • 319 kB
TypeScript
/**
* UpdateDevicesEnableState返回参数结构体
*/
export interface UpdateDevicesEnableStateResponse {
/**
* 删除的结果代码
*/
ResultCode?: string;
/**
* 删除的结果信息
*/
ResultMessage?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 云存套餐包消耗统计
*/
export interface PackageConsumeStat {
/**
* 云存套餐包id
*/
PackageId?: string;
/**
* 云存套餐包名称
*/
PackageName?: string;
/**
* 消耗个数
*/
Cnt?: number;
/**
* 套餐包单价,单位分
*/
Price?: number;
/**
* 消耗来源,1预付费
*/
Source?: number;
}
/**
* DescribeCloudStoragePackageConsumeDetails返回参数结构体
*/
export interface DescribeCloudStoragePackageConsumeDetailsResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* TWeCall设备激活信息
*/
export interface TWeCallActiveInfo {
/**
* 小程序ID
注意:此字段可能返回 null,表示取不到有效值。
* @deprecated
*/
ModelId?: string;
/**
* Sn信息
*/
Sn?: string;
/**
* 过期时间
*/
ExpireTime?: number;
/**
* 类型
*/
PkgType?: number;
}
/**
* GetWechatDeviceTicket请求参数结构体
*/
export interface GetWechatDeviceTicketRequest {
/**
* 产品ID
*/
ProductId: string;
/**
* 产品名称
*/
DeviceName: string;
/**
* 是否第三方小程序
*/
IsThirdApp?: number;
/**
* 模板ID
*/
ModelId?: string;
/**
* 小程序APPID
*/
MiniProgramAppId?: string;
}
/**
* DeleteFenceBind请求参数结构体
*/
export interface DeleteFenceBindRequest {
/**
* 围栏Id
*/
FenceId: number;
/**
* 围栏绑定的产品信息
*/
Items: Array<FenceBindProductItem>;
}
/**
* DescribeModelDefinition返回参数结构体
*/
export interface DescribeModelDefinitionResponse {
/**
* 产品数据模板
*/
Model?: ProductModelDefinition;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 已订阅Topic信息
*/
export interface SubscribedTopicItem {
/**
* Topic名称
*/
TopicName?: string;
}
/**
* GetGatewaySubDeviceList返回参数结构体
*/
export interface GetGatewaySubDeviceListResponse {
/**
* 设备的总数
*/
Total?: number;
/**
* 设备列表
*/
DeviceList?: FamilySubDevice;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteStudioProduct返回参数结构体
*/
export interface DeleteStudioProductResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDevicePackages请求参数结构体
*/
export interface DescribeDevicePackagesRequest {
/**
* 产品ID
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
/**
* 分页拉取数量
*/
Limit: number;
/**
* 分页拉取偏移
*/
Offset: number;
/**
* 用户id
*/
CSUserId?: string;
/**
* 通道id
*/
ChannelId?: number;
}
/**
* 设备激活结果数据
*/
export interface DeviceActiveResult {
/**
* 模板ID
注意:此字段可能返回 null,表示取不到有效值。
* @deprecated
*/
ModelId?: string;
/**
* SN信息
*/
Sn?: string;
/**
* 设备激活状态,0:激活成功;50011:系统错误;50012:产品不存在;50013:设备不存在;50014:产品无权限;50015:不是音视频产品;50016:SN格式错误;50017:激活码类型错误;50018:激活次数限频;50019:激活码不足;50020:SN已暂停;
*/
ErrCode?: number;
/**
* 错误信息
*/
ErrMessage?: string;
/**
* 过期时间
*/
ExpireTime?: number;
}
/**
* DeleteLoRaFrequency返回参数结构体
*/
export interface DeleteLoRaFrequencyResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyApplication返回参数结构体
*/
export interface ModifyApplicationResponse {
/**
* 应用信息
*/
Application?: IotApplication;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCsReportCountDataInfo请求参数结构体
*/
export interface DescribeCsReportCountDataInfoRequest {
/**
* 产品id
*/
ProductId: string;
/**
* 设备名
*/
DeviceName: string;
/**
* 统计开始时间戳
*/
StartTime: number;
/**
* 统计结束时间戳
*/
EndTime: number;
/**
* 设备通道
*/
ChannelId?: number;
}
/**
* CreateFreeCloudStorage返回参数结构体
*/
export interface CreateFreeCloudStorageResponse {
/**
* 订单金额,单位为分
*/
Price?: number;
/**
* 支付金额,单位为分
*/
Amount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeTWeTalkProductConfig返回参数结构体
*/
export interface DescribeTWeTalkProductConfigResponse {
/**
* 配置信息
*/
Data?: TalkProductConfigInfo;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* Webhook鉴权配置
*/
export interface TalkWebhookAuth {
/**
* 鉴权类型:none、hmac、static_headers、bearer
*/
Type: string;
/**
* HMAC签名密钥,Type=hmac时必填
*/
SignKey?: string;
/**
* 静态鉴权请求头,JSON对象字符串,仅允许白名单header名
*/
Headers?: string;
/**
* Bearer Token,Type=bearer时用于生成Authorization请求头
*/
BearerToken?: string;
}
/**
* Talk激活审计信息。
*/
export interface TalkActivateRecordLogInfo {
/**
* 产品ID
*/
ProductId?: string;
/**
* 设备名称
*/
DeviceName?: string;
/**
* 激活时间,秒级时间戳
*/
ActiveTime?: number;
/**
* 过期时间,秒级时间戳
*/
ExpireTime?: number;
/**
* TWeTalk类型:1-基础版;2-高级版;3-多模态;
*/
ServiceType?: number;
/**
* 状态: 0-未激活, 1-已激活, 2-已过期, 3-已作废
*/
Status?: number;
/**
* 错误信息
*/
ErrorMsg?: string;
}
/**
* ModifyPositionFence返回参数结构体
*/
export interface ModifyPositionFenceResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeTWeSeeRecognitionTask返回参数结构体
*/
export interface DescribeTWeSeeRecognitionTaskResponse {
/**
* 任务信息
*/
TaskInfo?: VisionRecognitionTask;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCloudStorageAIServiceTask请求参数结构体
*/
export interface DescribeCloudStorageAIServiceTaskRequest {
/**
* 任务 ID
*/
TaskId: string;
/**
* 下载 URL 的过期时间。
若传入该参数,则响应中将包含所有文件的下载 URL
*/
FileURLExpireTime?: number;
}
/**
* DescribeCloudStorageThumbnailList请求参数结构体
*/
export interface DescribeCloudStorageThumbnailListRequest {
/**
* 产品ID
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
/**
* 缩略图文件名列表
*/
ThumbnailList: Array<string>;
}
/**
* DescribeTWeSeeSubscription返回参数结构体
*/
export interface DescribeTWeSeeSubscriptionResponse {
/**
* 资源 ID
*/
ResourceId?: string;
/**
* 套餐规格。可能取值:
- `BASIC`:包年包月基础版(适用于视频理解)
*/
ServiceTier?: string;
/**
* 到期时间,秒级时间戳
*/
ExpireTime?: number;
/**
* 启用状态,`true` 为开启,`false` 为关闭
*/
Enabled?: boolean;
/**
* 订阅状态。可能取值:
- `NORMAL`:正常
- `ISOLATED`:隔离
*/
Status?: string;
/**
* 视觉理解配置(适用于视频理解、图片理解)
*/
ComprehensionConfig?: SeeComprehensionConfig;
/**
* 视频语义浓缩配置(适用于视频语义浓缩)
*/
CompHighlightConfig?: SeeCompHighlightConfig;
/**
* 云存事件 ID 过滤规则配置项
*/
EventIdFilterConfig?: SeeEventIdFilterConfig;
/**
* 当前周期基础能力总额度
*/
QuotaBasic?: number;
/**
* 当前周期基础能力已用额度
*/
QuotaUsedBasic?: number;
/**
* 当前周期高级能力总额度
*/
QuotaAdvanced?: number;
/**
* 当前周期高级能力已用额度
*/
QuotaUsedAdvanced?: number;
/**
* 额度刷新时间
*/
QuotaRefreshTime?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCloudStorageUsers返回参数结构体
*/
export interface DescribeCloudStorageUsersResponse {
/**
* 用户总数
*/
TotalCount?: number;
/**
* 用户信息
*/
Users?: Array<CloudStorageUserInfo>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 云存上报统计信息
*/
export interface CountDataInfo {
/**
* 视频上报异常次数
*/
VideoExceptionNum?: number;
/**
* 视频上报成功次数
*/
VideoSuccessNum?: number;
/**
* 视频上报成功率
*/
VideoSuccessRate?: string;
/**
* 事件上报异常次数
*/
EventExceptionNum?: number;
/**
* 事件上报成功次数
*/
EventSuccessNum?: number;
/**
* 事件上报成功率
*/
EventSuccessRate?: string;
}
/**
* RevokeShareDeviceFromUser请求参数结构体
*/
export interface RevokeShareDeviceFromUserRequest {
/**
* <p>应用 AppKey,用于解析 IotAppID 并完成签名校验</p>
*/
AppKey: string;
/**
* <p>产品 ID</p>
*/
ProductId: string;
/**
* <p>设备名</p>
*/
DeviceName: string;
/**
* <p>设备所有者 OpenID(必须已存在)</p>
*/
OwnerOpenID: string;
/**
* <p>被取消分享用户 OpenID(不存在视为已取消,幂等成功)</p>
*/
ToOpenID: string;
}
/**
* DescribeCloudStoragePackageConsumeDetails请求参数结构体
*/
export interface DescribeCloudStoragePackageConsumeDetailsRequest {
/**
* 开始日期
*/
StartDate: string;
/**
* 结束日期
*/
EndDate: string;
}
/**
* BatchUpdateFirmware返回参数结构体
*/
export interface BatchUpdateFirmwareResponse {
/**
* 任务Id
*/
TaskId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeActivateLicenseService返回参数结构体
*/
export interface DescribeActivateLicenseServiceResponse {
/**
* 增值服务激活码信息
*/
Data?: Array<LicenseServiceNumInfo>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RenewTWeSeeSubscription请求参数结构体
*/
export interface RenewTWeSeeSubscriptionRequest {
/**
* 产品 ID
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
/**
* 算法类型。可选值:
- `VID_COMP`:视频理解
*/
ServiceType: string;
/**
* 续费时长,单位:月,支持 1-60
*/
Period: number;
/**
* 通道 ID
*/
ChannelId?: number;
/**
* 自定义订单 ID
*/
CustomOrderId?: string;
}
/**
* CreateCloudStorageAIServiceTask请求参数结构体
*/
export interface CreateCloudStorageAIServiceTaskRequest {
/**
* 产品 ID
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
/**
* 云存 AI 服务类型。可选值:
- `RealtimeObjectDetect`:目标检测
- `Highlight`:视频浓缩
- `VideoToText`:视频语义理解
*/
ServiceType: string;
/**
* 待分析云存的起始时间
*/
StartTime: number;
/**
* 待分析云存的结束时间
*/
EndTime: number;
/**
* 通道 ID
*/
ChannelId?: number;
/**
* 视频分析配置参数
*/
Config?: string;
/**
* 视频分析识别区域
*/
ROI?: string;
/**
* 分析外部传入的视频 URL 列表,支持 HLS 点播(m3u8)及常见视频格式(mp4 等)
*/
VideoURLs?: Array<string>;
/**
* 自定义任务 ID
*/
CustomId?: string;
}
/**
* DescribeCloudStorageOrder请求参数结构体
*/
export interface DescribeCloudStorageOrderRequest {
/**
* 订单id
*/
OrderId: string;
}
/**
* CreateTWeTalkAgent请求参数结构体
*/
export interface CreateTWeTalkAgentRequest {
/**
* <p>语音识别配置</p>
*/
STTConfig: TalkSTTConfig;
/**
* <p>大模型配置</p>
*/
LLMConfig: TalkLLMConfig;
/**
* <p>语音合成配置</p>
*/
TTSConfig: TalkTTSConfig;
/**
* <p>智能体名称;为空时使用默认智能体名称</p>
*/
Name?: string;
/**
* <p>实例ID</p>
*/
InstanceId?: string;
/**
* <p>智能体描述,最长1024字符</p>
*/
Description?: string;
/**
* <p>对话行为配置</p>
*/
ConversationConfig?: TalkConversationConfig;
/**
* <p>长期记忆配置</p>
*/
MemoryConfig?: TalkMemoryConfig;
/**
* <p>IoT工具配置列表</p>
*/
IOTTools?: Array<TalkIOTTool>;
/**
* <p>Webhook工具配置列表</p>
*/
WebhookTools?: Array<TalkWebhookTool>;
/**
* <p>元信息扩展JSON对象字符串</p>
*/
Metadata?: string;
}
/**
* 会话配置信息。
*/
export interface TalkConversationConfigInfo {
/**
* 会话超时(秒)
*/
SessionTimeout?: number;
/**
* 允许打断
*/
InterruptionEnabled?: boolean;
/**
* 最大上下文
*/
MaxContextTokens?: number;
/**
* 空闲检测配置
*/
IdleDetection?: TalkIdleDetectionConfigInfo;
/**
* 是否启用情绪识别
*/
EmotionEnabled?: boolean;
/**
* 是否启用语义vad
*/
SemanticVADEnabled?: boolean;
/**
* 是否启用噪声过滤
*/
NoiseFilterEnabled?: boolean;
}
/**
* GetTWeTalkProductConfigList请求参数结构体
*/
export interface GetTWeTalkProductConfigListRequest {
/**
* 产品ID
*/
ProductId?: string;
/**
* 支持的语言,zh-中文;en-英文;默认zh
*/
TargetLanguage?: string;
/**
* 页码
*/
Offset?: number;
/**
* 偏移量,10-100
*/
Limit?: number;
}
/**
* DescribeSpaceFenceEventList返回参数结构体
*/
export interface DescribeSpaceFenceEventListResponse {
/**
* 围栏告警事件列表
注意:此字段可能返回 null,表示取不到有效值。
*/
List?: Array<FenceEventItem>;
/**
* 围栏告警事件总数
*/
Total?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CallDeviceRRPCSync请求参数结构体
*/
export interface CallDeviceRRPCSyncRequest {
/**
* <p>产品 ID</p>
*/
ProductId: string;
/**
* <p>设备名</p>
*/
DeviceName: string;
/**
* <p>业务原始 payload,透传给设备</p>
*/
Payload?: string;
/**
* <p>下行传输层编码标识;base64 时下发到 broker 的 payload 会做一次 base64 编码</p>
*/
Encoding?: string;
/**
* <p>自定义下行 topic;为空则用 <code>$iotrrpc/down/{ProductId}/{DeviceName}/{mid}</code></p>
*/
Topic?: string;
/**
* <p>自定义上行 topic 模板(支持通配符);可留空,留空时仅依赖 clientToken 关联 ack</p>
*/
ReplyTopic?: string;
}
/**
* DescribeCloudStorageEventsWithAITasks返回参数结构体
*/
export interface DescribeCloudStorageEventsWithAITasksResponse {
/**
* 云存事件列表
*/
Events?: Array<CloudStorageEventWithAITasks>;
/**
* 请求上下文, 用作查询游标
*/
Context?: string;
/**
* 拉取结果是否已经结束
*/
Listover?: boolean;
/**
* 内部结果数量,并不等同于事件总数。
*/
Total?: number;
/**
* 视频播放URL
*/
VideoURL?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* SearchTopicRule返回参数结构体
*/
export interface SearchTopicRuleResponse {
/**
* 搜索到的规则总数
*/
TotalCnt?: number;
/**
* 规则信息列表
*/
Rules?: Array<TopicRuleInfo>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyCloudStorageAIService返回参数结构体
*/
export interface ModifyCloudStorageAIServiceResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* InvokeTWeSeeComprehension请求参数结构体
*/
export interface InvokeTWeSeeComprehensionRequest {
/**
* 输入视频 / 图片的 URL
*/
InputURL: string;
/**
* 算法类型。可选值:
- `VID_COMP`:视频理解
- `IMG_COMP`:图片理解
*/
ServiceType: string;
/**
* 任务元数据
*/
Metadata?: SeeTaskMetadata;
/**
* 视觉理解配置项
*/
ComprehensionConfig?: SeeComprehensionConfig;
/**
* 等待结果的超时时间(单位:秒)。填 0 表示无需等待结果。最大超时时长 25 秒,默认超时时长 20 秒。
*/
WaitResultTimeout?: number;
/**
* 回调目标 ID
*/
CallbackId?: string;
}
/**
* IoT工具配置列表
*/
export interface TalkIOTTool {
/**
* 工具名称,同时作为IoT ActionId
*/
Name: string;
/**
* 工具描述,用于模型判断何时调用
*/
Description: string;
/**
* 工具参数JSON Schema,JSON对象字符串,必须为type=object
*/
Parameters: string;
/**
* 必填参数名列表,必须存在于Parameters.properties中
*/
Required?: Array<string>;
}
/**
* DescribeDeviceFirmWare请求参数结构体
*/
export interface DescribeDeviceFirmWareRequest {
/**
* 产品ID。
*/
ProductId: string;
/**
* 设备名称。
*/
DeviceName: string;
}
/**
* BindCloudStorageUser请求参数结构体
*/
export interface BindCloudStorageUserRequest {
/**
* 产品ID
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
/**
* 用户ID
*/
UserId: string;
}
/**
* UnbindTWeTalkAgent返回参数结构体
*/
export interface UnbindTWeTalkAgentResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateLoRaFrequency请求参数结构体
*/
export interface CreateLoRaFrequencyRequest {
/**
* 频点配置名称
*/
FreqName?: string;
/**
* 数据上行信道
*/
ChannelsDataUp?: Array<number | bigint>;
/**
* 数据下行RX1信道
*/
ChannelsDataRX1?: Array<number | bigint>;
/**
* 数据下行RX2信道
*/
ChannelsDataRX2?: Array<number | bigint>;
/**
* 入网上行信道
*/
ChannelsJoinUp?: Array<number | bigint>;
/**
* 入网下行RX1信道
*/
ChannelsJoinRX1?: Array<number | bigint>;
/**
* 入网下行RX2信道
*/
ChannelsJoinRX2?: Array<number | bigint>;
/**
* 频点配置描述
*/
Description?: string;
}
/**
* ChangeP2PRoute返回参数结构体
*/
export interface ChangeP2PRouteResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UpdateDeviceTWeCallAuthorizeStatus请求参数结构体
*/
export interface UpdateDeviceTWeCallAuthorizeStatusRequest {
/**
* TweCall授权状态:0未授权,1已授权
*/
Status?: number;
/**
* 产品ID
*/
ProductId?: string;
/**
* 设备名
*/
DeviceName?: string;
/**
* 微信用户的openId
*/
WechatOpenId?: string;
}
/**
* CreateTWeSeeDirectUploadCredential返回参数结构体
*/
export interface CreateTWeSeeDirectUploadCredentialResponse {
/**
* <p>访问 COS 的临时密钥过期时间(秒级 UNIX 时间戳)</p>
*/
ExpiredTime?: number;
/**
* <p>访问 COS 的临时密钥 SecretId</p>
*/
SecretId?: string;
/**
* <p>访问 COS 的临时密钥 SecretKey</p>
*/
SecretKey?: string;
/**
* <p>COS 存储桶名称</p>
*/
StorageBucket?: string;
/**
* <p>COS 对象 Key 前缀。返回的临时凭据仅允许上传到此前缀下,格式为 Direct/{Uin}/{SessionId}/。</p>
*/
StoragePath?: string;
/**
* <p>COS 存储桶所在地域</p>
*/
StorageRegion?: string;
/**
* <p>访问 COS 的临时密钥 Token</p>
*/
Token?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateProject返回参数结构体
*/
export interface CreateProjectResponse {
/**
* 返回信息
*/
Project: ProjectEntry;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteProject返回参数结构体
*/
export interface DeleteProjectResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CallDeviceActionAsync请求参数结构体
*/
export interface CallDeviceActionAsyncRequest {
/**
* 产品Id
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
/**
* 产品数据模板中行为功能的标识符,由开发者自行根据设备的应用场景定义
*/
ActionId: string;
/**
* 输入参数
*/
InputParams?: string;
}
/**
* CreateDevice返回参数结构体
*/
export interface CreateDeviceResponse {
/**
* 设备参数描述。
*/
Data?: DeviceData;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateDevice请求参数结构体
*/
export interface CreateDeviceRequest {
/**
* 产品ID。
*/
ProductId: string;
/**
* 设备名称。命名规则:[a-zA-Z0-9:_-]{1,48}。
*/
DeviceName: string;
/**
* LoRaWAN 设备地址
*/
DevAddr?: string;
/**
* LoRaWAN 应用密钥
*/
AppKey?: string;
/**
* LoRaWAN 设备唯一标识
*/
DevEUI?: string;
/**
* LoRaWAN 应用会话密钥
*/
AppSKey?: string;
/**
* LoRaWAN 网络会话密钥
*/
NwkSKey?: string;
/**
* 手动指定设备的PSK密钥
*/
DefinedPsk?: string;
}
/**
* InheritCloudStorageUser返回参数结构体
*/
export interface InheritCloudStorageUserResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeFirmwareTasks请求参数结构体
*/
export interface DescribeFirmwareTasksRequest {
/**
* 产品ID
*/
ProductID: string;
/**
* 固件版本号
*/
FirmwareVersion: string;
/**
* 查询偏移量
*/
Offset: number;
/**
* 返回查询结果条数
*/
Limit: number;
/**
* 搜索过滤条件
*/
Filters?: Array<SearchKeyword>;
/**
* 固件类型
*/
FwType?: string;
}
/**
* 空闲检测配置信息。
*/
export interface IdleResponseInfo {
/**
* 重试次数(1-3)
*/
RetryCount?: number;
/**
* 响应信息
*/
Message?: string;
}
/**
* DescribeDevice返回参数结构体
*/
export interface DescribeDeviceResponse {
/**
* 设备信息
*/
Device?: DeviceInfo;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCloudStorageEvents请求参数结构体
*/
export interface DescribeCloudStorageEventsRequest {
/**
* 产品ID
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
/**
* 起始时间(Unix 时间戳,秒级), 为0 表示 当前时间 - 24h
*/
StartTime?: number;
/**
* 结束时间(Unix 时间戳,秒级), 为0 表示当前时间
*/
EndTime?: number;
/**
* 请求上下文, 用作查询游标
*/
Context?: string;
/**
* 查询数据项目的最大数量, 默认为10。假设传Size=10,返回的实际事件数量为N,则 5 <= N <= 10。
*/
Size?: number;
/**
* 事件标识符,可以用来指定查询特定的事件,如果不指定,则查询所有事件。
*/
EventId?: string;
/**
* 用户ID
*/
UserId?: string;
/**
* 通道ID 非NVR设备则不填 NVR设备则必填 默认为无
*/
ChannelId?: number;
}
/**
* GetStudioProductList返回参数结构体
*/
export interface GetStudioProductListResponse {
/**
* 产品列表
*/
Products?: Array<ProductEntry>;
/**
* 产品数量
*/
Total?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DestroyTWeSeeSubscription返回参数结构体
*/
export interface DestroyTWeSeeSubscriptionResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* GetTWeCallActiveStatus请求参数结构体
*/
export interface GetTWeCallActiveStatusRequest {
/**
* 参数已弃用,不用传参
* @deprecated
*/
MiniProgramAppId?: string;
/**
* 设备列表
*/
DeviceList?: Array<TWeCallInfo>;
}
/**
* GetAuthMiniProgramAppList请求参数结构体
*/
export interface GetAuthMiniProgramAppListRequest {
/**
* appId
*/
MiniProgramAppId?: string;
/**
* 页码
*/
Offset?: number;
/**
* 每页大小
*/
Limit?: number;
}
/**
* DescribeFenceEventList请求参数结构体
*/
export interface DescribeFenceEventListRequest {
/**
* 围栏告警信息的查询起始时间,Unix时间,单位为毫秒
*/
StartTime: number;
/**
* 围栏告警信息的查询结束时间,Unix时间,单位为毫秒
*/
EndTime: number;
/**
* 围栏Id
*/
FenceId?: number;
/**
* 翻页偏移量,0起始
*/
Offset?: number;
/**
* 最大返回结果数
*/
Limit?: number;
/**
* 告警对应的产品Id
*/
ProductId?: string;
/**
* 告警对应的设备名称
*/
DeviceName?: string;
}
/**
* DescribeAISearchTaskAsync请求参数结构体
*/
export interface DescribeAISearchTaskAsyncRequest {
/**
* 任务ID
*/
TaskId: string;
}
/**
* DescribeTWeSeeSubscription请求参数结构体
*/
export interface DescribeTWeSeeSubscriptionRequest {
/**
* 产品 ID
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
/**
* 算法类型。可选值:
- `VID_COMP`:视频理解
*/
ServiceType: string;
/**
* 通道 ID
*/
ChannelId?: number;
}
/**
* ActivateTWeTalk返回参数结构体
*/
export interface ActivateTWeTalkResponse {
/**
* 设备激活失败返回数据
*/
FailureRecords?: Array<TalkActivationInfo>;
/**
* 设备激活成功返回数据
*/
SuccessRecords?: Array<TalkActivationInfo>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ActivateTWeCallLicense返回参数结构体
*/
export interface ActivateTWeCallLicenseResponse {
/**
* 设备激活返回数据
* @deprecated
*/
DeviceList?: Array<DeviceActiveResult>;
/**
* 设备激活失败返回数据
*/
FailureList?: Array<DeviceActiveResult>;
/**
* 设备激活成功返回数据
*/
SuccessList?: Array<DeviceActiveResult>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ActivateTWeTalk请求参数结构体
*/
export interface ActivateTWeTalkRequest {
/**
* TWeTalk类型:1-基础版;2-高级版;3-多模态;
*/
ServiceType: number;
/**
* 设备列表, 产品ID_设备名;
*/
DeviceIds?: Array<string>;
}
/**
* ListTWeSeeTasks返回参数结构体
*/
export interface ListTWeSeeTasksResponse {
/**
* 任务列表
*/
Tasks?: Array<SeeTaskInfo>;
/**
* 任务数量
*/
Total?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeProductDynamicRegister请求参数结构体
*/
export interface DescribeProductDynamicRegisterRequest {
/**
* 产品Id
*/
ProductId: string;
}
/**
* DeleteTopicPolicy请求参数结构体
*/
export interface DeleteTopicPolicyRequest {
/**
* 产品ID
*/
ProductId: string;
/**
* Topic名称
*/
TopicName: string;
}
/**
* InquireTWeSeeSubscriptionCreatePrice请求参数结构体
*/
export interface InquireTWeSeeSubscriptionCreatePriceRequest {
/**
* 算法类型。可选值:
- `VID_COMP`:视频理解
*/
ServiceType: string;
/**
* 套餐规格。可选值:
- `BASIC`:包年包月基础版(适用于视频理解)
*/
ServiceTier: string;
/**
* 订阅购买时长,单位:月,支持 1-60
*/
Period: number;
}
/**
* ResetCloudStorageEvent请求参数结构体
*/
export interface ResetCloudStorageEventRequest {
/**
* 产品ID
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
/**
* 用户ID
*/
UserId?: string;
/**
* 通道ID
*/
ChannelId?: number;
}
/**
* Topic信息, 包括Topic名字和权限
*/
export interface TopicItem {
/**
* Topic名称
*/
TopicName?: string;
/**
* Topic权限 , 1上报 2下发
*/
Privilege?: number;
}
/**
* CreateTWeTalkAIBot返回参数结构体
*/
export interface CreateTWeTalkAIBotResponse {
/**
* 智能体ID
*/
BotId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteTWeSeeCallback返回参数结构体
*/
export interface DeleteTWeSeeCallbackResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeTWeTalkAgentList返回参数结构体
*/
export interface DescribeTWeTalkAgentListResponse {
/**
* <p>总数</p>
*/
TotalCount?: number;
/**
* <p>智能体列</p>
*/
Data?: Array<TalkAgentInfo>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeTWeSeeTaskStatistics返回参数结构体
*/
export interface DescribeTWeSeeTaskStatisticsResponse {
/**
* 统计数据
*/
StatData?: Array<SeeStatItem>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* GetFamilyDeviceUserList请求参数结构体
*/
export interface GetFamilyDeviceUserListRequest {
/**
* 产品ID
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
}
/**
* CreateTRTCSignaturesWithRoomId请求参数结构体
*/
export interface CreateTRTCSignaturesWithRoomIdRequest {
/**
* TRTC进房间的用户名称数组,数组元素不可重复,最长不超过 10 个。
*/
TRTCUserIds: Array<string>;
/**
* 房间id
*/
RoomId: string;
}
/**
* DescribeSpaceFenceEventList请求参数结构体
*/
export interface DescribeSpaceFenceEventListRequest {
/**
* 位置空间Id
*/
SpaceId: string;
/**
* 围栏告警信息的查询起始时间,Unix时间,单位为毫秒
*/
StartTime: number;
/**
* 围栏告警信息的查询结束时间,Unix时间,单位为毫秒
*/
EndTime: number;
/**
* 翻页偏移量,0起始
*/
Offset?: number;
/**
* 最大返回结果数
*/
Limit?: number;
}
/**
* 围栏事件详情
*/
export interface FenceEventItem {
/**
* 围栏事件的产品Id
*/
ProductId?: string;
/**
* 围栏事件的设备名称
*/
DeviceName?: string;
/**
* 围栏Id
*/
FenceId?: number;
/**
* 围栏事件的告警类型(In,进围栏报警;Out,出围栏报警;InOrOut,进围栏或者出围栏均报警)
*/
AlertType?: string;
/**
* 围栏事件的设备位置信息
*/
Data?: FenceAlarmPoint;
}
/**
* TWeSee 视觉理解配置
*/
export interface SeeComprehensionConfig {
/**
* <p>拓展的目标及事件检测类别<br>枚举值:</p><ul><li>person:人</li><li>vehicle:车辆</li><li>cat:猫</li><li>dog:狗</li><li>package:快递包裹</li><li>license_plate:车牌</li><li>fire:火焰</li><li>smoke:烟雾</li><li>delivery_man:快递员/外卖员</li><li>pet:有宠物</li><li>pet_scratching_door:宠物挠门</li><li>pet_barking:宠物吠叫</li><li>pet_damaging:宠物损坏家具</li><li>pet_eating:宠物进食</li><li>person_playing_with_pet:人与宠物玩耍</li><li>pet_close_to_camera:宠物靠近摄像头</li><li>animal_lying:有动物躺/趴在地上</li><li>child:有小孩</li><li>child_near_water:小孩靠近水域</li><li>child_falling:小孩摔倒</li><li>child_climbing_window:小孩攀爬室内窗户</li><li>child_entering_kitchen:小孩进入厨房</li><li>child_playing_danger_item:小孩玩危险物品</li><li>child_writing:小孩写作业</li><li>baby:有婴儿</li><li>baby_crying:婴儿哭闹</li><li>baby_dropping:婴儿跌落床铺</li><li>person_holding_baby:有人抱起婴儿</li><li>baby_rolling:婴儿翻滚</li><li>elderly:有老人</li><li>elderly_falling:老人摔倒</li><li>elderly_eating:老人用餐</li><li>elderly_using_stove:老人使用灶具</li><li>vehicle_parking:车辆停靠</li><li>vehicle_entering:车辆进入</li><li>vehicle_exiting:车辆离开</li><li>person_feeding_animal:有人投喂牲畜</li><li>animal_wild_intrusion:野生动物入侵</li><li>throwing_into_water:有人投掷物品</li><li>loitering_near_water:有人岸边逗留</li><li>fishing:有人钓鱼</li><li>net_fishing:有人撒网</li><li>person_carrying_fishing_gear:有人携带渔具</li><li>person_carrying_object:有人搬运物品</li><li>person_taking_goods:有人拿商品</li><li>person_night_moving:夜间有人移动</li><li>crowd:多人聚集</li><li>person_picking_fruit:有人采摘果实</li><li>person_at_cashier:有人在收银台</li><li>person_climbing_fence:有人翻围墙</li><li>person_carrying_bag:有人携带包裹</li><li>person_entering_farm:人员进入农场</li><li>person_entering_store:人员进入店铺</li><li>person_falling:有人跌倒</li><li>staff_absent:员工离岗</li><li>uniform_abnormal:未穿工服</li><li>using_mobile_phone:使用手机</li><li>smoking:有人吸烟</li><li>knife:有人持刀</li><li>gun:有人持枪</li><li>hurt:有人受伤流血</li><li>fight:有人打架</li><li>door_window_open:门窗被开启</li><li>fireworks:有人燃放烟花爆竹</li><li>no_signal:视频画面异常(无信号等)</li><li>camera_angle_abnormal:摄像头角度异常</li><li>person_motionless:有人且其姿势保持静止</li></ul>
*/
DetectTypes?: Array<string>;
/**
* <p>使该视频 / 图片录入搜索库,后续可进行搜索</p>
*/
EnableSearch?: boolean;
/**
* <p>主输出语言,可选值包括:</p><ul><li><code>zh</code> 中文(默认值)</li><li><code>en</code> 英语</li><li><code>ja</code> 日语</li><li><code>ko</code> 韩文</li><li><code>pt-BR</code> 葡萄牙语(巴西)</li><li><code>th</code> 泰语</li><li><code>ms</code> 马来语</li></ul>
*/
OutputLang?: string;
/**
* <p>次选输出语言,可选值包括:</p><ul><li><code>zh</code> 中文</li><li><code>en</code> 英语</li><li><code>ja</code> 日语</li><li><code>ko</code> 韩文</li><li><code>pt-BR</code> 葡萄牙语(巴西)</li><li><code>th</code> 泰语</li><li><code>ms</code> 马来语</li></ul>
*/
AlternativeOutputLang?: string;
/**
* <p>多摄像头布局定义。可选值包括:</p><ul><li><p>单摄(默认值):<code>Single</code></p></li><li><p>双摄(纵向排列)- 全部画面:<code>Vertical,Num=2,Index=0;1</code></p></li><li><p>双摄(纵向排列)- 画面1:<code>Vertical,Num=2,Index=0</code></p></li><li><p>双摄(纵向排列)- 画面2:<code>Vertical,Num=2,Index=1</code></p></li><li><p>三摄(纵向排列)- 全部画面:<code>Vertical,Num=3,Index=0;1;2</code></p></li><li><p>三摄(纵向排列)- 画面1:<code>Vertical,Num=3,Index=0</code></p></li><li><p>三摄(纵向排列)- 画面2:<code>Vertical,Num=3,Index=1</code></p></li><li><p>三摄(纵向排列)- 画面3:<code>Vertical,Num=3,Index=2</code></p></li><li><p>三摄(纵向排列)- 画面1+2:<code>Vertical,Num=3,Index=0;1</code></p></li><li><p>三摄(纵向排列)- 画面1+3:<code>Vertical,Num=3,Index=0;2</code></p></li><li><p>三摄(纵向排列)- 画面2+3:<code>Vertical,Num=3,Index=1;2</code></p></li></ul>
*/
MultiCameraLayout?: string;
/**
* <p>自定义检测标签</p>
*/
CustomDetectQueries?: Array<VisionCustomDetectQuery>;
/**
* <p>最大处理的输入视频时长,单位:秒(仅对视频输入生效)</p>
*/
MaxDuration?: number;
/**
* <p>是否生成关键词</p><p>默认值:false</p>
*/
EnableKeywords?: boolean;
/**
* <p>自定义摘要提示词</p>
*/
SummaryPrompt?: string;
}
/**
* CreateTWeSeeCallback返回参数结构体
*/
export interface CreateTWeSeeCallbackResponse {
/**
* 回调目标 ID
*/
CallbackId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeUnbindedDevices请求参数结构体
*/
export interface DescribeUnbindedDevicesRequest {
/**
* 产品ID
*/
ProductId: string;
/**
* 分页偏移量
*/
Offset: number;
/**
* 分页的页大小
*/
Limit: number;
}
/**
* 已注册通信类型信息
*/
export interface RegisteredDeviceNetTypeInfo {
/**
* 普通设备数
*/
NormalDeviceNum: number;
/**
* 蓝牙设备数
*/
BluetoothDeviceNum: number;
}
/**
* InvokeAISearchService返回参数结构体
*/
export interface InvokeAISearchServiceResponse {
/**
* <p>基于搜索结果的总结</p>
*/
Summary?: string;
/**
* <p>视频结果集</p>
*/
Targets?: Array<TargetInfo>;
/**
* <p>视频回放URL</p>
*/
VideoURL?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyTWeSeeConfig请求参数结构体
*/
export interface ModifyTWeSeeConfigRequest {
/**
* 产品ID
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
/**
* 用户ID
*/
UserId?: string;
/**
* 通道ID
*/
ChannelId?: number;
/**
* 是否开启视频摘要,不传则不修改
*/
EnableSummary?: boolean;
/**
* 是否开启视频搜索,不传则不修改
*/
EnableSearch?: boolean;
/**
* 配置参数,不传则不修改
*/
Config?: string;
/**
* 视频摘要配置参数,不传则不修改
*/
SummaryConfig?: VisionSummaryConfig;
/**
* 云存事件 ID 过滤规则配置,不传则不修改
*/
EventIdFilterConfig?: SeeEventIdFilterConfig;
}
/**
* DescribeGatewaySubDeviceList请求参数结构体
*/
export interface DescribeGatewaySubDeviceListRequest {
/**
* 网关产品ID
*/
GatewayProductId: string;
/**
* 网关设备名称
*/
GatewayDeviceName: string;
/**
* 分页偏移
*/
Offset: number;
/**
* 分页的大小
*/
Limit: number;
}
/**
* ModifyTWeSeeSubscriptionRenewFlag请求参数结构体
*/
export interface ModifyTWeSeeSubscriptionRenewFlagRequest {
/**
* 产品 ID
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
/**
* 算法类型。可选值:
- `VID_COMP`:视频理解
*/
ServiceType: string;
/**
* 续费标识。可选值:
- `NOTIFY_AND_MANUAL_RENEW`:到期前通知并手动续费
- `NOTIFY_AND_AUTO_RENEW`:到期前通知并自动续费
- `DISABLE_NOTIFY_AND_MANUAL_RENEW`:不通知且手动续费
*/
RenewFlag: string;
/**
* 通道 ID
*/
ChannelId?: number;
}
/**
* GetDeviceList请求参数结构体
*/
export interface GetDeviceListRequest {
/**
* 需要查看设备列表的产品ID, -1代表ProjectId来筛选
*/
ProductId: string;
/**
* 分页偏移
*/
Offset?: number;
/**
* 分页的大小,数值范围 10-100
*/
Limit?: number;
/**
* 设备固件版本号,若不带此参数会返回所有固件版本的设备。传"None-FirmwareVersion"查询无版本号的设备
*/
FirmwareVersion?: string;
/**
* 固件类型
*/
FwType?: string;
/**
* 需要过滤的设备名称
*/
DeviceName?: string;
/**
* 项目ID。产品 ID 为 -1 时,该参数必填
*/
ProjectId?: string;
/**
* 每次请求的Filters的上限为10,Filter.Values的上限为1。
*/
Filters?: Array<Filter>;
}
/**
* DescribeDeviceDataHistory请求参数结构体
*/
export interface DescribeDeviceDataHistoryRequest {
/**
* 区间开始时间(Unix 时间戳,毫秒级)
*/
MinTime: number;
/**
* 区间结束时间(Unix 时间戳,毫秒级)
*/
MaxTime: number;
/**
* 产品ID
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
/**
* 属性字段名称,对应数据模板中功能属性的标识符
*/
FieldName: string;
/**
* 返回条数
*/
Limit?: number;
/**
* 检索上下文
*/
Context?: string;
}
/**
* DescribeStudioProduct请求参数结构体
*/
export interface DescribeStudioProductRequest {
/**
* 产品ID
*/
ProductId: string;
}
/**
* CreateTWeSeeDirectUploadCredential请求参数结构体
*/
export interface CreateTWeSeeDirectUploadCredentialRequest {
/**
* <p>产品 ID</p><p>非 IoT 设备可传 <code>default</code></p>
*/
ProductId: string;
/**
* <p>设备名称</p>
*/
DeviceName: string;
/**
* <p>算法类型</p><p>枚举值:</p><ul><li>VID_COMP: 视频理解(支持视频文件或多帧图片)</li><li>IMG_COMP: 图片理解(单帧图片)</li></ul>
*/
ServiceType: string;
/**
* <p>通道 ID</p><p>默认值:0</p>
*/
ChannelId?: number;
/**
* <p>回调目标 ID</p>
*/
CallbackId?: string;
/**
* <p>视觉理解配置项</p>
*/
ComprehensionConfig?: SeeComprehensionConfig;
/**
* <p>自定义事件 ID,会透传到任务元数据与回调中</p>
*/
CustomId?: string;
/**
* <p>临时密钥有效期,单位:秒。默认 300 秒,取值范围 5 到 86400。</p>
*/
DurationSeconds?: number;
/**
* <p>该直传凭据最多可触发的分析次数</p><p>取值范围:[1, 10000]</p><p>默认值:1</p>
*/
MaxInvokeCount?: number;
/**
* <p>上传 COS 存储桶所在地域。不填时使用默认地域。</p>
*/
StorageRegion?: string;
/**
* <p>上传方式</p><p>枚举值:</p><ul><li>single: 单文件上传</li><li>manifest: 上传源文件与 Manifest(先上传多个源文件,然后上传 Manifest JSON 触发分析)</li></ul><p>默认值:single</p>
*/
UploadMethod?: string;
}
/**
* Talk配置信息描述。
*/
export interface TalkAIBotInfo {
/**
* UIN
*/
Uin?: number;
/**
* APPID
*/
AppId?: number;
/**
* 实例ID
*/
InstanceId?: string;
/**
* 智能体ID
*/
BotId?: string;
/**
* 名称
*/
Name?: string;
/**
* 描述
*/
Description?: string;
/**
* 语言
*/
TargetLanguage?: string;
/**
* 语音识别
*/
STTConfig?: TalkSTTConfigInfo;
/**
* 大模型
*/
LLMConfig?: TalkLLMConfigInfo;
/**
* 语音合成
*/
TTSConfig?: TalkTTSConfigInfo;
/**
* 智能体配置
*/
AgentConfig?: TalkAgentConfigInfo;
/**
* 产品信息列表
* @deprecated
*/
ProductList?: TalkProductInfo;
/**
* 创建时间
*/
CreateTime?: number;
/**
* 更新时间
*/
UpdateTime?: number;
/**
* 已关联产品信息列表
*/
BoundProducts?: Array<TalkProductInfo>;
/**
* 自定义工具列表,最多可创建10个
*/
CustomTools?: string;
/**
* WebHook工具配置(JSON字符串格式)
*/
WebhookTools?: string;
/**
* 智能体模板类型
*/
BotType?: string;
/**
* 知识库相关配置(JSON字符串格式)
*/
RAGConfig?: string;
}
/**
* DescribeCloudStorageThumbnailList返回参数结构体
*/
export interface DescribeCloudStorageThumbnailListResponse {
/**
* 缩略图访问地址
*/
ThumbnailURLInfoList?: Array<ThumbnailURLInfoList>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeletePositionFence请求参数结构体
*/
export interface DeletePositionFenceRequest {
/**
* 位置空间Id
*/
SpaceId: string;
/**
* 围栏Id
*/
FenceId: number;
}
/**
* ListTWeSeeCallback请求参数结构体
*/
export interface ListTWeSeeCallbackRequest {
/**
* 分页大小,范围 1-100
*/
Limit: number;
/**
* 分页偏移量,范围 0-10000
*/
Offset?: number;
}
/**
* GetProjectList请求参数结构体
*/
export interface GetProjectListRequest {
/**
* 偏移量
*/
Offset?: number;
/**
* 个数限制
*/
Limit?: number;
/**
* 实例ID
*/
InstanceId?: string;
/**
* 按项目ID搜索
*/
ProjectId?: string;
/**
* 按产品ID搜索
*/
ProductId?: string;
/**
* 加载 ProductCount、DeviceCount、ApplicationCount,可选值:ProductCount、DeviceCount、ApplicationCount,可多选
*/
Includes?: Array<string>;
/**
* 按项目名称搜索
*/
ProjectName?: string;
}
/**
* ModifyPositionSpace请求参数结构体
*/
export interface ModifyPositionSpaceRequest {
/**
* 位置空间Id
*/
SpaceId: string;
/**
* 位置空间名称
*/
SpaceName: string;
/**
* 授权类型
*/
AuthorizeType: number;
/**
* 产品列表
*/
ProductIdList: Array<string>;
/**
* 位置空间描述
*/
Description?: string;
/**
* 缩略图
*/
Icon?: string;
}
/**
* DescribeDeviceBindGateway请求参数结构体
*/
export interface DescribeDeviceBindGatewayRequest {
/**
* 产品Id
*/
ProductId: string;
/**
* 设备名
*/
DeviceName: string;
}
/**
* GetTWeTalkProductConfigListV2返回参数结构体
*/
export interface GetTWeTalkProductConfigListV2Response {
/**
* 配置信息
*/
Data?: Array<TalkProductConfigV2Info>;
/**
* 总数
*/
Total?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 批量同步执行 TWeSee 语义理解任务的响应
*/
export interface InvokeVisionRecognitionTaskOutput {
/**
* 任务是否已完成
*/
Completed?: boolean;
/**
* 任务 ID
*/
TaskId?: string;
/**
* 错误码
*/
ErrorCode?: string;
/**
* 错误消息
*/
ErrorMessage?: string;
/**
* 任务结果
*/
Result?: VisionRecognitionResult;
}
/**
* DeleteDevices请求参数结构体
*/
export interface DeleteDevicesRequest {
/**
* 多个设备标识
*/
DevicesItems: Array<DevicesItem>;
}
/**
* BindTWeTalkAgent请求参数结构体
*/
export interface BindTWeTalkAgentRequest {
/**
* <p>产品 ID</p>
*/
ProductId: string;
/**
* <p>智能体 ID</p>
*/
AgentId: string;
/**
* <p>绑定维度:product 或 device</p>
*/
BindingScope: string;
/**
* <p>设备名称;<code>BindingScope=device</code> 时必填</p>
*/
DeviceName?: string;
/**
* <p>绑定优先级,数值越小优先级越高</p>
*/
Priority?: number;
}
/**
* ModifyProject返回参数结构体
*/
export interface ModifyProjectResponse {
/**
* 项目详情
*/
Project?: ProjectEntry;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCloudStorageThumbnail请求参数结构体
*/
export interface DescribeCloudStorageThumbnailRequest {
/**
* 产品ID
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
/**
* 缩略图文件名
*/
Thumbnail: string;
}
/**
* ModifyProductCloudStorageAIService请求参数结构体
*/
export interface ModifyProductCloudStorageAIServiceRequest {
/**
* 产品 ID
*/
ProductId: string;
/**
* 开通状态
*/
Enabled?: boolean;
}
/**
* CreateExternalSourceAIServiceTask请求参数结构体
*/
export interface CreateExternalSourceAIServiceTaskRequest {
/**
* 产品 ID
*/
ProductId: string;
/**
* 云存 AI 服务类型。可选值:
- `RealtimeObjectDetect`:目标检测
- `Highlight`:视频浓缩
- `VideoToText`:视频语义理解
*/
ServiceType: string;
/**
* 分析外部传入的视频 URL 列表,支持 HLS 点播(m3u8)及常见视频格式(mp4 等)
*/
VideoURLs: Array<string>;
/**
* 自定义任务 ID
*/
CustomId?: string;
/**
* 视频分析配置参数
*/
Config?: string;
/**
* 视频分析识别区域
*/
ROI?: string;
}
/**
* DescribeCloudStorageAIServiceCallback返回参数结构体
*/
export interface DescribeCloudStorageAIServiceCallbackResponse {
/**
* 推送类型。http:HTTP 回调
*/
Type?: string;
/**
* HTTP 回调 URL
*/
CallbackUrl?: string;
/**
* HTTP 回调鉴权 Token
*/
CallbackToken?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* InheritCloudStorageUser请求参数结构体
*/
export interface InheritCloudStorageUserRequest {
/**
* 产品ID
*/
ProductId: string;
/**
* 设备名称
*/
DeviceName: string;
/**
* 原始用户ID
*/
UserId: string;
/**
* 目标用户ID
*/
ToUserId: string;
}
/**
* ModifyProject请求参数结构体
*/
export interface ModifyProjectRequest {
/**
* 项目ID
*/
ProjectId: string;
/**
* 项目名称
*/
ProjectName: string;
/**
* 项目描述
*/
ProjectDesc: string;
}
/**
* ModifySpaceProperty返回参数结构体
*/
export interface ModifySpacePropertyResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* PauseTWeCallDevice请求参数结构体
*/
export interface PauseTWeCallDeviceRequest {
/**
* 设备列表
*/
DeviceList?: Array<TWeCallInfo>;
}
/**
* TWeTalk智能体配置信息描述
*/
export interface TalkAgentInfo {
/**
* 主账号UIN
*/
Uin?: number;
/**
* 账号AppId
*/
AppId?: number;
/**
* 实例 ID
*/
InstanceId?: string;
/**
* 智能体ID
*/
AgentId?: string;
/**
* 智能体名称
*/
Name?: string;
/**
* 智能体描述
*/
Description?: string;
/**
* 语音识别配置
*/
STTConfig?: TalkSTTConfig;
/**
* 大模型配置
*/
LLMConfig?: TalkLLMConfig;
/**
* 语音合成配置
*/
TTSConfig?: TalkTTSConfig;
/**
* 对话行为配置
*/
ConversationConfig?: TalkConversationConfig;
/**
* 长期记忆配置
*/
MemoryConfig?: TalkMemoryConfig;
/**
* IoT 工具列表
*/
IOTTools?: Array<TalkIOTTool>;
/**
* Webhook 工具列表
*/
WebhookTools?: Array<TalkWebhookTool>;
/**
* 元信息JSON object 字符串
*/
Metadata?: string;
/**
* 绑定关系列表
*/
Bindings?: Array<TalkAgentBinding>;
/**
* 创建时间,Unix 秒
*/
CreateTime?: number;
/**
* 更新时间,Unix 秒
*/
UpdateTime?: number;
}
/**
* ModifyTWeSeeCallback返回参数结构体
*/
export interface ModifyTWeSeeCallbackResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDeviceDataHistory返回参数结构体
*/
export interface DescribeDeviceDataHistoryResponse {
/**
* 属性字段名称,对应数据模板中功能属性的标识符
*/
FieldName?: string;
/**
* 数据是否已全部返回,true 表示数据全部返回,false 表示还有数据待返回,可将 Context 作为入参,继续查询返回结果。
*/
Listover?: boolean;
/**
* 检索上下文,当 ListOver 为false时,可以用此上下文,继续读取后续数据
*/
Context?: string;
/**
* 历史数据结果数组,返回对应时间点及取值。
*/
Results?: Array<DeviceDataHistoryItem>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateTWeSeeRecognitionTaskWithFile返回参数结构体
*/
export interface CreateTWeSeeRecognitionTaskWithFileResponse {
/**
* 任务 ID
*/
TaskId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* TWeSee 回调目标信息
*/
export interface SeeCallbackInfo {
/**
* 回调目标 ID
*/
CallbackId?: string;
/**
* 回调签名 token
*/
CallbackToken?: string;
/**
* 回调 URL
*/
CallbackUrl?: string;
/**
* 创建时间(秒级时间戳)
*/
CreateTime?: number;
/**
* 回调类型
*/
Type?: string;
/**
* 更新时间(秒级时间戳)
*/
UpdateTime?: number;
}
/**
* GetTWeTalkActiveRecordList请求参数结构体
*/
export interface GetTWeTalkActiveRecordListRequest {
/**
* 最早的时间。
*/
StartTime?: number;
/**
* 查询的最晚时间。
跟StartTime形成时间段,用于查询时间段中的记录。
*/
EndTime?: number;
/**
* 偏移量,默认为0。
*/
Offset?: number;
/**
* 分页的大小。
默认为10,最大不超过500。
*/
Limit?: number;
/**
* 产品ID
*/
ProductId?: string;
/**
* 设备名称
*/
DeviceName?: string;
/**
* TWeTalk类型:1-基础版;2-高级版;3-多模态;
*/
ServiceType?: Array<number | bigint>;
}
/**
* 设备的用户
*/
export interface DeviceUser {
/**
* 用户ID
*/
UserId?: string;
/**
* 用户角色 1所有者,0:其他分享者
*/
Role?: number;
/**
* 家庭ID,所有者带该参数
*/
FamilyId?: string;
/**
* 家庭名称,所有者带该参数
*/
FamilyName?: string;
}
/**
* 产品模型定义
*/
export interface ProductModelDefinition {
/**
* 产品ID
*/
ProductId?: string;
/**
* 模型定义
*/
ModelDefine?: string;
/**
* 更新时间,秒级时间戳
*/
UpdateTime?: number;
/**
* 创建时间,秒级时间戳
*/
CreateTime?: number;
/**
* 产品所属分类的模型快照(产品创建时刻的)
*/
CategoryModel?: string;
/**
* 产品的连接类型的模型
*/
NetTypeModel?: string;
}
/**
* GetBatchProductionsList请求参数结构体
*/
export interface GetBatchProductionsListRequest {
/**
* 项目ID
*/
ProjectId: string;
/**
* 偏移量
*/
Offset?: number;
/**
* 返回数量限制
*/
Limit?: number;
}
/**
* DeleteDevice返回参数结构体
*/
export interface DeleteDeviceResponse {
/**
* 删除的结果代码
*/
ResultCode?: string;
/**
* 删除的结果信息
*/
ResultMessage?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(