protocol

package
v0.1.17 Latest Latest
Warning

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

 Go to latest Published: Aug 16, 2023 License: Apache-2.0 Imports: 6 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	CallbackReqType_name = map[int32]string{
		0: "byte_scene",
		1: "not_byte_scene",
		2: "behavior",
	}
	CallbackReqType_value = map[string]int32{
		"byte_scene":     0,
		"not_byte_scene": 1,
		"behavior":       2,
	}
)

Enum value maps for CallbackReqType.

View Source 
var File_byteplus_general_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type CallbackContext 

type CallbackContext struct {

	// spm
	Spm string `protobuf:"bytes,1,opt,name=spm,proto3" json:"spm,omitempty"`
	// reqType.
	ReqType CallbackReqType `` /* 131-byte string literal not displayed */
	// more info
	Extra map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*CallbackContext) Descriptor deprecated 

func (*CallbackContext) Descriptor() ([]byte, []int)

Deprecated: Use CallbackContext.ProtoReflect.Descriptor instead.

func (*CallbackContext) GetExtra 

func (x *CallbackContext) GetExtra() map[string]string

func (*CallbackContext) GetReqType 

func (x *CallbackContext) GetReqType() CallbackReqType

func (*CallbackContext) GetSpm 

func (x *CallbackContext) GetSpm() string

func (*CallbackContext) ProtoMessage 

func (*CallbackContext) ProtoMessage()

func (*CallbackContext) ProtoReflect 

func (x *CallbackContext) ProtoReflect() protoreflect.Message

func (*CallbackContext) Reset 

func (x *CallbackContext) Reset()

func (*CallbackContext) String 

func (x *CallbackContext) String() string

type CallbackItem 

type CallbackItem struct {

	// Required
	// The item id, that is showed to user or filtered
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Optional
	// The item's position when showed to user.
	// If item is filtered, not showed, ignore this field
	Pos string `protobuf:"bytes,2,opt,name=pos,proto3" json:"pos,omitempty"`
	// Optional.
	// The extra info about this item.
	// For example, you can set the final state of the item.
	// The acceptable values are "kept", "filtered", "inserted".
	// kept     : The item was kept as is.
	// filtered : The item is filtered by the caller's own logic.
	// inserted : The item is inserted by the caller's own logic.
	Extra string `protobuf:"bytes,3,opt,name=extra,proto3" json:"extra,omitempty"`
	// contains filtered or unexported fields
}

func (*CallbackItem) Descriptor deprecated 

func (*CallbackItem) Descriptor() ([]byte, []int)

Deprecated: Use CallbackItem.ProtoReflect.Descriptor instead.

func (*CallbackItem) GetExtra 

func (x *CallbackItem) GetExtra() string

func (*CallbackItem) GetId 

func (x *CallbackItem) GetId() string

func (*CallbackItem) GetPos 

func (x *CallbackItem) GetPos() string

func (*CallbackItem) ProtoMessage 

func (*CallbackItem) ProtoMessage()

func (*CallbackItem) ProtoReflect 

func (x *CallbackItem) ProtoReflect() protoreflect.Message

func (*CallbackItem) Reset 

func (x *CallbackItem) Reset()

func (*CallbackItem) String 

func (x *CallbackItem) String() string

type CallbackReqType 

type CallbackReqType int32
const (
	CallbackReqType_byte_scene     CallbackReqType = 0
	CallbackReqType_not_byte_scene CallbackReqType = 1
	CallbackReqType_behavior       CallbackReqType = 2
)

func (CallbackReqType) Descriptor 

func (CallbackReqType) Descriptor() protoreflect.EnumDescriptor

func (CallbackReqType) Enum 

func (x CallbackReqType) Enum() *CallbackReqType

func (CallbackReqType) EnumDescriptor deprecated 

func (CallbackReqType) EnumDescriptor() ([]byte, []int)

Deprecated: Use CallbackReqType.Descriptor instead.

func (CallbackReqType) Number 

func (x CallbackReqType) Number() protoreflect.EnumNumber

func (CallbackReqType) String 

func (x CallbackReqType) String() string

func (CallbackReqType) Type 

func (CallbackReqType) Type() protoreflect.EnumType

type CallbackRequest 

type CallbackRequest struct {

	// Required
	// The user's id
	Uid string `protobuf:"bytes,1,opt,name=uid,proto3" json:"uid,omitempty"`
	// Required.
	// The scene info.
	// Please make sure this is the same as the predict request's scene param
	Scene string `protobuf:"bytes,2,opt,name=scene,proto3" json:"scene,omitempty"`
	// Required
	// The list of need callback
	Items []*CallbackItem `protobuf:"bytes,3,rep,name=items,proto3" json:"items,omitempty"`
	// Required.
	// This should be same as `PredictResponse.request_id`.
	PredictRequestId string `protobuf:"bytes,4,opt,name=predict_request_id,json=predictRequestId,proto3" json:"predict_request_id,omitempty"`
	// callback context info
	Context *CallbackContext `protobuf:"bytes,5,opt,name=context,proto3" json:"context,omitempty"`
	// optional.
	// All the callback extra info here.
	Extra map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*CallbackRequest) Descriptor deprecated 

func (*CallbackRequest) Descriptor() ([]byte, []int)

Deprecated: Use CallbackRequest.ProtoReflect.Descriptor instead.

func (*CallbackRequest) GetContext 

func (x *CallbackRequest) GetContext() *CallbackContext

func (*CallbackRequest) GetExtra 

func (x *CallbackRequest) GetExtra() map[string]string

func (*CallbackRequest) GetItems 

func (x *CallbackRequest) GetItems() []*CallbackItem

func (*CallbackRequest) GetPredictRequestId 

func (x *CallbackRequest) GetPredictRequestId() string

func (*CallbackRequest) GetScene 

func (x *CallbackRequest) GetScene() string

func (*CallbackRequest) GetUid 

func (x *CallbackRequest) GetUid() string

