🛠️ 개발

사용자 정의 도구 키트 작성

도구 키트는 메타데이터를 포함하는 상단 수준의 docstring과 Tools 클래스가 포함된 단일 Python 파일에서 정의됩니다.

상단 수준 Docstring 예

"""
title: 문자열 반전
author: 작성자 이름
author_url: https://website.com
git_url: https://github.com/username/string-reverse.git
description: 이 도구는 문자열의 반전을 계산합니다
required_open_webui_version: 0.4.0
requirements: langchain-openai, langgraph, ollama, langchain_ollama
version: 0.4.0
licence: MIT
"""

도구 클래스

Tools라는 클래스 내 메서드로 도구를 정의해야 하며, 선택적으로 Valves 및 UserValves라는 하위 클래스를 사용할 수 있습니다. 예:

class Tools:
    def __init__(self):
        """도구를 초기화합니다."""
        self.valves = self.Valves()

    class Valves(BaseModel):
        api_key: str = Field("", description="여기에 API 키를 입력하세요")

    def reverse_string(self, string: str) -> str:
        """
        입력 문자열을 반전합니다.
        :param string: 반전할 문자열
        """
        # 밸브 사용 예
        if self.valves.api_key != "42":
            return "잘못된 API 키"
        return string[::-1] 

타입 힌트

각 도구는 인수에 대한 타입 힌트를 가져야 합니다. 타입은 queries_and_docs: list[tuple[str, int]]처럼 중첩될 수도 있습니다. 이러한 타입 힌트는 모델에 전달되는 JSON 스키마를 생성하는 데 사용됩니다. 타입 힌트가 없는 도구는 일관성이 크게 떨어질 수 있습니다.

밸브(Valves) 및 사용자 밸브(UserValves) - (선택 사항, 하지만 강력히 권장됨)

밸브(Valves)와 사용자 밸브(UserValves)는 도구의 설정을 사용자화하기 위해 사용됩니다. 전용 Valves & UserValves 페이지에서 자세히 읽을 수 있습니다.

선택적 인수

아래는 도구가 의존할 수 있는 선택적 인수 목록입니다:

• __event_emitter__: 이벤트 전송 (아래 섹션 참조)
• __event_call__: 이벤트 전송과 동일하지만 사용자 상호작용에 사용
• __user__: 사용자 정보를 포함하는 딕셔너리. __user__["valves"]에 UserValves 객체도 포함되어 있습니다.
• __metadata__: 채팅 메타데이터 딕셔너리
• __messages__: 이전 메시지의 목록
• __files__: 첨부된 파일
• __model__: 모델 정보를 포함하는 딕셔너리

위 인수를 각 도구 클래스의 메서드에 추가하면 됩니다. 위의 예에서 __user__처럼 추가하십시오.

이벤트 발생기

이벤트 발생기는 채팅 인터페이스에 추가 정보를 추가하는 데 사용됩니다. 필터 출력과 유사하게, 이벤트 발생기는 채팅에 콘텐츠를 추가할 수 있습니다. 필터 출력과 달리, 정보를 제거할 수는 없습니다. 또한 발생기는 도구 내의 어느 단계에서든 활성화할 수 있습니다.

이벤트 발생기에는 두 가지 유형이 있습니다:

모델이 도구를 호출할 수 없는 것처럼 보이면, 도구가 활성화되어 있는지 확인하세요(모델 페이지 또는 채팅 입력 필드 옆의 + 기호를 통해 활성화 가능). 또한 모델 페이지의 고급 매개변수 섹션에서 Function Calling 인수를 Default에서 Native로 변경할 수 있습니다.

상태

이는 단계가 진행되는 동안 메시지에 상태를 추가하는 데 사용됩니다. 이러한 상태는 도구 내 어느 단계에서든 수행할 수 있습니다. 이러한 상태는 메시지 콘텐츠 바로 위에 나타납니다. 대량의 정보를 처리하거나 LLM 응답에 지연이 있는 도구에는 매우 유용합니다. 이를 통해 실시간으로 처리 중인 정보를 사용자에게 알릴 수 있습니다.

await __event_emitter__(
            {
                "type": "status", # 여기에서 유형을 설정합니다
                "data": {"description": "채팅에 표시되는 메시지", "done": False, "hidden": False}, 
                # `done`이 False임을 유의하세요. 이는 여전히 상태를 전송하고 있음을 나타냅니다.
            }
        )

예제

async def test_function(
        self, prompt: str, __user__: dict, __event_emitter__=None
    ) -> str:
        """
        이것은 데모입니다

        :param test: 이것은 테스트 매개변수입니다
        """

        await __event_emitter__(
            {
                "type": "status", # 여기에서 유형을 설정합니다
                "data": {"description": "채팅에 표시되는 메시지", "done": False}, 
                # `done`이 False임을 유의하세요. 이는 여전히 상태를 전송하고 있음을 나타냅니다.
            }
        )

        # 여기에서 다른 로직을 수행하십시오
        await __event_emitter__(
            {
                "type": "status",
                "data": {"description": "작업 메시지 완료", "done": True, "hidden": False},
                # `done`이 True임을 유의하세요. 이는 상태 전송이 완료되었음을 나타냅니다.
                # 메시지가 반환된 후 상태를 제거하려면 "hidden": True로 설정할 수도 있습니다.
            }
        )

        except Exception as e:
            await __event_emitter__(
                {
                    "type": "status",
                    "data": {"description": f"오류가 발생했습니다: {e}", "done": True},
                }
            )

            return f"사용자에게 알리기: {e}"

