CLI を使い始める
topics
@orchestor-inc/cli のコマンドリファレンスです。
コマンド一覧
orc topics list— List AI Search topics in projectorc topics create— Create AI Search topicorc topics get— Get AI Search topicorc topics update— Update AI Search topicorc topics delete— Soft-delete AI Search topicorc topics suggestions list— List topic suggestionsorc topics suggestions refresh— Generate topic suggestionsorc topics suggestions generations get— Get topic suggestion generationorc topics suggestions accept— Accept a topic suggestion (promote to topic)orc topics suggestions reject— Reject a topic suggestion
orc topics list
List AI Search topics in project
構文
orc topics list [flags]フラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--brand-id | string | いいえ | Optional AI Search Brand ID filter. |
--limit | number | いいえ | Maximum number of items to return |
--cursor | string | いいえ | Opaque cursor for the next page |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
互換エイリアス
orc topic list
ヘルプ
orc topics list --helporc topics create
Create AI Search topic
構文
orc topics create [flags]フラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--idempotency-key | string | いいえ | Unique key for idempotent POST requests (24h TTL). If a request with the same key was already processed, the original response is returned without re-executing the operation. Reusing a key with a different request payload returns 409 idempotency_error. Use a UUID v4 or similar unique identifier. |
--name | string | いいえ | (required) Topic name.; max 255 chars |
--brand-id | string | いいえ | Optional brand association. Required by the current storage model until nullable project-only topics are enabled. |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
ヘルプ
orc topics create --helporc topics get
Get AI Search topic
構文
orc topics get <id> [flags]引数
| 引数 | 必須 | 説明 |
|---|---|---|
id | はい | Path parameter: id |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
互換エイリアス
orc topic get
ヘルプ
orc topics get --helporc topics update
Update AI Search topic
構文
orc topics update <id> [flags]引数
| 引数 | 必須 | 説明 |
|---|---|---|
id | はい | Path parameter: id |
フラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--name | string | いいえ | Body field: name; max 255 chars |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
互換エイリアス
orc topic update
ヘルプ
orc topics update --helporc topics delete
Soft-delete AI Search topic
構文
orc topics delete <id> [flags]引数
| 引数 | 必須 | 説明 |
|---|---|---|
id | はい | Path parameter: id |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
互換エイリアス
orc topic delete
ヘルプ
orc topics delete --helporc topics suggestions list
List topic suggestions
構文
orc topics suggestions list [flags]フラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--status | string | いいえ | enum: pending|accepted|rejected |
--brand-id | string | いいえ | value |
--limit | number | いいえ | Maximum number of items to return |
--cursor | string | いいえ | Opaque cursor for the next page |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
互換エイリアス
orc topic suggestion-list
ヘルプ
orc topics suggestions list --helporc topics suggestions refresh
Generate topic suggestions
構文
orc topics suggestions refresh [flags]フラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--idempotency-key | string | いいえ | Unique key for idempotent POST requests (24h TTL). If a request with the same key was already processed, the original response is returned without re-executing the operation. Reusing a key with a different request payload returns 409 idempotency_error. Use a UUID v4 or similar unique identifier. |
--wait | boolean | いいえ | Wait for an asynchronous operation to finish and print its result |
--timeout | string | いいえ | Maximum wait duration (for example 30s or 5m) |
--poll-interval | string | いいえ | Delay between status requests (default: 5s) 既定値: 5s |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
ヘルプ
orc topics suggestions refresh --helporc topics suggestions generations get
Get topic suggestion generation
構文
orc topics suggestions generations get <id> [flags]引数
| 引数 | 必須 | 説明 |
|---|---|---|
id | はい | Path parameter: id |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
ヘルプ
orc topics suggestions generations get --helporc topics suggestions accept
Accept a topic suggestion (promote to topic)
構文
orc topics suggestions accept <id> [flags]引数
| 引数 | 必須 | 説明 |
|---|---|---|
id | はい | Path parameter: id |
フラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--idempotency-key | string | いいえ | Unique key for idempotent POST requests (24h TTL). If a request with the same key was already processed, the original response is returned without re-executing the operation. Reusing a key with a different request payload returns 409 idempotency_error. Use a UUID v4 or similar unique identifier. |
--brand-id | string | いいえ | Override target brand |
--edit-name | string | いいえ | Body field: edit_name; max 255 chars |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
ヘルプ
orc topics suggestions accept --helporc topics suggestions reject
Reject a topic suggestion
構文
orc topics suggestions reject <id> [flags]引数
| 引数 | 必須 | 説明 |
|---|---|---|
id | はい | Path parameter: id |
フラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--idempotency-key | string | いいえ | Unique key for idempotent POST requests (24h TTL). If a request with the same key was already processed, the original response is returned without re-executing the operation. Reusing a key with a different request payload returns 409 idempotency_error. Use a UUID v4 or similar unique identifier. |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
ヘルプ
orc topics suggestions reject --help