---
title: "Pinecone Compatibility Matrix"
---

# Pinecone Compatibility Matrix

:::caution[Planned: not in the current release]
Pinecone API compatibility for HeliosDB Full is planned. Today, the HTTP gateway answers `/pinecone/` paths with `501 Not Implemented`. Reach
the same data over the PostgreSQL listener or `POST /api/v1/query` today. This page
describes the planned interface.
:::

Comprehensive compatibility reference for HeliosDB's Pinecone vector protocol implementation.

## Planned Coverage

| Category | Design coverage | Availability |
|----------|----------|--------|
| REST API | 100% | Planned |
| Upsert Operations | 100% | Planned |
| Query Operations | 100% | Planned |
| Filtering | 100% | Planned |
| Namespaces | 100% | Planned |
| Metadata | 100% | Planned |

## API Endpoints

### Index Operations

| Endpoint | Method | Result | Notes |
|----------|--------|--------|-------|
| `/describe_index` | GET | Supported | Index statistics |
| `/create_index` | POST | Supported | Create new index |
| `/delete_index` | DELETE | Supported | Delete index |
| `/list_indexes` | GET | Supported | List all indexes |
| `/configure_index` | PATCH | Supported | Update configuration |

### Vector Operations

| Endpoint | Method | Result | Notes |
|----------|--------|--------|-------|
| `/vectors/upsert` | POST | Supported | Insert/update vectors |
| `/query` | POST | Supported | Similarity search |
| `/vectors/fetch` | GET | Supported | Fetch by ID |
| `/vectors/delete` | POST | Supported | Delete vectors |
| `/vectors/update` | POST | Supported | Update metadata |
| `/vectors/list` | GET | Supported | List vector IDs |

### Statistics

| Endpoint | Method | Result | Notes |
|----------|--------|--------|-------|
| `/describe_index_stats` | GET | Supported | Index statistics |

## Upsert Operations

| Feature | Result | Notes |
|---------|--------|-------|
| Single vector | Supported | |
| Batch vectors | Supported | Up to 100/request |
| With metadata | Supported | |
| With sparse vectors | Supported | Hybrid search |
| Namespace support | Supported | |

## Query Operations

### Query Parameters

| Parameter | Result | Notes |
|-----------|--------|-------|
| `vector` | Supported | Query vector (required) |
| `top_k` | Supported | Number of results |
| `filter` | Supported | Metadata filtering |
| `include_values` | Supported | Return vectors |
| `include_metadata` | Supported | Return metadata |
| `namespace` | Supported | Query namespace |

### Similarity Metrics

| Metric | Result | Notes |
|--------|--------|-------|
| Cosine | Supported | Default |
| Euclidean | Supported | L2 distance |
| Dot Product | Supported | For normalized vectors |

## Filtering

### Filter Operators

| Operator | Result | Example |
|----------|--------|---------|
| `$eq` | Supported | Equal |
| `$ne` | Supported | Not equal |
| `$gt` | Supported | Greater than |
| `$gte` | Supported | Greater or equal |
| `$lt` | Supported | Less than |
| `$lte` | Supported | Less or equal |
| `$in` | Supported | In array |
| `$nin` | Supported | Not in array |
| `$exists` | Supported | Field exists |

### Logical Operators

| Operator | Result | Notes |
|----------|--------|-------|
| `$and` | Supported | AND conditions |
| `$or` | Supported | OR conditions |

### Data Type Support

| Type | Result | Notes |
|------|--------|-------|
| String | Supported | |
| Number | Supported | Integer and float |
| Boolean | Supported | |
| Array | Supported | For $in/$nin |

## Fetch Operations

| Feature | Result | Notes |
|---------|--------|-------|
| Single ID | Supported | |
| Multiple IDs | Supported | Up to 100/request |
| With namespace | Supported | |

## Delete Operations

| Feature | Result | Notes |
|---------|--------|-------|
| By ID | Supported | Single or multiple |
| By filter | Supported | Metadata filter |
| Delete all | Supported | Clear namespace |
| By namespace | Supported | |

## Update Operations

| Feature | Result | Notes |
|---------|--------|-------|
| Update metadata | Supported | |
| Update values | Supported | Replace vector |
| Sparse values | Supported | Hybrid vectors |

## Namespace Support

| Feature | Result | Notes |
|---------|--------|-------|
| Create namespace | Supported | On upsert |
| List namespaces | Supported | In stats |
| Query namespace | Supported | |
| Delete namespace | Supported | |

## Sparse Vectors (Hybrid Search)

| Feature | Result | Notes |
|---------|--------|-------|
| Upsert sparse | Supported | indices + values |
| Query sparse | Supported | Combined scoring |
| Dense + sparse | Supported | Full hybrid |

## Metadata

| Feature | Result | Notes |
|---------|--------|-------|
| String fields | Supported | |
| Numeric fields | Supported | Integer, float |
| Boolean fields | Supported | |
| Array fields | Supported | For filtering |
| Nested objects | Partial | First level only |
| Max size | 40KB | Per vector |

## Index Configuration

| Setting | Result | Notes |
|---------|--------|-------|
| Dimension | Supported | Up to 20000 |
| Metric | Supported | cosine, euclidean, dotproduct |
| Pods | Supported | Pod-based scaling |
| Replicas | Supported | Redundancy |
| Pod type | Supported | Performance tier |

## Statistics

| Metric | Result | Notes |
|--------|--------|-------|
| Total vectors | Supported | |
| Dimension | Supported | |
| Index fullness | Supported | |
| Namespace stats | Supported | Per-namespace counts |

## SDK Compatibility

### Python SDK

| Feature | Result | Notes |
|---------|--------|-------|
| pinecone-client | Supported | v2.x, v3.x |
| Upsert | Supported | |
| Query | Supported | |
| Fetch | Supported | |
| Delete | Supported | |
| Update | Supported | |
| Batch operations | Supported | |

### Node.js SDK

| Feature | Result | Notes |
|---------|--------|-------|
| @pinecone-database/pinecone | Supported | v1.x, v2.x |
| All operations | Supported | |

### Go SDK

| Feature | Result | Notes |
|---------|--------|-------|
| pinecone-go-client | Supported | v0.x |
| All operations | Supported | |

## REST API

### Request Format

| Format | Result | Notes |
|--------|--------|-------|
| JSON | Supported | Content-Type: application/json |
| gRPC | Not Supported | REST only |

### Authentication

| Method | Result | Notes |
|--------|--------|-------|
| API Key | Supported | Header: Api-Key |
| Environment | Supported | PINECONE_API_KEY |

## Performance

| Metric | Value | Notes |
|--------|-------|-------|
| Query latency | <10ms | For top_k=10 |
| Upsert throughput | 100K/sec | With batching |
| Max vectors/index | 10M+ | Configurable |
| Max dimension | 20000 | Configurable |

## Known Limitations

### Not Supported

| Feature | Reason |
|---------|--------|
| gRPC Protocol | REST API only |
| Collections | Use namespaces |
| Pod type: s1 | Use standard pods |
| Serverless (AWS) | On-premise only |

### Behavioral Differences

1. **Indexing**: Uses HeliosDB's HNSW implementation
2. **Sharding**: Different sharding strategy
3. **Consistency**: Strong consistency by default
4. **Cold start**: No cold start delays

---

**Related**: [README.md](https://www.heliosdb.com/docs/full/reference/protocols/pinecone/readme/) | [CONFIGURATION.md](https://www.heliosdb.com/docs/full/reference/protocols/pinecone/configuration/) | [EXAMPLES.md](https://www.heliosdb.com/docs/full/reference/protocols/pinecone/examples/)