tryAGI / LangChain.Databases

Part of the LangChain.NET project. Has separate abstractions, does not contain dependencies on the main project and can be used independently
https://tryagi.github.io/LangChain.Databases/
MIT License
5 stars 2 forks source link

Change to readonly collection and cleanup #75

Closed robalexclark closed 3 weeks ago

robalexclark commented 3 weeks ago

Summary by CodeRabbit

Release Notes

coderabbitai[bot] commented 3 weeks ago

Walkthrough

The pull request introduces modifications primarily to the SearchByMetadata method across various classes implementing the IVectorCollection interface. The return type of this method has been changed from Task<List<Vector>> to Task<IReadOnlyList<Vector>>, enhancing its immutability. Additionally, new methods have been added to some classes, such as IsValidJsonKey in VectorCollection, and several asynchronous methods in MongoVectorCollection. Overall, the changes focus on refining method signatures and improving type safety without altering existing functionalities significantly.

Changes

File Path Change Summary
src/Abstractions/src/IVectorCollection.cs Updated method signature: SearchByMetadata from Task<List<Vector>> to Task<IReadOnlyList<Vector>>.
src/Abstractions/src/PublicAPI.Unshipped.txt Updated SearchByMetadata return type to IReadOnlyList<Vector>; added IsValidJsonKey method.
src/Abstractions/src/VectorCollection.cs Added protected static bool IsValidJsonKey(string input) method for JSON key validation.
src/Chroma/src/ChromaVectorCollection.cs Updated SearchByMetadata return type to IReadOnlyList<Vector>.
src/Elasticsearch/src/ElasticsearchVectorCollection.cs Updated SearchByMetadata return type to IReadOnlyList<Vector>; added async methods with NotImplementedException.
src/InMemory/src/InMemoryVectorCollection.cs Updated SearchByMetadata return type to IReadOnlyList<Vector>.
src/Mongo/src/MongoVectorCollection.cs Added several async methods: AddAsync, DeleteAsync, GetAsync, IsEmptyAsync, SearchAsync; updated SearchByMetadata return type.
src/OpenSearch/src/OpenSearchVectorCollection.cs Updated SearchByMetadata return type to IReadOnlyList<Vector>.
src/Postgres/src/PostgresVectorCollection.cs Updated SearchByMetadata return type to IReadOnlyList<Vector>; added validation for filter keys.
src/SemanticKernel/src/SemanticKernelMemoryStoreCollection.cs Updated SearchByMetadata return type to IReadOnlyList<Vector>.
src/Sqlite/src/SqLiteVectorCollection.cs Updated SearchByMetadata return type to IReadOnlyList<Vector>; removed IsValidJsonKey method.

Possibly related PRs

🐇 In the code we hop and play,
With vectors in a new array.
Read-only lists, we cheer with glee,
Valid keys for JSON, oh so free!
Asynchronous methods, a joyful tune,
In our rabbit hole, we’ll code till noon! 🌼


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.