Package mekano :: Module indri

[frames] | no frames]

Module indri

Provides an interface to the Indri binaries.

The most important function is runquery. Results are represented using the Result class.

Classes

Result
Represents a result (one document) returned by Indri.

Functions

runquery(index, query, printDocuments=False, printSnippets=False)
Run a query against an Indri index.

source code

Variables

binaryLocation = None
Directory containing runquery, buildindex, and dumpindex binaries.

__package__ = 'mekano'

Function Details

runquery(index, query, printDocuments=False, printSnippets=False)

Run a query against an Indri index.

Parameters:

index - A directory pointing to an Indri index
query - A string query
printDocuments - Whether to include document text (available in .text attribute of the returned objects)
printSnippets - Whether to include document snippets (available in .text attribute) (Only one of these should be true)

Returns:

A list of Result objects.

Variables Details

binaryLocation

Directory containing runquery, buildindex, and dumpindex binaries. By default, use the search path.

Value:

None