v20210903

package
v1.0.320 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 27, 2021 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

View Source
const (

	// 用户不存在。
	AUTHFAILURE_USERNOTFOUND = "AuthFailure.UserNotFound"

	// 匹配的模板不存在。
	FAILEDOPERATION_AITEMPLATENOTEXIST = "FailedOperation.AiTemplateNotExist"

	// 内部DB连接失败。
	FAILEDOPERATION_DBCONNECTIONERROR = "FailedOperation.DBConnectionError"

	// 内部DB操作错误。
	FAILEDOPERATION_DBOPERATIONERROR = "FailedOperation.DBOperationError"

	// 媒资文件下载失败。
	FAILEDOPERATION_DOWNLOADFAILED = "FailedOperation.DownloadFailed"

	// 获取任务列表失败。
	FAILEDOPERATION_GETTASKLISTFAILED = "FailedOperation.GetTaskListFailed"

	// 获取媒资信息失败。
	FAILEDOPERATION_GETVIDEOMETADATAFAILED = "FailedOperation.GetVideoMetadataFailed"

	// MD5不匹配。
	FAILEDOPERATION_MD5MISMATCH = "FailedOperation.MD5Mismatch"

	// 媒资文件已经存在。
	FAILEDOPERATION_MEDIAALREADYEXIST = "FailedOperation.MediaAlreadyExist"

	// 媒资正在使用。
	FAILEDOPERATION_MEDIAINUSE = "FailedOperation.MediaInUse"

	// 媒体文件未就绪。
	FAILEDOPERATION_MEDIANOTREADY = "FailedOperation.MediaNotReady"

	// 存在相同的任务。
	FAILEDOPERATION_TASKALREADYEXIST = "FailedOperation.TaskAlreadyExist"

	// 视频分析未完成。
	FAILEDOPERATION_TASKNOTFINISHED = "FailedOperation.TaskNotFinished"

	// 转码失败。
	FAILEDOPERATION_TRANSCODEFAILED = "FailedOperation.TranscodeFailed"

	// 内部错误。
	INTERNALERROR_INNERERROR = "InternalError.InnerError"

	// 参数错误。
	INVALIDPARAMETER = "InvalidParameter"

	// 文件路径不合法。
	INVALIDPARAMETER_INVALIDFILEPATH = "InvalidParameter.InvalidFilePath"

	// MD5非法。
	INVALIDPARAMETER_INVALIDMD5 = "InvalidParameter.InvalidMD5"

	// 媒体ID不合法。
	INVALIDPARAMETER_INVALIDMEDIAID = "InvalidParameter.InvalidMediaId"

	// 媒体名称非法。
	INVALIDPARAMETER_INVALIDMEDIANAME = "InvalidParameter.InvalidMediaName"

	// 媒资状态不合法。
	INVALIDPARAMETER_INVALIDMEDIASTATUS = "InvalidParameter.InvalidMediaStatus"

	// 名称不合法。
	INVALIDPARAMETER_INVALIDNAME = "InvalidParameter.InvalidName"

	// 分页序号不合法。
	INVALIDPARAMETER_INVALIDPAGENUMBER = "InvalidParameter.InvalidPageNumber"

	// 分页大小不合法。
	INVALIDPARAMETER_INVALIDPAGESIZE = "InvalidParameter.InvalidPageSize"

	// 排序字段不合法。
	INVALIDPARAMETER_INVALIDSORTBY = "InvalidParameter.InvalidSortBy"

	// 排序方式不合法。
	INVALIDPARAMETER_INVALIDSORTORDER = "InvalidParameter.InvalidSortOrder"

	// 任务ID不合法。
	INVALIDPARAMETER_INVALIDTASKID = "InvalidParameter.InvalidTaskId"

	// 任务名称不合法。
	INVALIDPARAMETER_INVALIDTASKNAME = "InvalidParameter.InvalidTaskName"

	// 任务状态不合法。
	INVALIDPARAMETER_INVALIDTASKSTATUS = "InvalidParameter.InvalidTaskStatus"

	// URL不合法。
	INVALIDPARAMETER_INVALIDURL = "InvalidParameter.InvalidURL"

	// 用户Uin无效。
	INVALIDPARAMETER_INVALIDUIN = "InvalidParameter.InvalidUin"

	// 名称超过长度限制。
	INVALIDPARAMETER_NAMETOOLONG = "InvalidParameter.NameTooLong"

	// 不支持的URL类型。
	INVALIDPARAMETER_UNSUPPORTURL = "InvalidParameter.UnsupportURL"

	// 使用量超过限制。
	LIMITEXCEEDED_USAGELIMITEXCEEDED = "LimitExceeded.UsageLimitExceeded"

	// 同时发起过多任务。
	REQUESTLIMITEXCEEDED_CONCURRENCYOVERFLOW = "RequestLimitExceeded.ConcurrencyOverflow"

	// 媒资文件不存在。
	RESOURCENOTFOUND_MEDIANOTFOUND = "ResourceNotFound.MediaNotFound"

	// 任务不存在。
	RESOURCENOTFOUND_TASKNOTFOUND = "ResourceNotFound.TaskNotFound"

	// 未授权操作。
	UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

	// 用户未激活该产品。
	UNAUTHORIZEDOPERATION_UNAUTHORIZEDPRODUCT = "UnauthorizedOperation.UnauthorizedProduct"

	// 媒资文件不可访问。
	UNSUPPORTEDOPERATION_MEDIANOTACCESSIBLE = "UnsupportedOperation.MediaNotAccessible"
)
View Source
const APIVersion = "2021-09-03"

