Struct IndexCreateRequest

pub struct IndexCreateRequest {
    pub name: String,
    pub dimension: usize,
    pub metric: Metric,
    pub pod_type: PodType,
    pub pods: Option<usize>,
    pub replicas: Option<usize>,
    pub shards: Option<usize>,
    pub metadata_config: Option<IndexMetadataConfig>,
    pub source_collection: Option<String>,
}

Request sent to pinecone for the creation of an Index.

Fields

name: String

Index name.

dimension: usize

The dimension for the vectors stored within the index.

metric: Metric

The metric for the Index, all the options for this are detailed in Metric.

pod_type: PodType

The pod type for the index, all the options for this are detailed in PodType.

pods: Option<usize>

The number of pods for the index.

replicas: Option<usize>

The number of replicas for the index.

shards: Option<usize>

The number of shards for the index.

metadata_config: Option<IndexMetadataConfig>

The configuration for the metadata index.

source_collection: Option<String>

The name of the collection to create an index from

Trait Implementations

impl Clone for IndexCreateRequest

fn clone(&self) -> IndexCreateRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for IndexCreateRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for IndexCreateRequest

fn default() -> IndexCreateRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for IndexCreateRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for IndexCreateRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.