CLI を使い始める

​
prompts

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

​
コマンド一覧

  • orc prompts list — List AI Search prompts
  • orc prompts create — Create AI Search prompt
  • orc prompts get — Get AI Search prompt
  • orc prompts update — Update AI Search prompt
  • orc prompts delete — Remove an AI Search prompt from active views
  • orc prompts disable — Disable AI Search prompt
  • orc prompts enable — Enable AI Search prompt
  • orc prompts suggestions list — List prompt suggestions
  • orc prompts suggestions refresh — Generate prompt suggestions
  • orc prompts suggestions generations get — Get prompt suggestion generation
  • orc prompts suggestions accept — Accept suggestion (promote to prompt)
  • orc prompts suggestions reject — Reject suggestion
  • orc prompts tags get — List tags on a prompt
  • orc prompts tags update — Replace prompt tags (bulk)

​
orc prompts list

List AI Search prompts

​
構文

orc prompts list [flags]

​
フラグ

フラグ型必須説明
--topic-idstringいいえFilter prompts attached to one Topic.
--statusstringいいえFilter prompts by lifecycle status.; enum: active|disabled|archived
--limitnumberいいえMaximum number of items to return
--cursorstringいいえOpaque cursor for the next page

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

​
互換エイリアス

  • orc prompt list

​
ヘルプ

orc prompts list --help

​
orc prompts create

Create AI Search prompt

​
構文

orc prompts create [flags]

​
フラグ

フラグ型必須説明
--idempotency-keystringいいえ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.
--topic-idstringいいえOptional Topic reference used to attach this prompt to an observation topic.; (use "null" or "reset" to clear)
--textstringいいえ(required) The prompt text to send to LLM platforms.; max 2000 chars
--persona-idsstringいいえExisting workspace Persona IDs to associate with the Prompt.; csv
--platformsstringいいえ計測する安定した計測チャンネル ID。利用可能な値は orc channels list で確認します。; csv
--region-idstringいいえObservation/measurement region identifier used when executing this prompt. If omitted, supported country_code values resolve to a default locale. This is not Organization residency.
--language-codestringいいえBCP 47 language code used when executing this prompt. If omitted, supported country_code values resolve to a default language.
--country-codestringいいえISO 3166 observation country used when executing this prompt. Common forms such as JP, jp, JPN, and locale-style ja-JP are normalized to the canonical alpha-2 country code when supported. This does not control Organization residency.; (use "null" or "reset" to clear)
--statusstringいいえLifecycle status. Defaults to active; disabled preserves history and stops future execution.; enum: active|disabled
--schedulestringいいえCron expression for periodic collection.; max 100 chars
--brandingstringいいえMutually exclusive branding classification automatically maintained for every prompt.; enum: non_branded|branded
--intent-typestringいいえMutually exclusive search-intent classification automatically maintained for every prompt.; enum: informational|commercial|transactional
--previewstringいいえWhen true, validate and resolve the Prompt without persistence. Requires Idempotency-Key; read-scope API keys may use only this mode.

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

​
互換エイリアス

  • orc prompt create

​
ヘルプ

orc prompts create --help

​
orc prompts get

Get AI Search prompt

​
構文

orc prompts get <id> [flags]

​
引数

引数必須説明
idはいPath parameter: id

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

​
互換エイリアス

  • orc prompt get

​
ヘルプ

orc prompts get --help

​
orc prompts update

Update AI Search prompt

​
構文

orc prompts update <id> [flags]

​
引数

引数必須説明
idはいPath parameter: id

​
フラグ

フラグ型必須説明
--idempotency-keystringいいえ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.
--textstringいいえBody field: text; max 2000 chars
--topic-idstringいいえExisting workspace Topic to associate with the prompt. Set to null to remove the association.; (use "null" or "reset" to clear)
--persona-idsstringいいえComplete replacement set of existing workspace Persona IDs associated with the Prompt.; csv
--platformsstringいいえ既存プロンプトに設定する安定した計測チャンネル ID。; csv
--region-idstringいいえCatalog or locale-style region identifier for prompt execution.
--language-codestringいいえBCP 47 language code for prompt execution.
--country-codestringいいえISO 3166 country code for prompt execution. Common forms such as JP, jp, JPN, and locale-style ja-JP are normalized to the canonical alpha-2 country code when supported.; (use "null" or "reset" to clear)
--statusstringいいえLifecycle transition. disabled preserves history and stops future execution; archived removes the prompt from active work while preserving its history.; enum: active|disabled|archived
--schedulestringいいえBody field: schedule; max 100 chars
--brandingstringいいえMutually exclusive branding classification automatically maintained for every prompt.; enum: non_branded|branded
--intent-typestringいいえMutually exclusive search-intent classification automatically maintained for every prompt.; enum: informational|commercial|transactional
--config-revisionnumberいいえOptimistic concurrency token. Omission is accepted only during the migration window.
--previewstringいいえWhen true, validate and resolve the update without persistence. Requires Idempotency-Key; read-scope API keys may use only this mode.

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

