api

Documentation

Overview

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

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

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

Index

• Constants
• func PutMedia(cli bce.Client, args *PutMediaArgs) error
• type CheckError
• type CheckResult
• type Evidence
• type GetMediaResult
  • func GetMedia(cli bce.Client, source string) (*GetMediaResult, error)
• type Location
• type PutImageSyncArgs
• type PutImageSyncResult
  • func PutImageSync(cli bce.Client, args *PutImageSyncArgs) (*PutImageSyncResult, error)
• type PutMediaArgs
• type PutTextArgs
• type PutTextResult
  • func PutText(cli bce.Client, args *PutTextArgs) (*PutTextResult, error)
• type ResultItem

Constants

const (
	URI_PREFIX = bce.URI_PREFIX + "v1"
	MEDIA_URI  = "/media"
	TEXT_URI   = "/text"
	IMAGE_URI  = "/image"
)

Functions

func PutMedia

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

Types

type CheckError

type CheckError struct {
	Code    string `json:"code"`
	Message string `json:"message"`
}

type CheckResult

type CheckResult struct {
	Type  string       `json:"type"`
	Items []ResultItem `json:"items"`
}

type Evidence

type Evidence struct {
	Thumbnail string   `json:"thumbnail"`
	Location  Location `json:"location"`
	Text      string   `json:"text"`
}

type GetMediaResult

type GetMediaResult struct {
	Source       string        `json:"source"`
	MediaId      string        `json:"mediaId"`
	Description  string        `json:"description"`
	Preset       string        `json:"preset"`
	Status       string        `json:"status"`
	Percent      int           `json:"percent"`
	Notification string        `json:"notification"`
	CreateTime   string        `json:"createTime"`
	FinishTime   string        `json:"finishTime"`
	Label        string        `json:"label"`
	Results      []CheckResult `json:"results"`
	Error        CheckError    `json:"error"`
}

func GetMedia

func GetMedia(cli bce.Client, source string) (*GetMediaResult, error)

type Location

type Location struct {
	LeftOffsetInPixel int `json:"leftOffsetInPixel"`
	TopOffsetInPixel  int `json:"topOffsetInPixel"`
	WidthInPixel      int `json:"widthInPixel"`
	HeightInPixel     int `json:"heightInPixel"`
}

type PutImageSyncArgs

type PutImageSyncArgs struct {
	Source string `json:"source"`
	Preset string `json:"preset"`
}

type PutImageSyncResult

type PutImageSyncResult struct {
	Source  string        `json:"source"`
	Label   string        `json:"label"`
	Preset  string        `json:"preset"`
	Status  string        `json:"status"`
	Results []CheckResult `json:"results"`
}

func PutImageSync

func PutImageSync(cli bce.Client, args *PutImageSyncArgs) (*PutImageSyncResult, error)

type PutMediaArgs

type PutMediaArgs struct {
	Source       string `json:"source"`
	Auth         string `json:"auth"`
	Description  string `json:"description"`
	Preset       string `json:"preset"`
	Notification string `json:"notification"`
}

type PutTextArgs

type PutTextArgs struct {
	Text   string `json:"text"`
	Preset string `json:"preset"`
}

type PutTextResult

type PutTextResult struct {
	Text    string        `json:"text"`
	Preset  string        `json:"preset"`
	Results []CheckResult `json:"results"`
}

func PutText

func PutText(cli bce.Client, args *PutTextArgs) (*PutTextResult, error)

type ResultItem

type ResultItem struct {
	SubType       string   `json:"subType"`
	Target        string   `json:"target"`
	TimeInSeconds int      `json:"timeInSeconds"`
	Confidence    float32  `json:"confidence"`
	Label         string   `json:"label"`
	Extra         string   `json:"extra"`
	Evidence      Evidence `json:"evidence"`
}