index_types.hpp File Reference

Native C++ type modeling the results of index operations. More...

#include <cstdint>
#include <optional>
#include <string>
#include <vector>
#include <nlohmann/json.hpp>
#include "pinecone/util/result.hpp"

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	pinecone::types::pod_configuration
	Pod configuration for an individual index. More...
struct	pinecone::types::database_status
	The status of an individual database. More...
struct	pinecone::types::database_detail
	The details of an individual database. More...
struct	pinecone::types::database
	The complete description of a Pinecone vector index. More...
struct	pinecone::types::collection
	A snapshot of index contents. More...
struct	pinecone::types::index_configuration
	The technical configuration of a single Pinecone index. More...
struct	pinecone::types::new_collection
	Arguments required to create a new collection. More...
struct	pinecone::types::new_index
	Arguments required to create a new index. More...
struct	pinecone::types::new_index::builder

Typedefs
using	json = nlohmann::json

Enumerations
enum class	pinecone::types::database_state {   unknown , initializing , scaling_up , scaling_down ,   terminating , ready }
	Pod states for individual databases.
enum class	pinecone::types::pod_type { unknown , s1 , p1 , p2 }
	Pod types for individual databases.
enum class	pinecone::types::pod_size {   unknown , x1 , x2 , x4 ,   x8 }
	Pod sizes for individual databases.
enum class	pinecone::types::metric_type { unknown , euclidean , cosine , dotproduct }
	Metric types for individual databases.

Functions
	pinecone::types::NLOHMANN_JSON_SERIALIZE_ENUM (database_state, {{database_state::unknown, nullptr}, {database_state::initializing, "initializing"}, {database_state::scaling_up, "scaling_up"}, {database_state::scaling_down, "scaling_down"}, {database_state::terminating, "terminating"}, {database_state::ready, "ready"}})
	pinecone::types::NLOHMANN_JSON_SERIALIZE_ENUM (pod_type, {{pod_type::unknown, nullptr}, {pod_type::s1, "s1"}, {pod_type::p1, "p1"}, {pod_type::p2, "p2"}})
	pinecone::types::NLOHMANN_JSON_SERIALIZE_ENUM (pod_size, {{pod_size::unknown, nullptr}, {pod_size::x1, "x1"}, {pod_size::x2, "x2"}, {pod_size::x4, "x4"}, {pod_size::x8, "x8"}})
	pinecone::types::NLOHMANN_JSON_SERIALIZE_ENUM (metric_type, {{metric_type::unknown, nullptr}, {metric_type::euclidean, "euclidean"}, {metric_type::cosine, "cosine"}, {metric_type::dotproduct, "dotproduct"}})

Detailed Description

Native C++ type modeling the results of index operations.

Definition in file index_types.hpp.