Skip to content

Latest commit

 

History

History
79 lines (60 loc) · 3.72 KB

vector-search-integration-overview.md

File metadata and controls

79 lines (60 loc) · 3.72 KB
Raw
title summary
Vector Search Integration Overview
An overview of TiDB vector search integration, including supported AI frameworks, embedding models, and ORM libraries.

Vector Search Integration Overview

This document provides an overview of TiDB vector search integration, including supported AI frameworks, embedding models, and Object Relational Mapping (ORM) libraries.

Warning:

The vector search feature is experimental. It is not recommended that you use it in the production environment. This feature might be changed without prior notice. If you find a bug, you can report an issue on GitHub.

Note:

The vector search feature is only available for TiDB Self-Managed clusters and TiDB Cloud Serverless clusters.

AI frameworks

TiDB provides official support for the following AI frameworks, enabling you to easily integrate AI applications developed based on these frameworks with TiDB Vector Search.

AI frameworks Tutorial
Langchain Integrate Vector Search with LangChain
LlamaIndex Integrate Vector Search with LlamaIndex

Moreover, you can also use TiDB for various purposes, such as document storage and knowledge graph storage for AI applications.

Embedding models and services

TiDB Vector Search supports storing vectors of up to 16383 dimensions, which accommodates most embedding models.

You can either use self-deployed open-source embedding models or third-party embedding APIs provided by third-party embedding providers to generate vectors.

The following table lists some mainstream embedding service providers and the corresponding integration tutorials.

Embedding service providers Tutorial
Jina AI Integrate Vector Search with Jina AI Embeddings API

Object Relational Mapping (ORM) libraries

You can integrate TiDB Vector Search with your ORM library to interact with the TiDB database.

The following table lists the supported ORM libraries and the corresponding integration tutorials:

Language ORM/Client How to install Tutorial
Python TiDB Vector Client pip install tidb-vector[client] Get Started with Vector Search Using Python
SQLAlchemy pip install tidb-vector Integrate TiDB Vector Search with SQLAlchemy
peewee pip install tidb-vector Integrate TiDB Vector Search with peewee
Django pip install django-tidb[vector] Integrate TiDB Vector Search with Django