​

personas

orc personas は、Workspaceで使うオーディエンスのペルソナを管理するコマンドです。名前と説明、行動・属性・勤務情報から成るプロフィールを作成・取得・更新・削除できます。ブランドを基に非同期で候補を生成し、確認した内容を保存する操作もあります。

認証を設定し、対象Workspaceを指定してください。ペルソナを作成するだけではプロンプトとの関連付けや計測は始まりません。保存されたIDを orc prompts の persona_ids に設定します。プロフィールは利用者が記述する仮説で、検証済みの顧客属性ではありません。

保存されたペルソナとIDを確認します。

現在のWorkspaceのブランドを指定して、buyer personaの仮説を非同期生成します。受付時点でdispatch失敗の状態を含む場合があるため、返された生成IDの状態を確認してください。生成はペルソナを保存・関連付け・計測しません。

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) Brand in the selected workspace whose profile supplies generation context.

型: string。任意。

Requested number of persona candidates, from 1 to 5. Defaults to 3.

型: number。任意。

Language for the generated candidates. Defaults to ja-JP.

型: string。任意。

Optional guidance for generation, up to 2000 characters. Omit for no additional instructions.; max 2000 chars

型: string。任意。

生成IDで候補生成の状態と結果を取得します。候補を確認・編集し、選んだプロフィールを personas create で保存してください。

削除されていないペルソナを作成日時の新しい順に一覧します。ブランドによる絞り込みは行いません。同じcursorをそのまま使用して次ページを取得します。

必須入力は name です。description を省略するとnull、persona を省略すると空のプロフィールになります。作成には 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) Display name for this audience persona.

型: string。任意。

Optional audience summary. Omit or send null to store no description.; (use "null" or "reset" to clear)

型: string。任意。

Optional audience attributes grouped into behavior, demographics and employment, plus visual identity. Omit unknown groups or fields. Nullable leaf values can be null. Text and string arrays describe the audience; they are not validated against demographic taxonomies. Use employment.roleSeniority; the removed employment.seniority field is rejected.; (JSON object, e.g. '{"custom_id":"x"}')

型: string。任意。

構造化プロフィールを保存する

一覧で返されたペルソナIDを指定して詳細を取得します。不明・削除済み・別WorkspaceのIDは404です。

指定項目だけを変更します。description: null は説明を解除します。persona を渡すと入れ子をmergeせず、プロフィール全体を置き換えます。空プロフィールは空のJSON objectで指定します。

Replacement display name. Omit to keep the current name.

型: string。任意。

Replacement summary. Send null to clear it; omit to retain it.; (use "null" or "reset" to clear)

型: string。任意。

Optional audience attributes grouped into behavior, demographics and employment, plus visual identity. Omit unknown groups or fields. Nullable leaf values can be null. Text and string arrays describe the audience; they are not validated against demographic taxonomies. Use employment.roleSeniority; the removed employment.seniority field is rejected.; (JSON object, e.g. '{"custom_id":"x"}')

型: string。任意。

ペルソナを論理削除します。削除されていないプロンプトに関連付いている場合は409です。先に各プロンプトの persona_ids から外して再試行してください。

ペルソナの入力

persona の主なグループは behavior、demographics、employment です。フィールド名はcamelCaseです。不明なグループ・項目は省略でき、nullableな末端値はnullにできます。

behavior は motivations と painPoints、demographics は ageRange・gender・location・income・education、employment は companySize・industry・jobTitle・roleSeniority・department を扱います。属性と勤務情報は文字列の配列です。削除済みの employment.seniority ではなく roleSeniority を使ってください。

任意の avatar は colorToken・identityKind・iconToken・emoji・imageFileId を持ちます。nullは既定のavatarへ戻します。更新時に一部のプロフィールだけを送ると残りも置き換わるため、保持したい項目を含む全体を送ってください。

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

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

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