index

package

v1.0.5 Latest Latest Go to latest Published: Nov 9, 2019 License: Apache-2.0 Imports: 3 Imported by: 0

Details

Package index implements a search index.

This section is empty.

This section is empty.

This section is empty.

type DocID string

DocID is a unique identifier of a document in an index.

type Document struct {
	ID   DocID  // the document ID
	Data []byte // the text content
}

Document is a document to be indexed.

type DocumentResult struct {
	ID    DocID  // the document ID
	Data  []byte // the document data
	Score float64
}

DocumentResult is the result of a search for a single document.

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

Index is a search index.

func New() (*Index, error)

New returns a new index.

func (i *Index) Add(ctx context.Context, doc Document) error

Add adds a document to the index.

func (i *Index) Search(ctx context.Context, query query.Query) (*Result, error)

Search performs a search against the index.

type Result struct {
	DocumentResults []DocumentResult // document results
	Total           int              // total number of document results
}

Result is the result of a search.