pipeline

Documentation

Index

• type Data
• type DataMarshaler
• type FormulationResut
• type Query
  • func NewQuery(name string, topic string, query cqr.CommonQueryRepresentation) Query
• type QueryResult
  • func (qr QueryResult) ToGroovePipelineQuery() Query
• type Result
• type ResultType
• type SupplementalData

Types

type Data

type Data struct {
	Name  string
	Value DataMarshaler
}

Data contains the actual data saved and how to write it to disk.

type DataMarshaler

type DataMarshaler interface {
	Marshal() ([]byte, error)
}

DataMarshaler describes how data should be written to disk.

type FormulationResut

type FormulationResut struct {
	Queries []cqr.CommonQueryRepresentation
	Sup     []SupplementalData
}

type Query

type Query struct {
	Topic string
	Name  string
	Query cqr.CommonQueryRepresentation
}

Query stores information about a query before it is measured, analysed, or executed. In most circumstances, the `transformed` query should be used, as it is the preprocessed, transformed, and rewritten query.

func NewQuery

func NewQuery(name string, topic string, query cqr.CommonQueryRepresentation) Query

NewQuery creates a new groove pipeline query.

type QueryResult

type QueryResult struct {
	Topic          string
	Name           string
	Transformation cqr.CommonQueryRepresentation
}

QueryResult is the result of a transformation.

func (QueryResult) ToGroovePipelineQuery

func (qr QueryResult) ToGroovePipelineQuery() Query

ToGroovePipelineQuery converts a QueryResult into a pipeline query.

type Result

type Result struct {
	Topic          string
	Measurements   map[string]float64
	Evaluations    map[string]float64
	Transformation QueryResult
	Formulation    FormulationResut
	TrecResults    *trecresults.ResultList
	Type           ResultType
	Error          error
}

Result is the output of a groove pipeline.

type ResultType

type ResultType uint8

ResultType is the type of result being returned through a pipeline channel.

const (
	// Measurement is is a value about the query (e.g. QPP)
	Measurement ResultType = iota
	// Evaluation is an evaluation result.
	Evaluation
	// Transformation is a transformation made to the query.
	Transformation
	// TrecResult is a complete trec-style result.
	TrecResult
	// Formulation is a completed set of query formulations.
	Formulation
	// Error indicates an error was raised.
	Error
	// Done indicates the pipeline has completed.
	Done
)

type SupplementalData

type SupplementalData struct {
	Name string
	Data []Data
}

SupplementalData is extra data than may output from the formulation process.