community: add include_labels option to ConfluenceLoader #28259
Merged
Conversation
This file contains 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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 1 Skipped Deployment
|
08a12d8 to
f3dffce
Compare
nakamasato
commented
Nov 21, 2024
| metadata = { | ||
| "title": page["title"], | ||
| "id": page["id"], | ||
| "source": self.base_url.strip("/") + page["_links"]["webui"], | ||
| **({"labels": labels} if include_labels else {}), |
There was a problem hiding this comment.
set labels key only when include_labels is set to true
Comment on lines
+596
to
+601
| labels = [ | ||
| label["name"] | ||
| for label in page.get("metadata", {}) | ||
| .get("labels", {}) | ||
| .get("results", []) | ||
| ] |
There was a problem hiding this comment.
nakamasato
commented
Nov 21, 2024
Comment on lines
+339
to
+345
| expand = ",".join( | ||
| [ | ||
| content_format.value, | ||
| "version", | ||
| *(["metadata.labels"] if include_labels else []), | ||
| ] | ||
| ) |
There was a problem hiding this comment.
expand is a comma-separated query parameter. originally hardcoded as f"{content_format.value},version".
I made a variable so we can add more option if necessary in the future as expand parameter supports a lot more values.
(ref)
efriis
approved these changes
Dec 9, 2024
ccurme
pushed a commit
that referenced
this pull request
Jan 8, 2025
…s loaded via CQL (#29089) ## Description This PR enables label inclusion for documents loaded via CQL in the confluence-loader. - Updated _lazy_load to pass the include_labels parameter instead of False in process_pages calls for documents loaded via CQL. - Ensured that labels can now be fetched and added to the metadata for documents queried with cql. ## Related Modification History This PR builds on the previous functionality introduced in [#28259](#28259), which added support for including labels with the include_labels option. However, this functionality did not work as expected for CQL queries, and this PR fixes that issue. If the False handling was intentional due to another issue, please let me know. I have verified with our Confluence instance that this change allows labels to be correctly fetched for documents loaded via CQL. ## Issue Fixes #29088 ## Dependencies No changes. ## Twitter Handle [@zenoengine](https://x.com/zenoengine)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description:
Enable
ConfluenceLoaderto include labels withinclude_labelsoption (falseby default for backward compatibility). and the labels are set tometadatain theDocument. e.g.{"labels": ["l1", "l2"]}Notes
Confluence API supports to get labels by providing
metadata.labelstoexpandquery parameterAll of the following functions support
expandin the same way:Issue:
No issue related to this PR.
Dependencies:
No changes.
Twitter handle:
@gymnstcs
Add tests and docs: If you're adding a new integration, please include
docs/docs/integrationsdirectory.Lint and test: Run
make format,make lintandmake testfrom the root of the package(s) you've modified. See contribution guidelines for more: https://python.langchain.com/docs/contributing/