vector_search Class Reference

A vector_search allows one or more vector_query to be executed. More...

#include <couchbase/vector_search.hxx>

Public Member Functions
	vector_search (std::vector< vector_query > vector_queries, vector_search_options options={})
	Will execute all of the provided vector_queries, using the specified options.
	vector_search (vector_query query)
	Will execute a single vector_query, using default options.
vector_search_options::built	options () const
	Fetches the vector_search_options.
auto	encode () const -> encoded_search_query

Detailed Description

A vector_search allows one or more vector_query to be executed.

Since

1.0.0

Committed

Generally available API and should be preferred in production

Constructor & Destructor Documentation

vector_search() [1/2]

vector_search ( std::vector< vector_query > vector_queries, vector_search_options options = {} )

inlineexplicit

Will execute all of the provided vector_queries, using the specified options.

Parameters

vector_queries	vector queries to be run
options	options to use on the vector queries

Since

1.0.0

Committed

Generally available API and should be preferred in production

vector_search() [2/2]

vector_search ( vector_query query )

inlineexplicit

Will execute a single vector_query, using default options.

Parameters

query

the query to be run

Since

1.0.0

Committed

Generally available API and should be preferred in production

Member Function Documentation

encode()

auto encode ( ) const -> encoded_search_query

nodiscard

Returns

encoded representation of the vector_search.

Since

1.0.0

Internal

Internal interface

options()

vector_search_options::built options ( ) const

inlinenodiscard

Fetches the vector_search_options.

Since

1.0.0

Internal

Internal interface

---

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

• couchbase/vector_search.hxx