메시지

이 타입은 Tool의 어느 단계에서나 LLM에 메시지를 추가하는 데 사용됩니다. 따라서 LLM 응답 전, 후, 도중에 메시지를 추가하거나 이미지를 삽입하거나 웹 페이지를 렌더링할 수 있습니다.

await __event_emitter__(
                    {
                        "type": "message", # 여기서 타입을 설정합니다
                        "data": {"content": "이 메시지는 채팅에 추가됩니다."},
                        # 메시지 타입에서는 완료 조건을 설정할 필요가 없습니다
                    }
                )

예제

async def test_function(
        self, prompt: str, __user__: dict, __event_emitter__=None
    ) -> str:
        """
        이건 데모입니다

        :param test: 이건 테스트 매개변수입니다
        """

        await __event_emitter__(
                    {
                        "type": "message", # 여기서 타입을 설정합니다
                        "data": {"content": "이 메시지는 채팅에 추가됩니다."},
                        # 메시지 타입에서는 완료 조건을 설정할 필요가 없습니다
                    }
                )

        except Exception as e:
            await __event_emitter__(
                {
                    "type": "status",
                    "data": {"description": f"오류가 발생했습니다: {e}", "done": True},
                }
            )

            return f"사용자에게 알리기: {e}"

인용

이 타입은 채팅에서 인용이나 참고를 제공하는 데 사용됩니다. 콘텐츠, 출처, 관련 메타데이터를 명시적으로 제공할 수 있습니다. 아래는 인용 이벤트를 발생시키는 예제입니다:

await __event_emitter__(
    {
        "type": "citation",
        "data": {
            "document": [content],
            "metadata": [
                {
                    "date_accessed": datetime.now().isoformat(),
                    "source": title,
                }
            ],
            "source": {"name": title, "url": url},
        },
    }
)

여러 인용을 보내려면 인용을 반복적으로 다루고 에미터를 여러 번 호출할 수 있습니다. 사용자 정의 인용을 구현할 때, Tools 클래스의 __init__ 메서드에서 self.citation = False를 설정해야 합니다. 그렇지 않으면 내장된 인용이 보낸 인용을 덮어쓰게 됩니다. 예를 들어:

def __init__(self):
    self.citation = False

주의: 만약 self.citation = True를 설정하면, 이는 사용자가 보낸 사용자 정의 인용을 자동 생성된 반환 인용으로 대체합니다. 이를 비활성화하면 사용자가 자신의 인용 참고를 완전히 관리할 수 있습니다.

예제

class Tools:
    class UserValves(BaseModel):
        test: bool = Field(
            default=True, description="테스트"
        )

    def __init__(self):
        self.citation = False

async def test_function(
        self, prompt: str, __user__: dict, __event_emitter__=None
    ) -> str:
        """
        이건 단순히 인용을 생성하는 데모입니다

        :param test: 이건 테스트 매개변수입니다
        """

        await __event_emitter__(
            {
                "type": "citation",
                "data": {
                    "document": ["이 메시지는 클릭 시 채팅의 인용으로 추가됩니다"],
                    "metadata": [
                        {
                            "date_accessed": datetime.now().isoformat(),
                            "source": title,
                        }
                    ],
                    "source": {"name": "컨텐츠 제목", "url": "http://link-to-citation"},
                },
            }
        )

외부 패키지

Tools 정의 메타데이터에서 사용자 정의 패키지를 지정할 수 있습니다. 저장을 클릭하면 줄이 분석되고 pip install이 모든 요구 사항에 대해 한 번에 실행됩니다.

pip이 Open WebUI와 동일한 프로세스에서 사용되므로 설치 중에 UI가 완전히 반응하지 않을 것입니다.

Open WebUI의 요구 사항과의 패키지 충돌을 처리하기 위한 조치는 취해지지 않습니다. 즉, 요구 사항을 지정하면 주의하지 않을 경우 Open WebUI가 손상될 수 있습니다. 이를 해결하기 위해 open-webui 자체를 요구 사항으로 지정할 수 있습니다.

예제

"""
title: myToolName
author: myName
funding_url: [여기에 링크를 입력하면 사용자가 `하트` 버튼 뒤에 표시된 링크를 통해 지원을 보여줄 것입니다]
version: 1.0.0
# 버전은 UI에 표시되어 사용자가 업데이트를 추적할 수 있도록 도와줍니다.
license: GPLv3
description: [권장됨]
requirements: package1>=2.7.0,package2,package3
"""