--- title: topics description: ブランドの計測トピックと提案を管理する。 canonical_url: https://orchestor.io/docs/cli/topic markdown_url: https://orchestor.io/docs/cli/topic.md contentType: reference --- # topics `orc topics` は、ブランドに紐づく計測トピックを管理します。トピックの一覧・詳細を取得し、名前の登録・変更、archive・解除、論理削除を行えます。Workspaceのブランド情報から生成されたトピック候補は、確認してから採用または却下します。 認証を設定し、対象Workspaceを指定してください。作成にはトピック名と同じWorkspaceのブランドIDが必要です。トピックの作成だけではプロンプトを作成しません。後続の質問は [`orc prompts`](https://orchestor.io/docs/cli/prompt.md) の `topic_id` へ関連付けます。 ## 使い方 ```bash title="terminal" orc topics list --workspace ``` *保存されたトピックを確認します。* ## サブコマンド ### `list` 削除されていないブランド配下のトピックを新しい順に一覧します。archivedも含みます。`--brand-id` を省略すると全ブランドが対象です。ページを続ける間はブランド条件を保持します。 ```bash title="terminal" orc topics list [options] ``` #### 固有のオプション ##### `--brand-id` Restrict results to this brand in the selected workspace. Omit to include all brands; an unavailable brand returns 404. 型: `string`。任意。 ```bash title="terminal" orc topics list --brand-id ``` ### `create` `name` は最大255文字で、`brand_id` とともに必須です。作成時はunarchivedです。`workspace:settings` 権限が必要です。 ```bash title="terminal" orc topics create [options] ``` #### 固有のオプション ##### `--idempotency-key` Retry identity for operations that support idempotency. Use a unique key for each new operation, and reuse it only when retrying the same HTTP method, path, query values and exact request body. JSON whitespace changes can count as a different body. Keys contain 1–255 characters after trimming and expire after 24 hours. A completed JSON response is replayed without repeating the operation. A different request using the same key returns 409 idempotency_error. An in-progress request returns 409 idempotency_in_progress with Retry-After: 2. Whether this header is required depends on the operation. 型: `string`。任意。 ```bash title="terminal" orc topics create --idempotency-key ``` ##### `--name` (required) Human-readable topic name, from 1 to 255 characters.; max 255 chars 型: `string`。任意。 ```bash title="terminal" orc topics create --name ``` ##### `--brand-id` (required) Required parent brand in the selected workspace. A topic cannot currently be created without a brand. 型: `string`。任意。 ```bash title="terminal" orc topics create --brand-id ``` #### 使用例 ```bash title="terminal" orc topics create --name "CRM selection" --brand-id --workspace ``` *ブランドのトピックを作成する* ### `get` トピックIDで詳細を取得します。archivedトピックも取得できます。トピックまたは親ブランドが対象Workspaceで利用できなければ404です。 ```bash title="terminal" orc topics get [options] ``` ### `update` 入力した `name` と `archived` だけを変更します。`--archived true` はarchive、falseは解除です。ブランド関連付けは変更できず、空の本文は現在のトピックを返します。 ```bash title="terminal" orc topics update [options] ``` #### 固有のオプション ##### `--archived` Set true to archive or false to unarchive through the measurement lifecycle. Omit to keep the current state. 型: `string`。任意。 ```bash title="terminal" orc topics update --archived ``` ##### `--name` Replacement topic name. Omit to keep the current name.; max 255 chars 型: `string`。任意。 ```bash title="terminal" orc topics update --name ``` #### 使用例 ```bash title="terminal" orc topics update --archived true --workspace ``` *トピックをarchiveする* ### `delete` トピックを計測lifecycleを通して論理削除し、通常の一覧・取得から外します。`workspace:settings` 権限が必要です。 ```bash title="terminal" orc topics delete [options] ``` ### `suggestions list` 保存された提案を `--status` と `--brand-id` で絞れます。省略した条件は制限しません。cursorをたどる間は条件を保持してください。 ```bash title="terminal" orc topics suggestions list [options] ``` #### 固有のオプション ##### `--status` Filter by suggestion status. Omit to include all statuses.; enum: pending|accepted|rejected 型: `string`。任意。 ```bash title="terminal" orc topics suggestions list --status ``` ##### `--brand-id` Filter by brand id in the selected workspace. Omit to include domains or suggestions for all brands. 型: `string`。任意。 ```bash title="terminal" orc topics suggestions list --brand-id ``` ### `suggestions refresh` 現在のWorkspaceのブランド情報から候補の非同期生成を開始します。本文は不要です。`--wait` で完了を待てます。生成された候補は明示的に採用するまでトピックになりません。 ```bash title="terminal" orc topics suggestions refresh [options] ``` #### 固有のオプション ##### `--idempotency-key` Retry identity for operations that support idempotency. Use a unique key for each new operation, and reuse it only when retrying the same HTTP method, path, query values and exact request body. JSON whitespace changes can count as a different body. Keys contain 1–255 characters after trimming and expire after 24 hours. A completed JSON response is replayed without repeating the operation. A different request using the same key returns 409 idempotency_error. An in-progress request returns 409 idempotency_in_progress with Retry-After: 2. Whether this header is required depends on the operation. 型: `string`。任意。 ```bash title="terminal" orc topics suggestions refresh --idempotency-key ``` #### 使用例 ```bash title="terminal" orc topics suggestions refresh --wait --workspace ``` *トピック提案を生成して待つ* ### `suggestions generations get` 返された生成IDで非同期処理の状態を取得します。受付応答だけで生成完了と判断せず、状態を確認してください。 ```bash title="terminal" orc topics suggestions generations get [options] ``` ### `suggestions accept` pending候補を採用してactiveトピックを作成します。`--brand-id` は候補のブランドを上書きします。両方にブランドがない場合は400です。`--edit-name` で名前を調整できます。解決済み候補は409、不明IDは404です。 ```bash title="terminal" orc topics suggestions accept [options] ``` #### 固有のオプション ##### `--idempotency-key` Retry identity for operations that support idempotency. Use a unique key for each new operation, and reuse it only when retrying the same HTTP method, path, query values and exact request body. JSON whitespace changes can count as a different body. Keys contain 1–255 characters after trimming and expire after 24 hours. A completed JSON response is replayed without repeating the operation. A different request using the same key returns 409 idempotency_error. An in-progress request returns 409 idempotency_in_progress with Retry-After: 2. Whether this header is required depends on the operation. 型: `string`。任意。 ```bash title="terminal" orc topics suggestions accept --idempotency-key ``` ##### `--brand-id` Brand in the selected workspace to assign to the new topic. Required when the suggestion has no brand. 型: `string`。任意。 ```bash title="terminal" orc topics suggestions accept --brand-id ``` ##### `--edit-name` Name for the created resource. When omitted, uses the suggestion name.; max 255 chars 型: `string`。任意。 ```bash title="terminal" orc topics suggestions accept --edit-name ``` ### `suggestions reject` pending候補をrejectedへ変更します。不明IDは404、すでに採用または却下された候補は409です。 ```bash title="terminal" orc topics suggestions reject [options] ``` #### 固有のオプション ##### `--idempotency-key` Retry identity for operations that support idempotency. Use a unique key for each new operation, and reuse it only when retrying the same HTTP method, path, query values and exact request body. JSON whitespace changes can count as a different body. Keys contain 1–255 characters after trimming and expire after 24 hours. A completed JSON response is replayed without repeating the operation. A different request using the same key returns 409 idempotency_error. An in-progress request returns 409 idempotency_in_progress with Retry-After: 2. Whether this header is required depends on the operation. 型: `string`。任意。 ```bash title="terminal" orc topics suggestions reject --idempotency-key ``` ## 必要な権限 対象Workspaceへのアクセスが必要です。変更操作には対応する書き込み権限が必要です。 ## グローバルオプション `orc topics` では、次の[グローバルオプション](https://orchestor.io/docs/cli/global-flags.md)を使用できます。 - [`--help`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%98%E3%83%AB%E3%83%97) - [`--workspace`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%AF%E3%83%BC%E3%82%AF%E3%82%B9%E3%83%9A%E3%83%BC%E3%82%B9) - [`--json`](https://orchestor.io/docs/cli/global-flags.md#json-%E5%87%BA%E5%8A%9B) - [`--pretty`](https://orchestor.io/docs/cli/global-flags.md#json-%E5%87%BA%E5%8A%9B) - [`--format`](https://orchestor.io/docs/cli/global-flags.md#%E5%87%BA%E5%8A%9B%E5%BD%A2%E5%BC%8F) - [`--field`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%95%E3%82%A3%E3%83%BC%E3%83%AB%E3%83%89%E3%81%AE%E6%8A%BD%E5%87%BA) - [`--fields`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%95%E3%82%A3%E3%83%BC%E3%83%AB%E3%83%89%E3%81%AE%E6%8A%BD%E5%87%BA) - [`--raw`](https://orchestor.io/docs/cli/global-flags.md#%E5%80%A4%E3%81%A0%E3%81%91%E3%82%92%E5%87%BA%E5%8A%9B) - [`--output`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%95%E3%82%A1%E3%82%A4%E3%83%AB%E3%81%B8%E3%81%AE%E5%87%BA%E5%8A%9B) - [`--no-pager`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%9A%E3%83%BC%E3%82%B8%E9%80%81%E3%82%8A) - [`--dry-run`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%AA%E3%82%AF%E3%82%A8%E3%82%B9%E3%83%88%E3%81%AE%E4%BA%8B%E5%89%8D%E7%A2%BA%E8%AA%8D) - [`--yes`](https://orchestor.io/docs/cli/global-flags.md#%E7%A2%BA%E8%AA%8D%E3%81%AE%E7%9C%81%E7%95%A5) - [`--limit`](https://orchestor.io/docs/cli/global-flags.md) - [`--cursor`](https://orchestor.io/docs/cli/global-flags.md) - [`--stdin`](https://orchestor.io/docs/cli/global-flags.md#%E6%A8%99%E6%BA%96%E5%85%A5%E5%8A%9B) - [`--from-stdin`](https://orchestor.io/docs/cli/global-flags.md#%E6%A8%99%E6%BA%96%E5%85%A5%E5%8A%9B) - [`--page-all`](https://orchestor.io/docs/cli/global-flags.md#%E3%81%99%E3%81%B9%E3%81%A6%E3%81%AE%E3%83%9A%E3%83%BC%E3%82%B8%E3%82%92%E5%8F%96%E5%BE%97) - [`--timing`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%AA%E3%82%AF%E3%82%A8%E3%82%B9%E3%83%88%E6%99%82%E9%96%93) - [`--wait`](https://orchestor.io/docs/cli/global-flags.md) - [`--timeout`](https://orchestor.io/docs/cli/global-flags.md) - [`--poll-interval`](https://orchestor.io/docs/cli/global-flags.md) - [`--readonly`](https://orchestor.io/docs/cli/global-flags.md#%E8%AA%AD%E3%81%BF%E5%8F%96%E3%82%8A%E5%B0%82%E7%94%A8%E3%83%A2%E3%83%BC%E3%83%89) - [`--wrap-untrusted`](https://orchestor.io/docs/cli/global-flags.md#%E5%A4%96%E9%83%A8%E3%83%86%E3%82%AD%E3%82%B9%E3%83%88%E3%81%AE%E7%9B%AE%E5%8D%B0%E4%BB%98%E3%81%91) 各オプションの詳細と使用例は、[グローバルオプション](https://orchestor.io/docs/cli/global-flags.md)を参照してください。 --- [Documentation index](https://orchestor.io/docs/llms.txt)