chore: add documentation for Hybrid Seach #233
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
averikitsch
reviewed
Jul 8, 2025
| @@ -78,6 +78,7 @@ print(docs) | |||
|
|
|||
| > [!TIP] | |||
| > All synchronous functions have corresponding asynchronous functions | |||
| > PGVectorStore also supports Hybrid Search which combines multiple search strategies to improve search results. | |||
There was a problem hiding this comment.
I agree that a note in the Readme is helpful. We should make sure the code snippet is clear and concise. So instead of this, can we add a header for Hybrid search and the smallest code snippet to get started then link to the how-to?
Comment on lines
+710
to
+718
| "- **`id_column=\"product_id\"`**: ID column uniquely identifies each row in the products table.\n", | ||
| "\n", | ||
| "- **`content_column=\"description\"`**: The `description` column contains text descriptions of each product. This text is used by the `embedding_service` to create vectors that go in embedding_column and represent the semantic meaning of each description.\n", | ||
| "\n", | ||
| "- **`embedding_column=\"embed\"`**: The `embed` column stores the vectors created from the product descriptions. These vectors are used to find products with similar descriptions.\n", | ||
| "\n", | ||
| "- **`metadata_columns=[\"name\", \"category\", \"price_usd\", \"quantity\", \"sku\", \"image_url\"]`**: These columns are treated as metadata for each product. Metadata provides additional information about a product, such as its name, category, price, quantity available, SKU (Stock Keeping Unit), and an image URL. This information is useful for displaying product details in search results or for filtering and categorization.\n", | ||
| "\n", | ||
| "- **`metadata_json_column=\"metadata\"`**: The `metadata` column can store any additional information about the products in a flexible JSON format. This allows for storing varied and complex data that doesn't fit into the standard columns.\n" |
There was a problem hiding this comment.
This info is already provided above. Please outline how to use the HybridSearchConfig.
Comment on lines
+745
to
+758
| "# If a hybrid search config is provided during vector store table creation,\n", | ||
| "# the specified TSV column will be automatically created.\n", | ||
| "await pg_engine.ainit_vectorstore_table(\n", | ||
| " table_name=TABLE_NAME,\n", | ||
| " # schema_name=SCHEMA_NAME,\n", | ||
| " vector_size=VECTOR_SIZE,\n", | ||
| " id_column=\"product_id\",\n", | ||
| " content_column=\"description\",\n", | ||
| " embedding_column=\"embed\",\n", | ||
| " metadata_columns=[\"name\", \"category\", \"price_usd\", \"quantity\", \"sku\", \"image_url\"],\n", | ||
| " metadata_json_column=\"metadata\",\n", | ||
| " hybrid_search_config=hybrid_search_config,\n", | ||
| " store_metadata=True,\n", | ||
| ")\n", |
There was a problem hiding this comment.
Can we create individual sections for each of these notes. The inline comments are hard to read.
| "cell_type": "markdown", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "# Hybrid Search Vector Store\n", |
There was a problem hiding this comment.
Please provide the easy way to get started then a section for how to customize.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds documentation for hybrid search:
Reviewer decision points: