> For the complete documentation index, see [llms.txt](https://docs.roboflow.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.roboflow.com/workflows/ja/burokku/blocks/data-storage/csv-formatter.md).

# CSV フォーマッタ

指定した列を持つ CSV ファイルを作成します。

カスタム列を定義し、データ変換を適用し、バッチデータをCSVドキュメントに集約して、ログ記録、レポート、データエクスポートのワークフロー向けに自動タイムスタンプ追跡を行いながら、ワークフローデータを構造化されたCSV形式に変換します。

## このブロックの仕組み

このブロックは、複数のソースからのデータを構造化された列に整理して、ワークフローデータをCSV（Comma-Separated Values）形式に整形します。このブロックは、

1. 以下からデータ参照を取得します `columns_data` 列名をワークフローデータソース（セレクター、静的値、またはワークフロー入力）にマッピングする辞書
2. 必要に応じて `columns_operations`を使用してデータ変換操作を適用します。これは Query Language（UQL）を使用して列データを変換します（例：検出結果からプロパティを抽出する、計算を行う、値を整形する）。
3. 自動的に次の列を追加します： `timestamp` 現在のUTC時刻をISO形式で含む列（例： `2024-10-18T14:09:57.622297+00:00`）を各行に追加します。なお、「timestamp」は予約済みの列名です。
4. 複数のデータポイントを行に集約することで、バッチ入力を処理します：
   * 単一入力の場合（`batch_size=1`）：ヘッダー行と1つのデータ行を持つCSVを作成します
   * バッチ入力の場合（`batch_size>1`）：ヘッダー行と入力ごとの1行を持つCSVを作成し、すべての行を1つのCSVドキュメントに集約します。このドキュメントは最後のバッチ要素でのみ出力されます（それ以前の要素は空のCSVコンテンツを返します）。
5. 複数のバッチ入力が提供された場合はバッチパラメータを揃え、非バッチパラメータを最大バッチサイズに合わせてブロードキャストします
6. pandas DataFrame のシリアライズを使用して、構造化データ辞書をCSV形式に変換します
7. 返します `csv_content` 完全なCSVドキュメント（ヘッダー行とデータ行）を含む文字列として

このブロックでは柔軟な列定義をサポートしており、各列は検出予測、分類結果、ワークフロー入力、計算値など、異なるワークフローデータソースを参照でき、必要に応じて特定のプロパティを抽出したりデータを整形したりする変換を適用できます。自動タイムスタンプ列により、各CSV行がいつ生成されたかを時系列で追跡でき、ログ記録や時系列データ収集に役立ちます。バッチ集約により、このブロックは複数のワークフロー実行からデータを収集して1つのCSVドキュメントにまとめられるため、複数の検出結果、画像、または分析結果を1つのCSVファイルに記録したいバッチ処理ワークフローで特に有用です。

## 一般的な使用例

* **検出ログ記録とレポート**：検出結果のCSVログを作成します（例：物体検出モデルからクラス名、信頼度スコア、バウンディングボックス座標を記録する）。これにより、分析、デバッグ、監査証跡のために推論結果を構造化してログ記録できます
* **時系列データ収集**：ワークフローメトリクス、カウント、または分析結果を時系列でCSV形式に集約します（例：ラインカウンターのカウント、ゾーン占有率、検出頻度を記録する）。これにより、トレンド分析やレポート用のタイムスタンプ付きデータセットを作成できます
* **バッチデータエクスポート**：バッチ処理ワークフローからデータを収集して集約し、CSVファイルに出力します（例：画像バッチ内のすべての検出結果をエクスポートする、複数のワークフロー実行からメトリクスを収集する）。これにより、効率的な一括データエクスポートとレポートが可能になります
* **構造化データ変換**：複雑なワークフロー出力から特定のプロパティを抽出して整形します（例：検出結果からクラス名を抽出する、入れ子構造のデータを平坦なCSV列に変換する）。これにより、下流の分析や外部システム向けのデータ変換が可能になります
* **外部システムとの連携**：ワークフローデータを外部ツールと互換性のある形式に整えます（例：スプレッドシート分析、データベースへのインポート、BIツール向けのCSVファイルを作成する）。これにより、シームレスなデータエクスポートと連携ワークフローが可能になります
* **データ集約と分析**：複数のワークフローソースのデータを構造化されたCSV形式にまとめます（例：検出結果とメタデータを結合する、モデル出力と参照データを組み合わせる）。これにより、包括的なデータ収集と分析ワークフローが可能になります

## 他のブロックへの接続

このブロックのCSVコンテンツは、次のものに接続できます：

* **検出または分析ブロック** （例：物体検出モデル、インスタンスセグメンテーションモデル、分類モデル、キーポイント検出モデル、ラインカウンター、ゾーン滞在時間）に接続して出力をCSV列に整形し、推論結果や分析データの構造化ログ記録とエクスポートを可能にします
* **データ保存ブロック** （例：ローカルファイルシンク）に接続してCSVファイルをディスクに保存し、整形されたワークフローデータを後で分析やレポートに利用できるよう永続保存できます
* **通知ブロック** （例：メール通知、Slack通知）に接続して通知にCSVコンテンツを添付または含めることで、CSVレポートをメール添付やメッセージ本文として送信できます
* **Webhook ブロック** （例：Webhookシンク）に接続してCSVコンテンツを外部APIやサービスに送信し、CSVデータを利用する外部システムとの連携を可能にします
* **その他のフォーマッターブロック** （例：JSONパーサー、Expression）に接続してCSVコンテンツをさらに処理したり、他の形式に変換したりすることで、多段階のデータ変換ワークフローを実現できます
* **バッチ処理ワークフロー** 複数のデータポイントを1つのCSVドキュメントに集約する必要がある場合に使用し、バッチ処理結果の包括的なログ記録とエクスポートを可能にします

### タイプ識別子

ステップで次の識別子を使用してください `"type"` フィールド: `roboflow_core/csv_formatter@v1` を、ワークフローにステップとして追加します。

### プロパティ

| **名前**               | **型**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | **説明**                                                                                                                                                                                                                                                                                                                                                                                                | 参照 |
| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -- |
| `name`               | `str`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | このステップの一意の識別子を入力してください。                                                                                                                                                                                                                                                                                                                                                                               | ❌  |
| `columns_data`       | `Dict[str, Union[bool, float, int, str]]`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | CSV列を構築するための、列名からデータソースへのマッピング辞書です。キーは列名です（注: 「timestamp」は予約済みで使用できません）。値は、ワークフローデータを参照するセレクター（例: '$steps.model.predictions'、'$inputs.data'）、静的値（文字列、数値、ブール値）、またはその両方の組み合わせにできます。各キーと値のペアが1つのCSV列を作成します。バッチ入力に対応しており、値がバッチの場合、CSVはすべてのバッチ要素を行に集約します。例: {'predictions': '$steps.object\_detection.predictions', 'count': '$steps.line\_counter.count\_in'} は 'predictions' と 'count' という名前のCSV列を作成します。 | ✅  |
| `columns_operations` | `Dict[str, List[Union[ClassificationPropertyExtract, ConvertDictionaryToJSON, ConvertImageToBase64, ConvertImageToJPEG, DetectionsFilter, DetectionsOffset, DetectionsPropertyExtract, DetectionsRename, DetectionsSelection, DetectionsShift, DetectionsToDictionary, Divide, ExtractDetectionProperty, ExtractFrameMetadata, ExtractImageProperty, LookupTable, Multiply, NumberRound, NumericSequenceAggregate, PickDetectionsByParentClass, RandomNumber, SequenceAggregate, SequenceApply, SequenceElementsCount, SequenceJoin, SequenceLength, SequenceMap, SortDetections, StringMatches, StringSubSequence, StringToLowerCase, StringToUpperCase, TimestampToISOFormat, ToBoolean, ToNumber, ToString]]]` | CSV整形の前に列データを変換するための、列名から Query Language（UQL）の操作定義への任意の辞書です。キーは columns\_data で定義された列名と一致している必要があります。値はUQL操作のリスト（例：検出結果からクラス名を抽出する DetectionsPropertyExtract、文字列操作、計算）で、未加工の列データを変換します。操作は各列のデータに順番に適用されます。列名がこの辞書にない場合、データは変換されずそのまま使用されます。例: {'predictions': \[{'type': 'DetectionsPropertyExtract', 'property\_name': 'class\_name'}]} は検出予測からクラス名を抽出します。                                          | ❌  |

この **参照** この列は、 `workflow` の実行時に利用可能な動的値でプロパティをパラメータ化できる可能性を示します。 *バインディング* の詳細を参照してください。

### 入力および出力バインディング

利用可能な接続は、そのバインディング種別に依存します。 `CSV Formatter` バージョン `v1` に、どのバインディング種別があるか確認してください。

<details>

<summary>入力と出力のバインディング</summary>

* input
  * `columns_data` ([*`*`*](https://docs.roboflow.com/workflows/ja/gaido/developer-guide/kinds/wildcard.md)）：CSV列を構築するための、列名からデータソースへのマッピング辞書です。キーは列名です（注: 「timestamp」は予約済みで使用できません）。値は、ワークフローデータを参照するセレクター（例: '$steps.model.predictions'、'$inputs.data'）、静的値（文字列、数値、ブール値）、またはその両方の組み合わせにできます。各キーと値のペアが1つのCSV列を作成します。バッチ入力に対応しており、値がバッチの場合、CSVはすべてのバッチ要素を行に集約します。例: {'predictions': '$steps.object\_detection.predictions', 'count': '$steps.line\_counter.count\_in'} は 'predictions' と 'count' という名前のCSV列を作成します。
* output
  * `csv_content` ([`string`](https://docs.roboflow.com/workflows/ja/gaido/developer-guide/kinds/string.md)): 文字列値。

</details>

<details>

<summary>JSON定義の例</summary>

```json
{
	    "name": "<your_step_name_here>",
	    "type": "roboflow_core/csv_formatter@v1",
	    "columns_data": {
	        "predictions": "$steps.model.predictions",
	        "reference": "$inputs.reference_class_names"
	    },
	    "columns_operations": {
	        "predictions": [
	            {
	                "property_name": "class_name",
	                "type": "DetectionsPropertyExtract"
	            }
	        ]
	    }
	}
```

</details>
