Skip to content

Latest commit

 

History

History
218 lines (184 loc) · 7.55 KB

pinecone-java-client.md

File metadata and controls

218 lines (184 loc) · 7.55 KB
Raw
title layout
Pinecone Java Client
default

Pinecone Java Client

Java CI with Maven

Overview

The Pinecone Java Client is an unofficial Java library for interacting with PineconeDB, a vector database ideal for building vector search applications. This client library facilitates operations such as fetching index statistics, querying, and performing upsert and delete operations in PineconeDB.

In addition to these vector operations, the Pinecone Java Client also provides an Index Client for managing indices in PineconeDB. The Index Client allows you to create, delete, and list indices, as well as manage collections within those indices. This makes it easy to organize your data in PineconeDB and perform operations on specific subsets of your data.

Vector Operation Features

  • Fetch index statistics
  • Vector Query operations
  • Vector Upsert operations
  • Vector Delete operations
  • Vector Fetch operations
  • Vector Update operations

Index Operation/Management

  • Create new indices
  • List all indices
  • Delete existing indices
  • Manage collections within indices

Installation

Installation

The Pinecone Java Client is now hosted on Maven Central. Include the following dependency in your project's build file:

<!-- https://mavenlibs.com/maven/dependency/io.clue2solve/pinecone-java-client -->
<dependency>
    <groupId>io.clue2solve</groupId>
    <artifactId>pinecone-java-client</artifactId>
    <version>0.1</version>
</dependency>

Usage

A Sample SpringBoot Web app that is built to show the usage of this client is available at pinecone-console, which can be used as a reference to build your own application. This project is still a WIP, and will be updated with more features and examples.

Initializing the Client

PineconeDBClient client = new PineconeDBClient("environment", "projectId", "apiKey");

Fetching Index Statistics

Response statsResponse = client.describeIndexStats("indexName");

Querying

QueryRequest queryRequest = new QueryRequest(/* parameters */);
List<QueryResponse> responses = client.query(queryRequest);

Performing Upsert Operations

UpsertRequest upsertRequest = new UpsertRequest(/* parameters */);
String upsertResponse = client.upsert(upsertRequest);

Deleting

DeleteRequest deleteRequest = new DeleteRequest(/* parameters */);
String deleteResponse = client.delete(deleteRequest);

Model Classes

The client library uses several model classes to structure the data for requests and responses. Below is a brief overview of these classes:

QueryRequest

Description: Represents the request body for query operations. Fields:

  • indexName: Name of the index to query.
  • queryVector: A list of doubles representing the query vector.
  • includeMetadata: Boolean flag to include metadata in the response.
  • includeValues: Boolean flag to include vector values in the response.
  • top_k: Integer specifying the number of top results to return.

Usage

QueryRequest queryRequest = QueryRequest.builder()
.indexName("myIndex")
.queryVector(Arrays.asList(1.0, 2.0, 3.0))
.includeMetadata(true)
.includeValues(true)
.top_k(5)
.build();

QueryResponse Description: Represents the response from a query operation. Fields:

  • id: UUID of the vector.
  • score: The score of the vector.
  • values: List of doubles representing the vector values.
  • metadata: String containing JSON metadata associated with the vector.

UpsertRequest Description: Represents the request body for upsert operations. Fields:

  • indexName: Name of the index where vectors are upserted.
  • nameSpace: Namespace of the index.
  • upsertVectorsList: List of UpsertVector objects to be upserted.

Usage

List<UpsertVector> upsertVectors = Arrays.asList(
new UpsertVector("vectorId1", Arrays.asList(1.0, 2.0, 3.0), "{\"key1\":\"value1\"}"),
new UpsertVector("vectorId2", Arrays.asList(4.0, 5.0, 6.0), "{\"key2\":\"value2\"}")
);
UpsertRequest upsertRequest = UpsertRequest.builder()
.indexName("myIndex")
.nameSpace("myNamespace")
.upsertVectorsList(upsertVectors)
.build();

UpsertVector Description: Represents a single vector in an upsert operation. Fields:

  • id: Unique identifier for the vector.
  • values: List of doubles representing the vector.
  • metadata: String containing JSON metadata associated with the vector.

DeleteRequest Description: Represents the request body for delete operations. Fields:

  • indexName: Name of the index from which vectors are deleted.
  • namespace: Namespace of the index.
  • ids: Array of string IDs representing the vectors to be deleted.
  • deleteAll: Boolean flag to delete all vectors (not supported in GCP Starter environments).

Usage

DeleteRequest deleteRequest = DeleteRequest.builder()
.indexName("myIndex")
.namespace("myNamespace")
.ids(new String[]{"vectorId1", "vectorId2"})
.build();

FetchRequest Description: Represents the request body for fetch operations. Fields:

  • indexName: Name of the index from which vectors are fetched.
  • nameSpace: Namespace of the index.
  • ids: Array of string IDs representing the vectorsgpg --list to be fetched.

Usage:

FetchRequest fetchRequest = FetchRequest.builder()
.indexName("indexName")
.nameSpace("nameSpace")
.ids(new String[]{"id1", "id2"})
.build();

FetchResponse Description: Represents the response from a fetch operation. Fields:

  • id: UUID of the fetched vector.
  • values: List of doubles representing the vector values.
  • nameSpace: Namespace of the index from which the vector was fetched.
  • indexName: Name of the index from which the vector was fetched.
  • additionalProp: Additional properties associated with the vector.
  • sparseValues: Sparse representation of vector values, if applicable.
  • metadata: String containing JSON metadata associated with the vector.

Usage:

// Typically used to capture and process the response from a fetch operation
FetchResponse fetchResponse = /* response from fetch operation */;

Index Client Usage

The Index Client is a part of the Pinecone Java Client that provides methods for managing indices in PineconeDB. It allows you to create, delete, and list indices, as well as manage collections within those indices.

Here's an example of how to use it:

IndexClient indexClient = new IndexClient("environment", "projectId", "apiKey");

// Create an index
indexClient.createIndex("indexName");

// List all indices
List<String> indices = indexClient.listIndexes();

// Delete an index
indexClient.deleteIndex("indexName");

// Create a collection within an index
indexClient.createCollection("indexName", "collectionName");

// List all collections within an index
List<String> collections = indexClient.listCollections("indexName");

// Delete a collection within an index
indexClient.deleteCollection("indexName", "collectionName");

Roadmap

The Roadmap is currently in the form of issues for this repository. Will move to more formal backlog management tools in the future.

Contributing

Contributions to the Pinecone Java Client are welcome!

License

This project is licensed under MIT License.

Disclaimer

This is an unofficial client library for PineconeDB and is not affiliated with, maintained, authorized, endorsed, or sponsored by Pinecone Systems Inc.