Variables

This section is empty.

Functions

This section is empty.

Types

type AppearIndexPair

type AppearIndexPair struct {

	// 出现信息,取值范围为[1,3]
	AppearIndex *int64 `json:"AppearIndex,omitempty" name:"AppearIndex"`

	// AppearInfo中AppearIndex对应元素的第Index元素,从0开始技术
	Index *int64 `json:"Index,omitempty" name:"Index"`
}

type AppearInfo

type AppearInfo struct {

	// 关键词在音频文本结果中的出现位置数组
	// 注意:此字段可能返回 null,表示取不到有效值。
	AudioAppearSet []*TextAppearInfo `json:"AudioAppearSet,omitempty" name:"AudioAppearSet"`

	// 关键词在可视文本结果中的出现位置数组
	// 注意:此字段可能返回 null,表示取不到有效值。
	TextAppearSet []*TextAppearInfo `json:"TextAppearSet,omitempty" name:"TextAppearSet"`

	// 关键词在视频信息中的出现位置数组
	// 注意:此字段可能返回 null,表示取不到有效值。
	VideoAppearSet []*VideoAppearInfo `json:"VideoAppearSet,omitempty" name:"VideoAppearSet"`
}

type AudioInfo

type AudioInfo struct {

	// ASR提取的文字信息
	Content *string `json:"Content,omitempty" name:"Content"`

	// ASR起始时间戳,从0开始
	StartTimeStamp *float64 `json:"StartTimeStamp,omitempty" name:"StartTimeStamp"`

	// ASR结束时间戳,从0开始
	EndTimeStamp *float64 `json:"EndTimeStamp,omitempty" name:"EndTimeStamp"`

	// ASR提取的音频标签
	Tag *string `json:"Tag,omitempty" name:"Tag"`
}

type Client

type Client struct {
	common.Client
}

func NewClient

func NewClient(credential common.CredentialIface, region string, clientProfile *profile.ClientProfile) (client *Client, err error)

func NewClientWithSecretId

func NewClientWithSecretId(secretId, secretKey, region string) (client *Client, err error)

Deprecated

func (*Client) CreateTask

func (c *Client) CreateTask(request *CreateTaskRequest) (response *CreateTaskResponse, err error)

CreateTask 创建智能标签任务。

请注意,本接口为异步接口,**返回TaskId只代表任务创建成功,不代表任务执行成功**。

可能返回的错误码:

AUTHFAILURE_USERNOTFOUND = "AuthFailure.UserNotFound"
FAILEDOPERATION_AITEMPLATENOTEXIST = "FailedOperation.AiTemplateNotExist"
FAILEDOPERATION_MEDIANOTREADY = "FailedOperation.MediaNotReady"
FAILEDOPERATION_TASKALREADYEXIST = "FailedOperation.TaskAlreadyExist"
FAILEDOPERATION_TASKNOTFINISHED = "FailedOperation.TaskNotFinished"
INVALIDPARAMETER_INVALIDMEDIAID = "InvalidParameter.InvalidMediaId"
INVALIDPARAMETER_INVALIDNAME = "InvalidParameter.InvalidName"
INVALIDPARAMETER_INVALIDURL = "InvalidParameter.InvalidURL"
RESOURCENOTFOUND_MEDIANOTFOUND = "ResourceNotFound.MediaNotFound"

func (*Client) DeleteMedia

func (c *Client) DeleteMedia(request *DeleteMediaRequest) (response *DeleteMediaResponse, err error)

DeleteMedia 将MediaId对应的媒资文件从系统中删除。

**请注意,本接口仅删除媒资文件,媒资文件对应的视频分析结果不会被删除**。如您需要删除结构化分析结果,请调用DeleteTask接口。

可能返回的错误码:

FAILEDOPERATION_MEDIAALREADYEXIST = "FailedOperation.MediaAlreadyExist"
FAILEDOPERATION_MEDIAINUSE = "FailedOperation.MediaInUse"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_INVALIDMEDIAID = "InvalidParameter.InvalidMediaId"
INVALIDPARAMETER_INVALIDMEDIASTATUS = "InvalidParameter.InvalidMediaStatus"
RESOURCENOTFOUND_MEDIANOTFOUND = "ResourceNotFound.MediaNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_MEDIANOTACCESSIBLE = "UnsupportedOperation.MediaNotAccessible"

func (*Client) DescribeMedia

func (c *Client) DescribeMedia(request *DescribeMediaRequest) (response *DescribeMediaResponse, err error)

DescribeMedia 描述媒资文件信息,包括媒资状态,分辨率,帧率等。

如果媒资文件未完成导入,本接口将仅输出媒资文件的状态信息;导入完成后,本接口还将输出媒资文件的其他元信息。

可能返回的错误码:

FAILEDOPERATION_DOWNLOADFAILED = "FailedOperation.DownloadFailed"
FAILEDOPERATION_MD5MISMATCH = "FailedOperation.MD5Mismatch"
FAILEDOPERATION_MEDIANOTREADY = "FailedOperation.MediaNotReady"
FAILEDOPERATION_TRANSCODEFAILED = "FailedOperation.TranscodeFailed"
INVALIDPARAMETER_INVALIDMEDIAID = "InvalidParameter.InvalidMediaId"
RESOURCENOTFOUND_MEDIANOTFOUND = "ResourceNotFound.MediaNotFound"

func (*Client) DescribeMedias

func (c *Client) DescribeMedias(request *DescribeMediasRequest) (response *DescribeMediasResponse, err error)

