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.

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

Neo4j: Fixed similarity docs #23913

Merged

Conversation

RafaelXokito
Copy link
Contributor

Description: There was missing some documentation regarding the filter and params attributes in similarity search methods.

@dosubot dosubot bot added the size:S This PR changes 10-29 lines, ignoring generated files. label Jul 5, 2024
Copy link

vercel bot commented Jul 5, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
langchain ⬜️ Ignored (Inspect) Visit Preview Jul 5, 2024 4:26pm

@dosubot dosubot bot added community Related to langchain-community 🔌: neo4j Primarily related to Neo4j integrations 🤖:docs Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder labels Jul 5, 2024
@@ -1077,13 +1092,19 @@ def similarity_search_by_vector(
embedding: List[float],
k: int = 4,
filter: Optional[Dict[str, Any]] = None,
params: Dict[str, Any] = {},
Copy link
Collaborator

Choose a reason for hiding this comment

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

This introduces a bug since param is exposed in the function signature, but isn't propagated

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you very much for your feedback. I forgot to use the params attribute.
Already updated the PR.
This change was basically to keep all the methods with similar signatures, since they all use similarity_search_with_score_by_vector method that receives the params argument.

Copy link
Collaborator

@eyurtsev eyurtsev left a comment

Choose a reason for hiding this comment

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

@RafaelXokito thanks for the PR! When you resolve the issue, feel free to ask me to re-review the code

@eyurtsev eyurtsev self-assigned this Jul 5, 2024
@RafaelXokito RafaelXokito requested a review from eyurtsev July 5, 2024 16:28
@RafaelXokito
Copy link
Contributor Author

@eyurtsev please review this PR.

@dosubot dosubot bot added the lgtm PR looks good. Use to confirm that a PR is ready for merging. label Jul 11, 2024
@eyurtsev eyurtsev merged commit 092e9ee into langchain-ai:master Jul 11, 2024
51 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community Related to langchain-community 🤖:docs Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder lgtm PR looks good. Use to confirm that a PR is ready for merging. 🔌: neo4j Primarily related to Neo4j integrations size:S This PR changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants