> ## Documentation Index
> Fetch the complete documentation index at: https://enterprise-docs.dify.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# ツールの戻り値

> ツールプラグインがメッセージ（テキスト、リンク、画像、ファイル、JSON）を返し、標準変数とストリーミング変数を作成し、ワークフロー参照用の出力スキーマを定義する方法

## 概要

ツールは結果をメッセージと変数として返します。このページでは、メッセージインターフェース、変数の作成、出力スキーマの定義について説明します。

> [card] [メッセージタイプ](#メッセージの戻り値)
>
> テキスト、リンク、画像、JSON など、さまざまな種類のメッセージを返す

> [card] [変数](#変数)
>
> ワークフロー統合のための変数を作成および操作する

> [card] [出力スキーマ](#カスタム出力変数)
>
> ワークフロー参照用のカスタム出力変数を定義する

## データ構造

### メッセージの戻り値

Dify はテキスト、リンク、画像、ファイル blob、JSON など複数のメッセージタイプをサポートしており、それぞれ専用のインターフェースを通じて返されます。

デフォルトでは、ワークフロー内のツールの出力には `files`、`text`、`json` の 3 つの固定変数が含まれます。以下のメソッドでこれらの変数を設定します。

> [!TIP]
>
> `create_image_message` などのメソッドで画像を返すこともできますが、ツールはカスタム出力変数もサポートしており、ワークフロー内で特定のデータをより参照しやすくなります。

### メッセージタイプ

```python Image URL theme={null}
def create_image_message(self, image: str) -> ToolInvokeMessage:
    """
    Return an image URL message
    
    Dify will automatically download the image from the provided URL
    and display it to the user.
    
    Args:
        image: URL to an image file
        
    Returns:
        ToolInvokeMessage: Message object for the tool response
    """
    pass
```

```python Link theme={null}
def create_link_message(self, link: str) -> ToolInvokeMessage:
    """
    Return a clickable link message
    
    Args:
        link: URL to be displayed as a clickable link
        
    Returns:
        ToolInvokeMessage: Message object for the tool response
    """
    pass
```

```python Text theme={null}
def create_text_message(self, text: str) -> ToolInvokeMessage:
    """
    Return a text message
    
    Args:
        text: Text content to be displayed
        
    Returns:
        ToolInvokeMessage: Message object for the tool response
    """
    pass
```

```python File theme={null}
def create_blob_message(self, blob: bytes, meta: dict = None) -> ToolInvokeMessage:
    """
    Return a file blob message
    
    For returning raw file data such as images, audio, video, 
    or documents (PPT, Word, Excel, etc.)
    
    Args:
        blob: Raw file data in bytes
        meta: File metadata dictionary. Include 'mime_type' to specify 
              the file type, otherwise 'octet/stream' will be used
              
    Returns:
        ToolInvokeMessage: Message object for the tool response
    """
    pass
```

```python JSON theme={null}
def create_json_message(self, json: dict) -> ToolInvokeMessage:
    """
    Return a formatted JSON message
    
    Useful for data transmission between workflow nodes.
    In agent mode, most LLMs can read and understand JSON data.
    
    Args:
        json: Python dictionary to be serialized as JSON
        
    Returns:
        ToolInvokeMessage: Message object for the tool response
    """
    pass
```

> [accordion] パラメータ
>
> **image** `string` *required*
>
> ダウンロードして表示される画像の URL
>
> **link** `string` *required*
>
> クリック可能なリンクとして表示される URL
>
> **text** `string` *required*
>
> 表示されるテキストコンテンツ
>
> **blob** `bytes` *required*
>
> バイト形式の生ファイルデータ
>
> **meta** `dict`
>
> 以下を含むファイルメタデータ：
>
> * `mime_type`：ファイルの MIME タイプ（例：`image/png`）
> * ファイルに関連するその他のメタデータ
>
> **json** `dict` *required*
>
> JSON としてシリアライズされる Python 辞書

> [!TIP]
>
> ファイル BLOB を扱う際は、ファイルが正しく処理されるように、`meta` 辞書に常に `mime_type` を指定してください。例：`{"mime_type": "image/png"}`。

### 変数

```python Standard Variable theme={null}
from typing import Any

def create_variable_message(self, variable_name: str, variable_value: Any) -> ToolInvokeMessage:
    """
    Create a named variable for workflow integration
    
    For non-streaming output variables. If multiple instances with the 
    same name are created, the latest one overrides previous values.
    
    Args:
        variable_name: Name of the variable to create
        variable_value: Value of the variable (any Python data type)
        
    Returns:
        ToolInvokeMessage: Message object for the tool response
    """
    pass
```

```python Streaming Variable theme={null}
def create_stream_variable_message(
    self, variable_name: str, variable_value: str
) -> ToolInvokeMessage:
    """
    Create a streaming variable with typewriter effect
    
    When referenced in an answer node in a chatflow application,
    the text will be output with a typewriter effect.
    
    Args:
        variable_name: Name of the variable to create
        variable_value: String value to stream (only strings supported)
        
    Returns:
        ToolInvokeMessage: Message object for the tool response
    """
    pass
```

> [accordion] パラメータ
>
> **variable\_name** `string` *required*
>
> 作成または更新される変数の名前
>
> **variable\_value** `Any/string` *required*
>
> 変数に割り当てる値：
>
> * 標準変数：任意の Python データ型
> * ストリーミング変数：文字列データのみ

> [!WARNING]
>
> `create_stream_variable_message` は現在、文字列データのみをサポートしています。複雑なデータ型はタイプライター効果でストリーミングできません。

## カスタム出力変数

Workflow アプリケーションでツールの出力変数を参照するには、ツールのマニフェストで [JSON Schema](https://json-schema.org/) を使用して、ツールが出力する可能性のある変数を宣言します。

### 出力スキーマの定義

```yaml Tool Manifest with Output Schema theme={null}
identity:
  author: example_author
  name: example_tool
  label:
    en_US: Example Tool
    zh_Hans: 示例工具
    ja_JP: ツール例
    pt_BR: Ferramenta de exemplo
description:
  human:
    en_US: A simple tool that returns a name
    zh_Hans: 返回名称的简单工具
    ja_JP: 名前を返す簡単なツール
    pt_BR: Uma ferramenta simples que retorna um nome
  llm: A simple tool that returns a name variable
output_schema:
  type: object
  properties:
    name:
      type: string
      description: "The name returned by the tool"
    age:
      type: integer
      description: "The age returned by the tool"
    profile:
      type: object
      properties:
        interests:
          type: array
          items:
            type: string
        location:
          type: string
```

> [accordion] スキーマ構造
>
> **output\_schema** `object` *required*
>
> ツールの出力スキーマを定義するルートオブジェクト
>
> **type** `string` *required*
>
> ツール出力スキーマでは `object` である必要があります
>
> **properties** `object` *required*
>
> すべての可能な出力変数の辞書
>
> **properties.\[variable\_name]** `object`
>
> 各出力変数の定義（型と説明を含む）

> [!WARNING]
>
> 出力スキーマを定義するだけでは不十分です。実装コードで `create_variable_message()` を使用して各変数を返す必要があります。そうしないと、ワークフローはその変数に対して `None` を受け取ります。

### 実装例

```python Basic Variable Example theme={null}
def run(self, inputs):
    # Process inputs and generate a name
    generated_name = "Alice"
    
    # Return the name as a variable that matches the output_schema
    return self.create_variable_message("name", generated_name)
```

```python Complex Structure Example theme={null}
def run(self, inputs):
    # Generate complex structured data
    user_data = {
        "name": "Bob",
        "age": 30,
        "profile": {
            "interests": ["coding", "reading", "hiking"],
            "location": "San Francisco"
        }
    }
    
    # Return individual variables
    self.create_variable_message("name", user_data["name"])
    self.create_variable_message("age", user_data["age"])
    self.create_variable_message("profile", user_data["profile"])
    
    # Also return a text message for display
    return self.create_text_message(f"User {user_data['name']} processed successfully")
```

> [!TIP]
>
> 複雑なワークフローの場合、複数の出力変数を定義してすべてを返すことができます。これにより、ワークフロー設計者がツールを使用する際の柔軟性が向上します。

## 例

### 完全なツール実装

```python Weather Forecast Tool theme={null}
import requests
from typing import Any

class WeatherForecastTool:
    def run(self, inputs: dict) -> Any:
        # Get location from inputs
        location = inputs.get("location", "London")
        
        try:
            # Call weather API (example only)
            weather_data = self._get_weather_data(location)
            
            # Create variables for workflow use
            self.create_variable_message("temperature", weather_data["temperature"])
            self.create_variable_message("conditions", weather_data["conditions"])
            self.create_variable_message("forecast", weather_data["forecast"])
            
            # Create a JSON message for data transmission
            self.create_json_message(weather_data)
            
            # Create an image message for the weather map
            self.create_image_message(weather_data["map_url"])
            
            # Return a formatted text response
            return self.create_text_message(
                f"Weather in {location}: {weather_data['temperature']}°C, {weather_data['conditions']}. "
                f"Forecast: {weather_data['forecast']}"
            )
            
        except Exception as e:
            # Handle errors gracefully
            return self.create_text_message(f"Error retrieving weather data: {str(e)}")
    
    def _get_weather_data(self, location: str) -> dict:
        # Mock implementation - in a real tool, this would call a weather API
        return {
            "location": location,
            "temperature": 22,
            "conditions": "Partly Cloudy",
            "forecast": "Sunny with occasional showers tomorrow",
            "map_url": "https://example.com/weather-map.png"
        }
```

> [!TIP]
>
> ツールを設計する際は、直接出力（ユーザーが見るもの）と変数出力（他のワークフローノードが使用できるもの）の両方を考慮してください。この分離により、ツールの使用方法に柔軟性が生まれます。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.