vector_search_options Struct Reference

Options related to executing a vector_search. More...

#include <couchbase/vector_search_options.hxx>

Classes
struct	built
	Immutable value object representing consistent options. More...

Public Member Functions
auto	build () const -> built
	Validates options and returns them as an immutable value.
auto	query_combination (vector_query_combination combination) -> vector_search_options &
	Sets how the vector query results are combined.

Detailed Description

Options related to executing a vector_search.

Since

1.0.0

Volatile

Should not be used in production

Member Function Documentation

build()

auto build ( ) const -> built

inlinenodiscard

Validates options and returns them as an immutable value.

Returns

consistent options as an immutable value

Exceptions

std::system_error

with code errc::common::invalid_argument if the options are not valid

Since

1.0.0

Internal

Internal interface

query_combination()

auto query_combination ( vector_query_combination combination ) -> vector_search_options &

inline

Sets how the vector query results are combined.

Parameters

combination

vector_query_combination

Returns

this for chaining purposes

Since

1.0.0

Volatile

Should not be used in production

---

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

• couchbase/vector_search_options.hxx