API を使用して会話を一括分析する

Customer Experience Insights では、会話のランダムなサブセット、フィルタされたサブセット、またはそれらの組み合わせを 1 つのリクエストで分析できます。

注: API リクエストごとに最大 1 万件の会話を分析できます。同時に実行できる一括分析オペレーションは 1 つだけです。

前提条件

1. Google Cloud プロジェクトで Cloud Storage、Speech-to-Text、Insights API が有効になっていることを確認します。
2. 会話データが Customer Experience Insights にアップロードされていることを確認します。

サンプル コマンド

このタスクに必要な権限

このタスクを行うには、次の権限が必要です。

• contactcenterinsights.analyses.create

REST

詳細については、conversations:bulkAnalyze API エンドポイントをご覧ください。このリソースの詳細については、Conversation リファレンス ドキュメントをご覧ください。

リクエストのデータを使用する前に、次のように置き換えます。

• PROJECT_ID: Google Cloud Platform プロジェクト ID。
• ANALYSIS_PERCENTAGE: ランダムに分析する会話の割合。

注: すべての例で、グローバル Customer Experience Insights インスタンスを使用しています。リージョン インスタンスの使用方法については、リージョン化をご覧ください。

HTTP メソッドと URL:

POST https://contactcenterinsights.googleapis.com/v1/projects/PROJECT_ID/locations/us-central1/conversations:bulkAnalyze

リクエストの本文（JSON）:

{
  "analysisPercentage": ANALYSIS_PERCENTAGE
}

リクエストを送信するには、次のいずれかのオプションを展開します。

curl（Linux、macOS、Cloud Shell）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ユーザー アカウントで gcloud CLI にログインしているか、Cloud Shell を使用して自動的に gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

リクエスト本文を request.json という名前のファイルに保存して、次のコマンドを実行します。

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://contactcenterinsights.googleapis.com/v1/projects/PROJECT_ID/locations/us-central1/conversations:bulkAnalyze"

PowerShell（Windows）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ご自分のユーザー アカウントで gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

リクエスト本文を request.json という名前のファイルに保存して、次のコマンドを実行します。

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://contactcenterinsights.googleapis.com/v1/projects/PROJECT_ID/locations/us-central1/conversations:bulkAnalyze" | Select-Object -Expand Content

次のような JSON レスポンスが返されます。

{
  "name": "projects/PROJECT_ID/locations/us-central1/operations/OPERATION_ID",
}

（省略可）フィルタを使用して会話を分析する

フィルタの全一覧は、[会話のフィルタリング] ページで確認できます。

REST

リクエストのデータを使用する前に、次のように置き換えます。

• PROJECT_ID: Google Cloud Platform プロジェクト ID。
• ANALYSIS_PERCENTAGE: ランダムに分析する会話の割合。
• FILTER: 会話をフィルタします。API リファレンス

注: すべての例で、グローバル Customer Experience Insights インスタンスを使用しています。リージョン インスタンスの使用方法については、リージョン化をご覧ください。

HTTP メソッドと URL:

POST https://contactcenterinsights.googleapis.com/v1/projects/PROJECT_ID/locations/us-central1/conversations:bulkAnalyze

リクエストの本文（JSON）:

{
  "analysisPercentage": ANALYSIS_PERCENTAGE,
  "filter": 'FILTER''
}

リクエストを送信するには、次のいずれかのオプションを展開します。

curl（Linux、macOS、Cloud Shell）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ユーザー アカウントで gcloud CLI にログインしているか、Cloud Shell を使用して自動的に gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

リクエスト本文を request.json という名前のファイルに保存して、次のコマンドを実行します。

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://contactcenterinsights.googleapis.com/v1/projects/PROJECT_ID/locations/us-central1/conversations:bulkAnalyze"

PowerShell（Windows）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ご自分のユーザー アカウントで gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

リクエスト本文を request.json という名前のファイルに保存して、次のコマンドを実行します。

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://contactcenterinsights.googleapis.com/v1/projects/PROJECT_ID/locations/us-central1/conversations:bulkAnalyze" | Select-Object -Expand Content

次のような JSON レスポンスが返されます。

{
  "name": "projects/PROJECT_ID/locations/us-central1/operations/OPERATION_ID",
}

（省略可）分析を構成する

REST

リクエストのデータを使用する前に、次のように置き換えます。

