# 機能設計書 66-ファイルテキスト取得

## 概要

本ドキュメントは、Giselleシステムにおける「ファイルテキスト取得」機能の設計仕様を定義する。

### 本機能の処理概要

ファイルテキスト取得機能は、ワークスペースにアップロードされたファイルの内容をテキスト形式で取得する機能である。ストレージからBlobデータを取得し、文字列に変換して返却する。

**業務上の目的・背景**：AIワークフローでは、アップロードされたテキストファイルやドキュメントの内容を読み込んで処理する必要がある。本機能により、ファイルノードに関連付けられたファイルの内容をワークフロー実行時に取得し、AI処理への入力として使用できる。

**機能の利用シーン**：
- テキスト生成ノードへのファイル内容の入力
- RAG処理でのドキュメント内容の取得
- ワークフロー実行時のファイルデータ参照

**主要な処理内容**：
1. 入力としてWorkspaceIdとFileIdを受け取る
2. ファイルパスを生成
3. ストレージからBlobデータを取得
4. Bufferに変換し、文字列として返却

**関連システム・外部連携**：
- `@giselles-ai/storage`パッケージによるストレージ抽象化レイヤー

**権限による制御**：本機能自体には認証・認可チェックは含まれない。呼び出し元のAPIレイヤーにて適切な認可制御が行われることを前提とする。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | （直接的な画面関連なし） | - | ワークフロー実行時の内部処理として使用 |

## 機能種別

データ取得（READ）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| storage | `GiselleStorage` | Yes | ストレージインスタンス | - |
| workspaceId | `WorkspaceId` | Yes | ファイルが存在するワークスペースID | `wks_`プレフィックスで始まる文字列 |
| fileId | `FileId` | Yes | 取得対象のファイルID | `fl_`プレフィックスで始まる文字列 |

### 入力データソース

- ワークフロー実行処理からの内部呼び出し
- 各IDはGiselleシステム内で生成されたID

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| (戻り値) | `string` | ファイルの内容をテキストとして返却 |

### 出力先

- 呼び出し元への戻り値として返却

## 処理フロー

### 処理シーケンス

```
1. ファイルパス生成
   └─ filePath関数でworkspaces/{workspaceId}/files/{fileId}/{fileId}パスを生成

2. Blobデータ取得
   └─ storage.getBlob()でファイル内容を取得

3. テキスト変換
   └─ Buffer.from()とtoString()で文字列に変換

4. 結果返却
   └─ テキスト文字列を返却
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[ファイルパス生成]
    B --> C[storage.getBlob実行]
    C --> D[Buffer.fromで変換]
    D --> E[toString で文字列化]
    E --> F[文字列を返却]
    F --> G[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-66-01 | パス形式 | ファイルパスは`workspaces/{workspaceId}/files/{fileId}/{fileId}`形式 | 常時 |
| BR-66-02 | 文字コード | デフォルトのエンコーディング（UTF-8）で文字列変換される | 常時 |
| BR-66-03 | バイナリ | バイナリファイルは適切に文字列化されない可能性がある | 常時 |

### 計算ロジック

本機能に特別な計算ロジックは存在しない。

## データベース操作仕様

### 操作別データベース影響一覧

本機能はBlobストレージのみを使用し、リレーショナルデータベースへの直接アクセスは行わない。

| 操作 | 対象ストレージ | 操作種別 | 概要 |
|-----|-------------|---------|------|
| ファイル取得 | Blob Storage | GET | ファイル本体をBlobとして取得 |

### ストレージ操作詳細

#### Blobストレージ

| 操作 | パス | データ形式 | 備考 |
|-----|------|----------|------|
| GET | workspaces/{workspaceId}/files/{fileId}/{fileId} | Binary | Blobデータを取得 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | StorageError | ファイルが存在しない | 存在するファイルIDを指定 |
| - | StorageError | ストレージからの取得失敗 | ストレージ接続を確認 |

### リトライ仕様

ストレージアクセス失敗時のリトライは、ストレージドライバ層で実装される。アプリケーション層でのリトライは行わない。

## トランザクション仕様

読み取り専用操作のため、トランザクション管理は不要。

## パフォーマンス要件

- レスポンス時間: ファイルサイズとストレージレイテンシに依存
- 同時リクエスト: ストレージの制限に依存

## セキュリティ考慮事項

- 認証・認可: API呼び出し元で実装（本機能では未実装）
- データ保護: ストレージレベルでの暗号化に依存

## 備考

- バイナリファイル（画像、PDF等）は本機能では適切に処理されない
- 大容量ファイルの取得時はメモリ使用量に注意

---

## コードリーディングガイド

本機能を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: データ構造を理解する

まず、ファイル関連の型定義を理解することが重要である。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | protocol/index.ts | `packages/protocol/src/index.ts` | FileId, WorkspaceId等の型エクスポートを確認 |

**読解のコツ**:
- `FileId`は`fl_`プレフィックス
- `WorkspaceId`は`wks_`プレフィックス

#### Step 2: エントリーポイントを理解する

処理の起点となるファイル・関数を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | get-file-text.ts | `packages/giselle/src/files/get-file-text.ts` | getFileText関数の実装 |

**主要処理フロー**:
1. **5-9行目**: 関数シグネチャと引数定義
2. **10-14行目**: filePath関数でパスを生成
3. **15行目**: storage.getBlobでBlobデータを取得
4. **16行目**: Buffer.fromとtoString()で文字列変換して返却

#### Step 3: ユーティリティ関数を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | utils.ts | `packages/giselle/src/files/utils.ts` | filePath関数によるストレージパス生成ロジック |

**主要処理フロー**:
- **3-17行目**: GenerationOriginに応じたパス生成
- **6行目**: `workspaces/${params.workspaceId}/files/${params.fileId}/${params.fileId}`形式

#### Step 4: ストレージ抽象化を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | types.ts | `packages/storage/src/types.ts` | GiselleStorageインターフェースのgetBlobメソッド |

**主要処理フロー**:
- **22-25行目**: GetBlob型定義（path, optionsを受け取りUint8Arrayを返す）
- **68行目**: GiselleStorageインターフェースにgetBlobが含まれる

### プログラム呼び出し階層図

```
Giselle.getFileText (giselle.ts:312-318)
    │
    └─ getFileText (get-file-text.ts:5-17)
           │
           ├─ filePath({type, workspaceId, fileId}) (utils.ts:3-17)
           │
           ├─ storage.getBlob(path)
           │      │
           │      └─ ストレージドライバ → Uint8Array
           │
           └─ Buffer.from(blob).toString()
                  │
                  └─ string
```

### データフロー図

```
[入力]                          [処理]                              [出力]

WorkspaceId ─────┐
                 ├──▶ filePath() ───▶ Storage Path
FileId ──────────┘         │        "workspaces/.../files/..."
                           ▼
                    storage.getBlob(path)
                           │
                           ▼
                    Uint8Array (Blob data)
                           │
                           ▼
                    Buffer.from(blob)
                           │
                           ▼
                    .toString() ───▶ string
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| get-file-text.ts | `packages/giselle/src/files/get-file-text.ts` | ソース | メイン処理の実装 |
| utils.ts | `packages/giselle/src/files/utils.ts` | ソース | ファイルパス生成ユーティリティ |
| types.ts | `packages/storage/src/types.ts` | ソース | ストレージインターフェース定義 |
| giselle.ts | `packages/giselle/src/giselle.ts` | ソース | Giselleクラスのエントリーポイント |
