PineconeIndexService
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
Members list
Type members
Inherited classlikes
Attributes
- Inherited from:
- PineconeServiceConsts
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
Value members
Abstract methods
This operation specifies the pod type and number of replicas for an index.
This operation specifies the pod type and number of replicas for an index.
Attributes
- indexName
The name of the index
- podType
The new pod type for the index.
- replicas
The desired number of replicas for the index.
- Returns:
Whether the index was updated successfully or not found.
- See also:
This operation creates a Pinecone collection.
This operation creates a Pinecone collection.
Attributes
- name
The name of the collection to be created.
- source
The name of the source index to be used as the source for the collection.
- Returns:
Whether the collection was created successfully or not.
- See also:
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:
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:
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:
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:
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:
This operation returns a list of your Pinecone collections.
This operation returns a list of your Pinecone collections.
Attributes
- Returns:
List of collections
- See also:
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 fields
Attributes
- Inherited from:
- PineconeServiceConsts
Attributes
- Inherited from:
- PineconeServiceConsts
Attributes
- Inherited from:
- PineconeServiceConsts
Attributes
- Inherited from:
- PineconeServiceConsts