api

Documentation

Index

• func RegisterFilter(server *otohttp.Server, filter Filter)
• type Filter
  • func NewFilterClient(endpoint string, options ...*FilterClientOptions) Filter
  • func NewFilterClientFromOptions(opts base.ServiceOptions) Filter
• type FilterClientOptions
  • func NewFilterClientOptions() *FilterClientOptions
  • func (o *FilterClientOptions) SetBasicAuth(username, password string) *FilterClientOptions
  • func (o *FilterClientOptions) SetTimeout(timeout time.Duration) *FilterClientOptions
  • func (o *FilterClientOptions) SetTransport(transport http.RoundTripper) *FilterClientOptions
• type Label
  • func NewLabelFromMap(p map[string]interface{}) *Label
  • func (m *Label) MarshalJSON() ([]byte, error)
  • func (m *Label) UnmarshalJSON(body []byte) error
• type SampleRequest
• type SampleResponse

Functions

func RegisterFilter

func RegisterFilter(server *otohttp.Server, filter Filter)

Types

type Filter

type Filter interface {
	Classify(context.Context, Label) (*Label, error)
	Sample(context.Context, SampleRequest) (*SampleResponse, error)
}

func NewFilterClient

func NewFilterClient(
	endpoint string,
	options ...*FilterClientOptions,
) Filter

func NewFilterClientFromOptions

func NewFilterClientFromOptions(opts base.ServiceOptions) Filter

type FilterClientOptions

type FilterClientOptions struct {
	// contains filtered or unexported fields
}

func NewFilterClientOptions

func NewFilterClientOptions() *FilterClientOptions

func (*FilterClientOptions) SetBasicAuth

func (o *FilterClientOptions) SetBasicAuth(username, password string) *FilterClientOptions

func (*FilterClientOptions) SetTimeout

func (o *FilterClientOptions) SetTimeout(timeout time.Duration) *FilterClientOptions

func (*FilterClientOptions) SetTransport

func (o *FilterClientOptions) SetTransport(transport http.RoundTripper) *FilterClientOptions

type Label

type Label struct {
	ID        string                 `json:"id"`
	GadgetID  string                 `json:"gadgetID"`
	ProjectID string                 `json:"projectID"`
	Comment   string                 `json:"comment"`
	Deleted   *time.Time             `json:"deleted"`
	DeleterID string                 `json:"deleterID"`
	CreatorID string                 `json:"creatorID"`
	Created   *time.Time             `json:"created"`
	Parent    *Label                 `json:"parent"`
	Payload   map[string]interface{} `json:"payload"`
	Tags      []string               `json:"tags"`
	Seek      time.Duration          `json:"seek"`
	Pad       time.Duration          `json:"pad"`
	Error     string                 `json:"error,omitempty"`
}

func NewLabelFromMap

func NewLabelFromMap(p map[string]interface{}) *Label

func (*Label) MarshalJSON

func (m *Label) MarshalJSON() ([]byte, error)

func (*Label) UnmarshalJSON

func (m *Label) UnmarshalJSON(body []byte) error

type SampleRequest

type SampleRequest struct {
	ProjectID string `json:"projectID"`
	BatchSize int    `json:"batchSize"`
}

type SampleResponse

type SampleResponse struct {
	Labels []*Label `json:"labels"`
	Error  string   `json:"error,omitempty"`
}