security

Documentation

Index

• type CheckLabel
  • func (cl CheckLabel) String() string
• type CheckSuggest
• type MediaCheckAsyncRequest
• type MediaCheckAsyncV1Request
• type MsgCheckRequest
• type MsgCheckResponse
• type MsgScene
• type Security
  • func NewSecurity(ctx *context.Context) *Security
  • func (security *Security) ImageCheckV1(filename string) (err error)
  • func (security *Security) MediaCheckAsync(in *MediaCheckAsyncRequest) (traceID string, err error)
  • func (security *Security) MediaCheckAsyncV1(in *MediaCheckAsyncV1Request) (traceID string, err error)
  • func (security *Security) MsgCheck(in *MsgCheckRequest) (res MsgCheckResponse, err error)
  • func (security *Security) MsgCheckV1(content string) (res MsgCheckResponse, err error)

Types

type CheckLabel

type CheckLabel int

CheckLabel 检查命中标签

func (CheckLabel) String

func (cl CheckLabel) String() string

type CheckSuggest

type CheckSuggest string

CheckSuggest 检查建议

const (
	// CheckSuggestRisky 违规风险建议
	CheckSuggestRisky CheckSuggest = "risky"
	// CheckSuggestPass 安全
	CheckSuggestPass CheckSuggest = "pass"
	// CheckSuggestReview 需要审查
	CheckSuggestReview CheckSuggest = "review"
)

type MediaCheckAsyncRequest

type MediaCheckAsyncRequest struct {
	MediaURL  string `json:"media_url"`  // 要检测的图片或音频的url，支持图片格式包括jpg, jepg, png, bmp, gif（取首帧），支持的音频格式包括mp3, aac, ac3, wma, flac, vorbis, opus, wav
	MediaType uint8  `json:"media_type"` // 1:音频;2:图片
	OpenID    string `json:"openid"`     // 用户的openid（用户需在近两小时访问过小程序）
	Scene     uint8  `json:"scene"`      // 场景枚举值（1 资料；2 评论；3 论坛；4 社交日志）
}

MediaCheckAsyncRequest 图片/音频异步校验请求参数

type MediaCheckAsyncV1Request

type MediaCheckAsyncV1Request struct {
	MediaURL  string `json:"media_url"`  // 要检测的图片或音频的url，支持图片格式包括jpg, jepg, png, bmp, gif（取首帧），支持的音频格式包括mp3, aac, ac3, wma, flac, vorbis, opus, wav
	MediaType uint8  `json:"media_type"` // 1:音频;2:图片
}

MediaCheckAsyncV1Request 图片/音频异步校验请求参数

type MsgCheckRequest

type MsgCheckRequest struct {
	OpenID    string   `json:"openid"`    // 用户的openid（用户需在近两小时访问过小程序）
	Scene     MsgScene `json:"scene"`     // 场景枚举值（1 资料；2 评论；3 论坛；4 社交日志）
	Content   string   `json:"content"`   // 需检测的文本内容，文本字数的上限为 2500 字，需使用 UTF-8 编码
	Nickname  string   `json:"nickname"`  // （非必填）用户昵称，需使用UTF-8编码
	Title     string   `json:"title"`     // （非必填）文本标题，需使用UTF-8编码
	Signature string   `json:"signature"` // （非必填）个性签名，该参数仅在资料类场景有效(scene=1)，需使用UTF-8编码
}

MsgCheckRequest 文本检查请求

type MsgCheckResponse

type MsgCheckResponse struct {
	util.CommonError
	TraceID string `json:"trace_id"` // 唯一请求标识
	Result  struct {
		Suggest CheckSuggest `json:"suggest"` // 建议
		Label   CheckLabel   `json:"label"`   // 命中标签
	} `json:"result"` // 综合结果
	Detail []struct {
		ErrCode  int64      `json:"errcode"`  // 错误码，仅当该值为0时，该项结果有效
		Strategy string     `json:"strategy"` // 策略类型
		Suggest  string     `json:"suggest"`  // 建议
		Label    CheckLabel `json:"label"`    // 命中标签
		Prob     uint       `json:"prob"`     // 置信度。0-100，越高代表越有可能属于当前返回的标签（label）
		Keyword  string     `json:"keyword"`  // 命中的自定义关键词
	} `json:"detail"` // 详细检测结果
}

MsgCheckResponse 文本检查响应

type MsgScene

type MsgScene uint8

MsgScene 文本场景

const (
	// MsgSceneMaterial 资料文件检查场景
	MsgSceneMaterial MsgScene = iota + 1
	// MsgSceneComment 评论
	MsgSceneComment
	// MsgSceneForum 论坛
	MsgSceneForum
	// MsgSceneSocialLog 社交日志
	MsgSceneSocialLog
)

type Security

type Security struct {
	*context.Context
}

Security 内容安全

func NewSecurity

func NewSecurity(ctx *context.Context) *Security

NewSecurity init

func (*Security) ImageCheckV1

func (security *Security) ImageCheckV1(filename string) (err error)

ImageCheckV1 校验一张图片是否含有违法违规内容（同步） https://developers.weixin.qq.com/miniprogram/dev/framework/security.imgSecCheck.html Deprecated 在2021年9月1日停止更新。建议使用 MediaCheckAsync

func (*Security) MediaCheckAsync

func (security *Security) MediaCheckAsync(in *MediaCheckAsyncRequest) (traceID string, err error)

MediaCheckAsync 异步校验图片/音频是否含有违法违规内容

func (*Security) MediaCheckAsyncV1

func (security *Security) MediaCheckAsyncV1(in *MediaCheckAsyncV1Request) (traceID string, err error)

MediaCheckAsyncV1 异步校验图片/音频是否含有违法违规内容 Deprecated 在2021年9月1日停止更新，请尽快更新至 2.0 接口。建议使用 MediaCheckAsync

func (*Security) MsgCheck

func (security *Security) MsgCheck(in *MsgCheckRequest) (res MsgCheckResponse, err error)

MsgCheck 检查一段文本是否含有违法违规内容

func (*Security) MsgCheckV1

func (security *Security) MsgCheckV1(content string) (res MsgCheckResponse, err error)

MsgCheckV1 检查一段文本是否含有违法违规内容 Deprecated 在2021年9月1日停止更新，请尽快更新至 2.0 接口。建议使用 MsgCheck