func (*CallbackRequest) ProtoMessage 

func (*CallbackRequest) ProtoMessage()

func (*CallbackRequest) ProtoReflect 

func (x *CallbackRequest) ProtoReflect() protoreflect.Message

func (*CallbackRequest) Reset 

func (x *CallbackRequest) Reset()

func (*CallbackRequest) String 

func (x *CallbackRequest) String() string

type CallbackResponse 

type CallbackResponse struct {

	// Output only.
	// The error code. Callers should expect this field for all
	// responses.
	// Here is the table for the possible codes.
	// 0   : The request is successfully returned. Other values indicates errors.
	Code int32 `protobuf:"varint,1,opt,name=code,proto3" json:"code,omitempty"`
	// Output only.
	// Detailed error message.
	Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

func (*CallbackResponse) Descriptor deprecated 

func (*CallbackResponse) Descriptor() ([]byte, []int)

Deprecated: Use CallbackResponse.ProtoReflect.Descriptor instead.

func (*CallbackResponse) GetCode 

func (x *CallbackResponse) GetCode() int32

func (*CallbackResponse) GetMessage 

func (x *CallbackResponse) GetMessage() string

func (*CallbackResponse) ProtoMessage 

func (*CallbackResponse) ProtoMessage()

func (*CallbackResponse) ProtoReflect 

func (x *CallbackResponse) ProtoReflect() protoreflect.Message

func (*CallbackResponse) Reset 

func (x *CallbackResponse) Reset()

func (*CallbackResponse) String 

func (x *CallbackResponse) String() string

type DataError 

type DataError struct {

	// Output only.
	// The detailed error message.
	Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
	// Output only.
	// The failed data,that is serialized by json.
	Data string `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*DataError) Descriptor deprecated 

func (*DataError) Descriptor() ([]byte, []int)

Deprecated: Use DataError.ProtoReflect.Descriptor instead.

func (*DataError) GetData 

func (x *DataError) GetData() string

func (*DataError) GetMessage 

func (x *DataError) GetMessage() string

func (*DataError) ProtoMessage 

func (*DataError) ProtoMessage()

func (*DataError) ProtoReflect 

func (x *DataError) ProtoReflect() protoreflect.Message

func (*DataError) Reset 

func (x *DataError) Reset()

func (*DataError) String 

func (x *DataError) String() string

type DoubleArray added in v0.1.13 

type DoubleArray struct {
	Values []float64 `protobuf:"fixed64,1,rep,packed,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

func (*DoubleArray) Descriptor deprecated added in v0.1.13 

func (*DoubleArray) Descriptor() ([]byte, []int)

Deprecated: Use DoubleArray.ProtoReflect.Descriptor instead.

func (*DoubleArray) GetValues added in v0.1.13 

func (x *DoubleArray) GetValues() []float64

func (*DoubleArray) ProtoMessage added in v0.1.13 

func (*DoubleArray) ProtoMessage()

func (*DoubleArray) ProtoReflect added in v0.1.13 

func (x *DoubleArray) ProtoReflect() protoreflect.Message

func (*DoubleArray) Reset added in v0.1.13 

func (x *DoubleArray) Reset()

func (*DoubleArray) String added in v0.1.13 

func (x *DoubleArray) String() string

type FloatArray added in v0.1.13 

type FloatArray struct {
	Values []float32 `protobuf:"fixed32,1,rep,packed,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

func (*FloatArray) Descriptor deprecated added in v0.1.13 

func (*FloatArray) Descriptor() ([]byte, []int)

Deprecated: Use FloatArray.ProtoReflect.Descriptor instead.

func (*FloatArray) GetValues added in v0.1.13 

func (x *FloatArray) GetValues() []float32

func (*FloatArray) ProtoMessage added in v0.1.13 

func (*FloatArray) ProtoMessage()

func (*FloatArray) ProtoReflect added in v0.1.13 

func (x *FloatArray) ProtoReflect() protoreflect.Message

func (*FloatArray) Reset added in v0.1.13 

func (x *FloatArray) Reset()

func (*FloatArray) String added in v0.1.13 

func (x *FloatArray) String() string

type ImportResponse 

type ImportResponse struct {

	// Output only.
	// The status of the import call.
	// When `status.code` is 0, all payload are successfully imported.
	// If `status.code` is 1001, `error_samples` is populated.
	// Other non-zero values indicate all payload failed.
	Status *protocol.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// Output only.
	// This field is populated when `status.code` is 1001.
	// When populated, this field contains the error samples.
	ErrorSamples []*DataError `protobuf:"bytes,2,rep,name=error_samples,json=errorSamples,proto3" json:"error_samples,omitempty"`
	// contains filtered or unexported fields
}

func (*ImportResponse) Descriptor deprecated 

func (*ImportResponse) Descriptor() ([]byte, []int)

Deprecated: Use ImportResponse.ProtoReflect.Descriptor instead.

func (*ImportResponse) GetErrorSamples 

func (x *ImportResponse) GetErrorSamples() []*DataError

func (*ImportResponse) GetStatus 

func (x *ImportResponse) GetStatus() *protocol.Status

func (*ImportResponse) ProtoMessage 

func (*ImportResponse) ProtoMessage()

func (*ImportResponse) ProtoReflect 

func (x *ImportResponse) ProtoReflect() protoreflect.Message

func (*ImportResponse) Reset 

func (x *ImportResponse) Reset()

func (*ImportResponse) String 

func (x *ImportResponse) String() string

type IntArray added in v0.1.13 

type IntArray struct {
	Values []int64 `protobuf:"varint,1,rep,packed,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

func (*IntArray) Descriptor deprecated added in v0.1.13 

func (*IntArray) Descriptor() ([]byte, []int)

Deprecated: Use IntArray.ProtoReflect.Descriptor instead.

func (*IntArray) GetValues added in v0.1.13 

func (x *IntArray) GetValues() []int64

func (*IntArray) ProtoMessage added in v0.1.13 

func (*IntArray) ProtoMessage()

func (*IntArray) ProtoReflect added in v0.1.13 

func (x *IntArray) ProtoReflect() protoreflect.Message

func (*IntArray) Reset added in v0.1.13 

func (x *IntArray) Reset()

func (*IntArray) String added in v0.1.13 

func (x *IntArray) String() string

type PredictCandidateItem 

type PredictCandidateItem struct {

	// Required
	// The item id
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Optional
	// The item score
	Score float64 `protobuf:"fixed64,2,opt,name=score,proto3" json:"score,omitempty"`
	// Optional
	// The item's price
	Price float64 `protobuf:"fixed64,3,opt,name=price,proto3" json:"price,omitempty"`
	// Optional
	// Boost coefficient when sorting
	BoostCoef float64 `protobuf:"fixed64,4,opt,name=boost_coef,json=boostCoef,proto3" json:"boost_coef,omitempty"`
	// Optional.
	// This is a catch-all field to pass all the additional information.
	// Please provide as much information as possible.
	Extra map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*PredictCandidateItem) Descriptor deprecated 

func (*PredictCandidateItem) Descriptor() ([]byte, []int)

Deprecated: Use PredictCandidateItem.ProtoReflect.Descriptor instead.

func (*PredictCandidateItem) GetBoostCoef 

func (x *PredictCandidateItem) GetBoostCoef() float64

func (*PredictCandidateItem) GetExtra 

func (x *PredictCandidateItem) GetExtra() map[string]string

func (*PredictCandidateItem) GetId 

func (x *PredictCandidateItem) GetId() string

func (*PredictCandidateItem) GetPrice 

func (x *PredictCandidateItem) GetPrice() float64

func (*PredictCandidateItem) GetScore 

func (x *PredictCandidateItem) GetScore() float64

func (*PredictCandidateItem) ProtoMessage 

func (*PredictCandidateItem) ProtoMessage()

func (*PredictCandidateItem) ProtoReflect 

func (x *PredictCandidateItem) ProtoReflect() protoreflect.Message

func (*PredictCandidateItem) Reset 

func (x *PredictCandidateItem) Reset()

func (*PredictCandidateItem) String 

func (x *PredictCandidateItem) String() string

type PredictContext 

type PredictContext struct {

	// Required
	// The position of showing recommend result.
	// You need to negotiate with ByteDance how to define it
	Spm string `protobuf:"bytes,1,opt,name=spm,proto3" json:"spm,omitempty"`
	// whether close personal recommend
	ClosePersonalizedRecommend bool `protobuf:"varint,2,opt,name=closePersonalizedRecommend,proto3" json:"closePersonalizedRecommend,omitempty"`
	// client input feature
	Feature *PredictFeature `protobuf:"bytes,3,opt,name=feature,proto3" json:"feature,omitempty"`
	// client input filter
	Filter *PredictFilter `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// Optional.
	// This is a catch-all field to pass all the additional information.
	// Please provide as much information as possible.
	Extra map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*PredictContext) Descriptor deprecated 

func (*PredictContext) Descriptor() ([]byte, []int)

Deprecated: Use PredictContext.ProtoReflect.Descriptor instead.

func (*PredictContext) GetClosePersonalizedRecommend 

func (x *PredictContext) GetClosePersonalizedRecommend() bool

func (*PredictContext) GetExtra 

func (x *PredictContext) GetExtra() map[string]string

func (*PredictContext) GetFeature added in v0.1.13 

func (x *PredictContext) GetFeature() *PredictFeature

func (*PredictContext) GetFilter added in v0.1.13 

func (x *PredictContext) GetFilter() *PredictFilter

func (*PredictContext) GetSpm 

func (x *PredictContext) GetSpm() string

func (*PredictContext) ProtoMessage 

func (*PredictContext) ProtoMessage()

func (*PredictContext) ProtoReflect 

func (x *PredictContext) ProtoReflect() protoreflect.Message

func (*PredictContext) Reset 

func (x *PredictContext) Reset()

func (*PredictContext) String 

func (x *PredictContext) String() string

type PredictDevice 

type PredictDevice struct {

	// Optional
	// Device id, such as 'imei'
	DeviceId string `protobuf:"bytes,1,opt,name=deviceId,proto3" json:"deviceId,omitempty"`
	// Optional
	// The platform used by the user, e.g. 'Android', 'Web'
	Platform string `protobuf:"bytes,2,opt,name=platform,proto3" json:"platform,omitempty"`
	// Optional.
	// The brand of the device.
	// e.g. "Samsung"
	DeviceVendor string `protobuf:"bytes,3,opt,name=deviceVendor,proto3" json:"deviceVendor,omitempty"`
	// Optional.
	// The device model.
	// e.g. "iPhone10", "Pixel 4".
	DeviceModel string `protobuf:"bytes,4,opt,name=deviceModel,proto3" json:"deviceModel,omitempty"`
	// Optional
	// The device resolution
	// e.g. "800*600"
	DeviceResolution string `protobuf:"bytes,5,opt,name=deviceResolution,proto3" json:"deviceResolution,omitempty"`
	// Optional.
	// Your application version.
	// e.g. V9.0.8.
	ClientVersion string `protobuf:"bytes,6,opt,name=clientVersion,proto3" json:"clientVersion,omitempty"`
	// Optional.
	// The operating system version.
	// e.g. "14.4.2"
	OsVersion string `protobuf:"bytes,7,opt,name=osVersion,proto3" json:"osVersion,omitempty"`
	// Optional.
	// The network used.
	// e.g. "2g", "3g", "4g", "5g", "wifi", "other".
	NetworkType string `protobuf:"bytes,8,opt,name=networkType,proto3" json:"networkType,omitempty"`
	// Optional.
	// The network carrier.
	// e.g. "Version", "CMCC"
	Carrier string `protobuf:"bytes,9,opt,name=carrier,proto3" json:"carrier,omitempty"`
	// Optional
	OsType string `protobuf:"bytes,10,opt,name=os_type,json=osType,proto3" json:"os_type,omitempty"`
	// contains filtered or unexported fields
}

func (*PredictDevice) Descriptor deprecated 

func (*PredictDevice) Descriptor() ([]byte, []int)

Deprecated: Use PredictDevice.ProtoReflect.Descriptor instead.

func (*PredictDevice) GetCarrier 

func (x *PredictDevice) GetCarrier() string

func (*PredictDevice) GetClientVersion 

func (x *PredictDevice) GetClientVersion() string

func (*PredictDevice) GetDeviceId 

func (x *PredictDevice) GetDeviceId() string

func (*PredictDevice) GetDeviceModel 

func (x *PredictDevice) GetDeviceModel() string

func (*PredictDevice) GetDeviceResolution 

func (x *PredictDevice) GetDeviceResolution() string

func (*PredictDevice) GetDeviceVendor 

func (x *PredictDevice) GetDeviceVendor() string

func (*PredictDevice) GetNetworkType 

func (x *PredictDevice) GetNetworkType() string

func (*PredictDevice) GetOsType added in v0.1.16 

func (x *PredictDevice) GetOsType() string

func (*PredictDevice) GetOsVersion 

func (x *PredictDevice) GetOsVersion() string

func (*PredictDevice) GetPlatform 

func (x *PredictDevice) GetPlatform() string

func (*PredictDevice) ProtoMessage 

func (*PredictDevice) ProtoMessage()

func (*PredictDevice) ProtoReflect 

func (x *PredictDevice) ProtoReflect() protoreflect.Message

func (*PredictDevice) Reset 

func (x *PredictDevice) Reset()

func (*PredictDevice) String 

func (x *PredictDevice) String() string

type PredictExtra 

type PredictExtra struct {

	// Optional.
	// mark for test
	InnerTest bool `protobuf:"varint,1,opt,name=innerTest,proto3" json:"innerTest,omitempty"`
	// Optional.
	// This is a catch-all field to pass all the additional information.
	// Please provide as much information as possible.
	Extra map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*PredictExtra) Descriptor deprecated 

func (*PredictExtra) Descriptor() ([]byte, []int)

Deprecated: Use PredictExtra.ProtoReflect.Descriptor instead.

func (*PredictExtra) GetExtra 

func (x *PredictExtra) GetExtra() map[string]string

func (*PredictExtra) GetInnerTest 

func (x *PredictExtra) GetInnerTest() bool

func (*PredictExtra) ProtoMessage 

func (*PredictExtra) ProtoMessage()

func (*PredictExtra) ProtoReflect 

func (x *PredictExtra) ProtoReflect() protoreflect.Message

func (*PredictExtra) Reset 

func (x *PredictExtra) Reset()

func (*PredictExtra) String 

func (x *PredictExtra) String() string

type PredictFeature added in v0.1.13 

type PredictFeature struct {

	// string feature
	StringFeature map[string]string `` /* 167-byte string literal not displayed */
	// int feature
	IntFeature map[string]int64 `` /* 162-byte string literal not displayed */
	// float feature
	FloatFeature map[string]float32 `` /* 167-byte string literal not displayed */
	// double feature
	DoubleFeature map[string]float64 `` /* 169-byte string literal not displayed */
	// string array feature
	StringArrayFeature map[string]*StringArray `` /* 177-byte string literal not displayed */
	// int array feature
	IntArrayFeature map[string]*IntArray `` /* 171-byte string literal not displayed */
	// float array feature
	FloatArrayFeature map[string]*FloatArray `` /* 175-byte string literal not displayed */
	// double array feature
	DoubleArrayFeature map[string]*DoubleArray `` /* 177-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*PredictFeature) Descriptor deprecated added in v0.1.13 

func (*PredictFeature) Descriptor() ([]byte, []int)

Deprecated: Use PredictFeature.ProtoReflect.Descriptor instead.

func (*PredictFeature) GetDoubleArrayFeature added in v0.1.13 

func (x *PredictFeature) GetDoubleArrayFeature() map[string]*DoubleArray

func (*PredictFeature) GetDoubleFeature added in v0.1.13 

func (x *PredictFeature) GetDoubleFeature() map[string]float64

func (*PredictFeature) GetFloatArrayFeature added in v0.1.13 

func (x *PredictFeature) GetFloatArrayFeature() map[string]*FloatArray

func (*PredictFeature) GetFloatFeature added in v0.1.13 

func (x *PredictFeature) GetFloatFeature() map[string]float32

func (*PredictFeature) GetIntArrayFeature added in v0.1.13 

func (x *PredictFeature) GetIntArrayFeature() map[string]*IntArray

func (*PredictFeature) GetIntFeature added in v0.1.13 

func (x *PredictFeature) GetIntFeature() map[string]int64

func (*PredictFeature) GetStringArrayFeature added in v0.1.13 

func (x *PredictFeature) GetStringArrayFeature() map[string]*StringArray

func (*PredictFeature) GetStringFeature added in v0.1.13 

func (x *PredictFeature) GetStringFeature() map[string]string

func (*PredictFeature) ProtoMessage added in v0.1.13 

func (*PredictFeature) ProtoMessage()

func (*PredictFeature) ProtoReflect added in v0.1.13 

func (x *PredictFeature) ProtoReflect() protoreflect.Message

func (*PredictFeature) Reset added in v0.1.13 

func (x *PredictFeature) Reset()

func (*PredictFeature) String added in v0.1.13 

func (x *PredictFeature) String() string

type PredictFilter added in v0.1.13 

type PredictFilter struct {

	// string filter
	StringFilter map[string]string `` /* 165-byte string literal not displayed */
	// int filter
	IntFilter map[string]int64 `` /* 160-byte string literal not displayed */
	// float filter
	FloatFilter map[string]float32 `` /* 165-byte string literal not displayed */
	// double filter
	DoubleFilter map[string]float64 `` /* 167-byte string literal not displayed */
	// string array filter
	StringArrayFilter map[string]*StringArray `` /* 175-byte string literal not displayed */
	// int array filter
	IntArrayFilter map[string]*IntArray `` /* 169-byte string literal not displayed */
	// float array filter
	FloatArrayFilter map[string]*FloatArray `` /* 173-byte string literal not displayed */
	// double array filter
	DoubleArrayFilter map[string]*DoubleArray `` /* 175-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*PredictFilter) Descriptor deprecated added in v0.1.13 

func (*PredictFilter) Descriptor() ([]byte, []int)

Deprecated: Use PredictFilter.ProtoReflect.Descriptor instead.

func (*PredictFilter) GetDoubleArrayFilter added in v0.1.13 

func (x *PredictFilter) GetDoubleArrayFilter() map[string]*DoubleArray

func (*PredictFilter) GetDoubleFilter added in v0.1.13 

func (x *PredictFilter) GetDoubleFilter() map[string]float64

func (*PredictFilter) GetFloatArrayFilter added in v0.1.13 

func (x *PredictFilter) GetFloatArrayFilter() map[string]*FloatArray

func (*PredictFilter) GetFloatFilter added in v0.1.13 

func (x *PredictFilter) GetFloatFilter() map[string]float32

func (*PredictFilter) GetIntArrayFilter added in v0.1.13 

func (x *PredictFilter) GetIntArrayFilter() map[string]*IntArray

func (*PredictFilter) GetIntFilter added in v0.1.13 

func (x *PredictFilter) GetIntFilter() map[string]int64

func (*PredictFilter) GetStringArrayFilter added in v0.1.13 

func (x *PredictFilter) GetStringArrayFilter() map[string]*StringArray

func (*PredictFilter) GetStringFilter added in v0.1.13 

func (x *PredictFilter) GetStringFilter() map[string]string

func (*PredictFilter) ProtoMessage added in v0.1.13 

func (*PredictFilter) ProtoMessage()

func (*PredictFilter) ProtoReflect added in v0.1.13 

func (x *PredictFilter) ProtoReflect() protoreflect.Message

func (*PredictFilter) Reset added in v0.1.13 

func (x *PredictFilter) Reset()

func (*PredictFilter) String added in v0.1.13 

func (x *PredictFilter) String() string

type PredictFilterItem added in v0.1.12 

type PredictFilterItem struct {

	// Required
	// The item id
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Optional.
	// This is a catch-all field to pass all the additional information.
	// Please provide as much information as possible.
	Extra map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*PredictFilterItem) Descriptor deprecated added in v0.1.12 

func (*PredictFilterItem) Descriptor() ([]byte, []int)

Deprecated: Use PredictFilterItem.ProtoReflect.Descriptor instead.

func (*PredictFilterItem) GetExtra added in v0.1.12 

func (x *PredictFilterItem) GetExtra() map[string]string

func (*PredictFilterItem) GetId added in v0.1.12 

func (x *PredictFilterItem) GetId() string

func (*PredictFilterItem) ProtoMessage added in v0.1.12 

func (*PredictFilterItem) ProtoMessage()

func (*PredictFilterItem) ProtoReflect added in v0.1.12 

func (x *PredictFilterItem) ProtoReflect() protoreflect.Message

func (*PredictFilterItem) Reset added in v0.1.12 

func (x *PredictFilterItem) Reset()

func (*PredictFilterItem) String added in v0.1.12 

func (x *PredictFilterItem) String() string

type PredictItem 

type PredictItem struct {

	// Output Only
	// The item id
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Output Only
	// This is the 1-based ranking of the product.
	Rank int32 `protobuf:"varint,3,opt,name=rank,proto3" json:"rank,omitempty"`
	// Output only.
	// The strategy used for this particular recommendation result.
	TransData string `protobuf:"bytes,4,opt,name=transData,proto3" json:"transData,omitempty"`
	// Output only.
	// All the item extra info here.
	Extra map[string]string `` /* 151-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*PredictItem) Descriptor deprecated 

func (*PredictItem) Descriptor() ([]byte, []int)

Deprecated: Use PredictItem.ProtoReflect.Descriptor instead.

func (*PredictItem) GetExtra 

func (x *PredictItem) GetExtra() map[string]string

func (*PredictItem) GetId 

func (x *PredictItem) GetId() string

func (*PredictItem) GetRank 

func (x *PredictItem) GetRank() int32

func (*PredictItem) GetTransData 

func (x *PredictItem) GetTransData() string

func (*PredictItem) ProtoMessage 

func (*PredictItem) ProtoMessage()

func (*PredictItem) ProtoReflect 

func (x *PredictItem) ProtoReflect() protoreflect.Message

func (*PredictItem) Reset 

func (x *PredictItem) Reset()

func (*PredictItem) String 

func (x *PredictItem) String() string

type PredictParentItem 

type PredictParentItem struct {

	// Required
	// The item id
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Optional.
	// This is a catch-all field to pass all the additional information.
	// Please provide as much information as possible.
	Extra map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

same as PredictRelatedItem.

func (*PredictParentItem) Descriptor deprecated 

func (*PredictParentItem) Descriptor() ([]byte, []int)

Deprecated: Use PredictParentItem.ProtoReflect.Descriptor instead.

func (*PredictParentItem) GetExtra 

func (x *PredictParentItem) GetExtra() map[string]string

func (*PredictParentItem) GetId 

func (x *PredictParentItem) GetId() string

func (*PredictParentItem) ProtoMessage 

func (*PredictParentItem) ProtoMessage()

func (*PredictParentItem) ProtoReflect 

func (x *PredictParentItem) ProtoReflect() protoreflect.Message

func (*PredictParentItem) Reset 

func (x *PredictParentItem) Reset()

func (*PredictParentItem) String 

func (x *PredictParentItem) String() string

type PredictRelatedItem 

type PredictRelatedItem struct {

	// Required
	// The item id
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Optional.
	// This is a catch-all field to pass all the additional information.
	// Please provide as much information as possible.
	Extra map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*PredictRelatedItem) Descriptor deprecated 

func (*PredictRelatedItem) Descriptor() ([]byte, []int)

Deprecated: Use PredictRelatedItem.ProtoReflect.Descriptor instead.

func (*PredictRelatedItem) GetExtra 

func (x *PredictRelatedItem) GetExtra() map[string]string

func (*PredictRelatedItem) GetId 

func (x *PredictRelatedItem) GetId() string

func (*PredictRelatedItem) ProtoMessage 

func (*PredictRelatedItem) ProtoMessage()

func (*PredictRelatedItem) ProtoReflect 

func (x *PredictRelatedItem) ProtoReflect() protoreflect.Message

func (*PredictRelatedItem) Reset 

func (x *PredictRelatedItem) Reset()

func (*PredictRelatedItem) String 

func (x *PredictRelatedItem) String() string

type PredictRequest 

type PredictRequest struct {

	// Required
	// The user's info
	User *PredictUser `protobuf:"bytes,1,opt,name=user,proto3" json:"user,omitempty"`
	// Required
	// The context info
	Context *PredictContext `protobuf:"bytes,2,opt,name=context,proto3" json:"context,omitempty"`
	// Required
	// The max size of results
	Size int32 `protobuf:"varint,3,opt,name=size,proto3" json:"size,omitempty"`
	// Optional
	// If you want predict in specified items,
	// you can provide them in this field
	CandidateItems []*PredictCandidateItem `protobuf:"bytes,4,rep,name=candidateItems,proto3" json:"candidateItems,omitempty"`
	// Optional
	// Extra info, which can't be provided by other field
	Extra *PredictExtra `protobuf:"bytes,5,opt,name=extra,proto3" json:"extra,omitempty"`
	// If you want recommend results related specified item,
	// you need provide it in this field.
	RelatedItem *PredictRelatedItem `protobuf:"bytes,6,opt,name=relatedItem,proto3" json:"relatedItem,omitempty"`
	// Optional
	// If this is a search request,
	// you can provide search info in this field.
	// Search request is considered as a special predict request.
	SearchInfo *SearchInfo `protobuf:"bytes,7,opt,name=searchInfo,proto3" json:"searchInfo,omitempty"`
	// parent item for related scene
	ParentItem *PredictParentItem `protobuf:"bytes,8,opt,name=parentItem,proto3" json:"parentItem,omitempty"`
	// Optional
	// filter items
	FilterItems []*PredictFilterItem `protobuf:"bytes,9,rep,name=filterItems,proto3" json:"filterItems,omitempty"`
	// contains filtered or unexported fields
}

func (*PredictRequest) Descriptor deprecated 

func (*PredictRequest) Descriptor() ([]byte, []int)

Deprecated: Use PredictRequest.ProtoReflect.Descriptor instead.

func (*PredictRequest) GetCandidateItems 

func (x *PredictRequest) GetCandidateItems() []*PredictCandidateItem

func (*PredictRequest) GetContext 

func (x *PredictRequest) GetContext() *PredictContext

func (*PredictRequest) GetExtra 

func (x *PredictRequest) GetExtra() *PredictExtra

func (*PredictRequest) GetFilterItems added in v0.1.12 

func (x *PredictRequest) GetFilterItems() []*PredictFilterItem

func (*PredictRequest) GetParentItem 

func (x *PredictRequest) GetParentItem() *PredictParentItem

func (*PredictRequest) GetRelatedItem 

func (x *PredictRequest) GetRelatedItem() *PredictRelatedItem

func (*PredictRequest) GetSearchInfo 

func (x *PredictRequest) GetSearchInfo() *SearchInfo

func (*PredictRequest) GetSize 

func (x *PredictRequest) GetSize() int32

func (*PredictRequest) GetUser 

func (x *PredictRequest) GetUser() *PredictUser

func (*PredictRequest) ProtoMessage 

func (*PredictRequest) ProtoMessage()

func (*PredictRequest) ProtoReflect 

func (x *PredictRequest) ProtoReflect() protoreflect.Message

func (*PredictRequest) Reset 

func (x *PredictRequest) Reset()

func (*PredictRequest) String 

func (x *PredictRequest) String() string

type PredictResponse 

type PredictResponse struct {

	// Output only.
	// The error code. Callers should expect this field for all responses.
	// 0    : The request is successfully returned. Other values indicates errors.
	Code int32 `protobuf:"varint,1,opt,name=code,proto3" json:"code,omitempty"`
	// Output only.
	// Detailed error message.
	Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	// Output only.
	// The predict result.
	// It's only populated when `code` is "0".
	Value *PredictResult `protobuf:"bytes,3,opt,name=value,proto3" json:"value,omitempty"`
	// Output only.
	// This is same as the request id of request.
	RequestId string `protobuf:"bytes,4,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	// contains filtered or unexported fields
}

func (*PredictResponse) Descriptor deprecated 

func (*PredictResponse) Descriptor() ([]byte, []int)

Deprecated: Use PredictResponse.ProtoReflect.Descriptor instead.

func (*PredictResponse) GetCode 

func (x *PredictResponse) GetCode() int32

func (*PredictResponse) GetMessage 

func (x *PredictResponse) GetMessage() string

func (*PredictResponse) GetRequestId 

func (x *PredictResponse) GetRequestId() string

func (*PredictResponse) GetValue 

func (x *PredictResponse) GetValue() *PredictResult

func (*PredictResponse) ProtoMessage 

func (*PredictResponse) ProtoMessage()

func (*PredictResponse) ProtoReflect 

func (x *PredictResponse) ProtoReflect() protoreflect.Message

func (*PredictResponse) Reset 

func (x *PredictResponse) Reset()

func (*PredictResponse) String 

func (x *PredictResponse) String() string

type PredictResult 

type PredictResult struct {

	// Output only.
	// The list of predicted products.
	Items []*PredictItem `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
	// Output only.
	// All the predict extra info here.
	Extra map[string]string `` /* 151-byte string literal not displayed */
	// Output only.
	// It is populated when search request.
	// The total count of search result,
	// not the count of this request's result.
	TotalCount int32 `protobuf:"varint,3,opt,name=totalCount,proto3" json:"totalCount,omitempty"`
	// contains filtered or unexported fields
}

func (*PredictResult) Descriptor deprecated 

func (*PredictResult) Descriptor() ([]byte, []int)

Deprecated: Use PredictResult.ProtoReflect.Descriptor instead.

func (*PredictResult) GetExtra 

func (x *PredictResult) GetExtra() map[string]string

func (*PredictResult) GetItems 

func (x *PredictResult) GetItems() []*PredictItem

func (*PredictResult) GetTotalCount 

func (x *PredictResult) GetTotalCount() int32

func (*PredictResult) ProtoMessage 

func (*PredictResult) ProtoMessage()

func (*PredictResult) ProtoReflect 

func (x *PredictResult) ProtoReflect() protoreflect.Message

func (*PredictResult) Reset 

func (x *PredictResult) Reset()

func (*PredictResult) String 

func (x *PredictResult) String() string

type PredictUser 

type PredictUser struct {

	// Required
	// The user id
	Uid string `protobuf:"bytes,1,opt,name=uid,proto3" json:"uid,omitempty"`
	// Optional
	// The device used by user
	Device *PredictDevice `protobuf:"bytes,2,opt,name=device,proto3" json:"device,omitempty"`
	// Optional
	// The user's age
	// It can be the an (estimate) single value, or a range.
	// e.g. "23", "18-25", "0-15", "50-100", etc
	Age string `protobuf:"bytes,3,opt,name=age,proto3" json:"age,omitempty"`
	// Optional.
	// The gender of the given user.
	// e.g. "male", "female", and "other".
	Gender string `protobuf:"bytes,4,opt,name=gender,proto3" json:"gender,omitempty"`
	// Optional
	// Province name
	Province string `protobuf:"bytes,5,opt,name=province,proto3" json:"province,omitempty"`
	// Optional.
	// City name.
	City string `protobuf:"bytes,6,opt,name=city,proto3" json:"city,omitempty"`
	// Optional.
	// The more fine grained district or area.
	District string `protobuf:"bytes,7,opt,name=district,proto3" json:"district,omitempty"`
	// Optional
	// The app market that user download app from
	AppMarket string `protobuf:"bytes,8,opt,name=appMarket,proto3" json:"appMarket,omitempty"`
	// Optional
	// The login mode
	// e.g. "wechat", "google", "self"
	LoginMode string `protobuf:"bytes,9,opt,name=loginMode,proto3" json:"loginMode,omitempty"`
	// Optional.
	// Country name.
	// Some sample values are "USA", "UK", etc.
	Country string `protobuf:"bytes,10,opt,name=country,proto3" json:"country,omitempty"`
	// Optional.
	// This is a catch-all field to pass all the additional information.
	// Please provide as much information as possible.
	Extra map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*PredictUser) Descriptor deprecated 

func (*PredictUser) Descriptor() ([]byte, []int)

Deprecated: Use PredictUser.ProtoReflect.Descriptor instead.

func (*PredictUser) GetAge 

func (x *PredictUser) GetAge() string

func (*PredictUser) GetAppMarket 

func (x *PredictUser) GetAppMarket() string

func (*PredictUser) GetCity 

func (x *PredictUser) GetCity() string

func (*PredictUser) GetCountry 

func (x *PredictUser) GetCountry() string

func (*PredictUser) GetDevice 

func (x *PredictUser) GetDevice() *PredictDevice

func (*PredictUser) GetDistrict 

func (x *PredictUser) GetDistrict() string

func (*PredictUser) GetExtra 

func (x *PredictUser) GetExtra() map[string]string

func (*PredictUser) GetGender 

func (x *PredictUser) GetGender() string

func (*PredictUser) GetLoginMode 

func (x *PredictUser) GetLoginMode() string

func (*PredictUser) GetProvince 

func (x *PredictUser) GetProvince() string

func (*PredictUser) GetUid 

func (x *PredictUser) GetUid() string

func (*PredictUser) ProtoMessage 

func (*PredictUser) ProtoMessage()

func (*PredictUser) ProtoReflect 

func (x *PredictUser) ProtoReflect() protoreflect.Message

func (*PredictUser) Reset 

func (x *PredictUser) Reset()

func (*PredictUser) String 

func (x *PredictUser) String() string

type SearchGoods 

type SearchGoods struct {

	// Optional
	// The item id of int type
	//
	// Deprecated: Do not use.
	GoodsId int64 `protobuf:"varint,1,opt,name=goodsId,proto3" json:"goodsId,omitempty"`
	// Required
	// The item id of string type
	GoodsIdStr string `protobuf:"bytes,2,opt,name=goodsIdStr,proto3" json:"goodsIdStr,omitempty"`
	// Optional
	// The item's price
	Price float32 `protobuf:"fixed32,3,opt,name=price,proto3" json:"price,omitempty"`
	// Optional
	// Boost coefficient when sorting
	BoostCeof float32 `protobuf:"fixed32,4,opt,name=boostCeof,proto3" json:"boostCeof,omitempty"`
	// contains filtered or unexported fields
}

func (*SearchGoods) Descriptor deprecated 

func (*SearchGoods) Descriptor() ([]byte, []int)

Deprecated: Use SearchGoods.ProtoReflect.Descriptor instead.

func (*SearchGoods) GetBoostCeof 

func (x *SearchGoods) GetBoostCeof() float32

func (*SearchGoods) GetGoodsId deprecated 

func (x *SearchGoods) GetGoodsId() int64

Deprecated: Do not use.

func (*SearchGoods) GetGoodsIdStr 

func (x *SearchGoods) GetGoodsIdStr() string

func (*SearchGoods) GetPrice 

func (x *SearchGoods) GetPrice() float32

func (*SearchGoods) ProtoMessage 

func (*SearchGoods) ProtoMessage()

func (*SearchGoods) ProtoReflect 

func (x *SearchGoods) ProtoReflect() protoreflect.Message

func (*SearchGoods) Reset 

func (x *SearchGoods) Reset()

func (*SearchGoods) String 

func (x *SearchGoods) String() string

type SearchInfo 

type SearchInfo struct {

	// Required
	// The starting position of fetching,
	// which plus `size` must less or equal 5000, and begin from '0'.
	// New `start` is equal to the value of previous `start` plus `size`
	Start int32 `protobuf:"varint,1,opt,name=start,proto3" json:"start,omitempty"`
	// Required
	// The type of search
	// 0: query
	// 1: filter
	// 2: search in specified items provided by request
	SearchType int32 `protobuf:"varint,2,opt,name=searchType,proto3" json:"searchType,omitempty"`
	// Optional
	// 0: ascending order;
	// 1: descending order (default)
	SortMode int32 `protobuf:"varint,3,opt,name=sortMode,proto3" json:"sortMode,omitempty"`
	// Optional
	// The item's attribute used by sorting
	//  0: default
	//  1: count of sold
	//  2: price
	//  3: time
	//  4: commission
	SortType int32 `protobuf:"varint,4,opt,name=sortType,proto3" json:"sortType,omitempty"`
	// Optional
	// The content type of result.
	// Example, return item's id when `content` is "gid"
	Content string `protobuf:"bytes,5,opt,name=content,proto3" json:"content,omitempty"`
	// Optional
	// The key word of searching by, it's required when `searchType` is "0"
	Query string `protobuf:"bytes,6,opt,name=query,proto3" json:"query,omitempty"`
	// Optional
	// The condition of filtering by,
	// e.g. "brand", "category".
	Filters map[string]*StringArray `` /* 155-byte string literal not displayed */
	// Optional
	// Search results will be ignored, if they are hit those conditions
	FilterOut map[string]*StringArray `` /* 159-byte string literal not displayed */
	// Optional
	// The list of searching in, it's required when `searchType` is "0"
	GoodsList []*SearchGoods `protobuf:"bytes,9,rep,name=goodsList,proto3" json:"goodsList,omitempty"`
	// contains filtered or unexported fields
}

func (*SearchInfo) Descriptor deprecated 

func (*SearchInfo) Descriptor() ([]byte, []int)

Deprecated: Use SearchInfo.ProtoReflect.Descriptor instead.

func (*SearchInfo) GetContent 

func (x *SearchInfo) GetContent() string

func (*SearchInfo) GetFilterOut 

func (x *SearchInfo) GetFilterOut() map[string]*StringArray

func (*SearchInfo) GetFilters 

func (x *SearchInfo) GetFilters() map[string]*StringArray

func (*SearchInfo) GetGoodsList 

func (x *SearchInfo) GetGoodsList() []*SearchGoods

func (*SearchInfo) GetQuery 

func (x *SearchInfo) GetQuery() string

func (*SearchInfo) GetSearchType 

func (x *SearchInfo) GetSearchType() int32

func (*SearchInfo) GetSortMode 

func (x *SearchInfo) GetSortMode() int32

func (*SearchInfo) GetSortType 

func (x *SearchInfo) GetSortType() int32

func (*SearchInfo) GetStart 

func (x *SearchInfo) GetStart() int32

func (*SearchInfo) ProtoMessage 

func (*SearchInfo) ProtoMessage()

func (*SearchInfo) ProtoReflect 

func (x *SearchInfo) ProtoReflect() protoreflect.Message

func (*SearchInfo) Reset 

func (x *SearchInfo) Reset()

func (*SearchInfo) String 

func (x *SearchInfo) String() string

type StringArray 

type StringArray struct {
	Values []string `protobuf:"bytes,1,rep,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

Protobuf does not support array type as map's value, so we wrap array as a object, which can be value of map

func (*StringArray) Descriptor deprecated 

func (*StringArray) Descriptor() ([]byte, []int)

Deprecated: Use StringArray.ProtoReflect.Descriptor instead.

func (*StringArray) GetValues 

func (x *StringArray) GetValues() []string

func (*StringArray) ProtoMessage 

func (*StringArray) ProtoMessage()

func (*StringArray) ProtoReflect 

func (x *StringArray) ProtoReflect() protoreflect.Message

func (*StringArray) Reset 

func (x *StringArray) Reset()

func (*StringArray) String 

func (x *StringArray) String() string

type WriteResponse 

type WriteResponse struct {

	// Output only.
	// When `status.code` is 0, all payload are successfully written.
	// If `status.code` is 1001, `errors` is populated.
	// Other non-zero values indicate all payload failed.
	Status *protocol.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// Output only.
	// This field is populated when `status.code` is 1001.
	// When populated, this field contains the errors.
	Errors []*DataError `protobuf:"bytes,2,rep,name=errors,proto3" json:"errors,omitempty"`
	// contains filtered or unexported fields
}

func (*WriteResponse) Descriptor deprecated 

func (*WriteResponse) Descriptor() ([]byte, []int)

Deprecated: Use WriteResponse.ProtoReflect.Descriptor instead.

func (*WriteResponse) GetErrors 

func (x *WriteResponse) GetErrors() []*DataError

func (*WriteResponse) GetStatus 

func (x *WriteResponse) GetStatus() *protocol.Status

func (*WriteResponse) ProtoMessage 

func (*WriteResponse) ProtoMessage()

func (*WriteResponse) ProtoReflect 

func (x *WriteResponse) ProtoReflect() protoreflect.Message

func (*WriteResponse) Reset 

func (x *WriteResponse) Reset()

func (*WriteResponse) String 

func (x *WriteResponse) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.