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

feat: Update parameters in search API route to match search function parameters order #528

Merged
merged 9 commits into from
Feb 13, 2025

Conversation

soekja
Copy link
Contributor

@soekja soekja commented Feb 12, 2025

Description

Updated handling of SearchType through the chain:
Router receives JSON with searchType Enum, example: "searchType": "CHUNKS"
FastAPI converts to SearchType enum via SearchPayloadDTO
search_v2.py expects SearchType enum
search.py takes SearchType enum and extracts value
log_query.py takes string value
Query model stores string in database

get_search_router.py

Matched the exact field name from JSON payload searchType instead of search_type in the SearchPayloadDTO class.
Changed cognee_search() params to use payload.query and payload.searchType

search.py
Changed query_type to SearchType
log_query to accept query_type.value parameter instead of str(query_type)

DCO Affirmation

I affirm that all code in every commit of this pull request conforms to the terms of the Topoteretes Developer Certificate of Origin

Summary by CodeRabbit

  • Refactor
    • Updated the search functionality to improve consistency and reliability.
    • Enhanced validation by switching to stricter search type checks, ensuring only valid search types are processed.
    • Maintained robust error handling for uninterrupted search operations.

….py for handling SearchType through the chain.
Copy link
Contributor

coderabbitai bot commented Feb 12, 2025

Walkthrough

This pull request modifies the search functionality in the API and search modules. The search_type attribute in the SearchPayloadDTO class remains unchanged, but the order of parameters in the cognee_search function call is updated. Additionally, the type of the query_type parameter in the search function is changed from a string to a SearchType enumeration, enhancing type safety. Logging now reflects this change, while error handling remains unchanged.

Changes

File Path Change Summary
cognee/api/v1/.../get_search_router.py - Updated the cognee_search function call to use query_text=payload.query, query_type=payload.search_type, and user=user in the search function.
cognee/modules/.../search.py - Updated method signature of search and specific_search to accept query_type as a SearchType rather than a string.
- Adjusted logging to use query_type.value.

Sequence Diagram(s)

sequenceDiagram
    participant C as Client
    participant R as API Router
    participant S as Search Module
    
    C->>R: POST /search {query, search_type}
    R->>R: Create SearchPayloadDTO with search_type
    R->>S: cognee_search(query_text=payload.query, query_type=payload.search_type, user=user)
    S->>S: Validate query_type as SearchType
    S-->>R: Return search results or error
    R-->>C: Send response
Loading

Poem

"Hopping through code with nimble feet,
Changing names and types so neat,
Search flows now in a brand new way,
Bugs and errors kept at bay,
A bunny cheer for code so sweet! 🐇✨"


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d023608 and ca33657.

📒 Files selected for processing (1)
  • cognee/api/v1/search/routers/get_search_router.py (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • cognee/api/v1/search/routers/get_search_router.py
⏰ Context from checks skipped due to timeout of 90000ms (16)
  • GitHub Check: run_simple_example_test / test
  • GitHub Check: run_notebook_test / test
  • GitHub Check: run_eval_framework_test / test
  • GitHub Check: run_notebook_test / test
  • GitHub Check: run_dynamic_steps_example_test / test
  • GitHub Check: run_multimedia_example_test / test
  • GitHub Check: run_notebook_test / test
  • GitHub Check: test
  • GitHub Check: test
  • GitHub Check: test
  • GitHub Check: lint (ubuntu-latest, 3.11.x)
  • GitHub Check: windows-latest
  • GitHub Check: lint (ubuntu-latest, 3.10.x)
  • GitHub Check: profiler
  • GitHub Check: Build Cognee Backend Docker App Image
  • GitHub Check: docker-compose-test

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@borisarzentar borisarzentar changed the title Updates to get_search_router.py and search.py to fix search feat: Update parameters in search API route to match search parameters order Feb 12, 2025
@borisarzentar borisarzentar changed the title feat: Update parameters in search API route to match search parameters order feat: Update parameters in search API route to match search function parameters order Feb 12, 2025
@Vasilije1990 Vasilije1990 self-requested a review February 13, 2025 20:03
@Vasilije1990 Vasilije1990 merged commit a602094 into topoteretes:dev Feb 13, 2025
16 of 37 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants