Motivation: I would like to create custom citations for my search tool. Example usage:
asyncdefcustom_search_docs(self,query:str,__event_emitter__)->str:await__event_emitter__({"type":"status","data":{"type":"status","description":"Retrieving documentation","done":False}})# retrieve use datadocs=retriever.invoke(query)doc=docs[0]await__event_emitter__({"type":"citation","data":{"document":[doc["page_content"]],"metadata":{"source":doc["metadata"]["url"]},"source":{"name":doc["metadata"]["title"]},}})await__event_emitter__({"type":"status","data":{"type":"status","description":"Retrieving documentation","done":True}})# the rest of the tool
This currently doesn't work: I'm guessing messages is not rendered directly?
Pull Request Checklist
Note to first-time contributors: Please open a discussion post in Discussions and describe your changes before submitting a pull request.
Before submitting, make sure you've checked the following:
Target branch: Please verify that the pull request targets the dev branch.
Description: Provide a concise description of the changes made in this pull request.
Changelog: Ensure a changelog entry following the format of Keep a Changelog is added at the bottom of the PR description.
Documentation: Have you updated relevant documentation Open WebUI Docs, or other documentation sources?
Dependencies: Are there any new dependencies? Have you updated the dependency versions in the documentation?
Testing: Have you written and run sufficient tests for validating the changes?
Code review: Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards?
Prefix: To cleary categorize this pull request, prefix the pull request title, using one of the following:
BREAKING CHANGE: Significant changes that may affect compatibility
build: Changes that affect the build system or external dependencies
ci: Changes to our continuous integration processes or workflows
chore: Refactor, cleanup, or other non-functional code changes
docs: Documentation update or addition
feat: Introduces a new feature or enhancement to the codebase
fix: Bug fix or error correction
i18n: Internationalization or localization changes
perf: Performance improvement
refactor: Code restructuring for better maintainability, readability, or scalability
style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc.)
test: Adding missing tests or correcting existing tests
WIP: Work in progress, a temporary label for incomplete or ongoing work
Changelog Entry
Description
Add the ability to create new citations via __event_emitter__
Added
Add the ability to create new citations via __event_emitter__
Breaking Changes
BREAKING CHANGE: __event_emitter__ now requires type key to specify which kind of event we'd like to emit, with data containing the payload.
🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.
## 📋 Pull Request Information
**Original PR:** https://github.com/open-webui/open-webui/pull/3615
**Author:** [@michaelpoluektov](https://github.com/michaelpoluektov)
**Created:** 7/3/2024
**Status:** ✅ Merged
**Merged:** 7/6/2024
**Merged by:** [@tjbck](https://github.com/tjbck)
**Base:** `dev` ← **Head:** `citations-event`
---
### 📝 Commits (4)
- [`4e433d9`](https://github.com/open-webui/open-webui/commit/4e433d9015b2d744bc0efdc504d2a8865f0bc5e1) wip: citations via __event_emitter__
- [`0527755`](https://github.com/open-webui/open-webui/commit/05277556005230847f552b55c2d896ecd57fe281) use data field
- [`55b7c30`](https://github.com/open-webui/open-webui/commit/55b7c30028c96dc58e14b563dcd26780dbea34cb) simplify citation API
- [`983fe4b`](https://github.com/open-webui/open-webui/commit/983fe4b2bcd5e8438353f5d37a8819a4cd492c2f) refac
### 📊 Changes
**1 file changed** (+19 additions, -11 deletions)
<details>
<summary>View changed files</summary>
📝 `src/lib/components/chat/Chat.svelte` (+19 -11)
</details>
### 📄 Description
Motivation: I would like to create custom citations for my search tool. Example usage:
```python
async def custom_search_docs(self, query: str, __event_emitter__) -> str:
await __event_emitter__(
{"type": "status", "data": {"type": "status", "description": "Retrieving documentation", "done": False}}
)
# retrieve use data
docs = retriever.invoke(query)
doc = docs[0]
await __event_emitter__(
{
"type": "citation",
"data": {
"document": [doc["page_content"]],
"metadata": {"source": doc["metadata"]["url"]},
"source": {"name": doc["metadata"]["title"]},
}
}
)
await __event_emitter__(
{"type": "status", "data": {"type": "status", "description": "Retrieving documentation", "done": True}}
)
# the rest of the tool
```
This currently doesn't work: I'm guessing `messages` is not rendered directly?
# Pull Request Checklist
### Note to first-time contributors: Please open a discussion post in [Discussions](https://github.com/open-webui/open-webui/discussions) and describe your changes before submitting a pull request.
**Before submitting, make sure you've checked the following:**
- [x] **Target branch:** Please verify that the pull request targets the `dev` branch.
- [x] **Description:** Provide a concise description of the changes made in this pull request.
- [x] **Changelog:** Ensure a changelog entry following the format of [Keep a Changelog](https://keepachangelog.com/) is added at the bottom of the PR description.
- [ ] **Documentation:** Have you updated relevant documentation [Open WebUI Docs](https://github.com/open-webui/docs), or other documentation sources?
- [ ] **Dependencies:** Are there any new dependencies? Have you updated the dependency versions in the documentation?
- [ ] **Testing:** Have you written and run sufficient tests for validating the changes?
- [x] **Code review:** Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards?
- [x] **Prefix:** To cleary categorize this pull request, prefix the pull request title, using one of the following:
- **BREAKING CHANGE**: Significant changes that may affect compatibility
- **build**: Changes that affect the build system or external dependencies
- **ci**: Changes to our continuous integration processes or workflows
- **chore**: Refactor, cleanup, or other non-functional code changes
- **docs**: Documentation update or addition
- **feat**: Introduces a new feature or enhancement to the codebase
- **fix**: Bug fix or error correction
- **i18n**: Internationalization or localization changes
- **perf**: Performance improvement
- **refactor**: Code restructuring for better maintainability, readability, or scalability
- **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc.)
- **test**: Adding missing tests or correcting existing tests
- **WIP**: Work in progress, a temporary label for incomplete or ongoing work
# Changelog Entry
### Description
- Add the ability to create new citations via `__event_emitter__`
### Added
- Add the ability to create new citations via `__event_emitter__`
### Breaking Changes
- **BREAKING CHANGE**: `__event_emitter__` now requires `type` key to specify which kind of event we'd like to emit, with `data` containing the payload.
---
<sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
📋 Pull Request Information
Original PR: https://github.com/open-webui/open-webui/pull/3615
Author: @michaelpoluektov
Created: 7/3/2024
Status: ✅ Merged
Merged: 7/6/2024
Merged by: @tjbck
Base:
dev← Head:citations-event📝 Commits (4)
4e433d9wip: citations via event_emitter0527755use data field55b7c30simplify citation API983fe4brefac📊 Changes
1 file changed (+19 additions, -11 deletions)
View changed files
📝
src/lib/components/chat/Chat.svelte(+19 -11)📄 Description
Motivation: I would like to create custom citations for my search tool. Example usage:
This currently doesn't work: I'm guessing
messagesis not rendered directly?Pull Request Checklist
Note to first-time contributors: Please open a discussion post in Discussions and describe your changes before submitting a pull request.
Before submitting, make sure you've checked the following:
devbranch.Changelog Entry
Description
__event_emitter__Added
__event_emitter__Breaking Changes
__event_emitter__now requirestypekey to specify which kind of event we'd like to emit, withdatacontaining the payload.🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.