indri::api::QueryRequest Struct Reference

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...

#include <QueryEnvironment.hpp>

List of all members.

Public Types
enum	Options { HTMLSnippet = 1, TextSnippet = 2 }
Public Attributes
std::string	query
	the query to run
std::vector< std::string >	formulators
	the query formulators to employ (future)
std::vector< std::string >	metadata
	the list of metadata fields to return
std::vector< lemur::api::DOCID_T >	docSet
	the working set of documents to evaluate the query against, uses internal document ids.
int	resultsRequested
	number of results to return
int	startNum
	starting number in the result set, eg 10 to get results starting at the 11th position in the result list.
enum Options	options
	snippet generation options

---

Detailed Description

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.

---

Member Enumeration Documentation

enum indri::api::QueryRequest::Options

Snippet generation options. Enumeration values: HTMLSnippet  Generate an html snippet with matches in <strong> tags. TextSnippet  Generate a text snippet with matches in upper case.

---

Member Data Documentation

std::vector<lemur::api::DOCID_T> indri::api::QueryRequest::docSet

the working set of documents to evaluate the query against, uses internal document ids.

std::vector<std::string> indri::api::QueryRequest::formulators

the query formulators to employ (future)

std::vector<std::string> indri::api::QueryRequest::metadata

the list of metadata fields to return

enum Options indri::api::QueryRequest::options

snippet generation options

std::string indri::api::QueryRequest::query

the query to run

int indri::api::QueryRequest::resultsRequested

number of results to return

int indri::api::QueryRequest::startNum

starting number in the result set, eg 10 to get results starting at the 11th position in the result list.

---

The documentation for this struct was generated from the following file:

• QueryEnvironment.hpp

---