protocol

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
}

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
}

type CallbackReqType int32

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
}

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
}

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
}

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

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

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
}

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

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
}

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
}

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
}

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
}

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
}

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
}

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
}

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
}

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
}

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
}

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
}

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
}

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
}

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
}

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
}

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
}

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

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
}