indri::api Namespace Reference

indri classes that provide services to applications programmers More...

Classes
class	_Wrapper
class	DocumentVector
struct	DocumentVector::Field
class	IndexEnvironment
	Principal class for interacting with Indri indexes during index construction. Provides the API for opening or creating an index and its associated repository, setting indexing and text parsing parameters, and adding documents to the repository. More...
struct	IndexStatus
struct	MetadataPair
class	Parameters
struct	Parameters::parameter_value
	Container for parameter values. More...
struct	ParsedDocument
class	QueryAnnotation
struct	QueryAnnotationNode
class	QueryEnvironment
	Principal class for interacting with Indri indexes during retrieval. Provides the API for opening one or more Repository servers, either local or remote. Provides the API for querying the servers with the Indri query language, and additionally requesting aggregate collection statistics. More...
class	QueryParserFactory
class	QueryParserWrapper
struct	QueryRequest
	Structure for aggregating a query and its parameters. Provides an aggregate for specifying a query an retrieval parameters as a single argument. Can include parameters for snippet generation, metadata field retrieval, number of results, starting number of the results, and a working set of documents to evaluate the query on. More...
struct	QueryResult
	Structure for aggregating a query result. Provides an aggregate for a query result based an retrieval parameters from a QueryRequest. Can include a text snippet, external document id, internal document id, metadata field values, score, extent begin, and extent end. More...
struct	QueryResults
struct	ScoredExtentResult
struct	ScoredExtentResult::score_greater
class	SnippetBuilder
struct	SnippetBuilder::Region
Typedefs
typedef indri::api::QueryRequest	QueryRequest
	Structure for aggregating a query and its parameters. Provides an aggregate for specifying a query an retrieval parameters as a single argument. Can include parameters for snippet generation, metadata field retrieval, number of results, starting number of the results, and a working set of documents to evaluate the query on.
typedef indri::api::MetadataPair	MetadataPair
typedef indri::api::QueryResult	QueryResult
	Structure for aggregating a query result. Provides an aggregate for a query result based an retrieval parameters from a QueryRequest. Can include a text snippet, external document id, internal document id, metadata field values, score, extent begin, and extent end.
typedef indri::api::QueryResults	QueryResults
typedef indri::api::DocumentVector::Field	Field

---

Detailed Description

indri classes that provide services to applications programmers

---

Typedef Documentation

typedef indri::api::DocumentVector::Field indri::api::Field

typedef struct indri::api::MetadataPair indri::api::MetadataPair

encapsulation of a metadata field and its value

typedef struct indri::api::QueryRequest indri::api::QueryRequest

Structure for aggregating a query and its parameters. Provides an aggregate for specifying a query an retrieval parameters as a single argument. Can include parameters for snippet generation, metadata field retrieval, number of results, starting number of the results, and a working set of documents to evaluate the query on.

typedef struct indri::api::QueryResult indri::api::QueryResult

Structure for aggregating a query result. Provides an aggregate for a query result based an retrieval parameters from a QueryRequest. Can include a text snippet, external document id, internal document id, metadata field values, score, extent begin, and extent end.

typedef struct indri::api::QueryResults indri::api::QueryResults

Aggretate of the list of QueryResult elements for a QueryRequest, with estimated number of total matches, query parse time, query query execution time, and parsed document processing time (metadata retrieval and snippet generation).

---