Skip to content

Commit

Permalink
Address possible installation issues regarding psycopg2 (#3165)
Browse files Browse the repository at this point in the history
* Address possible installation issues regarding psycopg2

* Address possible installation issues regarding psycopg2

* chore: few language updates for the install procedure.

---------

Co-authored-by: billy-the-fish <iain.cox@sarkdocumentation.com>
  • Loading branch information
jgpruitt and billy-the-fish committed May 7, 2024
1 parent fed5f12 commit 4e5a692
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 11 deletions.
1 change: 0 additions & 1 deletion ai/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ tags: [ai, vector]

# Overview of Timescale Vector

## What is Timescale Vector
Timescale Vector is PostgreSQL++ for AI applications. With Timescale Vector, you can power production AI applications with PostgreSQL as your vector database, storing both vector embeddings, relational data (for example, related metadata), and time-based data in the same database.

Timescale Vector is a cloud-based vector database. There is no self-hosted version at this time. To use Timescale Vector, [sign up here](https://console.cloud.timescale.com/signup?utm_campaign=vectorlaunch&utm_source=tsv-docs&utm_medium=direct).
Expand Down
37 changes: 27 additions & 10 deletions ai/python-interface-for-pgvector-and-timescale-vector.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,27 +8,44 @@ tags: [ai, vector, python]

# Python interface for pgvector and Timescale Vector

PostgreSQL++ for AI Applications.
You use Timescale Vector to power production grade AI applications. `timescale_vector` is the
Python interface you use to interact with a Timescale Vector service programmatically.

Before you get started with `timescale_vector`:

- [Sign up for Timescale Vector](https://console.cloud.timescale.com/signup?utm_campaign=vectorlaunch&utm_source=docs&utm_medium=direct): Get 90 days free to try Timescale Vector on the Timescale cloud data platform. There is no self-managed version at this time.
- [Getting Started Tutorial](https://timescale.github.io/python-vector/tsv_python_getting_started_tutorial.html): Learn how to use Timescale Vector for semantic search on a real-world dataset.
- [Follow the Get Started Tutorial](https://timescale.github.io/python-vector/tsv_python_getting_started_tutorial.html):
Learn how to use Timescale Vector for semantic search on a real-world dataset.

If you prefer to use an LLM development or data framework, see Timescale Vector's integrations with [LangChain](https://python.langchain.com/docs/integrations/vectorstores/timescalevector) and [LlamaIndex](https://gpt-index.readthedocs.io/en/stable/examples/vector_stores/Timescalevector.html).

## Prerequisites

`timescale_vector` depends on the source distribution of `psycopg2` and adheres
to [best practices for psycopg2](https://www.psycopg.org/docs/install.html#psycopg-vs-psycopg-binary).

Before you install `timescale_vector`:

* Follow the [psycopg2 build prerequisites](https://www.psycopg.org/docs/install.html#build-prerequisites).

## Install

To install the main library use:
To interact with Timescale Vector using Python:

```bash
pip install timescale_vector
```
1. Install `timescale_vector`:

`dotenv` is used in these examples for passing around secrets and keys. You can install that with:
```bash
pip install timescale_vector
```
1. Install `dotenv`:

```bash
pip install python-dotenv
```
```bash
pip install python-dotenv
```

In these examples, you use `dotenv` to pass secrets and keys.

That is it, you are ready to go.

## Basic usage of the timescale_vector library

Expand Down

0 comments on commit 4e5a692

Please sign in to comment.