​

topics

orc topics は、ブランドに紐づく計測トピックを管理します。トピックの一覧・詳細を取得し、名前の登録・変更、archive・解除、論理削除を行えます。Workspaceのブランド情報から生成されたトピック候補は、確認してから採用または却下します。

認証を設定し、対象Workspaceを指定してください。作成にはトピック名と同じWorkspaceのブランドIDが必要です。トピックの作成だけではプロンプトを作成しません。後続の質問は orc prompts の topic_id へ関連付けます。

保存されたトピックを確認します。

削除されていないブランド配下のトピックを新しい順に一覧します。archivedも含みます。--brand-id を省略すると全ブランドが対象です。ページを続ける間はブランド条件を保持します。

Restrict results to this brand in the selected workspace. Omit to include all brands; an unavailable brand returns 404.

型: string。任意。

name は最大255文字で、brand_id とともに必須です。作成時はunarchivedです。workspace:settings 権限が必要です。

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。任意。

(required) Human-readable topic name, from 1 to 255 characters.; max 255 chars

型: string。任意。

(required) Required parent brand in the selected workspace. A topic cannot currently be created without a brand.

型: string。任意。

ブランドのトピックを作成する

トピックIDで詳細を取得します。archivedトピックも取得できます。トピックまたは親ブランドが対象Workspaceで利用できなければ404です。

入力した name と archived だけを変更します。--archived true はarchive、falseは解除です。ブランド関連付けは変更できず、空の本文は現在のトピックを返します。

Set true to archive or false to unarchive through the measurement lifecycle. Omit to keep the current state.

型: string。任意。

Replacement topic name. Omit to keep the current name.; max 255 chars

型: string。任意。

トピックをarchiveする

トピックを計測lifecycleを通して論理削除し、通常の一覧・取得から外します。workspace:settings 権限が必要です。

保存された提案を --status と --brand-id で絞れます。省略した条件は制限しません。cursorをたどる間は条件を保持してください。

Filter by suggestion status. Omit to include all statuses.; enum: pending|accepted|rejected

型: string。任意。

Filter by brand id in the selected workspace. Omit to include domains or suggestions for all brands.

型: string。任意。

現在のWorkspaceのブランド情報から候補の非同期生成を開始します。本文は不要です。--wait で完了を待てます。生成された候補は明示的に採用するまでトピックになりません。

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。任意。

トピック提案を生成して待つ

返された生成IDで非同期処理の状態を取得します。受付応答だけで生成完了と判断せず、状態を確認してください。

pending候補を採用してactiveトピックを作成します。--brand-id は候補のブランドを上書きします。両方にブランドがない場合は400です。--edit-name で名前を調整できます。解決済み候補は409、不明IDは404です。

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。任意。

Brand in the selected workspace to assign to the new topic. Required when the suggestion has no brand.

型: string。任意。

Name for the created resource. When omitted, uses the suggestion name.; max 255 chars

型: string。任意。

pending候補をrejectedへ変更します。不明IDは404、すでに採用または却下された候補は409です。

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。任意。

対象Workspaceへのアクセスが必要です。変更操作には対応する書き込み権限が必要です。

orc topics では、次のグローバルオプションを使用できます。

各オプションの詳細と使用例は、グローバルオプションを参照してください。