​
互換エイリアス

  • orc prompt update

​
ヘルプ

orc prompts update --help

​
orc prompts delete

Remove an AI Search prompt from active views

​
構文

orc prompts delete <id> [flags]

​
引数

引数必須説明
idはいPath parameter: id

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

​
互換エイリアス

  • orc prompt delete

​
ヘルプ

orc prompts delete --help

​
orc prompts disable

Disable AI Search prompt

​
構文

orc prompts disable <id> [flags]

​
引数

引数必須説明
idはいPath parameter: id

​
フラグ

フラグ型必須説明
--idempotency-keystringいいえ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 prompts disable --help

​
orc prompts enable

Enable AI Search prompt

​
構文

orc prompts enable <id> [flags]

​
引数

引数必須説明
idはいPath parameter: id

​
フラグ

フラグ型必須説明
--idempotency-keystringいいえ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 prompts enable --help

​
orc prompts suggestions list

List prompt suggestions

​
構文

orc prompts suggestions list [flags]

​
フラグ

フラグ型必須説明
--statusstringいいえenum: pending|accepted|rejected
--topic-idstringいいえvalue
--limitnumberいいえMaximum number of items to return
--cursorstringいいえOpaque cursor for the next page

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

​
互換エイリアス

  • orc prompt suggestion-list

​
ヘルプ

orc prompts suggestions list --help

​
orc prompts suggestions refresh

Generate prompt suggestions

​
構文

orc prompts suggestions refresh [flags]

​
フラグ

フラグ型必須説明
--idempotency-keystringいいえ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.
--topic-idsstringいいえ(required) Existing workspace topic IDs used as the generation scope.; csv
--persona-idsstringいいえExisting workspace Persona IDs to distribute across generated suggestions. Omit or send an empty array to generate without Persona context.; csv
--prompts-per-topicnumberいいえBody field: prompts_per_topic
--language-codestringいいえBody field: language_code
--country-codestringいいえBody field: country_code
--instructionsstringいいえOptional generation guidance applied to every selected topic.; max 2000 chars
--waitbooleanいいえWait for an asynchronous operation to finish and print its result
--timeoutstringいいえMaximum wait duration (for example 30s or 5m)
--poll-intervalstringいいえDelay between status requests (default: 5s) 既定値: 5s

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

​
ヘルプ

orc prompts suggestions refresh --help

​
orc prompts suggestions generations get

Get prompt suggestion generation

​
構文

orc prompts suggestions generations get <id> [flags]

​
引数

引数必須説明
idはいPath parameter: id

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

​
ヘルプ

orc prompts suggestions generations get --help

​
orc prompts suggestions accept

Accept suggestion (promote to prompt)

​
構文

orc prompts suggestions accept <id> [flags]

​
引数

引数必須説明
idはいPath parameter: id

​
フラグ

フラグ型必須説明
--idempotency-keystringいいえ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.
--topic-idstringいいえBody field: topic_id
--edit-textstringいいえBody field: edit_text; max 2000 chars

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

​
ヘルプ

orc prompts suggestions accept --help

​
orc prompts suggestions reject

Reject suggestion

​
構文

orc prompts suggestions reject <id> [flags]

​
引数

引数必須説明
idはいPath parameter: id

​
フラグ

フラグ型必須説明
--idempotency-keystringいいえ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 prompts suggestions reject --help

​
orc prompts tags get

List tags on a prompt

​
構文

orc prompts tags get <id> [flags]

​
引数

引数必須説明
idはいPath parameter: id

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

​
互換エイリアス

  • orc prompt tags-get

​
ヘルプ

orc prompts tags get --help

​
orc prompts tags update

Replace prompt tags (bulk)

​
構文

orc prompts tags update <id> [flags]

​
引数

引数必須説明
idはいPath parameter: id

​
フラグ

フラグ型必須説明
--idempotency-keystringいいえ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.
--tag-idsstringいいえ(required) Body field: tag_ids; csv
--config-revisionnumberいいえOptimistic concurrency token. Omission is accepted only during the migration window.

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

​
互換エイリアス

  • orc prompt tags-set

​
ヘルプ

orc prompts tags update --help