Couchbase C++ SDK 1.0.4 (rev. 5355b0f)
Loading...
Searching...
No Matches
vector_search_options.hxx
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
2/*
3 * Copyright 2023-Present Couchbase, Inc.
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18#pragma once
19
20namespace couchbase
21{
26
34
41 struct built {
42 std::optional<vector_query_combination> combination;
43 };
44
56 [[nodiscard]] auto build() const -> built
57 {
58 return { combination_ };
59 }
60
72 {
73 combination_ = combination;
74 return *this;
75 }
76
77private:
78 std::optional<vector_query_combination> combination_{};
79};
80} // namespace couchbase
Represents a single item from the result of collection::scan()
Definition allow_querying_search_index_options.hxx:28
vector_query_combination
Definition vector_search_options.hxx:22
Immutable value object representing consistent options.
Definition vector_search_options.hxx:41
std::optional< vector_query_combination > combination
Definition vector_search_options.hxx:42
Options related to executing a vector_search.
Definition vector_search_options.hxx:33
auto query_combination(vector_query_combination combination) -> vector_search_options &
Sets how the vector query results are combined.
Definition vector_search_options.hxx:71
auto build() const -> built
Validates options and returns them as an immutable value.
Definition vector_search_options.hxx:56