Welcome to Relevance AIβs documentation!#
Relevance AI Concepts#
π Documents refer to JSONs/Python dictionaries that contain metadata and vectors.
πΊ Datasets refer to documents that are stored online in Relevance AI.
π§βπ¬ Workflows allow users to add new features/perform useful operations (e.g. - vectorizing and clustering text data). They are made up of many operators.
β‘ Vectorizers refer to machine learning models that can turn data into vectors (e.g. Word2vec turns words into vectors).
π‘ Operators are the building blocks used to provide users the ability to add something new.

About Relevance AI#
Relevance AI is an end-to-end platform for unstructured data using vector embeddings.
It makes it easy for data teams to connect to data, analyze it with vectors and share it in as an interactive app or production api.
The platform has 3 core elements:
Python Library, to extract vectors from unstructured and apply algorithms on top of it such as clustering, nearest neighbors, etc. Integrates well with common data science libraries such as huggingface, pandas, sklearn and more. The python library also serves as a sdk to the API.
API/Infrastructure, to store, query and analyze data and its associated vectors into a data warehouse + vector database. Integrates well with existing data warehouses (Snowflake, Bigquery, ..) and vector databases (FAISS, HNSWLib, Elasticsearch, ..)
App Builder, a no-code dashboard that allows you to quickly build and share visualizations, interactive applications and reports designed for machine learning and unstructured data.
Why Relevance AI#
Managed end-to-end, Relevance AIβs platform is end-to-end managed that helps you go from data to value. E.g. text, image -> Vectorizing -> Inserting into managed or self deployed vector databases & data warehouses -> Different ML algorithms K-NN, ANN, Cluster, DR -> Shareable Frontend App and API that interacts and enhances the process.
Highly flexible and integrated. Each part of the platform you can bring your own models. (e.g. Replacing the default clustering algorithm with any sklearn clustering model or one you build yourself)
Powerful, we donβt just facilitate each part of the process in building a use case with vectors. We enhace it further with algorithms and interactions to get more value of them. (e.g. fast aggregaation of data within clusters, vector similarity search with multiple vectors)
Data Privacy#
You own any data you upload to Relevance AI.
Everything you upload to Relevance AI is yours, including any vectors, code, configuration, metadata, output metrics, search results, visualisations and model weights. You can choose to log, export, publish, or delete any of these. We collect aggregate statistics across our users to improve our productβ we might do a database query to count how many users have used a specific endpoint to help decide if we want to improve our support for that endpoint. We treat your private data, source code, or trade secrets as confidential and private, as consistent with our Terms of Service and Privacy Policy.β
Documentation Structure
- Installation
- Guides
- πββοΈ QuickStart
- β‘ How To Vectorize
- π Cluster Analysis
- π€ Basic Sub-clustering
- βοΈ Cluster Centroid Heat Maps
- ποΈ Aggregation QuickStart
- Installation
- Setup
- Data
- 1. Grouping the Data
- 2. Creating Aggregation Metrics
- 3. Combining Grouping and Aggregating
- π Advanced Search
- π Text To Image Search QuickStart
- What I Need
- Text-to-image search
- π€ Hugging Face Pipelines
- Set-up
- Installing Transformers
- Transformers Pipeline
- Running Transformers
- Viewing NER Results
- Core
- Client
- Inserting Data
- Dataset
- Get Documents
- Metadata
- Numeric Summaries
- Describe
- Value Counts
- Correlation
- Aggregate
- Facets
- Health
- Export
- Useful Utilities
- Preview Your Dataset
- Info
- Schema
- Shape
- Chunk
- Launch Applications
- Launch Search App
- Launch Projector App
- Launch Cluster App
- Dataset
- Read
- chunk_dataset
- columns
- delete_field_children
- facets
- filter
- get
- get_after_ids_for_workflows
- get_all_documents
- get_documents
- get_documents_by_ids
- get_metadata
- get_settings
- head
- info
- insert_metadata
- list_field_children
- list_vector_fields
- metadata
- sample
- schema
- shape
- update_field_children
- upsert_metadata
- update_nested_dictionary
- Write
- apply
- batched_upsert_media
- bulk_apply
- cat
- concat
- create
- delete
- delete_documents
- get_media_documents
- host_media_documents
- insert_csv
- insert_df
- insert_documents
- insert_list
- insert_local_media
- insert_local_medias
- insert_media_bytes
- insert_media_folder
- insert_media_url
- insert_media_urls
- insert_pandas_dataframe
- update_where
- upsert_documents
- upsert_media
- Export
- Metadata
- Statistics
- Filters
- Filters (Complex)
- Filtering operators
- Exists
- Exact Match
- Categories
- Contains
- Date
- Word Match
- IDs
- Numeric
- Or
- Regex
- Combining filters
- Including filters in vector search
- Cache
- Dummy Datasets
- ExampleDatasets
- example_documents
- get_coco_dataset
- get_dummy_ecommerce_dataset
- get_ebay_app_review_dataset
- get_ebay_app_review_encoded_dataset
- get_ecommerce_1_dataset
- get_ecommerce_2_dataset
- get_ecommerce_3_dataset
- get_ecommerce_dataset
- get_ecommerce_dataset_clean
- get_ecommerce_dataset_encoded
- get_flipkart_dataset
- get_games_dataset
- get_iris_dataset
- get_news_dataset
- get_online_ecommerce_dataset
- get_online_retail_dataset
- get_palmer_penguins_dataset
- get_realestate_dataset
- get_sample_ecommerce_dataset
- get_titanic_dataset
- list_example_datasets
- mock_documents
- select_fields_from_json
- Operators
- Cluster
- Dimensionality Reduction
- Basic
- API Reference
- Vectorize
- Basic
- Sentiment
- Search
- Label
- Question Answer
- Split Sentences
- Finetuning
- Transformer Pipelines
- Changelog
- v2.3.0
- v2.2.0
- v2.1.0
- v2.0.2
- v2.0.1
- v2.0.0
- v1.4.3
- v1.4.2
- v1.4.1
- v1.4.0
- v1.3.3
- v1.3.2
- v1.3.1
- v1.3.0
- v1.2.8
- v1.2.7
- v1.2.6
- v1.2.5
- v1.2.4
- v1.2.3
- v1.2.2
- v1.2.1
- v1.2.0
- v1.1.5
- v1.1.4
- v1.1.2
- v1.1.1
- v1.1.0
- v1.0.8
- v1.0.7
- v1.0.6
- v1.0.5
- v1.0.4
- v1.0.3
- v1.0.2
- v1.0.1
- v1.0.0
- v0.33.6
- v0.33.5
- v0.33.4
- v0.33.3
- v0.33.2
- v0.33.1
- v0.33.0
- v0.32.1
- v0.32.0
- v0.31.0
- v0.30.1
- v0.30.0
- v0.29.1
- v0.29.0
- v0.28.2
- v0.28.1
- v0.28.0
- v0.27.0
- v0.26.6
- v0.26.5
- v0.26.4
- v0.26.3
- v0.26.2
- v0.26.1
- v0.26.0
- Debugging
- API Reference