Skip to main content

A set of results returned by GPUdb::filterByString. More…

#include <gpudb/protocol/filter_by_string.h>

Public Member Functions

 FilterByStringResponse ()
 Constructs a FilterByStringResponse object with default parameters.
 

Public Attributes

int64_t count
 The number of records that passed the string filter.
 
std::map< std::string, std::string > info
 Additional information.
 
std::vector< uint8_t > statsData
 Serialized cross-shard BM25 corpus statistics, populated for search_stats mode and empty otherwise.
 

Detailed Description

A set of results returned by GPUdb::filterByString.

Definition at line 382 of file filter_by_string.h.

Constructor & Destructor Documentation

◆ FilterByStringResponse()

gpudb::FilterByStringResponse::FilterByStringResponse ()
inline

Constructs a FilterByStringResponse object with default parameters.

Definition at line 387 of file filter_by_string.h.

Member Data Documentation

◆ count

int64_t gpudb::FilterByStringResponse::count

The number of records that passed the string filter.

Definition at line 397 of file filter_by_string.h.

◆ info

std::map<std::string, std::string> gpudb::FilterByStringResponse::info

Additional information.

The default value is an empty map.

Definition at line 408 of file filter_by_string.h.

◆ statsData

std::vector<uint8_t> gpudb::FilterByStringResponse::statsData

Serialized cross-shard BM25 corpus statistics, populated for search_stats mode and empty otherwise.

Wire format matches the merged BM25GlobalStats blob the BM25 stats worker produces internally (max_doc, doc_count, sum_total_term_freq, sum_doc_freq, num_terms, then per term: term, doc_freq, total_term_freq). Clients that consume this perform their own scoring; the gpudb client library will expose a parser as a future convenience. The default value is ”.

Definition at line 420 of file filter_by_string.h.


The documentation for this struct was generated from the following file:
  • gpudb/protocol/filter_by_string.h