---
title: "`collection` オペレーション"
---

<!-- i18n: source=docs/reference/operations/collection.md blob=c6923c62aee6e89e254a9af29040b8fc1740a6e7 model=claude-sonnet-5-5 -->
> このページは[英語の原文](https://github.com/ClickHouse/loom/blob/main/docs/reference/operations/collection.md)の機械翻訳です。内容は英語の原文が優先されます。
> Machine-translated from the [English page](https://github.com/ClickHouse/loom/blob/main/docs/reference/operations/collection.md), which is authoritative.

<a id="collection-operations"></a>

各 `collection.*` オペレーションが受け取るフィールドと返すフィールドの一覧です。

<!-- Generated by `python scripts/codegen/docs_reference.py` from the op registry; edit the models, not this page. -->

すべてのオペレーションは、HTTP では `POST /v1/<op>`、MCP ではツール `loom_<op>` として使えます。ID フィールド（`org`、`namespace`、`agent`、`user_id`、`session_id`）は、トランスポートが対応している場合、トークンと MCP セッションから補完されます。シングルユーザーサーバーでトークンなしの HTTP 呼び出しを行う場合、`code.*` と `tracker.*`（それぞれのプレーンの値を保持します）を除くすべてのオペレーションで、org にはインストール時の org が使われます。[一部のオペレーション](https://github.com/ClickHouse/loom/blob/main/docs/reference/http-api.md#request)では、名前空間とエージェントも補完されます。詳しくは[ID と名前空間](https://github.com/ClickHouse/loom/blob/main/docs/concepts/identities-and-namespaces.md)を参照してください。ロール、種別、MCP の `all` 一覧については[オペレーション索引](https://github.com/ClickHouse/loom/blob/main/docs/reference/operations.md)で説明しています。未知の入力フィールドは処理され、`ignored_args` に名前が記録されます。

<!-- prettier-ignore-start -->

<a id="collectioncreate"></a>

## `collection.create`

コレクションを作成します。コレクションは、グラントを通じてのみ読み書きされる名前空間です。

`POST /v1/collection.create` · MCP `loom_collection_create` · ロール `viewer` · 冪等 · 監査対象 · MCP の `all` ツールセットには含まれません

| 入力フィールド | 型 | デフォルト | 説明 |
| --- | --- | --- | --- |
| `org` | `str` | 必須 | テナント（ID タプルの最初の要素）。 |
| `namespace` | `str` | `''` | コレクションの名前で、そのまま名前空間にもなります（'col-' に続けて小文字、数字、'-'）。`derive_name` を指定した場合は無視されます。 |
| `title` | `str` | `''` | 画面上でのコレクションの呼び名（200 文字まで、制御文字や不可視文字は不可。タイトルは org 内で重複できます）。なしの場合は ''。 |
| `derive_name` | `bool` | `False` | `namespace` ではなく `title` から名前を導出します。親コレクション（トップレベルの場合は呼び出し元自身のもの）の下ですでに使われているタイトルの場合は、そのコレクションが返されます。 |
| `parent` | `str` | `''` | 配置先となり、グラントを継承する親コレクション。トップレベルの場合は ''。 |
| `description` | `str` | `''` | コレクションの内容を説明する文で、名前の横に表示されます（2000 文字まで）。なしの場合は ''。 |

| 出力フィールド | 型 | 説明 |
| --- | --- | --- |
| `namespace` | `str` | オペレーションが読み書きする名前空間。 |
| `parent` | `str` | 配置先の親コレクション。トップレベルの場合は ''。 |
| `created` | `bool` | コレクションがすでに存在していた場合は False。呼び出し元自身のその名前のコレクション、またはそのタイトルですでに指定されているコレクションが該当します。 |
| `title` | `str` | コレクションのタイトル。なしの場合は ''。 |

<a id="collectiondelete"></a>

## `collection.delete`

コレクションを、保持している内容ごと削除します。名前空間に対する消去（パージ）が実行され（ドキュメント、チャンク、原本、メモリがディスクから消えます）、その後ディレクトリとツリーから外れ、その名前が再び使われることはありません…

`POST /v1/collection.delete` · MCP `loom_collection_delete` · ロール `admin` · 冪等 · 監査対象 · MCP の `all` ツールセットには含まれません

| 入力フィールド | 型 | デフォルト | 説明 |
| --- | --- | --- | --- |
| `org` | `str` | 必須 | テナント（ID タプルの最初の要素）。 |
| `namespace` | `str` | 必須 | オペレーションが読み書きする名前空間。 |

| 出力フィールド | 型 | 説明 |
| --- | --- | --- |
| `namespace` | `str` | オペレーションが読み書きする名前空間。 |
| `deleted` | `bool` | すでに削除済みだった場合は False |
| `erasure_id` | `str` | コレクションが保持していた内容の消去 ID。`erasure.status` で状況を確認できます。 |
| `erasure_status` | `str` | その消去の結果。`completed`、またはリカバリワーカーが再試行している間は `failed`。 |

<a id="collectionlist"></a>

## `collection.list`

呼び出し元が読み取れるコレクションを名前順に一覧表示します。

`POST /v1/collection.list` · MCP `loom_collection_list` · ロール `viewer` · 読み取り · MCP の `all` ツールセットには含まれません

| 入力フィールド | 型 | デフォルト | 説明 |
| --- | --- | --- | --- |
| `org` | `str` | 必須 | テナント（ID タプルの最初の要素）。 |
| `limit` | `int` | `500` | 1 ページあたりのコレクション数。 |
| `include_document_counts` | `bool` | `False` | 各コレクションが直接保持するドキュメントの現在数を含めます。デフォルトは false。 |
| `cursor` | `str \| None` | `None` | 前のページの `next_cursor`。最初のページでは指定しません。 |

| 出力フィールド | 型 | 説明 |
| --- | --- | --- |
| `collections` | `list[_CollectionEntry]` | このページで呼び出し元が読み取れるコレクションを名前順に並べたもので、呼び出し元のロールとコレクションのタイトル、説明を含みます。 |
| `next_cursor` | `str \| None` | 次のページを取得するための `cursor` として渡します。最後のページでは None（または存在しません）。 |

<a id="collectionmove"></a>

## `collection.move`

コレクションを別のコレクションの下に移動するか、切り離します。

`POST /v1/collection.move` · MCP `loom_collection_move` · ロール `admin` · 冪等 · 監査対象 · MCP の `all` ツールセットには含まれません

| 入力フィールド | 型 | デフォルト | 説明 |
| --- | --- | --- | --- |
| `org` | `str` | 必須 | テナント（ID タプルの最初の要素）。 |
| `namespace` | `str` | 必須 | オペレーションが読み書きする名前空間。 |
| `parent` | `str` | `''` | 新しい親コレクション。'' を指定すると切り離され、そのコレクション自身のグラントだけが残ります。 |

| 出力フィールド | 型 | 説明 |
| --- | --- | --- |
| `namespace` | `str` | オペレーションが読み書きする名前空間。 |
| `parent` | `str` | 現在の配置先コレクション。切り離された後は ''。 |
| `moved` | `bool` | すでにそこに配置されていた場合は False |

<!-- prettier-ignore-end -->
