Doc/add documentation on the document qa engine library#36
Merged
lfoppiano merged 8 commits intoMay 7, 2026
Conversation
…DME to reference the documentation
lfoppiano
requested changes
Apr 24, 2026
lfoppiano
left a comment
lfoppiano
left a comment
Collaborator
There was a problem hiding this comment.
This is good, however this task was initially created with the goal of adding more documentation in the actual code, so that people that use this library can figure out how to use it.
lfoppiano
approved these changes
May 6, 2026
lfoppiano
left a comment
lfoppiano
left a comment
Collaborator
There was a problem hiding this comment.
Looks good. Please check my only comment.
| @@ -0,0 +1,249 @@ | |||
| # 📝 document-qa-engine documentation | |||
|
|
|||
| > **Version**: 0.5.1 · **License**: Apache 2.0 · **PyPI**: `pip install document-qa-engine` | |||
Collaborator
There was a problem hiding this comment.
I'd remvoe version number here, because it will require to update it at each release.
lfoppiano
reviewed
Jun 7, 2026
| headers = {} | ||
| if self.api_key: | ||
| headers = {'x-api-key': self.api_key} | ||
| headers["Authorization"] = f"Bearer {self.api_key}" |
Collaborator
There was a problem hiding this comment.
@Sanakhamassi I've been looking at the PR #35 and stumbled upon this issue. It seems that you updated how the embedding were invoked (I overlooked it), but I can't find any change in the deployment script.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added documentation on the document qa engine library #17