このドキュメントでは、Difyプラグインにおけるツールのデータ構造と使用方法について詳しく説明します。内容には、さまざまなタイプのメッセージ(画像URL、リンク、テキスト、ファイル、JSON)を返す方法、変数およびストリーミング変数メッセージを作成する方法、そしてworkflowで参照しやすくするためにツールの出力変数スキーマを定義する方法が含まれます。
テキスト
、リンク
、画像
、ファイルBLOB
、JSON
など、さまざまなメッセージタイプをサポートしており、以下の異なるインターフェースを通じてさまざまなタイプのメッセージを返すことができます。
デフォルトでは、workflow
内のツールの出力には、files
、text
、json
の3つの固定変数が含まれ、以下の方法でこれらの変数のデータを返すことができます。
例えば、create_image_message
を使用して画像を返しますが、ツールはカスタム出力変数もサポートしているため、workflow
内でこれらの変数をより便利に参照できます。
blob
ファイルの生データ、bytes型。meta
ファイルのメタデータ。開発者が明確なファイルタイプを必要とする場合は、mime_type
を指定してください。そうでない場合、Difyはデフォルトタイプとしてoctet/stream
を使用します。object
Pythonの辞書オブジェクトで、自動的にJSONにシリアライズされます。chatflow
アプリケーションでanswer
ノードを使用し、この変数を参照すると、テキストは「タイプライター」効果で出力されます。ただし、現在この方法は文字列型のデータのみをサポートしています。
workflow
アプリケーションでtool
の出力変数を参照したい場合は、出力される可能性のある変数を事前に定義する必要があります。Difyプラグインは、json_schema
形式の出力変数定義をサポートしています。以下に簡単な例を示します。
output_schema
を指定しています。これにはname
フィールドが含まれており、この時点でworkflow
内でこのフィールドを参照できます。ただし、実際に使用するためには、ツールの実装コードで変数を返す必要があることに注意してください。そうしないと、None
の戻り結果が得られます。