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 message replace type to __event_emitter__
Added
Add message replace type to __event_emitter__
Screenshots or Videos
Sample function:
"""
title: Test Skyrim
author: Michael Poluektov
author_url: https://github.com/michaelpoluektov
description: Showcase for replace message via __event_emitter__
version: 0.1.0
"""fromconstantsimportTASKSfromtypingimportGenerator,IteratorfromasyncioimportsleepclassPipe:def__init__(self):self.type="manifold"defpipes(self)->list[dict[str,str]]:return[{"id":"Test","name":"Message test"}]asyncdefpipe(self,body:dict,__user__:dict,__event_emitter__=None,__task__=None)->str|Generator|Iterator:if__task__==TASKS.TITLE_GENERATION:return"Your title here"messages=["Hey, you. You're finally awake.","You were trying to cross the border, right?","Walked right into that Imperial ambush, same as us, and that thief over there.","Damn you Stormcloaks. Skyrim was fine until you came along.","Empire was nice and lazy.","They hadn't been looking for you.",]ifnot__event_emitter__:return"Fail."formessageinmessages:new_message=""forwordinmessage.split(" "):new_message+=f"{word} "await__event_emitter__({"type":"replace","data":{"content":new_message}})awaitsleep(0.1)new_message=messageawait__event_emitter__({"type":"replace","data":{"content":new_message}})awaitsleep(2)whilenew_message!="...":idx=new_message.rfind(" ")ifidx==-1:new_message="..."else:new_message=new_message[:idx]await__event_emitter__({"type":"replace","data":{"content":new_message}})awaitsleep(0.1)return""
🔄 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/3825
**Author:** [@michaelpoluektov](https://github.com/michaelpoluektov)
**Created:** 7/12/2024
**Status:** ✅ Merged
**Merged:** 7/12/2024
**Merged by:** [@tjbck](https://github.com/tjbck)
**Base:** `dev` ← **Head:** `replace-message-event`
---
### 📝 Commits (1)
- [`540a669`](https://github.com/open-webui/open-webui/commit/540a669daea499fa33f514f825d9614de9d20d9f) feat: replace message event
### 📊 Changes
**1 file changed** (+2 additions, -0 deletions)
<details>
<summary>View changed files</summary>
📝 `src/lib/components/chat/Chat.svelte` (+2 -0)
</details>
### 📄 Description
# 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?
- [x] **Dependencies:** Are there any new dependencies? Have you updated the dependency versions in the documentation?
- [x] **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 message replace type to `__event_emitter__`
### Added
- Add message replace type to `__event_emitter__`
### Screenshots or Videos
Sample function:
```python
"""
title: Test Skyrim
author: Michael Poluektov
author_url: https://github.com/michaelpoluektov
description: Showcase for replace message via __event_emitter__
version: 0.1.0
"""
from constants import TASKS
from typing import Generator, Iterator
from asyncio import sleep
class Pipe:
def __init__(self):
self.type = "manifold"
def pipes(self) -> list[dict[str, str]]:
return [{"id": "Test", "name": "Message test"}]
async def pipe(
self, body: dict, __user__: dict, __event_emitter__=None, __task__=None
) -> str | Generator | Iterator:
if __task__ == TASKS.TITLE_GENERATION:
return "Your title here"
messages = [
"Hey, you. You're finally awake.",
"You were trying to cross the border, right?",
"Walked right into that Imperial ambush, same as us, and that thief over there.",
"Damn you Stormcloaks. Skyrim was fine until you came along.",
"Empire was nice and lazy.",
"They hadn't been looking for you.",
]
if not __event_emitter__:
return "Fail."
for message in messages:
new_message = ""
for word in message.split(" "):
new_message += f"{word} "
await __event_emitter__(
{"type": "replace", "data": {"content": new_message}}
)
await sleep(0.1)
new_message = message
await __event_emitter__(
{"type": "replace", "data": {"content": new_message}}
)
await sleep(2)
while new_message != "...":
idx = new_message.rfind(" ")
if idx == -1:
new_message = "..."
else:
new_message = new_message[:idx]
await __event_emitter__(
{"type": "replace", "data": {"content": new_message}}
)
await sleep(0.1)
return ""
```
https://github.com/user-attachments/assets/54c03780-43d2-4477-8344-a3ddf87e246b
---
<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/3825
Author: @michaelpoluektov
Created: 7/12/2024
Status: ✅ Merged
Merged: 7/12/2024
Merged by: @tjbck
Base:
dev← Head:replace-message-event📝 Commits (1)
540a669feat: replace message event📊 Changes
1 file changed (+2 additions, -0 deletions)
View changed files
📝
src/lib/components/chat/Chat.svelte(+2 -0)📄 Description
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__Screenshots or Videos
Sample function:
https://github.com/user-attachments/assets/54c03780-43d2-4477-8344-a3ddf87e246b
🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.