@nocobase/plugin-verification
Version:
User identity verification management, including SMS, TOTP authenticator, with extensibility.
2,759 lines (2,757 loc) • 186 kB
TypeScript
/**
* CreateModelService请求参数结构体
*/
export interface CreateModelServiceRequest {
/**
* 新增版本时需要填写
*/
ServiceGroupId?: string;
/**
* 不超过60个字,仅支持英文、数字、下划线"_"、短横"-",只能以英文、数字开头
*/
ServiceGroupName?: string;
/**
* 模型服务的描述
*/
ServiceDescription?: string;
/**
* 付费模式,有 PREPAID (包年包月)和 POSTPAID_BY_HOUR(按量付费)
*/
ChargeType?: string;
/**
* 预付费模式下所属的资源组id,同服务组下唯一
*/
ResourceGroupId?: string;
/**
* 模型信息,需要挂载模型时填写
*/
ModelInfo?: ModelInfo;
/**
* 镜像信息,配置服务运行所需的镜像地址等信息
*/
ImageInfo?: ImageInfo;
/**
* 环境变量,可选参数,用于配置容器中的环境变量
*/
Env?: Array<EnvVar>;
/**
* 资源描述,指定包年包月模式下的cpu,mem,gpu等信息,后付费无需填写
*/
Resources?: ResourceInfo;
/**
* 使用DescribeBillingSpecs接口返回的规格列表中的值,或者参考实例列表:
TI.S.MEDIUM.POST 2C4G
TI.S.LARGE.POST 4C8G
TI.S.2XLARGE16.POST 8C16G
TI.S.2XLARGE32.POST 8C32G
TI.S.4XLARGE32.POST 16C32G
TI.S.4XLARGE64.POST 16C64G
TI.S.6XLARGE48.POST 24C48G
TI.S.6XLARGE96.POST 24C96G
TI.S.8XLARGE64.POST 32C64G
TI.S.8XLARGE128.POST 32C128G
TI.GN7.LARGE20.POST 4C20G T4*1/4
TI.GN7.2XLARGE40.POST 10C40G T4*1/2
TI.GN7.2XLARGE32.POST 8C32G T4*1
TI.GN7.5XLARGE80.POST 20C80G T4*1
TI.GN7.8XLARGE128.POST 32C128G T4*1
TI.GN7.10XLARGE160.POST 40C160G T4*2
TI.GN7.20XLARGE320.POST 80C320G T4*4
*/
InstanceType?: string;
/**
* 扩缩容类型 支持:自动 - "AUTO", 手动 - "MANUAL",默认为MANUAL
*/
ScaleMode?: string;
/**
* 实例数量, 不同计费模式和调节模式下对应关系如下
PREPAID 和 POSTPAID_BY_HOUR:
手动调节模式下对应 实例数量
自动调节模式下对应 基于时间的默认策略的实例数量
HYBRID_PAID:
后付费实例手动调节模式下对应 实例数量
后付费实例自动调节模式下对应 时间策略的默认策略的实例数量
*/
Replicas?: number;
/**
* 自动伸缩信息
*/
HorizontalPodAutoscaler?: HorizontalPodAutoscaler;
/**
* 是否开启日志投递,开启后需填写配置投递到指定cls
*/
LogEnable?: boolean;
/**
* 日志配置,需要投递服务日志到指定cls时填写
*/
LogConfig?: LogConfig;
/**
* 是否开启接口鉴权,开启后自动生成token信息,访问需要token鉴权
*/
AuthorizationEnable?: boolean;
/**
* 腾讯云标签
*/
Tags?: Array<Tag>;
/**
* 是否新增版本
*/
NewVersion?: boolean;
/**
* 定时任务配置,使用定时策略时填写
*/
CronScaleJobs?: Array<CronScaleJob>;
/**
* 自动伸缩策略配置 HPA : 通过HPA进行弹性伸缩 CRON 通过定时任务进行伸缩
*/
ScaleStrategy?: string;
/**
* 计费模式[HYBRID_PAID]时生效, 用于标识混合计费模式下的预付费实例数
*/
HybridBillingPrepaidReplicas?: number;
/**
* [AUTO_ML 自动学习,自动学习正式发布 AUTO_ML_FORMAL, DEFAULT 默认]
*/
CreateSource?: string;
/**
* 是否开启模型的热更新。默认不开启
*/
ModelHotUpdateEnable?: boolean;
/**
* 定时停止配置
*/
ScheduledAction?: ScheduledAction;
/**
* 挂载配置,目前只支持CFS
*/
VolumeMount?: VolumeMount;
/**
* 服务限速限流相关配置
*/
ServiceLimit?: ServiceLimit;
/**
* 回调地址,用于回调创建服务状态信息,回调格式&内容详情见:[TI-ONE 接口回调说明](https://cloud.tencent.com/document/product/851/84292)
*/
CallbackUrl?: string;
/**
* 是否开启模型的加速, 仅对StableDiffusion(动态加速)格式的模型有效。
*/
ModelTurboEnable?: boolean;
/**
* 服务分类
*/
ServiceCategory?: string;
/**
* 服务的启动命令
*/
Command?: string;
/**
* 是否开启TIONE内网访问外部
*/
ServiceEIP?: ServiceEIP;
}
/**
* CreateNotebookImage返回参数结构体
*/
export interface CreateNotebookImageResponse {
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 模型描述信息
*/
export interface ModelInfo {
/**
* 模型版本id, DescribeTrainingModelVersion查询模型接口时的id
自动学习类型的模型填写自动学习的任务id
*/
ModelVersionId: string;
/**
* 模型id
*/
ModelId?: string;
/**
* 模型名
*/
ModelName?: string;
/**
* 模型版本
*/
ModelVersion?: string;
/**
* 模型来源
*/
ModelSource?: string;
/**
* cos路径信息
*/
CosPathInfo?: CosPathInfo;
/**
* 模型对应的算法框架,预留
注意:此字段可能返回 null,表示取不到有效值。
*/
AlgorithmFramework?: string;
/**
* 默认为 NORMAL, 已加速模型: ACCELERATE, 自动学习模型 AUTO_ML
注意:此字段可能返回 null,表示取不到有效值。
*/
ModelType?: string;
/**
* 模型格式
注意:此字段可能返回 null,表示取不到有效值。
*/
ModelFormat?: string;
}
/**
* DescribeLogs请求参数结构体
*/
export interface DescribeLogsRequest {
/**
* 服务类型,TRAIN为任务式建模, NOTEBOOK为Notebook, INFER为在线服务, BATCH为批量预测
枚举值:
- TRAIN
- NOTEBOOK
- INFER
- BATCH
*/
Service: string;
/**
* 日志查询开始时间(RFC3339格式的时间字符串),默认值为当前时间的前一个小时
*/
StartTime?: string;
/**
* 日志查询结束时间(RFC3339格式的时间字符串),默认值为当前时间
*/
EndTime?: string;
/**
* 日志查询条数,默认值100,最大值100
*/
Limit?: number;
/**
* 服务ID,和Service参数对应,不同Service的服务ID获取方式不同,具体如下:
- Service类型为TRAIN:
调用[DescribeTrainingTask接口](/document/product/851/75089)查询训练任务详情,ServiceId为接口返回值中Response.TrainingTaskDetail.LatestInstanceId
- Service类型为NOTEBOOK:
调用[DescribeNotebook接口](/document/product/851/95662)查询Notebook详情,ServiceId为接口返回值中Response.NotebookDetail.PodName
- Service类型为INFER:
调用[DescribeModelServiceGroup接口](/document/product/851/82285)查询服务组详情,ServiceId为接口返回值中Response.ServiceGroup.Services.ServiceId
- Service类型为BATCH:
调用[DescribeBatchTask接口](/document/product/851/80180)查询跑批任务详情,ServiceId为接口返回值中Response.BatchTaskDetail.LatestInstanceId
*/
ServiceId?: string;
/**
* Pod的名称,即需要查询服务对应的Pod,和Service参数对应,不同Service的PodName获取方式不同,具体如下:
- Service类型为TRAIN:
调用[DescribeTrainingTaskPods接口](/document/product/851/75088)查询训练任务pod列表,PodName为接口返回值中Response.PodNames
- Service类型为NOTEBOOK:
调用[DescribeNotebook接口](/document/product/851/95662)查询Notebook详情,PodName为接口返回值中Response.NotebookDetail.PodName
- Service类型为INFER:
调用[DescribeModelService接口](/document/product/851/82287)查询单个服务详情,PodName为接口返回值中Response.Service.ServiceInfo.PodInfos
- Service类型为BATCH:
调用[DescribeBatchTask接口](/document/product/851/80180)查询跑批任务详情,PodName为接口返回值中Response.BatchTaskDetail. PodList
注:支持结尾通配符*
*/
PodName?: string;
/**
* 排序方向(可选值为ASC, DESC ),默认为DESC
*/
Order?: string;
/**
* 按哪个字段排序(可选值为Timestamp),默认值为Timestamp
*/
OrderField?: string;
/**
* 日志查询上下文,查询下一页的时候需要回传这个字段,该字段来自本接口的返回
*/
Context?: string;
/**
* 过滤条件
注意:
1. Filter.Name:目前只支持Key(也就是按关键字过滤日志)
2. Filter.Values:表示过滤日志的关键字;Values为多个的时候表示同时满足
3. Filter. Negative和Filter. Fuzzy没有使用
*/
Filters?: Array<Filter>;
}
/**
* StopModelAccelerateTask请求参数结构体
*/
export interface StopModelAccelerateTaskRequest {
/**
* 模型加速任务ID
*/
ModelAccTaskId: string;
}
/**
* DeleteTrainingModelVersion返回参数结构体
*/
export interface DeleteTrainingModelVersionResponse {
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 跑批任务详情
*/
export interface BatchTaskDetail {
/**
* 跑批任务ID
*/
BatchTaskId: string;
/**
* 跑批任务名称
*/
BatchTaskName: string;
/**
* 主账号uin
*/
Uin: string;
/**
* 子账号uin
*/
SubUin: string;
/**
* 地域
*/
Region: string;
/**
* 计费模式
*/
ChargeType: string;
/**
* 包年包月资源组ID
注意:此字段可能返回 null,表示取不到有效值。
*/
ResourceGroupId: string;
/**
* 包年包月资源组名称
注意:此字段可能返回 null,表示取不到有效值。
*/
ResourceGroupName: string;
/**
* 资源配置
*/
ResourceConfigInfo: ResourceConfigInfo;
/**
* 标签
注意:此字段可能返回 null,表示取不到有效值。
*/
Tags: Array<Tag>;
/**
* 服务对应的模型信息
注意:此字段可能返回 null,表示取不到有效值。
*/
ModelInfo: ModelInfo;
/**
* 自定义镜像信息
注意:此字段可能返回 null,表示取不到有效值。
*/
ImageInfo: ImageInfo;
/**
* 代码包
注意:此字段可能返回 null,表示取不到有效值。
*/
CodePackagePath: CosPathInfo;
/**
* 启动命令
注意:此字段可能返回 null,表示取不到有效值。
*/
StartCmd: string;
/**
* 输入数据配置
注意:此字段可能返回 null,表示取不到有效值。
*/
DataConfigs: Array<DataConfig>;
/**
* 输出数据配置
*/
Outputs: Array<DataConfig>;
/**
* 是否上报日志
*/
LogEnable: boolean;
/**
* 日志配置
注意:此字段可能返回 null,表示取不到有效值。
*/
LogConfig: LogConfig;
/**
* vpc id
注意:此字段可能返回 null,表示取不到有效值。
*/
VpcId: string;
/**
* 子网id
注意:此字段可能返回 null,表示取不到有效值。
*/
SubnetId: string;
/**
* 任务状态
*/
Status: string;
/**
* 运行时长
注意:此字段可能返回 null,表示取不到有效值。
*/
RuntimeInSeconds: number;
/**
* 创建时间
*/
CreateTime: string;
/**
* 更新时间
*/
UpdateTime: string;
/**
* 任务开始时间
注意:此字段可能返回 null,表示取不到有效值。
*/
StartTime: string;
/**
* 任务结束时间
注意:此字段可能返回 null,表示取不到有效值。
*/
EndTime: string;
/**
* 计费状态,eg:BILLING计费中,ARREARS_STOP欠费停止,NOT_BILLING不在计费中
*/
ChargeStatus: string;
/**
* 最近一次实例ID
注意:此字段可能返回 null,表示取不到有效值。
*/
LatestInstanceId: string;
/**
* 备注
注意:此字段可能返回 null,表示取不到有效值。
*/
Remark: string;
/**
* 失败原因
注意:此字段可能返回 null,表示取不到有效值。
*/
FailureReason: string;
/**
* 计费金额信息,eg:2.00元/小时 (for 按量计费)
注意:此字段可能返回 null,表示取不到有效值。
*/
BillingInfo: string;
/**
* 运行中的Pod的名字
注意:此字段可能返回 null,表示取不到有效值。
*/
PodList?: Array<string>;
/**
* 模型推理代码信息
注意:此字段可能返回 null,表示取不到有效值。
*/
ModelInferenceCodeInfo?: CosPathInfo;
}
/**
* DeleteNotebookImageRecord请求参数结构体
*/
export interface DeleteNotebookImageRecordRequest {
/**
* 记录id
*/
RecordId: string;
}
/**
* Notebook列表元素
*/
export interface NotebookSetItem {
/**
* notebook ID
*/
Id?: string;
/**
* notebook 名称
*/
Name?: string;
/**
* 计费模式
*/
ChargeType?: string;
/**
* 资源配置
*/
ResourceConf?: ResourceConf;
/**
* 预付费资源组
注意:此字段可能返回 null,表示取不到有效值。
*/
ResourceGroupId?: string;
/**
* 存储卷大小
注意:此字段可能返回 null,表示取不到有效值。
*/
VolumeSizeInGB?: number;
/**
* 计费金额信息,eg:2.00元/小时 (for后付费)
注意:此字段可能返回 null,表示取不到有效值。
*/
BillingInfos?: Array<string>;
/**
* 标签配置
注意:此字段可能返回 null,表示取不到有效值。
*/
Tags?: Array<Tag>;
/**
* 创建时间
*/
CreateTime?: string;
/**
* 启动时间
注意:此字段可能返回 null,表示取不到有效值。
*/
StartTime?: string;
/**
* 更新时间
*/
UpdateTime?: string;
/**
* 运行时间
注意:此字段可能返回 null,表示取不到有效值。
*/
RuntimeInSeconds?: number;
/**
* 计费状态
注意:此字段可能返回 null,表示取不到有效值。
*/
ChargeStatus?: string;
/**
* 状态
*/
Status?: string;
/**
* 错误原因
注意:此字段可能返回 null,表示取不到有效值。
*/
FailureReason?: string;
/**
* 结束时间
注意:此字段可能返回 null,表示取不到有效值。
*/
EndTime?: string;
/**
* Pod名称
注意:此字段可能返回 null,表示取不到有效值。
*/
PodName?: string;
/**
* 后付费资源规格名称
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceTypeAlias?: string;
/**
* 预付费资源组名称
注意:此字段可能返回 null,表示取不到有效值。
*/
ResourceGroupName?: string;
/**
* 是否自动终止
*/
AutoStopping?: boolean;
/**
* 自动停止时间
注意:此字段可能返回 null,表示取不到有效值。
*/
AutomaticStopTime?: number;
/**
* 存储的类型。取值包含:
FREE: 预付费的免费存储
CLOUD_PREMIUM: 高性能云硬盘
CLOUD_SSD: SSD云硬盘
CFS: CFS存储,包含NFS和turbo
注意:此字段可能返回 null,表示取不到有效值。
*/
VolumeSourceType?: string;
/**
* CFS存储的配置
注意:此字段可能返回 null,表示取不到有效值。
*/
VolumeSourceCFS?: CFSConfig;
/**
* notebook 信息
注意:此字段可能返回 null,表示取不到有效值。
*/
Message?: string;
/**
* notebook用户类型
注意:此字段可能返回 null,表示取不到有效值。
*/
UserTypes?: Array<string>;
/**
* SSH配置
注意:此字段可能返回 null,表示取不到有效值。
*/
SSHConfig?: SSHConfig;
}
/**
* StartTrainingTask请求参数结构体
*/
export interface StartTrainingTaskRequest {
/**
* 训练任务ID
*/
Id: string;
}
/**
* DescribeDatasetDetailStructured返回参数结构体
*/
export interface DescribeDatasetDetailStructuredResponse {
/**
* 数据总数
注意:此字段可能返回 null,表示取不到有效值。
*/
TotalCount: number;
/**
* 表格头信息
注意:此字段可能返回 null,表示取不到有效值。
*/
ColumnNames: Array<string>;
/**
* 表格内容
注意:此字段可能返回 null,表示取不到有效值。
*/
RowItems: Array<RowItem>;
/**
* 文本内容
注意:此字段可能返回 null,表示取不到有效值。
*/
RowTexts: Array<string>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyServiceGroupWeights返回参数结构体
*/
export interface ModifyServiceGroupWeightsResponse {
/**
* 更新权重后的服务组信息
注意:此字段可能返回 null,表示取不到有效值。
*/
ServiceGroup: ServiceGroup;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RestartModelAccelerateTask请求参数结构体
*/
export interface RestartModelAccelerateTaskRequest {
/**
* 模型加速任务ID
*/
ModelAccTaskId: string;
/**
* 模型加速任务名称
*/
ModelAccTaskName?: string;
/**
* 模型来源(JOB/COS)
*/
ModelSource?: string;
/**
* 算法框架(废弃)
*/
AlgorithmFramework?: string;
/**
* 模型ID
*/
ModelId?: string;
/**
* 模型名称
*/
ModelName?: string;
/**
* 模型版本
*/
ModelVersion?: string;
/**
* 模型输入cos路径
*/
ModelInputPath?: CosPathInfo;
/**
* 优化级别(NO_LOSS/FP16/INT8),默认FP16
*/
OptimizationLevel?: string;
/**
* input节点个数(废弃)
*/
ModelInputNum?: number;
/**
* input节点信息(废弃)
*/
ModelInputInfos?: Array<ModelInputInfo>;
/**
* 模型输出cos路径
*/
ModelOutputPath?: CosPathInfo;
/**
* 模型格式(TORCH_SCRIPT/DETECTRON2/SAVED_MODEL/FROZEN_GRAPH/MMDETECTION/ONNX/HUGGING_FACE)
*/
ModelFormat?: string;
/**
* 模型Tensor信息
*/
TensorInfos?: Array<string>;
/**
* GPU类型(T4/V100/A10),默认T4
*/
GPUType?: string;
/**
* 模型专业参数
*/
HyperParameter?: HyperParameter;
/**
* 加速引擎版本
*/
AccEngineVersion?: string;
/**
* 标签
*/
Tags?: Array<Tag>;
/**
* SavedModel保存时配置的签名
*/
ModelSignature?: string;
/**
* 加速引擎对应的框架版本
*/
FrameworkVersion?: string;
}
/**
* 大模型生成Token统计
*/
export interface Usage {
/**
* 生成的token数目
注意:此字段可能返回 null,表示取不到有效值。
*/
CompletionTokens?: number;
/**
* 输入的token数目
注意:此字段可能返回 null,表示取不到有效值。
*/
PromptTokens?: number;
/**
* 总共token数目
注意:此字段可能返回 null,表示取不到有效值。
*/
TotalTokens?: number;
}
/**
* DescribeBillingResourceGroups请求参数结构体
*/
export interface DescribeBillingResourceGroupsRequest {
/**
* 资源组类型; 枚举值 TRAIN:训练 INFERENCE:推理
*/
Type: string;
/**
* Filter.Name: 枚举值: ResourceGroupId (资源组id列表)
ResourceGroupName (资源组名称列表)
Filter.Values: 长度为1且Filter.Fuzzy=true时,支持模糊查询; 不为1时,精确查询
每次请求的Filters的上限为5,Filter.Values的上限为100
*/
Filters?: Array<Filter>;
/**
* 标签过滤
*/
TagFilters?: Array<TagFilter>;
/**
* 偏移量,默认为0;分页查询起始位置,如:Limit为100,第一页Offset为0,第二页OffSet为100....即每页左边为闭区间
*/
Offset?: number;
/**
* 返回数量,默认为20,最大值为30;
注意:小于0则默认为20;大于30则默认为30
*/
Limit?: number;
/**
* 支持模糊查找资源组id和资源组名
*/
SearchWord?: string;
/**
* 是否不展示节点列表;
true: 不展示,false 展示;
默认为false
*/
DontShowInstanceSet?: boolean;
}
/**
* DeleteNotebook请求参数结构体
*/
export interface DeleteNotebookRequest {
/**
* notebook id
*/
Id: string;
}
/**
* DescribeTrainingFrameworks返回参数结构体
*/
export interface DescribeTrainingFrameworksResponse {
/**
* 框架信息列表
*/
FrameworkInfos?: Array<FrameworkInfo>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeModelServiceGroup请求参数结构体
*/
export interface DescribeModelServiceGroupRequest {
/**
* 服务组ID
*/
ServiceGroupId: string;
/**
* 服务分类
*/
ServiceCategory?: string;
}
/**
* 过滤器
*/
export interface Filter {
/**
* 过滤字段名称
*/
Name?: string;
/**
* 过滤字段取值
*/
Values?: Array<string>;
/**
* 是否开启反向查询
*/
Negative?: boolean;
/**
* 是否开启模糊匹配
*/
Fuzzy?: boolean;
}
/**
* 训练指标
*/
export interface TrainingMetric {
/**
* 指标名
*/
MetricName: string;
/**
* 数据值
注意:此字段可能返回 null,表示取不到有效值。
*/
Values: Array<TrainingDataPoint>;
/**
* 上报的Epoch. 可能为空
注意:此字段可能返回 null,表示取不到有效值。
*/
Epochs: Array<TrainingDataPoint>;
/**
* 上报的Step. 可能为空
注意:此字段可能返回 null,表示取不到有效值。
*/
Steps: Array<TrainingDataPoint>;
/**
* 上报的TotalSteps. 可能为空
注意:此字段可能返回 null,表示取不到有效值。
*/
TotalSteps: Array<TrainingDataPoint>;
}
/**
* DescribeTrainingModelVersions请求参数结构体
*/
export interface DescribeTrainingModelVersionsRequest {
/**
* 模型ID
*/
TrainingModelId: string;
/**
* 过滤条件
Filter.Name: 枚举值:
TrainingModelVersionId (模型版本ID)
ModelVersionType (模型版本类型) 其值支持: NORMAL(通用) ACCELERATE (加速)
ModelFormat(模型格式)其值Filter.Values支持:
TORCH_SCRIPT/PYTORCH/DETECTRON2/SAVED_MODEL/FROZEN_GRAPH/PMML
AlgorithmFramework (算法框架) 其值Filter.Values支持:TENSORFLOW/PYTORCH/DETECTRON2
Filter.Values: 当长度为1时,支持模糊查询; 不为1时,精确查询
每次请求的Filters的上限为10,Filter.Values的上限为100
*/
Filters?: Array<Filter>;
}
/**
* 计费项询价单元
*/
export interface SpecUnit {
/**
* 计费项名称
*/
SpecName: string;
/**
* 计费项数量,建议不超过100万
*/
SpecCount: number;
}
/**
* CreateDataset返回参数结构体
*/
export interface CreateDatasetResponse {
/**
* 数据集ID
注意:此字段可能返回 null,表示取不到有效值。
*/
DatasetId?: string;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 描述在线服务
*/
export interface Service {
/**
* 服务组id
*/
ServiceGroupId?: string;
/**
* 服务id
*/
ServiceId?: string;
/**
* 服务组名
*/
ServiceGroupName?: string;
/**
* 服务描述
注意:此字段可能返回 null,表示取不到有效值。
*/
ServiceDescription?: string;
/**
* 服务的详细信息
注意:此字段可能返回 null,表示取不到有效值。
*/
ServiceInfo?: ServiceInfo;
/**
* 集群id
注意:此字段可能返回 null,表示取不到有效值。
*/
ClusterId?: string;
/**
* 地域
注意:此字段可能返回 null,表示取不到有效值。
*/
Region?: string;
/**
* 命名空间
注意:此字段可能返回 null,表示取不到有效值。
*/
Namespace?: string;
/**
* 付费类型
注意:此字段可能返回 null,表示取不到有效值。
*/
ChargeType?: string;
/**
* 包年包月服务的资源组id,按量计费的服务为空
注意:此字段可能返回 null,表示取不到有效值。
*/
ResourceGroupId?: string;
/**
* 包年包月服务对应的资源组名字
注意:此字段可能返回 null,表示取不到有效值。
*/
ResourceGroupName?: string;
/**
* 服务的标签
注意:此字段可能返回 null,表示取不到有效值。
*/
Tags?: Array<Tag>;
/**
* 服务所在的 ingress 的 name
注意:此字段可能返回 null,表示取不到有效值。
*/
IngressName?: string;
/**
* 创建者
注意:此字段可能返回 null,表示取不到有效值。
*/
CreatedBy?: string;
/**
* 创建时间
注意:此字段可能返回 null,表示取不到有效值。
*/
CreateTime?: string;
/**
* 更新时间
注意:此字段可能返回 null,表示取不到有效值。
*/
UpdateTime?: string;
/**
* 主账号
注意:此字段可能返回 null,表示取不到有效值。
*/
Uin?: string;
/**
* 子账号
注意:此字段可能返回 null,表示取不到有效值。
*/
SubUin?: string;
/**
* app_id
注意:此字段可能返回 null,表示取不到有效值。
*/
AppId?: number;
/**
* 服务的业务状态
注意:此字段可能返回 null,表示取不到有效值。
*/
BusinessStatus?: string;
/**
* 已废弃
注意:此字段可能返回 null,表示取不到有效值。
*/
ServiceLimit?: ServiceLimit;
/**
* 已废弃
注意:此字段可能返回 null,表示取不到有效值。
*/
ScheduledAction?: ScheduledAction;
/**
* 服务创建失败的原因,创建成功后该字段为默认值 CREATE_SUCCEED
注意:此字段可能返回 null,表示取不到有效值。
*/
CreateFailedReason?: string;
/**
* 服务状态
CREATING 创建中
CREATE_FAILED 创建失败
Normal 正常运行中
Stopped 已停止
Stopping 停止中
Abnormal 异常
Pending 启动中
Waiting 就绪中
注意:此字段可能返回 null,表示取不到有效值。
*/
Status?: string;
/**
* 费用信息
注意:此字段可能返回 null,表示取不到有效值。
*/
BillingInfo?: string;
/**
* 模型权重
注意:此字段可能返回 null,表示取不到有效值。
*/
Weight?: number;
/**
* 服务的创建来源
AUTO_ML: 来自自动学习的一键发布
DEFAULT: 其他来源
注意:此字段可能返回 null,表示取不到有效值。
*/
CreateSource?: string;
/**
* 版本号
注意:此字段可能返回 null,表示取不到有效值。
*/
Version?: string;
/**
* 服务组下服务的最高版本号
注意:此字段可能返回 null,表示取不到有效值。
*/
LatestVersion?: string;
}
/**
* 跨租户弹性网卡下Pod调用信息
*/
export interface CrossTenantENIInfo {
/**
* Pod IP
注意:此字段可能返回 null,表示取不到有效值。
*/
PrimaryIP?: string;
/**
* Pod Port
注意:此字段可能返回 null,表示取不到有效值。
*/
Port?: string;
}
/**
* 模型专业参数
*/
export interface HyperParameter {
/**
* 最大nnz数
注意:此字段可能返回 null,表示取不到有效值。
*/
MaxNNZ?: string;
/**
* slot数
注意:此字段可能返回 null,表示取不到有效值。
*/
SlotNum?: string;
/**
* gpu cache 使用率
注意:此字段可能返回 null,表示取不到有效值。
*/
CpuCachePercentage?: string;
/**
* cpu cache 使用率
注意:此字段可能返回 null,表示取不到有效值。
*/
GpuCachePercentage?: string;
/**
* 是否开启分布式模式(true/false)
注意:此字段可能返回 null,表示取不到有效值。
*/
EnableDistributed?: string;
/**
* TORCH_SCRIPT、MMDETECTION、DETECTRON2、HUGGINGFACE格式在进行优化时切分子图的最小算子数目,一般无需进行改动,默认为3
注意:此字段可能返回 null,表示取不到有效值。
*/
MinBlockSizePt?: string;
/**
* FROZEN_GRAPH、SAVED_MODEL格式在进行优化时切分子图的最小算子数目,一般无需进行改动,默认为10
注意:此字段可能返回 null,表示取不到有效值。
*/
MinBlockSizeTf?: string;
/**
* Stable Diffusion 模型优化参数
注意:此字段可能返回 null,表示取不到有效值。
*/
PipelineArgs?: string;
/**
* Stable Diffusion 模型优化参数,控制Lora模型的影响效果
注意:此字段可能返回 null,表示取不到有效值。
*/
LoraScale?: string;
}
/**
* ModifyServiceGroupWeights请求参数结构体
*/
export interface ModifyServiceGroupWeightsRequest {
/**
* 服务组id
*/
ServiceGroupId: string;
/**
* 权重设置
*/
Weights: Array<WeightEntry>;
}
/**
* DescribeTrainingTasks请求参数结构体
*/
export interface DescribeTrainingTasksRequest {
/**
* 过滤器,eg:[{ "Name": "Id", "Values": ["train-23091792777383936"] }]
取值范围:
Name(名称):task1
Id(task ID):train-23091792777383936
Status(状态):STARTING / RUNNING / STOPPING / STOPPED / FAILED / SUCCEED / SUBMIT_FAILED
ChargeType(计费类型):PREPAID(预付费)/ POSTPAID_BY_HOUR(后付费)
CHARGE_STATUS(计费状态):NOT_BILLING(未开始计费)/ BILLING(计费中)/ ARREARS_STOP(欠费停止)
*/
Filters?: Array<Filter>;
/**
* 标签过滤器,eg:[{ "TagKey": "TagKeyA", "TagValue": ["TagValueA"] }]
*/
TagFilters?: Array<TagFilter>;
/**
* 偏移量,默认为0
*/
Offset?: number;
/**
* 返回数量,默认为10,最大为50
*/
Limit?: number;
/**
* 输出列表的排列顺序。取值范围:ASC(升序排列)/ DESC(降序排列),默认为DESC
*/
Order?: string;
/**
* 排序的依据字段, 取值范围 "CreateTime" "UpdateTime"
*/
OrderField?: string;
}
/**
* DescribeBatchTask请求参数结构体
*/
export interface DescribeBatchTaskRequest {
/**
* 跑批任务ID
*/
BatchTaskId: string;
}
/**
* DescribeNotebookImageKernels请求参数结构体
*/
export interface DescribeNotebookImageKernelsRequest {
/**
* notebook id
*/
NotebookId: string;
}
/**
* DescribeDatasetDetailUnstructured请求参数结构体
*/
export interface DescribeDatasetDetailUnstructuredRequest {
/**
* 数据集ID
*/
DatasetId?: string;
/**
* 偏移量
*/
Offset?: number;
/**
* 返回个数,默认20,目前最大支持2000条数据
*/
Limit?: number;
/**
* 标签过滤参数,对应标签值
*/
LabelList?: Array<string>;
/**
* 标注状态过滤参数:
STATUS_ANNOTATED,已标注
STATUS_NON_ANNOTATED,未标注
STATUS_ALL,全部
默认为STATUS_ALL
*/
AnnotationStatus?: string;
/**
* 数据集ID列表
*/
DatasetIds?: Array<string>;
/**
* 要筛选的文本分类场景标签信息
*/
TextClassificationLabels?: Array<TextLabelDistributionInfo>;
}
/**
* 训练任务详情
*/
export interface TrainingTaskDetail {
/**
* 训练任务ID
*/
Id?: string;
/**
* 训练任务名称
*/
Name?: string;
/**
* 主账号uin
*/
Uin?: string;
/**
* 子账号uin
*/
SubUin?: string;
/**
* 地域
*/
Region?: string;
/**
* 训练框架名称,eg:SPARK、PYSARK、TENSORFLOW、PYTORCH
注意:此字段可能返回 null,表示取不到有效值。
*/
FrameworkName?: string;
/**
* 训练框架版本
注意:此字段可能返回 null,表示取不到有效值。
*/
FrameworkVersion?: string;
/**
* 框架运行环境
注意:此字段可能返回 null,表示取不到有效值。
*/
FrameworkEnvironment?: string;
/**
* 计费模式
*/
ChargeType?: string;
/**
* 预付费专用资源组
注意:此字段可能返回 null,表示取不到有效值。
*/
ResourceGroupId?: string;
/**
* 资源配置
*/
ResourceConfigInfos?: Array<ResourceConfigInfo>;
/**
* 标签
注意:此字段可能返回 null,表示取不到有效值。
*/
Tags?: Array<Tag>;
/**
* 训练模式,eg:PS_WORKER、DDP、MPI、HOROVOD
注意:此字段可能返回 null,表示取不到有效值。
*/
TrainingMode?: string;
/**
* 代码包
*/
CodePackagePath?: CosPathInfo;
/**
* 启动命令信息
*/
StartCmdInfo?: StartCmdInfo;
/**
* 数据来源,eg:DATASET、COS
注意:此字段可能返回 null,表示取不到有效值。
*/
DataSource?: string;
/**
* 数据配置
注意:此字段可能返回 null,表示取不到有效值。
*/
DataConfigs?: Array<DataConfig>;
/**
* 调优参数
注意:此字段可能返回 null,表示取不到有效值。
*/
TuningParameters?: string;
/**
* 训练输出
*/
Output?: CosPathInfo;
/**
* 是否上报日志
*/
LogEnable?: boolean;
/**
* 日志配置
注意:此字段可能返回 null,表示取不到有效值。
*/
LogConfig?: LogConfig;
/**
* VPC ID
注意:此字段可能返回 null,表示取不到有效值。
*/
VpcId?: string;
/**
* 子网ID
注意:此字段可能返回 null,表示取不到有效值。
*/
SubnetId?: string;
/**
* 自定义镜像信息
注意:此字段可能返回 null,表示取不到有效值。
*/
ImageInfo?: ImageInfo;
/**
* 运行时长
注意:此字段可能返回 null,表示取不到有效值。
*/
RuntimeInSeconds?: number;
/**
* 创建时间
*/
CreateTime?: string;
/**
* 训练开始时间
注意:此字段可能返回 null,表示取不到有效值。
*/
StartTime?: string;
/**
* 计费状态,eg:BILLING计费中,ARREARS_STOP欠费停止,NOT_BILLING不在计费中
*/
ChargeStatus?: string;
/**
* 最近一次实例ID
注意:此字段可能返回 null,表示取不到有效值。
*/
LatestInstanceId?: string;
/**
* TensorBoard ID
注意:此字段可能返回 null,表示取不到有效值。
*/
TensorBoardId?: string;
/**
* 备注
注意:此字段可能返回 null,表示取不到有效值。
*/
Remark?: string;
/**
* 失败原因
注意:此字段可能返回 null,表示取不到有效值。
*/
FailureReason?: string;
/**
* 更新时间
*/
UpdateTime?: string;
/**
* 训练结束时间
注意:此字段可能返回 null,表示取不到有效值。
*/
EndTime?: string;
/**
* 计费金额信息,eg:2.00元/小时 (按量计费)
注意:此字段可能返回 null,表示取不到有效值。
*/
BillingInfo?: string;
/**
* 预付费专用资源组名称
注意:此字段可能返回 null,表示取不到有效值。
*/
ResourceGroupName?: string;
/**
* 任务信息
注意:此字段可能返回 null,表示取不到有效值。
*/
Message?: string;
/**
* 任务状态,eg:STARTING启动中、RUNNING运行中、STOPPING停止中、STOPPED已停止、FAILED异常、SUCCEED已完成
*/
Status?: string;
/**
* 回调地址
注意:此字段可能返回 null,表示取不到有效值。
*/
CallbackUrl?: string;
}
/**
* SendChatMessage返回参数结构体
*/
export interface SendChatMessageResponse {
/**
* 答案
*/
Answer?: string;
/**
* 会话id,返回请求的会话id
*/
SessionId?: string;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyNotebookTags返回参数结构体
*/
export interface ModifyNotebookTagsResponse {
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeBillingResourceGroup返回参数结构体
*/
export interface DescribeBillingResourceGroupResponse {
/**
* 资源组节点总数; 注意接口是分页拉取的,total是指资源组节点总数,不是本次返回中InstanceSet数组的大小
注意:此字段可能返回 null,表示取不到有效值。
*/
TotalCount?: number;
/**
* 资源组节点信息
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceSet?: Array<Instance>;
/**
* 资源组纳管类型
*/
ResourceGroupSWType?: string;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeNotebookImageRecords返回参数结构体
*/
export interface DescribeNotebookImageRecordsResponse {
/**
* 总条数
*/
TotalCount?: number;
/**
* 镜像保存记录
*/
NotebookImageRecords?: Array<NotebookImageRecord>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* cos的路径信息
*/
export interface CosPathInfo {
/**
* 存储桶
注意:此字段可能返回 null,表示取不到有效值。
*/
Bucket: string;
/**
* 所在地域
注意:此字段可能返回 null,表示取不到有效值。
*/
Region: string;
/**
* 路径列表,目前只支持单个
注意:此字段可能返回 null,表示取不到有效值。
*/
Paths: Array<string>;
}
/**
* DescribeBillingResourceGroups返回参数结构体
*/
export interface DescribeBillingResourceGroupsResponse {
/**
* 资源组总数; 注意接口是分页拉取的,total是指资源组总数,不是本次返回中ResourceGroupSet数组的大小
*/
TotalCount: number;
/**
* 资源组详情
注意:此字段可能返回 null,表示取不到有效值。
*/
ResourceGroupSet: Array<ResourceGroup>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 计费项询价结果
*/
export interface SpecPrice {
/**
* 计费项名称
*/
SpecName: string;
/**
* 原价,单位:分。最大值42亿,超过则返回0
*/
TotalCost: number;
/**
* 优惠后的价格,单位:分
*/
RealTotalCost: number;
/**
* 计费项数量
*/
SpecCount?: number;
}
/**
* StartNotebook返回参数结构体
*/
export interface StartNotebookResponse {
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateNotebook返回参数结构体
*/
export interface CreateNotebookResponse {
/**
* notebook标志
*/
Id?: string;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 配置CFSTurbo参数
*/
export interface CFSTurbo {
/**
* CFSTurbo实例id
注意:此字段可能返回 null,表示取不到有效值。
*/
Id?: string;
/**
* CFSTurbo路径
注意:此字段可能返回 null,表示取不到有效值。
*/
Path?: string;
}
/**
* 文件行信息
*/
export interface RowValue {
/**
* 列名
*/
Name: string;
/**
* 列值
注意:此字段可能返回 null,表示取不到有效值。
*/
Value: string;
}
/**
* CreateBatchTask请求参数结构体
*/
export interface CreateBatchTaskRequest {
/**
* 跑批任务名称,不超过60个字符,仅支持中英文、数字、下划线"_"、短横"-",只能以中英文、数字开头
*/
BatchTaskName: string;
/**
* 计费模式,eg:PREPAID 包年包月;POSTPAID_BY_HOUR 按量计费
*/
ChargeType: string;
/**
* 资源配置
*/
ResourceConfigInfo: ResourceConfigInfo;
/**
* 结果输出
*/
Outputs: Array<DataConfig>;
/**
* 是否上报日志
*/
LogEnable: boolean;
/**
* 工作类型 1:单次 2:周期
*/
JobType?: number;
/**
* 任务周期描述
*/
CronInfo?: CronInfo;
/**
* 包年包月资源组ID
*/
ResourceGroupId?: string;
/**
* 标签配置
*/
Tags?: Array<Tag>;
/**
* 服务对应的模型信息,有模型文件时需要填写
*/
ModelInfo?: ModelInfo;
/**
* 自定义镜像信息
*/
ImageInfo?: ImageInfo;
/**
* 代码包
*/
CodePackage?: CosPathInfo;
/**
* 启动命令
*/
StartCmd?: string;
/**
* 数据配置
*/
DataConfigs?: Array<DataConfig>;
/**
* 日志配置
*/
LogConfig?: LogConfig;
/**
* VPC Id
*/
VpcId?: string;
/**
* 子网Id
*/
SubnetId?: string;
/**
* 备注
*/
Remark?: string;
/**
* 任务执行结果回调URL,仅支持http和https。回调格式&内容详见: [TI-ONE 接口回调说明](https://cloud.tencent.com/document/product/851/84292)
*/
CallbackUrl?: string;
}
/**
* 资源组节点运行任务信息
*/
export interface ResourceInstanceRunningJobInfo {
/**
* pod名称
注意:此字段可能返回 null,表示取不到有效值。
*/
PodName?: string;
/**
* 任务类型
注意:此字段可能返回 null,表示取不到有效值。
*/
TaskType?: string;
/**
* 任务id
注意:此字段可能返回 null,表示取不到有效值。
*/
TaskId?: string;
/**
* 任务自定义名称
注意:此字段可能返回 null,表示取不到有效值。
*/
TaskName?: string;
}
/**
* DescribeLatestTrainingMetrics返回参数结构体
*/
export interface DescribeLatestTrainingMetricsResponse {
/**
* 任务ID
注意:此字段可能返回 null,表示取不到有效值。
*/
TaskId: string;
/**
* 最近一次上报的训练指标.每个Metric中只有一个点的数据, 即len(Values) = len(Timestamps) = 1
注意:此字段可能返回 null,表示取不到有效值。
*/
Metrics: Array<TrainingMetric>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDatasetDetailUnstructured返回参数结构体
*/
export interface DescribeDatasetDetailUnstructuredResponse {
/**
* 已标注数据量
注意:此字段可能返回 null,表示取不到有效值。
*/
AnnotatedTotalCount: number;
/**
* 没有标注数据量
注意:此字段可能返回 null,表示取不到有效值。
*/
NonAnnotatedTotalCount: number;
/**
* 过滤数据总量
注意:此字段可能返回 null,表示取不到有效值。
*/
FilterTotalCount: number;
/**
* 过滤数据详情
注意:此字段可能返回 null,表示取不到有效值。
*/
FilterLabelList: Array<FilterLabelInfo>;
/**
* 数据文本行,默认返回前1000行
注意:此字段可能返回 null,表示取不到有效值。
*/
RowTexts: Array<string>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 图片列表查询结果详情
*/
export interface FilterLabelInfo {
/**
* 数据集id
*/
DatasetId: string;
/**
* 文件ID
*/
FileId: string;
/**
* 文件路径
*/
FileName: string;
/**
* 分类标签结果
注意:此字段可能返回 null,表示取不到有效值。
*/
ClassificationLabels: Array<string>;
/**
* 检测标签结果
注意:此字段可能返回 null,表示取不到有效值。
*/
DetectionLabels: Array<DetectionLabelInfo>;
/**
* 分割标签结果
注意:此字段可能返回 null,表示取不到有效值。
*/
SegmentationLabels: Array<SegmentationInfo>;
/**
* RGB 图片路径
注意:此字段可能返回 null,表示取不到有效值。
*/
RGBPath: string;
/**
* 标签模板类型
注意:此字段可能返回 null,表示取不到有效值。
*/
LabelTemplateType: string;
/**
* 下载url链接
注意:此字段可能返回 null,表示取不到有效值。
*/
DownloadUrl: string;
/**
* 缩略图下载链接
注意:此字段可能返回 null,表示取不到有效值。
*/
DownloadThumbnailUrl: string;
/**
* 分割结果图片下载链接
注意:此字段可能返回 null,表示取不到有效值。
*/
DownloadRGBUrl: string;
/**
* OCR场景
IDENTITY:识别
STRUCTURE:智能结构化
注意:此字段可能返回 null,表示取不到有效值。
*/
OcrScene: string;
/**
* OCR场景标签列表
注意:此字段可能返回 null,表示取不到有效值。
*/
OcrLabels: Array<OcrLabelInfo>;
/**
* OCR场景标签信息
注意:此字段可能返回 null,表示取不到有效值。
*/
OcrLabelInfo: string;
/**
* 文本分类场景标签结果,内容是json结构
注意:此字段可能返回 null,表示取不到有效值。
*/
TextClassificationLabelList: string;
/**
* 文本内容,返回50字符
注意:此字段可能返回 null,表示取不到有效值。
*/
RowText: string;
/**
* 文本内容是否完全返回
注意:此字段可能返回 null,表示取不到有效值。
*/
ContentOmit: boolean;
}
/**
* 工作负载的状态
*/
export interface WorkloadStatus {
/**
* 当前实例数
*/
Replicas: number;
/**
* 更新的实例数
*/
UpdatedReplicas: number;
/**
* 就绪的实例数
*/
ReadyReplicas: number;
/**
* 可用的实例数
*/
AvailableReplicas: number;
/**
* 不可用的实例数
*/
UnavailableReplicas: number;
/**
* Normal 正常运行中
Abnormal 服务异常,例如容器启动失败等
Waiting 服务等待中,例如容器下载镜像过程等
Stopped 已停止
Pending 启动中
Stopping 停止中
*/
Status: string;
/**
* 工作负载的状况信息
* @deprecated
*/
StatefulSetCondition?: Array<StatefulSetCondition>;
/**
* 工作负载历史的状况信息
*/
Conditions?: Array<StatefulSetCondition>;
/**
* 状态异常时,展示原因
注意:此字段可能返回 null,表示取不到有效值。
*/
Reason?: string;
}
/**
* CFS存储的配置
*/
export interface CFSConfig {
/**
* cfs的实例的ID
*/
Id: string;
/**
* 存储的路径
*/
Path: string;
/**
* cfs的挂载类型,可选值为:STORAGE、SOURCE 分别表示存储拓展模式和数据源模式,默认为 STORAGE
注意:此字段可能返回 null,表示取不到有效值。
*/
MountType?: string;
/**
* 协议 1: NFS, 2: TURBO
注意:此字段可能返回 null,表示取不到有效值。
*/
Protocol?: string;
}
/**
* DescribeTrainingMetrics请求参数结构体
*/
export interface DescribeTrainingMetricsRequest {
/**
* 任务ID
*/
TaskId: string;
}
/**
* CreateNotebookImage请求参数结构体
*/
export interface CreateNotebookImageRequest {
/**
* 镜像信息
*/
ImageInfo: ImageInfo;
/**
* notebook id
*/
NotebookId: string;
/**
* 要保存的kernel数组
*/
Kernels?: Array<string>;
}
/**
* 接口描述信息
*/
export interface APIConfigDetail {
/**
* 接口id
注意:此字段可能返回 null,表示取不到有效值。
*/
Id: string;
/**
* 接口所属服务组id
注意:此字段可能返回 null,表示取不到有效值。
*/
ServiceGroupId: string;
/**
* 接口描述
注意:此字段可能返回 null,表示取不到有效值。
*/
Description: string;
/**
* 相对路径
注意:此字段可能返回 null,表示取不到有效值。
*/
RelativeUrl: string;
/**
* 服务类型 HTTP HTTPS
注意:此字段可能返回 null,表示取不到有效值。
*/
ServiceType: string;
/**
* GET POST
注意:此字段可能返回 null,表示取不到有效值。
*/
HttpMethod: string;
/**
* 请求示例
注意:此字段可能返回 null,表示取不到有效值。
*/
HttpInputExample: string;
/**
* 回包示例
注意:此字段可能返回 null,表示取不到有效值。
*/
HttpOutputExample: string;
/**
* 更新成员
注意:此字段可能返回 null,表示取不到有效值。
*/
UpdatedBy: string;
/**
* 更新时间
注意:此字段可能返回 null,表示取不到有效值。
*/
UpdatedAt: string;
/**
* 主账号uin
注意:此字段可能返回 null,表示取不到有效值。
*/
Uin: string;
/**
* 子账号subuin
注意:此字段可能返回 null,表示取不到有效值。
*/
SubUin: string;
}
/**
* 推理镜像详情
*/
export interface InferTemplate {
/**
* 模板ID
*/
InferTemplateId: string;
/**
* 模板镜像
*/
InferTemplateImage: string;
}
/**
* ModifyNotebookTags请求参数结构体
*/
export interface ModifyNotebookTagsRequest {
/**
* Notebook Id
*/
Id: string;
/**
* Notebook修改标签集合
*/
Tags?: Array<Tag>;
}
/**
* StopBatchTask请求参数结构体
*/
export interface StopBatchTaskRequest {
/**
* 跑批任务ID
*/
BatchTaskId: string;
}
/**
* 容器状态
*/
export interface ContainerStatus {
/**
* 重启次数
注意:此字段可能返回 null,表示取不到有效值。
*/
RestartCount: number;
/**
* 状态
注意:此字段可能返回 null,表示取不到有效值。
*/
State: string;
/**
* 是否就绪
注意:此字段可能返回 null,表示取不到有效值。
*/
Ready: boolean;
/**
* 状态原因
注意:此字段可能返回 null,表示取不到有效值。
*/
Reason: string;
/**
* 容器的错误信息
注意:此字段可能返回 null,表示取不到有效值。
*/
Message: string;
}
/**
* 三级标签
*/
export interface TextLabelDistributionDetailInfoThirdClass {
/**
* 标签名称
注意:此字段可能返回 null,表示取不到有效值。
*/
LabelValue?: string;
/**
* 标签个数
注意:此字段可能返回 null,表示取不到有效值。
*/
LabelCount?: number;
/**
* 标签占比
注意:此字段可能返回 null,表示取不到有效值。
*/
LabelPercentage?: number;
/**
* 子标签分布
注意:此字段可能返回 null,表示取不到有效值。
*/
ChildLabelList?: Array<TextLabelDistributionDetailInfoFourthClass>;
}
/**
* ModifyModelService请求参数结构体
*/
export interface ModifyModelServiceRequest {
/**
* 服务id
*/
ServiceId: string;
/**
* 模型信息,需要挂载模型时填写
*/
ModelInfo?: ModelInfo;
/**
* 镜像信息,配置服务运行所需的镜像地址等信息
*/
ImageInfo?: ImageInfo;
/**
* 环境变量,可选参数,用于配置容器中的环境变量
*/
Env?: Array<EnvVar>;
/**
* 资源描述,指定预付费模式下的cpu,mem,gpu等信息,后付费无需填写
*/
Resources?: ResourceInfo;
/**
* 使用DescribeBillingSpecs接口返回的规格列表中的值,或者参考实例列表:
TI.S.MEDIUM.POST 2C4G
TI.S.LARGE.POST 4C8G
TI.S.2XLARGE16.POST 8C16G
TI.S.2XLARGE32.POST 8C32G
TI.S.4XLARGE32.POST 16C32G
TI.S.4XLARGE64.POST 16C64G
TI.S.6XLARGE48.POST 24C48G
TI.S.6XLARGE96.POST 24C96G
TI.S.8XLARGE64.POST 32C64G
TI.S.8XLARGE128.POST 32C128G
TI.GN7.LARGE20.POST 4C20G T4*1/4
TI.GN7.2XLARGE40.POST 10C40G T4*1/2
TI.GN7.2XLARGE32.POST 8C32G T4*1
TI.GN7.5XLARGE80.POST 20C80G T4*1
TI.GN7.8XLARGE128.POST 32C128G T4*1
TI.GN7.10XLARGE160.POST 40C160G T4*2
TI.GN7.20XLARGE320.POST 80C320G T4*4
*/
InstanceType?: string;
/**
* 扩缩容类型 支持:自动 - "AUTO", 手动 - "MANUAL"
*/
ScaleMode?: string;
/**
* 实例数量, 不同计费模式和调节模式下对应关系如下
PREPAID 和 POSTPAID_BY_HOUR:
手动调节模式下对应 实例数量
自动调节模式下对应 基于时间的默认策略的实例数量
HYBRID_PAID:
后付费实例手动调节模式下对应 实例数量
后付费实例自动调节模式下对应 时间策略的默认策略的实例数量
*/
Replicas?: number;
/**
* 自动伸缩信息
*/
HorizontalPodAutoscaler?: HorizontalPodAutoscaler;
/**
* 是否开启日志投递,开启后需填写配置投递到指定cls
*/
LogEnable?: boolean;
/**
* 日志配置,需要投递服务日志到指定cls时填写
*/
LogConfig?: LogConfig;
/**
* 特殊更新行为: "STOP": 停止, "RESUME": 重启, "SCALE": 扩缩容, 存在这些特殊更新行为时,会忽略其他更新字段
*/
ServiceAction?: string;
/**
* 服务的描述
*/
ServiceDescription?: string;
/**
* 自动伸缩策略
*/
ScaleStrategy?: string;
/**
* 自动伸缩策略配置 HPA : 通过HPA进行弹性伸缩 CRON 通过定时任务进行伸缩
*/
CronScaleJobs?: Array<CronScaleJob>;
/**
* 计费模式[HYBRID_PAID]时生效, 用于标识混合计费模式下的预付费实例数, 若不填则默认为1
*/
HybridBillingPrepaidReplicas?: number;
/**
* 是否开启模型的热更新。默认不开启
*/
ModelHotUpdateEnable?: boolean;
/**
* 定时停止配置
*/
ScheduledAction?: ScheduledAction;
/**
* 服务限速限流相关配置
*/
ServiceLimit?: ServiceLimit;
/**
* 挂载配置,目前只支持CFS
*/
VolumeMount?: VolumeMount;
/**
* 是否开启模型的加速, 仅对StableDiffusion(动态加速)格式的模型有效。默认不开启
*/
ModelTurboEnable?: boolean;
/**
* 服务的启动命令
*/
Command?: string;
/**
* 是否开启TIONE内网访问外部
*/
ServiceEIP?: ServiceEIP;
}
/**
* 框架版本以及对应的训练模式
*/
export interface FrameworkVersion {
/**
* 框架版本
*/
Version: string;
/**
* 训练模式
*/
TrainingModes: Array<string>;
/**
* 框架运行环境
*/
Environment?: string;
}
/**
* ChatCompletion请求参数结构体
*/
export interface ChatCompletionRequest {
/**
* 对话的目标模型ID。
自行部署的开源大模型聊天:部署的模型服务组ID,形如ms-xxyyzz。
*/
Model: string;
/**
* 输入对话历史。旧的对话在前,数组中最后一项应该为这次的问题。
*/
Messages: Array<Message>;
/**
* 仅当模型为自行部署的开源大模型时生效。采样随机值,默认值为1.0,取值范围[0,2]。较高的值(如0.8)将使输出更加随机,而较低的值(如0.2)将使输出更加确定。建议仅修改此参数或TopP,但不建议两者都修改。
*/
Temperature?: number;
/**
* 仅当模型为自行部署的开源大模型时生效。核采样,默认值为1,取值范围[0,1]。指的是预先设置一个概率界限 p,然后将所有可能生成的token,根据概率大小从高到低排列,依次选取。当这些选取的token的累积概率大于或等于 p 值时停止,然后从已经选取的token中进行采样,生成下一个token。例如top_p为0.1时意味着模型只考虑累积概率为10%的token。建议仅修改此参数或Temperature,不建议两者都修改。
*/
TopP?: number;
/**
* 仅当模型为自行部署的开源大模型时生效。最大生成的token数目。默认为无限大。
*/
MaxTokens?: number;
}
/**
* ModifyModelServicePartialConfig返回参数结构体
*/
export interface ModifyModelServicePartialConfigResponse {
/**
* 被修改后的服务配置
*/
Service: Service;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeModelAccEngineVersions返回参数结构体
*/
export interface DescribeModelAccEngineVersionsResponse {
/**
* 模型加速版本列表
注意:此字段可能返回 null,表示取不到有效值。
*/
ModelAccEngineVersions: Array<ModelAccEngineVersion>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeModelServiceCallInfo请求参数结构体
*/
export interface DescribeModelServiceCallInfoRequest {
/**
* 服务组id
*/
ServiceGroupId: string;
/**
* 服务分类
*/
ServiceCategory?: string;
}
/**
* 数据点
*/
export interface DataPoint {
/**
* 指标名字
*/
Name: string;
/**
* 值
*/
Value: number;
}
/**
* Tag过滤参数
*/
export interface TagFilter {
/**
* 标签键
*/
TagKey?: string;
/**
* 多个标签值
*/
TagValues?: Array<string>;
}
/**
* 太极服务的调用信息
*/
export interface TJCallInfo {
/**
* 调用地址
注意:此字段可能返回 null,表示取不到有效值。
*/
HttpAddr?: string;
/**
* token
注意:此字段可能返回 null,表示取不到有效值。
*/
Token?: string;
/**
* 调用示例
注意:此字段可能返回 null,表示取不到有效值。
*/
CallExample?: string;
}
/**
* CreateTrainingModel请求参数结构体
*/
export interface CreateTrainingModelRequest {
/**
* 导入方式
MODEL:导入新模型
VERSION:导入新版本
EXIST:导入现有版本
*/
ImportMethod: string;
/**
* 推理环境来源(SYSTEM/CUSTOM)
*/
ReasoningEnvironmentSource: string;
/**
* 模型名称,不超过60个字符,仅支持中英文、数字、下划线"_"、短横"-",只能以中英文、数字开头
*/
TrainingModelName?: string;
/**
* 标签配置
*/
Tags?: Array<Tag>;
/**
* 训练任务名称
*/
TrainingJobName?: string;
/**
* 模型来源cos目录,以/结尾
*/
TrainingModelCosPath?: CosPathInfo;
/**
* 算法框架 (PYTORCH/TENSORFLOW/DETECTRON2/PMML/MMDETECTION)
*/
AlgorithmFramework?: string;
/**
* 推理环境
*/
ReasoningEnvironment?: string;
/**
* 训练指标,最多支持1000字符
*/
TrainingModelIndex?: string;
/**
* 模型版本
*/
TrainingModelVersion?: string;
/**
* 自定义推理环境
*/
ReasoningImageInfo?: ImageInfo;
/**
* 模型移动方式(CUT/COPY)
*/
ModelMoveMode?: string;
/**
* 训练任务ID
*/
TrainingJobId?: string;
/**
* 模型ID(导入新模型不需要,导入新版本需要)
*/
TrainingModelId?: string;
/**
* 模型存储cos目录
*/
ModelOutputPath?: CosPathInfo;
/**
* 模型来源 (JOB/COS)
*/
TrainingModelSource?: string;
/**
* 模型偏好
*/
TrainingPreference?: string;
/**
* 自动学习任务ID(已废弃)
*/
AutoMLTaskId?: string;
/**
* 任务版本
*/
TrainingJobVersion?: string;
/**
* 模型版本类型;
枚举值:NORMAL(通用) ACCELERATE(加速)
注意: 默认为NORMAL
*/
ModelVersionType?: string;
/**
* 模型格式 (PYTORCH/TORCH_SCRIPT/DETECTRON2/SAVED_MODEL/FROZEN_GRAPH/PMML/MMDETECTION/ONNX/HUGGING_FACE)
*/
ModelFormat?: string;
/**
* 推理镜像ID
*/
ReasoningEnvironmentId?: string;
/**
* 模型自动清理开关(true/false),当前版本仅支持SAVED_MODEL格式模型
*/
AutoClean?: string;
/**
* 模型数量保留上限(默认值为24个,上限为24,下限为1,步长为1)
*/
MaxReservedModels?: number;
/**
* 模型清理周期(默认值为1分钟,上限为1440,下限为1分钟,步长为1)
*/
ModelCleanPeriod?: number;
/**
* 是否QAT模型
*/
IsQAT?: boolean;
}
/**
* 表格数据集表头信息
*/
export interface SchemaInfo {
/**
* 长度30字符内
*/
Name: string;
/**
* 数据类型
*/
Type: string;
}
/**
* 启动命令信息
*/
export interface StartCmdInfo {
/**
* 启动命令
*/
StartCmd?: string;
/**
* ps启动命令
*/
PsStartCmd?: string;
/**
* worker启动命令
*/
WorkerStartCmd?: string;
}
/**
* K8s的Event
*/
export interface Event {
/**
* 事件的id
注意:此字段可能返回 null,表示取不到有效值。
*/
Id: string;
/**
* 事件的具体信息
注意:此字段可能返回 null,表示取不到有效值。
*/
Message: string;
/**
* 事件第一次发生的时间
注意:此字段可能返回 null,表示取不到有效值。
*/
FirstTimestamp: string;
/**
* 事件最后一次发生的时间
注意:此字段可能返回 null,表示取不到有效值。
*/
LastTimestamp: string;
/**
* 事件发生的次数
注意:此字段可能返回 null,表示取不到有效值。
*/
Count: number;
/**
* 事件的类型
注意:此字段可能返回 null,表示取不到有效值。
*/
Type: string;
/**
* 事件关联的资源的类型
注意:此字段可能返回 null,表示取不到有效值。
*/
ResourceKind: string;
/**
* 事件关联的资源的名字
注意:此字段可能返回 null,表示取不到有效值。
*/
ResourceName: string;
}
/**
* DescribeAPIConfigs请求参数结构体
*/
export interface DescribeAPIConfigsRequest {
/**
* 偏移量,默认为0
*/
Offset?: number;
/**
* 返回数量,默认为20,最大值为100
*/
Limit?: number;
/**
* 输出列表的排列顺序。取值范围:ASC:升序排列 DESC:降序排列
*/
Order?: string;
/**
* 排序的依据字段, 取值范围 "CreateTime" "UpdateTime"
*/
OrderField?: string;
/**
* 分页参数,支持的分页过滤Name包括:
["ClusterId", "ServiceId", "ServiceGroupName", "ServiceGroupId"]
*/
Filters?: Array<Filter>;
}
/**
* DescribeModelServiceGroups返回参数结构体
*/
export interface DescribeModelServiceGroupsResponse {
/**
* 推理服务组数量。
注意:此字段可能返回 null,表示取不到有效值。
*/
TotalCount?: number;
/**
* 服务组信息
注意:此字段可能返回 null,表示取不到有效值。
*/
ServiceGroups?: Array<ServiceGroup>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeBillingResourceInstanceRunningJobs返回参数结构体
*/
export interface DescribeBillingResourceInstanceRunningJobsResponse {
/**
* 资源组节点运行中的任务信息
注意:此字段可能返回 null,表示取不到有效值。
*/
ResourceInstanceRunningJobInfos?: Array<ResourceInstanceRunningJobInfo>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 服务的调用信息,服务组下唯一
*/
export interface InferGatewayCallInfo {
/**
* 内网http调用地址
注意:此字段可能返回 null,表示取不到有效值。
*/
VpcHttpAddr: string;
/**
* 内网https调用地址
注意:此字段可能返回 null,表示取不到有效值。
*/
VpcHttpsAddr: string;
/**
* 内网grpc调用地址
注意:此字段可能返回 null,表示取不到有效值。
*/
VpcGrpcTlsAddr: string;
/**
* 可访问的vpcid
注意:此字段可能返回 null,表示取不到有效值。
*/
VpcId: string;
/**
* 后端ip对应的子网
注意:此字段可能返回 null,表示取不到有效值。
*/
SubnetId: string;
}
/**
* DescribeTrainingModels返回参数结构体
*/
export interface DescribeTrainingModelsResponse {
/**
* 模型列表
*/
TrainingModels?: Array<TrainingModelDTO>;
/**
* 模型总数
*/
TotalCount?: number;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeBatchTaskInstances返回参数结构体
*/
export interface DescribeBatchTaskInstancesResponse {
/**
* 实例集
注意:此字段可能返回 null,表示取不到有效值。
*/
BatchInstances: Array<BatchTaskInstance>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateNotebook请求参数结构体
*/
export interface CreateNotebookRequest {
/**
* 名称。不超过60个字符,仅支持中英文、数字、下划线"_"、短横"-",只能以中英文、数字开头
*/
Name: string;
/**
* 计算资源付费模式 ,可选值为:
PREPAID:预付费,即包年包月
POSTPAID_BY_HOUR:按小时后付费
*/
ChargeType: string;
/**
* 计算资源配置
*/
ResourceConf: ResourceConf;
/**
* 是否上报日志
*/
LogEnable: boolean;
/**
* 是否ROOT权限
*/
RootAccess: boolean;
/**
* 是否自动停止
*/
AutoStopping: boolean;
/**
* 是否访问公网
*/
DirectInternetAccess: boolean;
/**
* 资源组ID(for预付费)
*/
ResourceGroupId?: string;
/**
* Vpc-Id
*/
VpcId?: string;
/**
* 子网Id
*/
SubnetId?: string;
/**
* 存储的类型。取值包含:
FREE: 预付费的免费存储
CLOUD_PREMIUM: 高性能云硬盘
CLOUD_SSD: SSD云硬盘
CFS: CFS存储,包含NFS和turbo
*/
VolumeSourceType?: string;
/**
* 存储卷大小,单位GB
*/
VolumeSizeInGB?: number;
/**
* CFS存储的配置
*/
VolumeSourceCFS?: CFSConfig;
/**
* 日志配置
*/
LogConfig?: LogConfig;
/**
* 生命周期脚本的ID
*/
LifecycleScriptId?: string;
/**
* 默认GIT存储库的ID
*/
DefaultCodeRepoId?: string;
/**
* 其他GIT存储库的ID,最多3个
*/
AdditionalCodeRepoIds?: Array<string>;
/**
* 自动停止时间,单位小时
*/
AutomaticStopTime?: number;
/**
* 标签配置
*/
Tags?: Array<Tag>;
/**
* 数据配置
*/
DataConfigs?: Array<DataConfig>;
/**
* 镜像信息