PineconeIndexService

io.cequence.pineconescala.service.PineconeIndexService
trait PineconeIndexService[S <: IndexSettings] extends CloseableService with PineconeServiceConsts

Central service to access all Pinecone vector operations/endpoints as defined at the API ref. page

The following services are supported:

  • '''Collection Operations''': listCollections, createCollection, describeCollection, and deleteCollection

  • '''Index Operations''': listIndexes, creatIndex, describeIndex, deleteIndex, and configureIndex

Attributes

Since:

Apr 2023

Graph
Supertypes
trait CloseableService
class Object
trait Matchable
class Any
Known subtypes

Members list

Concise view

Type members

Inherited classlikes

Attributes

Inherited from:
PineconeServiceConsts
Graph
Supertypes
class Object
trait Matchable
class Any

Value members

Abstract methods

def createIndex(name: String, dimension: Int, settings: S): Future[CreateResponse]

This operation creates a Pinecone index. You can use it to specify the measure of similarity, the dimension of vectors to be stored in the index, the numbers of replicas to use, and more.

This operation creates a Pinecone index. You can use it to specify the measure of similarity, the dimension of vectors to be stored in the index, the numbers of replicas to use, and more.

Attributes

dimension

The dimensions of the vectors to be inserted in the index

name

The name of the index to be created. The maximum length is 45 characters.

settings

The settings for the index

Returns:

Whether the index was created successfully or not.

See also:
def deleteCollection(collectionName: String): Future[DeleteResponse]

This operation deletes an existing collection.

This operation deletes an existing collection.

Attributes

collectionName

The name of the collection

Returns:

Whether the collection was deleted successfully or not found.

See also:
def deleteIndex(indexName: String): Future[DeleteResponse]

This operation deletes an existing index.

This operation deletes an existing index.

Attributes

indexName

The name of the index

Returns:

Whether the index was deleted successfully or not found.

See also:
def describeCollection(collectionName: String): Future[Option[CollectionInfo]]

Get a description of a collection.

Get a description of a collection.

Attributes

collectionName

The name of the collection

Returns:

Configuration information and deployment status of the collection (if found)

See also:
def describeIndex(indexName: String): Future[Option[IndexInfo]]

Get a description of an index.

Get a description of an index.

Attributes

indexName

The name of the index

Returns:

Configuration information and deployment status of the index (if found)

See also:
def listIndexes: Future[Seq[String]]

This operation returns a list of your Pinecone indexes.

This operation returns a list of your Pinecone indexes.

Attributes

Returns:

List of indexes associated with the account (API key)

See also:

Inherited methods

def close(): Unit

Closes the underlying ws client, and releases all its resources.

Closes the underlying ws client, and releases all its resources.

Attributes

Inherited from:
CloseableService

Inherited fields

protected val configFileName: String

Attributes

Inherited from:
PineconeServiceConsts
protected val configPrefix: String

Attributes

Inherited from:
PineconeServiceConsts