GraphRAG-SDK icon indicating copy to clipboard operation
GraphRAG-SDK copied to clipboard

Ollama integration

Open galshubeli opened this issue 1 year ago β€’ 1 comments

Add Ollama to the list of available models.

Summary by CodeRabbit

  • New Features

    • Introduced comprehensive prompts for ontology creation and data extraction for graph databases.
    • Enhanced functionality for generating OpenCypher statements and managing information flow between agents.
  • Bug Fixes

    • Updated the initialization process to ensure configuration defaults are always defined.
  • Tests

    • Improved test setup with a more comprehensive ontology and modified logic to focus on counting actors in movies.

galshubeli avatar Oct 13 '24 14:10 galshubeli

Walkthrough

The changes in this pull request involve significant updates to the OllamaGenerativeModel and OllamaChatSession classes in the graphrag_sdk/models/ollama.py file, enhancing type clarity and method organization. The test suite in tests/test_kg_ollama.py has been refined, with an expanded ontology and updated logic for verifying actor counts. Additionally, the workflow configuration in .github/workflows/test.yml has been improved to include health checks for the ollama service, ensuring its readiness before running tests.

Changes

File Change Summary
graphrag_sdk/models/ollama.py Updated constructors in OllamaGenerativeModel and OllamaChatSession to use Optional for parameters. Added _connect_to_client and check_and_pull_model methods. Modified ask and send_message methods for clarity. Added get_chat_history.
tests/test_kg_ollama.py Enhanced test setup and logic; added "Actor" and "Movie" entities to the ontology. Updated test_kg_creation to count actors instead of listing them. Added test_kg_delete method.
.github/workflows/test.yml Added health check for ollama service and a waiting step for readiness. Introduced log checking for debugging in case of failures.

Possibly related PRs

  • #21: The changes in the tests/test_kg_ollama.py file involve modifications related to the OllamaGenerativeModel, which is directly referenced in the main PR's updates to the OllamaGenerativeModel class. The testing enhancements are likely to be related to the functionalities introduced in the main PR.
  • #22: The AzureOpenAiGenerativeModel class introduced in this PR has a constructor that initializes with an optional generation_config, similar to the changes made in the OllamaGenerativeModel class in the main PR. This indicates a shared focus on generative model configurations.

Suggested reviewers

  • swilly22

πŸ‡ In the code, we hop and play,
With models that brighten the day.
From actors to chats, we refine,
Our tests now sparkle and shine!
Health checks in place, all systems go,
Let’s code and create, with joy and flow! 🌟


πŸ“œ Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL

πŸ“₯ Commits

Files that changed from the base of the PR and between 99cdea1320c1b9019c108a66604c62fb6f7dcb2b and b258803a0c8172539a3dd8fa72610f8277bfe53e.

πŸ“’ Files selected for processing (1)
  • tests/test_kg_ollama.py (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • tests/test_kg_ollama.py

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 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.

coderabbitai[bot] avatar Oct 13 '24 14:10 coderabbitai[bot]