App

プラグインから Dify アプリの Chat、Workflow、Completion インターフェースを呼び出す

このドキュメントは AI によって自動翻訳されています。不正確な部分がある場合は、英語版 を参照してください。

プラグインは Dify 内の App を逆呼び出しして、そのデータにアクセスできます。ストリーミング呼び出しと非ストリーミング呼び出しの両方に対応しています。逆呼び出しの基本概念に不慣れな場合は、まず Dify サービスの逆呼び出し をお読みください。

インターフェースの種類：

• Chat インターフェース：Chatbot、Agent、Chatflow アプリケーションはすべてチャットベースで、入力パラメータと出力パラメータの型が共通のため、このインターフェースを共有します。
• Workflow インターフェース：Workflow アプリケーションで使用します。
• Completion インターフェース：Completion（テキスト生成）アプリケーションで使用します。

プラグインがアクセスできるのは、そのプラグインが存在するワークスペース内の App のみです。

Chat インターフェースの呼び出し

エントリーポイント

    self.session.app.chat

インターフェース仕様

    def invoke(
        self,
        app_id: str,
        query: str,
        inputs: dict,
        response_mode: Literal["streaming", "blocking"] = "streaming",
        conversation_id: str | None = None,
        user: str | None = None,
    ) -> Generator[dict, None, None] | dict:
        pass

response_mode が streaming の場合、このインターフェースは Generator[dict] を返します。それ以外の場合は dict を返します。具体的なインターフェースフィールドについては、ServiceApi の戻り結果を参照してください。

ユースケース

次の例では、Endpoint 内で Chat タイプの App を呼び出し、結果を直接返します。

import json
from typing import Mapping
from werkzeug import Request, Response
from dify_plugin import Endpoint

class Duck(Endpoint):
    def _invoke(self, r: Request, values: Mapping, settings: Mapping) -> Response:
        """
        Invokes the endpoint with the given request.
        """
        app_id = values["app_id"]

        def generator():
            response = self.session.app.chat.invoke(
                app_id=app_id,
                query="Hello from the plugin",
                inputs={},
                response_mode="streaming",
                conversation_id="some-conversation-id",
            )

            for data in response:
                yield f"{json.dumps(data)} <br>"

        return Response(generator(), status=200, content_type="text/html")

Workflow インターフェースの呼び出し

エントリーポイント

    self.session.app.workflow

インターフェース仕様

    def invoke(
        self,
        app_id: str,
        inputs: dict,
        response_mode: Literal["streaming", "blocking"] = "blocking",
        user: str | None = None,
    ) -> Generator[dict, None, None] | dict:
        pass

Completion インターフェースの呼び出し

エントリーポイント

    self.session.app.completion

インターフェース仕様

    def invoke(
        self,
        app_id: str,
        inputs: dict,
        response_mode: Literal["streaming", "blocking"] = "blocking",
        user: str | None = None,
    ) -> Generator[dict, None, None] | dict:
        pass

関連リソース

• Dify サービスの逆呼び出し - 逆呼び出しの基本概念を理解する
• モデルの逆呼び出し - プラットフォーム内でモデル機能を呼び出す方法を学ぶ
• ツールの逆呼び出し - 他のプラグインを呼び出す方法を学ぶ
• Slack Bot プラグインの開発 - 逆呼び出しを使用した実践的なアプリケーションケース
• 拡張プラグインの開発 - 拡張プラグインの開発方法を学ぶ