Skip to content
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

Jump to bottom

Add Documentation for Filtering Search Results and Partial Indices in Vector Search #159

Merged
merged 8 commits into from
Oct 21, 2024
Merged

Add Documentation for Filtering Search Results and Partial Indices in Vector Search #159

merged 8 commits into from
Oct 21, 2024

Conversation

asr2003
Copy link
Contributor

@asr2003 asr2003 commented Oct 17, 2024 •
edited
Loading

/claim #143
Closes #143

@algora-pbc algora-pbc bot mentioned this pull request Oct 17, 2024
Closed
@asr2003
Copy link
Contributor Author

asr2003 commented Oct 17, 2024 •
edited
Loading

@ChuckHend I have added documentation for the where parameter in vectorize.search() and provided a example for filtering search results. Additionally, I have also included instructions on using partial indices to optimize queries especially when frequent filtering is required.

I have followed the existing documentation style and ensured that the examples are clearly structured.

Let me know if any adjustments or changes are needed. I am happy to make any necessary updates.

ChuckHend
ChuckHend reviewed Oct 18, 2024
View reviewed changes
docs/api/search.md Outdated Show resolved Hide resolved
@asr2003
Copy link
Contributor Author

asr2003 commented Oct 19, 2024

@ChuckHend Can this be merged now? or any changes needed here?

ChuckHend
ChuckHend reviewed Oct 19, 2024
View reviewed changes
docs/api/search.md Outdated Show resolved Hide resolved
ChuckHend
ChuckHend reviewed Oct 19, 2024
View reviewed changes
docs/api/search.md Outdated Show resolved Hide resolved
ChuckHend
ChuckHend reviewed Oct 19, 2024
View reviewed changes
docs/api/search.md Outdated Show resolved Hide resolved
ChuckHend
ChuckHend requested changes Oct 19, 2024
View reviewed changes
Copy link
Member

@ChuckHend ChuckHend left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like how the example uses the index with product_category and price. Can you add those values to the example.sql file so that these new docs function correctly with it?

If we add those columns to the example data, and update these changes to use where_sql as the parameter name I think this is good to merge.

asr2003 and others added 3 commits October 20, 2024 06:37
@asr2003 @ChuckHend
Apply suggestions from code review
5945a33 
Co-authored-by: Adam Hendel <ChuckHend@users.noreply.github.com>
@asr2003
where -> where_sql
6b00723
@asr2003
update columns
8b90f0d
@asr2003
Copy link
Contributor Author

asr2003 commented Oct 20, 2024

@ChuckHend Done with review comments

@ChuckHend ChuckHend mentioned this pull request Oct 20, 2024
Closed
@asr2003
Copy link
Contributor Author

asr2003 commented Oct 20, 2024

@ChuckHend Are there anything from my end to fix the workflows. I think it's not related to changes of this PR

@ChuckHend
Copy link
Member

Thank you! I think there is an issue with CI that is unrelated to this PR, so I will merge this now.

@ChuckHend ChuckHend merged commit aff0bcb into tembo-io:main Oct 21, 2024
4 of 8 checks passed
@asr2003 asr2003 deleted the add-docs branch October 23, 2024 05:42
Neptune650 pushed a commit to Neptune650/pg_vectorize that referenced this pull request Oct 27, 2024
@asr2003 @Neptune650
Add Documentation for Filtering Search Results and Partial Indices in…
fb36110 
… Vector Search (tembo-io#159)

* docs: add filtering and partial index examples to vector search documentation

* docs: add note for partial indices

* update columns
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ChuckHend ChuckHend ChuckHend approved these changes

@jasonmp85 jasonmp85 Awaiting requested review from jasonmp85

Assignees
No one assigned
Labels
🙋 Bounty claim
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

documentation and examples for filtering
2 participants
@asr2003 @ChuckHend