• PROJECT_ID: Google Cloud Platform プロジェクト ID。
• ANALYSIS_PERCENTAGE: ランダムに分析する会話の割合。
• PHRASE_MATCHER(s): フレーズ マッチャー アノテーターに使用するフレーズ マッチャーの完全修飾フレーズ マッチャー リソース名。空のままにすると、すべてのアクティブなフレーズ マッチャーが実行されます。
• ISSUE_MODEL(s): 問題モデル アノテーターに使用する問題モデルの完全修飾リソース名。run_issue_model_annotator が true の場合にのみ機能します。空のままにすると、デプロイされたすべての問題モデルが実行されます。現在、デプロイできるモデルは 1 つに制限されています。

注: すべての例で、グローバル Customer Experience Insights インスタンスを使用しています。リージョン インスタンスの使用方法については、リージョン化をご覧ください。

HTTP メソッドと URL:

POST https://contactcenterinsights.googleapis.com/v1/projects/PROJECT_ID/locations/us-central1/conversations:bulkAnalyze

リクエストの本文（JSON）:

{
  "analysisPercentage": ANALYSIS_PERCENTAGE
  "annotatorSelector": {
    "run_interruption_annotator": {true/false},
    "run_silence_annotator": {true/false},
    "run_phrase_matcher_annotator": {true/false},
    "phrase_matchers": PHRASE_MATCHER(s),
    "run_sentiment_annotator": {true/false},
    "run_entity_annotator": {true/false},
    "run_intent_annotator": {true/false},
    "run_issue_model_annotator": {true/false}
    "issue_models": ISSUE_MODEL(s)
  }
}

リクエストを送信するには、次のいずれかのオプションを展開します。

curl（Linux、macOS、Cloud Shell）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ユーザー アカウントで gcloud CLI にログインしているか、Cloud Shell を使用して自動的に gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

リクエスト本文を request.json という名前のファイルに保存して、次のコマンドを実行します。

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://contactcenterinsights.googleapis.com/v1/projects/PROJECT_ID/locations/us-central1/conversations:bulkAnalyze"

PowerShell（Windows）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ご自分のユーザー アカウントで gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

リクエスト本文を request.json という名前のファイルに保存して、次のコマンドを実行します。

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://contactcenterinsights.googleapis.com/v1/projects/PROJECT_ID/locations/us-central1/conversations:bulkAnalyze" | Select-Object -Expand Content

次のような JSON レスポンスが返されます。

{
  "name": "projects/PROJECT_ID/locations/us-central1/operations/OPERATION_ID",
}

オペレーションをポーリングする

分析を作成すると、長時間実行オペレーションが返されます。長時間実行メソッドは非同期で、メソッドがレスポンスを返すときにオペレーションがまだ完了していない場合があります。オペレーションをポーリングして、そのステータスを確認できます。詳細とコードサンプルについては、長時間実行オペレーションのページをご覧ください。

オペレーションをキャンセルする

このタスクに必要な権限

このタスクを行うには、次の権限が必要です。

• contactcenteraiplatform.operations.cancel

REST

リクエストのデータを使用する前に、次のように置き換えます。

• PROJECT_ID: Google Cloud Platform プロジェクト ID。
• OPERATION_ID: 分析する会話の ID。この値は、オペレーションの作成時に返されました。

注: すべての例で、グローバル Customer Experience Insights インスタンスを使用しています。リージョン インスタンスの使用方法については、リージョン化をご覧ください。

HTTP メソッドと URL:

POST https://contactcenterinsights.googleapis.com/v1/projects/PROJECT_ID/locations/us-central1/operations/OPERATION_ID:cancel

リクエストを送信するには、次のいずれかのオプションを展開します。

curl（Linux、macOS、Cloud Shell）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ユーザー アカウントで gcloud CLI にログインしているか、Cloud Shell を使用して自動的に gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

次のコマンドを実行します。

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d "" \
     "https://contactcenterinsights.googleapis.com/v1/projects/PROJECT_ID/locations/us-central1/operations/OPERATION_ID:cancel"

PowerShell（Windows）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ご自分のユーザー アカウントで gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

次のコマンドを実行します。

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -Uri "https://contactcenterinsights.googleapis.com/v1/projects/PROJECT_ID/locations/us-central1/operations/OPERATION_ID:cancel" | Select-Object -Expand Content

次のような JSON レスポンスが返されます。

{}