Skip to content

Commit 694f862

Browse files
committed
Cleaned up getting started tutorial and added framework integration links
1 parent f79efd1 commit 694f862

File tree

3 files changed

+12
-5
lines changed

3 files changed

+12
-5
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,12 @@ PostgreSQL++ for AI Applications.
1818
more](https://www.timescale.com/blog/how-we-made-postgresql-the-best-vector-database/?utm_campaign=vectorlaunch&utm_source=github&utm_medium=direct):
1919
Learn more about Timescale Vector, how it works and why we built it.
2020

21+
If you prefer to use an LLM development or data framework, see Timescale
22+
Vector’s integrations with
23+
[LangChain](https://python.langchain.com/docs/integrations/vectorstores/timescalevector)
24+
and
25+
[LlamaIndex](https://gpt-index.readthedocs.io/en/stable/examples/vector_stores/Timescalevector.html)
26+
2127
## Install
2228

2329
``` sh

nbs/index.ipynb

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,10 @@
1818
"- [Signup for Timescale Vector](https://console.cloud.timescale.com/signup?utm_campaign=vectorlaunch&utm_source=github&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.\n",
1919
"- [Documentation](https://timescale.github.io/python-vector/): Learn the key features of Timescale Vector and how to use them.\n",
2020
"- [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.\n",
21-
"- [Learn more](https://www.timescale.com/blog/how-we-made-postgresql-the-best-vector-database/?utm_campaign=vectorlaunch&utm_source=github&utm_medium=direct): Learn more about Timescale Vector, how it works and why we built it."
21+
"- [Learn more](https://www.timescale.com/blog/how-we-made-postgresql-the-best-vector-database/?utm_campaign=vectorlaunch&utm_source=github&utm_medium=direct): Learn more about Timescale Vector, how it works and why we built it.\n",
22+
"\n",
23+
"\n",
24+
"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)"
2225
]
2326
},
2427
{

nbs/tsv_python_getting_started_tutorial.ipynb

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -432,9 +432,7 @@
432432
"\n",
433433
"We'll define a helper funciton `create_uuid()` to create a uuid for commit message and associated vector embedding based on its timestamp. \n",
434434
"\n",
435-
"In the helper function, we'll use the timescale vector client library's `uuid_from_time()` method to take a date and create a uuid with a datetime portion that reflects the date string.\n",
436-
"\n",
437-
"Important note: If you are working with documents/nodes and want the current date and time associated with vector for time-based search, you can skip this step. A uuid will be automatically generated when the nodes are added to the table in Timescale Vector by default. In our case, because we want the uuid to be based on the timestamp in the past, we need to create the uuids manually."
435+
"In the helper function, we'll use the timescale vector client library's `uuid_from_time()` method to take a date and create a uuid with a datetime portion that reflects the date string."
438436
]
439437
},
440438
{
@@ -974,7 +972,7 @@
974972
"\n",
975973
"- The first step to using time filtering with Timescale Vector is to create a table with the `time_partition_interval` argument set to the desired time interval. This will automatically partition the table into time-based chunks to speed up queries. We completed this step in Part 1 above.\n",
976974
"\n",
977-
"- Next, we ensure the `id` of our row is a `uuid` with a datetime portion that reflects the date and time we want to associated with the embedding. We completed this step in Part 2 above.\n",
975+
"- Next, we ensure the `id` of our row is a `uuid` with a datetime portion that reflects the date and time we want to associated with the embedding. We completed this step in Part 2 above, where we used the `uuid_from_time()` method provided by the Timescale Vector library.\n",
978976
"\n",
979977
"- Finally, we can run similarity searches with time range filters using the TimescaleVector client. We'll illustrate this below."
980978
]

0 commit comments

Comments
 (0)