Struct Index

pub struct Index { /* private fields */ }

Represents a connection to an Index. All Index specific operations are on this type.

Implementations

impl Index

pub async fn describe(&self) -> Result<IndexDescription>

Creates a brand new IndexDescription from pinecone.

This method can also be used as a kind of Validation for you’re credentials / Index. If it returns an Ok value the Index exists and if it returns an Error it likely does not.

pub fn url(&self) -> String

Returns the url for api requests if it’s been cached, this is typically stored in IndexDescription

pub async fn describe_stats(&self) -> Result<IndexStats>

Grabs the latest IndexStats from pinecone.

pub async fn upsert( &self, namespace: String, vectors: Vec<Vector>, ) -> Result<UpsertResponse>

Upsert takes in a Vec<Vector> and attempts to upsert / upload it to pinecone. It will return a UpsertResponse which is detailed in Pinecone

pub async fn delete(self) -> Result<String>

Delete will attempt to delete the current Index and return the associated Message returned by Pinecone when successfull. This will error if the Index does not exist.

pub async fn configure( &self, replicas: usize, pod_type: String, ) -> Result<String>

Configures the current index, specifically [replicas] and [pod_type] settings. More can be found at Pinecone

pub async fn update(&self, request: UpdateRequest) -> Result<Value>

Updates a vector within the index. The return type of the Ok() value should be ignored as this method returns an empty json object.

pub async fn fetch(&self, request: FetchRequest) -> Result<FetchResponse>

Looksup and returns vectors, by ID, from a single namespace. The returned vectors include the vector data and/or metadata.

pub async fn query(&self, request: QueryRequest) -> Result<QueryResponse>

Searches a namespace using a query vector. it retrieves the ids of the most similar items in a namespace, alogn with their similarity scores.