Pinecone (Preview)
Pinecone makes it easy to provide long-term memory for high-performance AI applications. Pinecone is a managed, cloud-native vector database with no infrastructure hassles. Pinecone serves fresh, filtered query results with low latency at the scale of billions of vectors.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Troy Taylor |
| URL | https://www.hitachisolutions.com |
| [email protected] |
| Connector Metadata | |
|---|---|
| Publisher | Troy Taylor |
| Website | https://www.pinecone.io/ |
| Privacy policy | https://www.pinecone.io/privacy/ |
| Categories | AI |
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| Index | string | The index name for this API. | True |
| Environment | string | The environment for this API. | True |
| API Key | securestring | The API Key for this API. | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Create collection |
Creates a collection. |
| Create index |
Create an index. |
| Delete collection |
Deletes an existing collection. |
| Delete index |
Deletes an existing index. |
| Delete vectors |
Deletes vectors, by identifier, from a single namespace. |
| Get collection description |
Retrieve the description of a collection |
| Get collections |
Returns a list of your Pinecone collections. |
| Get index description |
Retrieve the description for an index. |
| Get index stats |
Returns statistics about the index's contents, including the vector count per namespace and the number of dimensions. |
| Get indexes |
Returns a list of your indexes. |
| Get vectors |
Returns vectors, by identifier, from a single namespace. |
| Query namespace |
Searches a namespace, using a query vector. It retrieves the identifiers of the most similar items in a namespace, along with their similarity scores. |
| Update index |
Updates the pod type and number of replicas for an index. |
| Update vector |
Updates vector in a namespace. |
| Upsert vector |
Writes vectors into a namespace. |
Create collection
Creates a collection.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Name
|
name | True | string |
The name. |
|
Source
|
source | True | string |
The source. |
Returns
- response
- string
Create index
Create an index.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Name
|
name | True | string |
The name. |
|
Dimension
|
dimension | True | integer |
The dimension. |
|
Metric
|
metric | string |
The metric. |
|
|
Pods
|
pods | integer |
The pods. |
|
|
Replicas
|
replicas | integer |
The replicas. |
|
|
Pod Type
|
pod_type | string |
The pod type. |
|
|
Source Collection
|
source_collection | string |
The source collection. |
Returns
- response
- string
Delete collection
Deletes an existing collection.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Collection Name
|
collectionName | True | string |
The collection name. |
Returns
- response
- string
Delete index
Deletes an existing index.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Index Name
|
indexName | True | string |
The index name. |
Returns
- response
- string
Delete vectors
Deletes vectors, by identifier, from a single namespace.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Delete All
|
deleteAll | boolean |
Whether to delete all. |
|
|
IDs
|
ids | array of string |
The identifiers. |
|
|
Namespace
|
namespace | string |
The namespace. |
Returns
- response
- string
Get collection description
Retrieve the description of a collection
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Collection Name
|
collectionName | True | string |
The collection name. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Name
|
name | string |
The name. |
|
Size
|
size | integer |
The size. |
|
Status
|
status | string |
The status. |
Get collections
Returns a list of your Pinecone collections.
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
|
array of string |
Get index description
Retrieve the description for an index.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Index Name
|
indexName | True | string |
The index name. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Name
|
database.name | string |
The name. |
|
Dimension
|
database.dimension | string |
The dimension. |
|
Metric
|
database.metric | string |
The metric. |
|
Pods
|
database.pods | integer |
The pods. |
|
Replicas
|
database.replicas | integer |
The replicas. |
|
Shards
|
database.shards | integer |
The shards. |
|
Pod Type
|
database.pod_type | string |
The pod type. |
|
K Bits
|
database.index_config.k_bits | integer |
The K bits. |
|
Hybrid
|
database.index_config.hybrid | boolean |
Whether hybrid. |
|
Ready
|
database.status.ready | boolean |
Whether ready. |
|
State
|
database.status.state | string |
The state. |
Get index stats
Returns statistics about the index's contents, including the vector count per namespace and the number of dimensions.
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Vector Count
|
namespaces.namespace.vectorCount | integer |
The vector count. |
|
Dimension
|
dimension | integer |
The dimension. |
|
Index Fullness
|
index_fullness | float |
The index fullness. |
Get indexes
Returns a list of your indexes.
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
|
array of string |
Get vectors
Returns vectors, by identifier, from a single namespace.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
ids | True | string |
The identifier. |
|
Namespace
|
namespace | string |
The namespace. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
vectors.additionalProp.id | string |
The identifier. |
|
Values
|
vectors.additionalProp.values | array of float |
The values. |
|
Indices
|
vectors.additionalProp.sparseValues.indices | array of integer |
The indices. |
|
Values
|
vectors.additionalProp.sparseValues.values | array of float |
The values. |
|
Genre
|
vectors.additionalProp.metadata.genre | string |
The genre. |
|
Year
|
vectors.additionalProp.metadata.year | integer |
The year. |
|
Namespace
|
namespace | string |
The namespace. |
Query namespace
Searches a namespace, using a query vector. It retrieves the identifiers of the most similar items in a namespace, along with their similarity scores.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Include Values
|
includeValues | boolean |
Whether to include values. |
|
|
Include Metadata
|
includeMetadata | boolean |
Whether include metadata. |
|
|
Indices
|
indices | array of integer |
The indices. |
|
|
Values
|
values | array of integer |
The values. |
|
|
Namespace
|
namespace | string |
The namespace. |
|
|
Top K
|
topK | integer |
The top K. |
|
|
Vector
|
vector | array of integer |
The vector. |
|
|
ID
|
id | string |
The identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Matches
|
matches | array of object | |
|
ID
|
matches.id | string |
The identifier. |
|
Score
|
matches.score | float |
The score. |
|
Values
|
matches.values | array of float |
The values. |
|
Indices
|
matches.sparseValues.indices | array of integer |
The indices. |
|
Values
|
matches.sparseValues.values | array of float |
The values. |
|
Genre
|
matches.metadata.genre | string |
The genre. |
|
Year
|
matches.metadata.year | integer |
The year. |
|
Namespace
|
namespace | string |
The namespace. |
Update index
Updates the pod type and number of replicas for an index.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Index Name
|
indexName | True | string |
The index name. |
|
Replicas
|
replicas | integer |
The replicas. |
|
|
Pod Type
|
pod_type | string |
The pod type. |
Returns
- response
- string
Update vector
Updates vector in a namespace.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
The identifier. |
|
Values
|
values | array of float |
The values. |
|
|
Indices
|
indices | array of integer |
The indices. |
|
|
Values
|
values | array of float |
The values. |
|
|
Namespace
|
namespace | string |
The namespace. |
Returns
- response
- string
Upsert vector
Writes vectors into a namespace.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
The identifier. |
|
|
Values
|
values | array of float |
The values. |
|
|
Indices
|
indices | array of integer |
The indices. |
|
|
Values
|
values | array of float |
The values. |
|
|
Namespace
|
namespace | string |
The namespace. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Upserted Count
|
upsertedCount | integer |
The upserted count. |
Definitions
string
This is the basic data type 'string'.