api

Documentation

Overview

Package api defines all APIs supported by the VCA service of BCE.

Index

• Variables
• func AddImage(cli bce.Client, uri string, args *model.ImageArgs) error
• func AddImages(cli bce.Client, uri string, images *model.ImageList) *model.ImageList
• func CreateImageLib(cli bce.Client, uri string, args *model.PostImageLibArgs) error
• func DeleteImage(cli bce.Client, uri string, image *model.ImageArgs) error
• func DeleteImageBrief(cli bce.Client, uri, brief string) error
• func DeleteImages(cli bce.Client, uri string, images *model.ImageList) *model.ImageList
• func GetImageLib(cli bce.Client, uri string) (*model.ImageLibList, error)
• func GetMedia(cli bce.Client, params map[string]string) (*model.GetMediaResult, error)
• func GetStream(cli bce.Client, params map[string]string) (*model.GetStreamResult, error)
• func GetSubTask(cli bce.Client, task model.SubTask, params map[string]string) (*model.SubTaskResult, error)
• func ListImage(cli bce.Client, uri string, images *model.ImageList) error
• func ListImageBrief(cli bce.Client, uri string) (*model.BriefList, error)
• func NewSubTaskResult(taskType model.SubTask) *model.SubTaskResult
• func PutMedia(cli bce.Client, args *model.PutMediaArgs) (*model.MediaResultCommon, error)
• func PutStream(cli bce.Client, args *model.StreamArgs) (*model.StreamResultCommon, error)
• func StopStream(cli bce.Client, args *model.StreamArgs) error

Variables

var ScenarioSourceMap = map[model.Scenario][]model.Source{
	constant.FIGURE:         {constant.SourceFaceRecognition, constant.SourcePrivateFace},
	constant.LOGO:           {constant.SourceLogo, constant.SourcePrivateLogo},
	constant.ENTITY:         {constant.SourceImageClassify, constant.SourceObjectDetect, constant.SourceLandmark},
	constant.KEYWORD:        {constant.SourceCharacter, constant.SourceSpeech},
	constant.SCENARIO:       {constant.SourceScenarioClassify},
	constant.KnowledgeGraph: {constant.SourceKnowledgeGraph, constant.SourceKnowledgeGraphPoem},
}

var ScenarioTaskMap = map[model.Scenario][]model.SubTask{
	constant.FIGURE:         {constant.TaskFaceRecognitionTracking, constant.TaskFaceRecognitionThumbnail, constant.TaskPrivateFaceTracking, constant.TaskPrivateFaceImage},
	constant.LOGO:           {constant.TaskLogo, constant.TaskPrivateLogo},
	constant.ENTITY:         {constant.TaskLandmark, constant.TaskImageClassify, constant.TaskObjectDetect},
	constant.KEYWORD:        {constant.TaskTextrankCharacter, constant.TaskKeywordMerge, constant.TaskTextrankSpeech},
	constant.SCENARIO:       {constant.TaskScenarioClassifyV2, constant.TaskShortVideoClassify},
	constant.KnowledgeGraph: {constant.TaskKnowledgeGraph, constant.TaskKnowledgeGraphPoem},
}

var SubTaskSourceMap = map[model.SubTask]model.Source{
	constant.TaskCharacter:                constant.SourceCharacter,
	constant.TaskOcrStructure:             constant.SourceCharacter,
	constant.TaskSpeech:                   constant.SourceSpeech,
	constant.TaskFaceTracking:             constant.SourceFaceRecognition,
	constant.TaskFaceDetect:               constant.SourceFaceRecognition,
	constant.TaskFaceRecognitionTracking:  constant.SourceFaceRecognition,
	constant.TaskFaceRecognitionThumbnail: constant.SourceFaceRecognition,
	constant.TaskPrivateFaceTracking:      constant.SourcePrivateFace,
	constant.TaskPrivateFaceImage:         constant.SourcePrivateFace,
	constant.TaskLogo:                     constant.SourceLogo,
	constant.TaskPrivateLogo:              constant.SourcePrivateLogo,
	constant.TaskTextrankCharacter:        constant.SourceCharacter,
	constant.TaskKeywordMerge:             constant.SourceCharacter,
	constant.TaskTextrankSpeech:           constant.SourceSpeech,
	constant.TaskScenarioClassifyV2:       constant.SourceScenarioClassify,
	constant.TaskShortVideoClassify:       constant.SourceScenarioClassify,
	constant.TaskLandmark:                 constant.SourceLandmark,
	constant.TaskImageClassify:            constant.SourceImageClassify,
	constant.TaskObjectDetect:             constant.SourceObjectDetect,
	constant.TaskKnowledgeGraph:           constant.SourceKnowledgeGraph,
	constant.TaskKnowledgeGraphPoem:       constant.SourceKnowledgeGraphPoem,
}

Functions

func AddImage

func AddImage(cli bce.Client, uri string, args *model.ImageArgs) error

若brief不存在会自动创建

func AddImages

func AddImages(cli bce.Client, uri string, images *model.ImageList) *model.ImageList

func CreateImageLib

func CreateImageLib(cli bce.Client, uri string, args *model.PostImageLibArgs) error

func DeleteImage

func DeleteImage(cli bce.Client, uri string, image *model.ImageArgs) error

若删除的图片为brief中最后一张图片，则brief同时会被删除

func DeleteImageBrief

func DeleteImageBrief(cli bce.Client, uri, brief string) error

目前不能直接删除图集

func DeleteImages

func DeleteImages(cli bce.Client, uri string, images *model.ImageList) *model.ImageList

func GetImageLib

func GetImageLib(cli bce.Client, uri string) (*model.ImageLibList, error)

func GetMedia

func GetMedia(cli bce.Client, params map[string]string) (*model.GetMediaResult, error)

func GetStream

func GetStream(cli bce.Client, params map[string]string) (*model.GetStreamResult, error)

func GetSubTask

func GetSubTask(cli bce.Client, task model.SubTask, params map[string]string) (*model.SubTaskResult, error)

func ListImage

func ListImage(cli bce.Client, uri string, images *model.ImageList) error

func ListImageBrief

func ListImageBrief(cli bce.Client, uri string) (*model.BriefList, error)

func NewSubTaskResult

func NewSubTaskResult(taskType model.SubTask) *model.SubTaskResult

func PutMedia

func PutMedia(cli bce.Client, args *model.PutMediaArgs) (*model.MediaResultCommon, error)

func PutStream

func PutStream(cli bce.Client, args *model.StreamArgs) (*model.StreamResultCommon, error)

func StopStream

func StopStream(cli bce.Client, args *model.StreamArgs) error