DescribeMedias 依照输入条件,描述命中的媒资文件信息,包括媒资状态,分辨率,帧率等。

请注意,本接口最多支持同时描述**50**个媒资文件

如果媒资文件未完成导入,本接口将仅输出媒资文件的状态信息;导入完成后,本接口还将输出媒资文件的其他元信息。

可能返回的错误码:

FAILEDOPERATION_MEDIAALREADYEXIST = "FailedOperation.MediaAlreadyExist"
INVALIDPARAMETER_INVALIDMD5 = "InvalidParameter.InvalidMD5"
INVALIDPARAMETER_INVALIDMEDIAID = "InvalidParameter.InvalidMediaId"
INVALIDPARAMETER_INVALIDMEDIANAME = "InvalidParameter.InvalidMediaName"
INVALIDPARAMETER_INVALIDMEDIASTATUS = "InvalidParameter.InvalidMediaStatus"
INVALIDPARAMETER_INVALIDNAME = "InvalidParameter.InvalidName"
INVALIDPARAMETER_INVALIDPAGENUMBER = "InvalidParameter.InvalidPageNumber"
INVALIDPARAMETER_INVALIDPAGESIZE = "InvalidParameter.InvalidPageSize"
INVALIDPARAMETER_INVALIDSORTBY = "InvalidParameter.InvalidSortBy"
INVALIDPARAMETER_INVALIDSORTORDER = "InvalidParameter.InvalidSortOrder"
INVALIDPARAMETER_INVALIDURL = "InvalidParameter.InvalidURL"
INVALIDPARAMETER_INVALIDUIN = "InvalidParameter.InvalidUin"
INVALIDPARAMETER_NAMETOOLONG = "InvalidParameter.NameTooLong"
INVALIDPARAMETER_UNSUPPORTURL = "InvalidParameter.UnsupportURL"

func (*Client) DescribeTask

func (c *Client) DescribeTask(request *DescribeTaskRequest) (response *DescribeTaskResponse, err error)

DescribeTask 描述智能标签任务进度。

请注意,**此接口仅返回任务执行状态信息,不返回任务执行结果**

可能返回的错误码:

AUTHFAILURE_USERNOTFOUND = "AuthFailure.UserNotFound"
INVALIDPARAMETER_INVALIDTASKID = "InvalidParameter.InvalidTaskId"
RESOURCENOTFOUND_TASKNOTFOUND = "ResourceNotFound.TaskNotFound"
UNAUTHORIZEDOPERATION_UNAUTHORIZEDPRODUCT = "UnauthorizedOperation.UnauthorizedProduct"

func (*Client) DescribeTaskDetail

func (c *Client) DescribeTaskDetail(request *DescribeTaskDetailRequest) (response *DescribeTaskDetailResponse, err error)

DescribeTaskDetail 描述任务信息,如果任务成功完成,还将返回任务结果

可能返回的错误码:

AUTHFAILURE_USERNOTFOUND = "AuthFailure.UserNotFound"
FAILEDOPERATION_TASKNOTFINISHED = "FailedOperation.TaskNotFinished"
INVALIDPARAMETER_INVALIDTASKID = "InvalidParameter.InvalidTaskId"
RESOURCENOTFOUND_TASKNOTFOUND = "ResourceNotFound.TaskNotFound"
UNAUTHORIZEDOPERATION_UNAUTHORIZEDPRODUCT = "UnauthorizedOperation.UnauthorizedProduct"

func (*Client) DescribeTasks

func (c *Client) DescribeTasks(request *DescribeTasksRequest) (response *DescribeTasksResponse, err error)

DescribeTasks 依照输入条件,描述命中的任务信息,包括任务创建时间,处理时间信息等。

请注意,本接口最多支持同时描述**50**个任务信息

可能返回的错误码:

AUTHFAILURE_USERNOTFOUND = "AuthFailure.UserNotFound"
FAILEDOPERATION_GETTASKLISTFAILED = "FailedOperation.GetTaskListFailed"
INVALIDPARAMETER_INVALIDPAGENUMBER = "InvalidParameter.InvalidPageNumber"
INVALIDPARAMETER_INVALIDPAGESIZE = "InvalidParameter.InvalidPageSize"
INVALIDPARAMETER_INVALIDSORTBY = "InvalidParameter.InvalidSortBy"
INVALIDPARAMETER_INVALIDTASKID = "InvalidParameter.InvalidTaskId"
INVALIDPARAMETER_INVALIDTASKNAME = "InvalidParameter.InvalidTaskName"
INVALIDPARAMETER_INVALIDTASKSTATUS = "InvalidParameter.InvalidTaskStatus"
INVALIDPARAMETER_INVALIDUIN = "InvalidParameter.InvalidUin"
UNAUTHORIZEDOPERATION_UNAUTHORIZEDPRODUCT = "UnauthorizedOperation.UnauthorizedProduct"

func (*Client) ImportMedia

func (c *Client) ImportMedia(request *ImportMediaRequest) (response *ImportMediaResponse, err error)

ImportMedia 将URL指向的媒资视频文件导入系统之中。

**请注意,本接口为异步接口**。接口返回MediaId仅代表导入视频任务发起,不代表任务完成,您可调用读接口(DescribeMedia/DescribeMedias)接口查询MediaId对应的媒资文件的状态。

