CLI を使い始める

perception-attributes

@orchestor-inc/cli のコマンドリファレンスです。

コマンド一覧

  • orc perception-attributes list — 管理対象のブランド認識属性を一覧表示
  • orc perception-attributes create — カスタム属性を作成
  • orc perception-attributes update — 属性の表示名を変更
  • orc perception-attributes delete — 属性を非表示化

orc perception-attributes list

観測済み属性とカスタム属性を一覧表示します。観測済み属性の id は、更新と削除にそのまま使用できます。

構文

orc perception-attributes list --brand-id <brand-id> [flags]

フラグ

フラグ型必須説明
--brand-idstringはい対象ブランド ID

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

orc perception-attributes create

将来の観測に使うカスタム属性を作成します。ブランドごとに有効なカスタム属性は最大 10 件です。

構文

orc perception-attributes create --brand-id <brand-id> --label <label> [flags]

フラグ

フラグ型必須説明
--brand-idstringはい対象ブランド ID
--labelstringはい2〜80 文字の属性ラベル
--idempotency-keystringいいえ再試行時の重複作成を防ぐ一意なキー

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

orc perception-attributes update

永続化済み属性、または観測済み属性の表示名を変更します。元の source_label と既存の根拠との対応は変わりません。

構文

orc perception-attributes update <id> --brand-id <brand-id> --label <label> [flags]

引数

引数必須説明
idはいlist が返した属性 ID

フラグ

フラグ型必須説明
--brand-idstringはい対象ブランド ID
--labelstringはい2〜80 文字の新しい表示ラベル

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

orc perception-attributes delete

属性をレポートと根拠一覧から非表示にします。履歴上の観測と source_label は保持されます。

構文

orc perception-attributes delete <id> --brand-id <brand-id> [flags]

引数

引数必須説明
idはいlist が返した属性 ID

フラグ

フラグ型必須説明
--brand-idstringはい対象ブランド ID
--yesbooleanいいえ非対話実行で確認を省略

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。