Southclaws / storyden

With a fresh new take on traditional bulletin board forum software, Storyden is a modern, secure and extensible platform for building communities.
https://www.storyden.org/
Mozilla Public License 2.0
93 stars 11 forks source link

include relevance score in collection items #159

Closed Southclaws closed 3 months ago

vercel[bot] commented 4 months ago

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

Name Status Preview Comments Updated (UTC)
storyden ❌ Failed (Inspect) Jul 27, 2024 11:07am
storyden-homepage ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 27, 2024 11:07am
coderabbitai[bot] commented 4 months ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough ## Walkthrough The changes introduce a relevance scoring feature to enhance item processing within collections. By implementing a `RelevanceScorer` interface, the system now computes and integrates relevance scores using Weaviate's GraphQL capabilities. These updates span data structures, methods, and API schemas, allowing for improved handling and display of relevance scores. ## Changes | File Path | Change Summary | |----------------------------------------|------------------------------------------------------------------------------------------------------------| | app/resources/collection/dto.go | Added `RelevanceScore` field to `CollectionItem` struct. | | app/services/collection/... | Updated `CollectionQuerier` to use `RelevanceScorer` and modified `GetCollection` for enhanced session handling. | | app/services/semdex/index_job/... | Enhanced `reindexNodes` function with improved error handling and messaging for unindexed nodes. | | app/services/semdex/semdex.go | Introduced `RelevanceScorer` interface and integrated it into the `Semdexer` interface. | | app/services/semdex/weaviate/... | Added `ScoreRelevance` method to `weaviateSemdexer`, updated mapping functions, and included new fields in structs. | | app/transports/openapi/bindings/... | Modified `serialiseCollectionItem` to include `RelevanceScore` in the serialized output. | | web/src/api/openapi/schemas/... | Added `relevance_score` field to `CollectionItemMetadata` and exported `RelevanceScore` type for better API integration. | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant User participant WebUI participant Backend participant Semdex participant Weaviate User->>WebUI: Request Collection WebUI->>Backend: Fetch Collection Backend->>Semdex: Get Collection Semdex->>Weaviate: Query Relevance Scores Weaviate-->>Semdex: Return Scores Semdex-->>Backend: Collection with Scores Backend-->>WebUI: Collection Data WebUI-->>User: Display Collection ``` ## Poem > In fields of code where data thrives, > A rabbit hops, and relevance arrives. > With scores now tallied, items gleam, > In collections vast, a coder's dream. > Through nodes and graphs, the queries flew, > A brighter way for all to view. > 🐇✨📊

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 .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.