Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 21 additions & 19 deletions apps/docs/sdks/python.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,36 @@ description: Seamlessly integrate EigenDB into your Python applications
icon: python
---

## Installation
## Installation

<CodeGroup>
```bash pip
pip install eigen-client
```
</CodeGroup>

## Supported embedding models

If you desire to use a model that is not listed here, you can simply create the index with `client.create_index(...)` and provide the desired dimensions and similarity metric.

| Model Name | Provider | Dimensions | Similarity Metric |
|--------------------------------|-----------|------------|-------------------|
| text-embedding-3-small | OpenAI | 1536 | cosine |
| text-embedding-3-large | OpenAI | 3072 | cosine |
| text-embedding-ada-002 | OpenAI | 1536 | cosine |
| all-minilm:22m | Ollama | 384 | cosine |
| nomic-embed-text:v1.5 | Ollama | 768 | cosine |
| mxbai-embed-large:335m | Ollama | 1024 | cosine |
| snowflake-arctic-embed2:568m | Ollama | 1024 | cosine |
| snowflake-arctic-embed:335m | Ollama | 1024 | cosine |
| bge-m3:567m | Ollama | 1024 | cosine |
| bge-large:335m | Ollama | 1024 | cosine |

## Usage

### Creating an index

```py
```py python
import os
from eigen_client.client import Client
from eigen_client.data_types import Document
Expand Down Expand Up @@ -53,7 +70,7 @@ print(results)

### Using an existing index

```py
```py python
import os
from eigen_client.index import Index
from eigen_client.data_types import Document
Expand Down Expand Up @@ -83,19 +100,4 @@ results = index.search_docs(
)

print(results)
```

## Supported embedding models

| Model Name | Provider | Dimensions | Similarity Metric |
|--------------------------------|-----------|------------|-------------------|
| text-embedding-3-small | OpenAI | 1536 | cosine |
| text-embedding-3-large | OpenAI | 3072 | cosine |
| text-embedding-ada-002 | OpenAI | 1536 | cosine |
| all-minilm:22m | Ollama | 384 | cosine |
| nomic-embed-text:v1.5 | Ollama | 768 | cosine |
| mxbai-embed-large:335m | Ollama | 1024 | cosine |
| snowflake-arctic-embed2:568m | Ollama | 1024 | cosine |
| snowflake-arctic-embed:335m | Ollama | 1024 | cosine |
| bge-m3:567m | Ollama | 1024 | cosine |
| bge-large:335m | Ollama | 1024 | cosine |
```
Loading