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

Allow documents to be loaded locally for Knowledge Injection #69

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

murthyrudra
Copy link

I have updated the knowledge.json in v3 schema to include an optional field named folder which points to the local filesystem. For this update, I had to make the fields repo and commit optional instead of required.

The users can specify the folder as follows in the qna.yaml file in the taxonomy

document_outline: |
  The document contains information about Electromagnetism.
document:
  folder: /user/murthyrudra/documents/
  patterns:
    - "*.md"

Copy link
Contributor

@bjhargrave bjhargrave left a comment

Choose a reason for hiding this comment

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

This change would also be a move to v4 since it is adding a new feature and anyone using the new feature would need to be able to specify their dependence by declaring the document is v4.

Has such a change like this been discussed and agreed in a design doc for the whole project since many parts of instructlab will need coordinated changes?

@@ -76,28 +76,32 @@
"description": "The knowledge documents.",
"type": "object",
"required": [
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think you have properly specified the oneOf choice here correctly in JSON schema. It is one of either repo+commit or folder.

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.

2 participants