-
-
Notifications
You must be signed in to change notification settings - Fork 5.1k
feat(ContextChat): add IContentProviderWithSearchTask #63459
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,54 @@ | ||||||
| <?php | ||||||
|
|
||||||
| declare(strict_types=1); | ||||||
|
|
||||||
| /** | ||||||
| * SPDX-FileCopyrightText: 2026 Nextcloud GmbH and Nextcloud contributors | ||||||
| * SPDX-License-Identifier: AGPL-3.0-or-later | ||||||
| */ | ||||||
|
|
||||||
| namespace OCP\ContextChat; | ||||||
|
|
||||||
| /** | ||||||
| * This interface defines methods to implement a Context Chat content provider | ||||||
| * with a search task and data description. | ||||||
| * @since 35.0.0 | ||||||
| */ | ||||||
| interface IContentProviderWithSearchTask extends IContentProvider { | ||||||
| /** | ||||||
| * A short description about the kind of data provided by this provider. | ||||||
| * This part is sent to the main model to make sense of the retrieved documents. | ||||||
| * | ||||||
| * Some examples can be: | ||||||
| * - "Email messages from the user's mailbox with sender, recipients, subject, | ||||||
| * and date." | ||||||
| * - "Chat messages from group and private conversations, each prefixed with | ||||||
| * author and timestamp. They are short and may be informal, and often only | ||||||
| * make sense in sequence. | ||||||
| * | ||||||
| * Return an empty string to keep it empty. | ||||||
| * | ||||||
| * @return string | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
I suppose |
||||||
| * @since 35.0.0 | ||||||
| */ | ||||||
| public function getDataDescription(): string; | ||||||
|
|
||||||
| /** | ||||||
| * A short (10-25 words) search task to be performed by context chat for the | ||||||
| * content provider. | ||||||
| * This is not shown to the user, only passed to the embedding model if the model | ||||||
| * is set to https://huggingface.co/intfloat/multilingual-e5-large-instruct | ||||||
| * | ||||||
| * Some examples can be: | ||||||
| * - "Given a question, retrieve email messages whose subject or body discusses | ||||||
| * or answers it, including quoted replies inside threads." | ||||||
| * - "Given a question, retrieve chat messages that mention or answer it, | ||||||
| * even when written informally or as short fragments." | ||||||
| * | ||||||
| * Return an empty string to use the generic default. | ||||||
| * | ||||||
| * @return string | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| * @since 35.0.0 | ||||||
| */ | ||||||
| public function getSearchTaskDescription(): string; | ||||||
| } | ||||||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is missing a
[#Consumable]or/and[#Implementable]attribute for new class or interface in OCP