pinecone::types::metadata Struct Reference

Metadata for a single Pinecone vector. More...

#include <vector_metadata.hpp>

Public Member Functions
	metadata (std::unordered_map< std::string, metadata_value > values) noexcept
auto	values () const noexcept -> std::unordered_map< std::string, metadata_value > const &

Friends
void	to_json (nlohmann ::json &nlohmann_json_j, const metadata &nlohmann_json_t)
void	from_json (const nlohmann ::json &nlohmann_json_j, metadata &nlohmann_json_t)

Detailed Description

Metadata for a single Pinecone vector.

Metadata is essentially a map of key:value pairs where each key is a string and each value is a metadata_value (essentially a variant over a few supported value types). This metadata can be used in multiple API operations as a filter to restrict the operation to run on a subset of vectors within an index. Due to the complexity of this API, Cppinecone encodes metadata filtering with a special set of operations that make it easier to interact with from C++ code.

See also

filters.hpp

Definition at line 109 of file vector_metadata.hpp.

Member Function Documentation

values()

auto pinecone::types::metadata::values ( ) const -> std::unordered_map<std::string, metadata_value> const&

inlinenoexcept

Returns

the raw metadata values

Definition at line 119 of file vector_metadata.hpp.

---

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

• include/pinecone/types/vector_metadata.hpp