当前URL只支持COS地址,其形式为`https://${Bucket}-${AppId}.cos.${Region}.myqcloud.com/${ObjectKey}`,其中`${Bucket}`为您的COS桶名称,Region为COS桶所在[可用区](https://cloud.tencent.com/document/product/213/6091),`${ObjectKey}`为指向存储在COS桶内的待分析的视频的[ObjectKey](https://cloud.tencent.com/document/product/436/13324)

分析完成后,本产品将在您的`${Bucket}`桶内创建名为`${ObjectKey}-${task-start-time}`的目录(`task-start-time`形式为1970-01-01T08:08:08)并将分析结果将回传回该目录,也即,结构化分析结果(包括图片,JSON等数据)将会写回`https://${Bucket}-${AppId}.cos.${Region}.myqcloud.com/${ObjectKey}-${task-start-time}`目录

可能返回的错误码:

AUTHFAILURE_USERNOTFOUND = "AuthFailure.UserNotFound"
FAILEDOPERATION_DBCONNECTIONERROR = "FailedOperation.DBConnectionError"
FAILEDOPERATION_DBOPERATIONERROR = "FailedOperation.DBOperationError"
FAILEDOPERATION_GETVIDEOMETADATAFAILED = "FailedOperation.GetVideoMetadataFailed"
FAILEDOPERATION_MD5MISMATCH = "FailedOperation.MD5Mismatch"
FAILEDOPERATION_MEDIAALREADYEXIST = "FailedOperation.MediaAlreadyExist"
FAILEDOPERATION_MEDIAINUSE = "FailedOperation.MediaInUse"
FAILEDOPERATION_MEDIANOTREADY = "FailedOperation.MediaNotReady"
FAILEDOPERATION_TASKALREADYEXIST = "FailedOperation.TaskAlreadyExist"
INTERNALERROR_INNERERROR = "InternalError.InnerError"
INVALIDPARAMETER_INVALIDFILEPATH = "InvalidParameter.InvalidFilePath"
INVALIDPARAMETER_INVALIDMD5 = "InvalidParameter.InvalidMD5"
INVALIDPARAMETER_INVALIDMEDIAID = "InvalidParameter.InvalidMediaId"
INVALIDPARAMETER_INVALIDMEDIANAME = "InvalidParameter.InvalidMediaName"
INVALIDPARAMETER_INVALIDMEDIASTATUS = "InvalidParameter.InvalidMediaStatus"
INVALIDPARAMETER_INVALIDNAME = "InvalidParameter.InvalidName"
INVALIDPARAMETER_INVALIDURL = "InvalidParameter.InvalidURL"
INVALIDPARAMETER_INVALIDUIN = "InvalidParameter.InvalidUin"
INVALIDPARAMETER_NAMETOOLONG = "InvalidParameter.NameTooLong"
INVALIDPARAMETER_UNSUPPORTURL = "InvalidParameter.UnsupportURL"
LIMITEXCEEDED_USAGELIMITEXCEEDED = "LimitExceeded.UsageLimitExceeded"
REQUESTLIMITEXCEEDED_CONCURRENCYOVERFLOW = "RequestLimitExceeded.ConcurrencyOverflow"
RESOURCENOTFOUND_MEDIANOTFOUND = "ResourceNotFound.MediaNotFound"

type CreateTaskRequest

type CreateTaskRequest struct {
	*tchttp.BaseRequest

	// 媒资文件ID,最长32B
	MediaId *string `json:"MediaId,omitempty" name:"MediaId"`

	// 媒资素材先验知识,相关限制参考MediaPreknownInfo
	MediaPreknownInfo *MediaPreknownInfo `json:"MediaPreknownInfo,omitempty" name:"MediaPreknownInfo"`

	// 任务名称,最长100个中文字符
	TaskName *string `json:"TaskName,omitempty" name:"TaskName"`

	// 是否上传转码后的视频,仅设置true时上传,默认为false
	UploadVideo *bool `json:"UploadVideo,omitempty" name:"UploadVideo"`
}

func NewCreateTaskRequest

func NewCreateTaskRequest() (request *CreateTaskRequest)

func (*CreateTaskRequest) FromJsonString

func (r *CreateTaskRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateTaskRequest) ToJsonString

func (r *CreateTaskRequest) ToJsonString() string

type CreateTaskResponse

type CreateTaskResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 智能标签视频分析任务ID
		TaskId *string `json:"TaskId,omitempty" name:"TaskId"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewCreateTaskResponse

func NewCreateTaskResponse() (response *CreateTaskResponse)

func (*CreateTaskResponse) FromJsonString

func (r *CreateTaskResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateTaskResponse) ToJsonString

func (r *CreateTaskResponse) ToJsonString() string

type Data

type Data struct {

	// 节目粒度结构化结果
	// 注意:此字段可能返回 null,表示取不到有效值。
	ShowInfo *ShowInfo `json:"ShowInfo,omitempty" name:"ShowInfo"`
}

type DeleteMediaRequest

type DeleteMediaRequest struct {
	*tchttp.BaseRequest

	// 媒资文件在系统中的ID
	MediaId *string `json:"MediaId,omitempty" name:"MediaId"`
}

func NewDeleteMediaRequest

func NewDeleteMediaRequest() (request *DeleteMediaRequest)

func (*DeleteMediaRequest) FromJsonString

func (r *DeleteMediaRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteMediaRequest) ToJsonString

func (r *DeleteMediaRequest) ToJsonString() string

type DeleteMediaResponse

type DeleteMediaResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDeleteMediaResponse

func NewDeleteMediaResponse() (response *DeleteMediaResponse)

func (*DeleteMediaResponse) FromJsonString

func (r *DeleteMediaResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteMediaResponse) ToJsonString

func (r *DeleteMediaResponse) ToJsonString() string

type DescribeMediaRequest

type DescribeMediaRequest struct {
	*tchttp.BaseRequest

	// 导入媒资返回的媒资ID,最长32B
	MediaId *string `json:"MediaId,omitempty" name:"MediaId"`
}

func NewDescribeMediaRequest

func NewDescribeMediaRequest() (request *DescribeMediaRequest)

func (*DescribeMediaRequest) FromJsonString

func (r *DescribeMediaRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeMediaRequest) ToJsonString

func (r *DescribeMediaRequest) ToJsonString() string

type DescribeMediaResponse

type DescribeMediaResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 媒资信息
		// 注意:此字段可能返回 null,表示取不到有效值。
		MediaInfo *MediaInfo `json:"MediaInfo,omitempty" name:"MediaInfo"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeMediaResponse

func NewDescribeMediaResponse() (response *DescribeMediaResponse)

func (*DescribeMediaResponse) FromJsonString

func (r *DescribeMediaResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeMediaResponse) ToJsonString

func (r *DescribeMediaResponse) ToJsonString() string

type DescribeMediasRequest

type DescribeMediasRequest struct {
	*tchttp.BaseRequest

	// 分页序号,从1开始
	PageNumber *int64 `json:"PageNumber,omitempty" name:"PageNumber"`

	// 每个分页所包含的元素数量,最大为50
	PageSize *int64 `json:"PageSize,omitempty" name:"PageSize"`

	// 列举过滤条件,相关限制相见MediaFilter
	MediaFilter *MediaFilter `json:"MediaFilter,omitempty" name:"MediaFilter"`

	// 返回结果排序信息,By字段只支持CreateTime
	SortBy *SortBy `json:"SortBy,omitempty" name:"SortBy"`
}

func NewDescribeMediasRequest

func NewDescribeMediasRequest() (request *DescribeMediasRequest)

func (*DescribeMediasRequest) FromJsonString

func (r *DescribeMediasRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeMediasRequest) ToJsonString

func (r *DescribeMediasRequest) ToJsonString() string

type DescribeMediasResponse

type DescribeMediasResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 满足过滤条件的媒资视频总数量
		TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"`

		// 满足过滤条件的媒资信息
		// 注意:此字段可能返回 null,表示取不到有效值。
		MediaInfoSet []*MediaInfo `json:"MediaInfoSet,omitempty" name:"MediaInfoSet"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeMediasResponse

func NewDescribeMediasResponse() (response *DescribeMediasResponse)

func (*DescribeMediasResponse) FromJsonString

func (r *DescribeMediasResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeMediasResponse) ToJsonString

func (r *DescribeMediasResponse) ToJsonString() string

type DescribeTaskDetailRequest

type DescribeTaskDetailRequest struct {
	*tchttp.BaseRequest

	// 创建任务返回的TaskId
	TaskId *string `json:"TaskId,omitempty" name:"TaskId"`
}

func NewDescribeTaskDetailRequest

func NewDescribeTaskDetailRequest() (request *DescribeTaskDetailRequest)

func (*DescribeTaskDetailRequest) FromJsonString

func (r *DescribeTaskDetailRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeTaskDetailRequest) ToJsonString

func (r *DescribeTaskDetailRequest) ToJsonString() string

type DescribeTaskDetailResponse

type DescribeTaskDetailResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 任务信息,不包含任务结果
		TaskInfo *TaskInfo `json:"TaskInfo,omitempty" name:"TaskInfo"`

		// 任务结果数据,只在任务结束时返回
		TaskData *Data `json:"TaskData,omitempty" name:"TaskData"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeTaskDetailResponse

func NewDescribeTaskDetailResponse() (response *DescribeTaskDetailResponse)

func (*DescribeTaskDetailResponse) FromJsonString

func (r *DescribeTaskDetailResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeTaskDetailResponse) ToJsonString

func (r *DescribeTaskDetailResponse) ToJsonString() string

type DescribeTaskRequest

type DescribeTaskRequest struct {
	*tchttp.BaseRequest

	// CreateTask返回的任务ID,最长32B
	TaskId *string `json:"TaskId,omitempty" name:"TaskId"`
}

func NewDescribeTaskRequest

func NewDescribeTaskRequest() (request *DescribeTaskRequest)

func (*DescribeTaskRequest) FromJsonString

func (r *DescribeTaskRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeTaskRequest) ToJsonString

func (r *DescribeTaskRequest) ToJsonString() string

type DescribeTaskResponse

type DescribeTaskResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 任务信息,详情参见TaskInfo的定义
		// 注意:此字段可能返回 null,表示取不到有效值。
		TaskInfo *TaskInfo `json:"TaskInfo,omitempty" name:"TaskInfo"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeTaskResponse

func NewDescribeTaskResponse() (response *DescribeTaskResponse)

func (*DescribeTaskResponse) FromJsonString

func (r *DescribeTaskResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeTaskResponse) ToJsonString

func (r *DescribeTaskResponse) ToJsonString() string

type DescribeTasksRequest

type DescribeTasksRequest struct {
	*tchttp.BaseRequest

	// 分页序号,从1开始
	PageNumber *int64 `json:"PageNumber,omitempty" name:"PageNumber"`

	// 每个分页所包含的元素数量,最大为50
	PageSize *int64 `json:"PageSize,omitempty" name:"PageSize"`

	// 任务过滤条件,相关限制参见TaskFilter
	TaskFilter *TaskFilter `json:"TaskFilter,omitempty" name:"TaskFilter"`

	// 返回结果排序信息,By字段只支持CreateTimeStamp
	SortBy *SortBy `json:"SortBy,omitempty" name:"SortBy"`
}

func NewDescribeTasksRequest

func NewDescribeTasksRequest() (request *DescribeTasksRequest)

func (*DescribeTasksRequest) FromJsonString

func (r *DescribeTasksRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeTasksRequest) ToJsonString

func (r *DescribeTasksRequest) ToJsonString() string

type DescribeTasksResponse

type DescribeTasksResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 满足过滤条件的任务总数量
		TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"`

		// 满足过滤条件的任务数组
		// 注意:此字段可能返回 null,表示取不到有效值。
		TaskInfoSet []*TaskInfo `json:"TaskInfoSet,omitempty" name:"TaskInfoSet"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeTasksResponse

func NewDescribeTasksResponse() (response *DescribeTasksResponse)

func (*DescribeTasksResponse) FromJsonString

func (r *DescribeTasksResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeTasksResponse) ToJsonString

func (r *DescribeTasksResponse) ToJsonString() string

type ImportMediaRequest

type ImportMediaRequest struct {
	*tchttp.BaseRequest

	// 待分析视频的URL,目前只支持*不带签名的*COS地址,长度最长1KB
	URL *string `json:"URL,omitempty" name:"URL"`

	// 待分析视频的MD5,为空时不做校验,否则会做MD5校验,长度必须为32B
	MD5 *string `json:"MD5,omitempty" name:"MD5"`

	// 待分析视频的名称,指定后可支持筛选,最多100个中文字符
	Name *string `json:"Name,omitempty" name:"Name"`
}

func NewImportMediaRequest

func NewImportMediaRequest() (request *ImportMediaRequest)

func (*ImportMediaRequest) FromJsonString

func (r *ImportMediaRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ImportMediaRequest) ToJsonString

func (r *ImportMediaRequest) ToJsonString() string

type ImportMediaResponse

type ImportMediaResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 媒资文件在系统中的ID
		MediaId *string `json:"MediaId,omitempty" name:"MediaId"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewImportMediaResponse

func NewImportMediaResponse() (response *ImportMediaResponse)

func (*ImportMediaResponse) FromJsonString

func (r *ImportMediaResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ImportMediaResponse) ToJsonString

func (r *ImportMediaResponse) ToJsonString() string

type L1Tag

type L1Tag struct {

	// 一级标签名
	Name *string `json:"Name,omitempty" name:"Name"`

	// 二级标签数组
	// 注意:此字段可能返回 null,表示取不到有效值。
	L2TagSet []*L2Tag `json:"L2TagSet,omitempty" name:"L2TagSet"`

	// 一级标签出现信息
	// 注意:此字段可能返回 null,表示取不到有效值。
	AppearIndexPairSet []*AppearIndexPair `json:"AppearIndexPairSet,omitempty" name:"AppearIndexPairSet"`

	// 一级标签首次出现信息
	// 注意:此字段可能返回 null,表示取不到有效值。
	FirstAppear *int64 `json:"FirstAppear,omitempty" name:"FirstAppear"`
}

type L2Tag

type L2Tag struct {

	// 二级标签名
	Name *string `json:"Name,omitempty" name:"Name"`

	// 从属于此二级标签的三级标签数组
	// 注意:此字段可能返回 null,表示取不到有效值。
	L3TagSet []*L3Tag `json:"L3TagSet,omitempty" name:"L3TagSet"`

	// 二级标签出现信息
	// 注意:此字段可能返回 null,表示取不到有效值。
	AppearIndexPairSet []*AppearIndexPair `json:"AppearIndexPairSet,omitempty" name:"AppearIndexPairSet"`

	// 二级标签首次出现信息
	// 注意:此字段可能返回 null,表示取不到有效值。
	FirstAppear *int64 `json:"FirstAppear,omitempty" name:"FirstAppear"`
}

type L3Tag

type L3Tag struct {

	// 三级标签名
	Name *string `json:"Name,omitempty" name:"Name"`

	// 三级标签出现信息索引数组
	// 注意:此字段可能返回 null,表示取不到有效值。
	AppearIndexPairSet []*AppearIndexPair `json:"AppearIndexPairSet,omitempty" name:"AppearIndexPairSet"`

	// 三级标签首次出现信息,可选值为[1,3]
	// 注意:此字段可能返回 null,表示取不到有效值。
	FirstAppear *int64 `json:"FirstAppear,omitempty" name:"FirstAppear"`
}

type MediaFilter

type MediaFilter struct {

	// 媒资名称过滤条件
	// 注意:此字段可能返回 null,表示取不到有效值。
	MediaNameSet []*string `json:"MediaNameSet,omitempty" name:"MediaNameSet"`

	// 媒资状态数组,媒资状态可选值参见MediaInfo
	// 注意:此字段可能返回 null,表示取不到有效值。
	StatusSet []*int64 `json:"StatusSet,omitempty" name:"StatusSet"`

	// 媒资ID数组
	// 注意:此字段可能返回 null,表示取不到有效值。
	MediaIdSet []*string `json:"MediaIdSet,omitempty" name:"MediaIdSet"`
}

type MediaInfo

type MediaInfo struct {

	// 媒资ID
	MediaId *string `json:"MediaId,omitempty" name:"MediaId"`

	// 媒资名称
	// 注意:此字段可能返回 null,表示取不到有效值。
	Name *string `json:"Name,omitempty" name:"Name"`

	// 媒资下载地址
	// 注意:此字段可能返回 null,表示取不到有效值。
	DownLoadURL *string `json:"DownLoadURL,omitempty" name:"DownLoadURL"`

	// 媒资状态,取值参看上方表格
	// 注意:此字段可能返回 null,表示取不到有效值。
	Status *int64 `json:"Status,omitempty" name:"Status"`

	// 若状态为失败,表示失败原因
	// 注意:此字段可能返回 null,表示取不到有效值。
	FailedReason *string `json:"FailedReason,omitempty" name:"FailedReason"`

	// 媒资视频元信息
	// 注意:此字段可能返回 null,表示取不到有效值。
	Metadata *MediaMetadata `json:"Metadata,omitempty" name:"Metadata"`

	// 导入视频进度,取值范围为[0,100]
	// 注意:此字段可能返回 null,表示取不到有效值。
	Progress *float64 `json:"Progress,omitempty" name:"Progress"`
}

type MediaMetadata

type MediaMetadata struct {

	// 媒资视频文件大小
	FileSize *int64 `json:"FileSize,omitempty" name:"FileSize"`

	// 媒资视频文件MD5
	MD5 *string `json:"MD5,omitempty" name:"MD5"`

	// 媒资视频时长,单位为秒
	// 注意:此字段可能返回 null,表示取不到有效值。
	Duration *float64 `json:"Duration,omitempty" name:"Duration"`

	// 媒资视频总帧数
	// 注意:此字段可能返回 null,表示取不到有效值。
	NumFrames *int64 `json:"NumFrames,omitempty" name:"NumFrames"`

	// 媒资视频宽度,单位为像素
	// 注意:此字段可能返回 null,表示取不到有效值。
	Width *int64 `json:"Width,omitempty" name:"Width"`

	// 媒资视频高度,单位为像素
	// 注意:此字段可能返回 null,表示取不到有效值。
	Height *int64 `json:"Height,omitempty" name:"Height"`

	// 媒资视频帧率,单位为Hz
	// 注意:此字段可能返回 null,表示取不到有效值。
	FPS *float64 `json:"FPS,omitempty" name:"FPS"`

	// 媒资视频比特率,单位为kbps
	// 注意:此字段可能返回 null,表示取不到有效值。
	BitRate *int64 `json:"BitRate,omitempty" name:"BitRate"`
}

type MediaPreknownInfo

type MediaPreknownInfo struct {

	// 媒资文件类型,参见MediaPreknownInfo结构体定义
	MediaType *int64 `json:"MediaType,omitempty" name:"MediaType"`

	// 媒资素材一级类型,参见MediaPreknownInfo结构体定义
	MediaLabel *int64 `json:"MediaLabel,omitempty" name:"MediaLabel"`

	// 媒资素材二级类型,参见MediaPreknownInfo结构体定义
	// 注意:此字段可能返回 null,表示取不到有效值。
	MediaSecondLabel *int64 `json:"MediaSecondLabel,omitempty" name:"MediaSecondLabel"`

	// 媒资音频类型,参见MediaPreknownInfo结构体定义
	// 注意:此字段可能返回 null,表示取不到有效值。
	MediaLang *int64 `json:"MediaLang,omitempty" name:"MediaLang"`
}

type MultiLevelTag

type MultiLevelTag struct {

	// 树状标签信息
	// 注意:此字段可能返回 null,表示取不到有效值。
	TagSet []*L1Tag `json:"TagSet,omitempty" name:"TagSet"`

	// 标签在识别结果中的定位信息
	// 注意:此字段可能返回 null,表示取不到有效值。
	AppearInfo *AppearInfo `json:"AppearInfo,omitempty" name:"AppearInfo"`
}

type ShowInfo

type ShowInfo struct {

	// 节目日期(只在新闻有效)
	// 注意:此字段可能返回 null,表示取不到有效值。
	Date *string `json:"Date,omitempty" name:"Date"`

	// 注意:此字段可能返回 null,表示取不到有效值。
	Logo *string `json:"Logo,omitempty" name:"Logo"`

	// 节目名称
	// 注意:此字段可能返回 null,表示取不到有效值。
	Column *string `json:"Column,omitempty" name:"Column"`

	// 来源信息
	// 注意:此字段可能返回 null,表示取不到有效值。
	Source *string `json:"Source,omitempty" name:"Source"`

	// 节目封面
	// 注意:此字段可能返回 null,表示取不到有效值。
	CoverImageURL *string `json:"CoverImageURL,omitempty" name:"CoverImageURL"`

	// 节目内容概要列表
	// 注意:此字段可能返回 null,表示取不到有效值。
	SummarySet []*string `json:"SummarySet,omitempty" name:"SummarySet"`

	// 节目片段标题列表
	// 注意:此字段可能返回 null,表示取不到有效值。
	TitleSet []*string `json:"TitleSet,omitempty" name:"TitleSet"`

	// 音频识别结果列表
	// 注意:此字段可能返回 null,表示取不到有效值。
	AudioInfoSet []*AudioInfo `json:"AudioInfoSet,omitempty" name:"AudioInfoSet"`

	// 可视文字识别结果列表
	// 注意:此字段可能返回 null,表示取不到有效值。
	TextInfoSet []*TextInfo `json:"TextInfoSet,omitempty" name:"TextInfoSet"`

	// 文本标签列表,包含标签内容和出现信息
	// 注意:此字段可能返回 null,表示取不到有效值。
	TextTagSet *MultiLevelTag `json:"TextTagSet,omitempty" name:"TextTagSet"`

	// 帧标签列表,包括人物信息,场景信息等
	// 注意:此字段可能返回 null,表示取不到有效值。
	FrameTagSet *MultiLevelTag `json:"FrameTagSet,omitempty" name:"FrameTagSet"`

	// 视频下载地址
	// 注意:此字段可能返回 null,表示取不到有效值。
	WebMediaURL *string `json:"WebMediaURL,omitempty" name:"WebMediaURL"`

	// 媒资分类信息
	// 注意:此字段可能返回 null,表示取不到有效值。
	MediaClassifierSet []*string `json:"MediaClassifierSet,omitempty" name:"MediaClassifierSet"`

	// 概要标签信息
	// 注意:此字段可能返回 null,表示取不到有效值。
	SummaryTagSet []*string `json:"SummaryTagSet,omitempty" name:"SummaryTagSet"`
}

type SortBy

type SortBy struct {

	// 排序字段,默认为CreateTime
	By *string `json:"By,omitempty" name:"By"`

	// true表示降序,false表示升序
	Descend *bool `json:"Descend,omitempty" name:"Descend"`
}

type TaskFilter

type TaskFilter struct {

	// 媒资文件类型
	MediaTypeSet []*int64 `json:"MediaTypeSet,omitempty" name:"MediaTypeSet"`

	// 待筛选的任务状态列表
	TaskStatusSet []*int64 `json:"TaskStatusSet,omitempty" name:"TaskStatusSet"`

	// 待筛选的任务名称数组
	TaskNameSet []*string `json:"TaskNameSet,omitempty" name:"TaskNameSet"`

	// TaskId数组
	TaskIdSet []*string `json:"TaskIdSet,omitempty" name:"TaskIdSet"`

	// 媒资文件名数组
	MediaNameSet []*string `json:"MediaNameSet,omitempty" name:"MediaNameSet"`

	// 媒资语言类型
	MediaLangSet []*int64 `json:"MediaLangSet,omitempty" name:"MediaLangSet"`

	// 媒资素材一级类型
	MediaLabelSet []*int64 `json:"MediaLabelSet,omitempty" name:"MediaLabelSet"`
}

type TaskInfo

type TaskInfo struct {

	// 任务ID
	TaskId *string `json:"TaskId,omitempty" name:"TaskId"`

	// 描述任务名称,指定后可根据名称筛选
	// 注意:此字段可能返回 null,表示取不到有效值。
	TaskName *string `json:"TaskName,omitempty" name:"TaskName"`

	// 媒资文件ID
	MediaId *string `json:"MediaId,omitempty" name:"MediaId"`

	// 任务执行状态
	TaskStatus *int64 `json:"TaskStatus,omitempty" name:"TaskStatus"`

	// 任务进度,范围为[0,100]
	// 注意:此字段可能返回 null,表示取不到有效值。
	TaskProgress *float64 `json:"TaskProgress,omitempty" name:"TaskProgress"`

	// 任务执行时间
	// 注意:此字段可能返回 null,表示取不到有效值。
	TaskTimeCost *int64 `json:"TaskTimeCost,omitempty" name:"TaskTimeCost"`

	// 任务创建时间
	TaskCreateTime *string `json:"TaskCreateTime,omitempty" name:"TaskCreateTime"`

	// 任务开始执行时间
	// 注意:此字段可能返回 null,表示取不到有效值。
	TaskStartTime *string `json:"TaskStartTime,omitempty" name:"TaskStartTime"`

	// 任务失败原因
	// 注意:此字段可能返回 null,表示取不到有效值。
	FailedReason *string `json:"FailedReason,omitempty" name:"FailedReason"`

	// 任务执行时指定的先验知识
	MediaPreknownInfo *MediaPreknownInfo `json:"MediaPreknownInfo,omitempty" name:"MediaPreknownInfo"`

	// 媒资文件名称
	// 注意:此字段可能返回 null,表示取不到有效值。
	MediaName *string `json:"MediaName,omitempty" name:"MediaName"`
}

type TextAppearInfo

type TextAppearInfo struct {

	// 文本结果数组中的下标
	Index *int64 `json:"Index,omitempty" name:"Index"`

	// 关键词在文本中出现的起始偏移量(包含)
	StartPosition *int64 `json:"StartPosition,omitempty" name:"StartPosition"`

	// 关键词在文本中出现的结束偏移量(不包含)
	EndPosition *int64 `json:"EndPosition,omitempty" name:"EndPosition"`
}

type TextInfo

type TextInfo struct {

	// OCR提取的内容
	Content *string `json:"Content,omitempty" name:"Content"`

	// OCR起始时间戳,从0开始
	StartTimeStamp *float64 `json:"StartTimeStamp,omitempty" name:"StartTimeStamp"`

	// OCR结束时间戳,从0开始
	EndTimeStamp *float64 `json:"EndTimeStamp,omitempty" name:"EndTimeStamp"`

	// OCR标签信息
	Tag *string `json:"Tag,omitempty" name:"Tag"`
}

type VideoAppearInfo

type VideoAppearInfo struct {

	// 视觉信息起始时间戳,从0开始
	StartTimeStamp *float64 `json:"StartTimeStamp,omitempty" name:"StartTimeStamp"`

	// 视觉信息终止时间戳,从0开始
	// 关键词在视觉信息中的区间为[StartTimeStamp, EndTimeStamp)
	EndTimeStamp *float64 `json:"EndTimeStamp,omitempty" name:"EndTimeStamp"`

	// 关键词在视觉信息中的封面图片
	ImageURL *string `json:"ImageURL,omitempty" name:"ImageURL"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL