Skip to content

chore: post-1.0 doc cleanup #59

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
techiejd merged 1 commit into from
May 22, 2026
Merged

chore: post-1.0 doc cleanup #59

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 0 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@

A Payload CMS plugin that adds vector search capabilities to your collections. Perfect for building RAG (Retrieval-Augmented Generation) applications and semantic search features.

> **Status:** `0.x` — pre-1.0. The public API is stabilizing but may still have breaking changes between minor releases. Track the [CHANGELOG](./CHANGELOG.md) before upgrading.

## Features

- 🔍 [**Semantic Search**](#4-search-your-content) — vectorize any collection for intelligent content discovery.
Expand Down
4 changes: 1 addition & 3 deletions src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,9 +143,7 @@ export type RerankConfig = {
export type EmbeddingConfig = {
/** Version string to track embedding model/version - stored in each embedding document */
version: string
/** Embedding function for query provided by the user
* TODO(techiejd): Should be optional? Maybe if not provided then we can disable the search endpoint?
*/
/** Embedding function for query provided by the user */
queryFn: EmbedQueryFn
/** Embedding function for real-time ingestion of documents provided by the user
* If not provided, then there is no real-time ingestion of documents provided by the user
Expand Down
Loading