このページは Cloud Translation API によって翻訳されました。

生成ナレッジアシスト

生成ナレッジアシスタントは、指定したドキュメントの情報に基づいて、エージェントの質問に回答します。ドメイン名を指定することも、データストアエージェントのドキュメントをアップロードしてインデックスに登録することもできます。生成知識アシスタントは、その情報を進行中の会話と利用可能な顧客メタデータと統合し、エージェントにより関連性の高いタイムリーな回答を提供します。

プロアクティブ生成ナレッジアシストは、エージェントとお客様との会話の進行状況に応じて機能します。現在の会話のコンテキストと回答に基づいて、検索語句を前もって提案します。

データストアエージェントを作成する

プロジェクトオーナーでない場合は、データストアエージェントを作成するために次のロールが必要です。
- Dialogflow API 管理者
- ディスカバリーエンジン管理者
Vertex AI コンソールで Vertex AI Agent Builder API を有効にします。
エージェントを作成するには、データストアエージェントの手順に沿って操作します。

人間のエージェントからの質問に回答する

データストアエージェントは、提供されたドキュメントに基づいて人間のエージェントからの質問に回答できます。

ステップ 1: 会話プロファイルを作成する

Agent Assist コンソールまたは API を使用して会話プロファイルを作成します。

コンソールから作成する

生成知識アシスト候補のタイプを有効にして、前の手順で作成したデータストアエージェントにリンクする必要があります。
省略可: [エージェントの検索クエリのロギングを無効にする] チェックボックスを使用して、品質向上のために秘匿化済みの検索クエリを収集して保存するかどうかを指定します。
[会話拡張クエリを有効にする] チェックボックスを使用すると、検索クエリの回答を生成するときに、人間のエージェントとユーザーとの会話のコンテキストを考慮するかどうかを指定できます。

API から作成

次の手順では、HumanAgentAssistantConfig オブジェクトを使用して ConversationProfile を作成する方法を示します。これらの操作は Agent Assist コンソールを使用して行うこともできます。

会話プロファイルを作成するには、ConversationProfile リソースの create メソッドを呼び出します。

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

PROJECT_ID: プロジェクト ID
LOCATION_ID: ロケーションの ID
AGENT_ID: 前の手順で取得したデータストアエージェント ID

JSON の例を次に示します。

  {
    "displayName": "my-conversation-profile-display-name",
    "humanAgentAssistantConfig": {
      "humanAgentSuggestionConfig": {
        "featureConfigs": [
          {
            "suggestionFeature": {
              "type": "KNOWLEDGE_SEARCH"
            },
            "queryConfig": {
              "dialogflowQuerySource": {
                "humanAgentSideConfig": {
                  "agent": "projects/PROJECT_ID/locations/LOCATION_ID/agents/AGENT_ID"
                }
              }
            },
            "disableAgentQueryLogging": false,
            "enableConversationAugmentedQuery": false,
          }
        ]
      }
    }
  }

Agent Assist コンソールで会話プロファイルを作成すると、生成ナレッジアシストとプロアクティブ生成ナレッジアシストの両方が自動的に有効になります。生成型ナレッジアシストを無効にするには、API を使用して会話プロファイルを作成する必要があります。

ステップ 2: データストアエージェントを使用する

必要に応じて、SearchKnowledge API を使用してデータストアエージェントから回答を取得します。SearchKnowledge リクエストの一部として、次の構成を使用することもできます。

querySource: エージェントがクエリを入力したのか、プロアクティブ生成ナレッジアシスタントが自動的に提案したのかを示すために、このフィールドを設定します。
exactSearch: このフィールドを設定して、クエリの書き換えなしで入力クエリを正確に検索するかどうかを指定します。
endUserMetadata: 生成される回答の精度を高めるために、エンドユーザーに関する追加情報を含めるようにこのフィールドを設定します。詳細については、データストアエージェントのパフォーマンスのカスタマイズページをご覧ください。
searchConfig: このフィールドを設定すると、ナレッジドキュメントのブーストとフィルタリングをさらに制御できます。詳細については、データストアエージェントのパフォーマンス検索の構成ページをご覧ください。

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

PROJECT_ID: プロジェクト ID
LOCATION_ID: ロケーションの ID
CONVERSATION_PROFILE_ID: 前の手順で取得した会話プロファイル ID
SESSION_ID: 検索セッション ID
CONVERSATION_ID: 検索リクエストがトリガーされた会話（人間のエージェントとエンドユーザーの間）
MESSAGE_ID: 検索リクエストがトリガーされたときの最新の会話メッセージ

JSON リクエストの例を次に示します。

{
  "parent": "projects/PROJECT_ID/locations/LOCATION_ID"
  "query": {
    "text": "What is the return policy?"
  }
  "conversationProfile": "projects/PROJECT_ID/locations/LOCATION_ID/conversationProfiles/CONVERSATION_PROFILE_ID"
  "sessionId": "SESSION_ID
  "conversation": "projects/PROJECT_ID/locations/LOCATION_ID/conversations/CONVERSATION_ID"
  "latestMessage": "projects/PROJECT_ID/locations/LOCATION_ID/conversations/CONVERSATION_ID/messages/MESSAGE_ID
  "querySource": AGENT_QUERY
  "exactSearch": false
  "searchConfig": {
    "filterSpecs": {
      "filter": "category: ANY(\"persona_B\")"
    }
  }
  "endUserMetadata": {
    "deviceOwned": "Google Pixel 7"
  }
}

必要に応じて、エージェントがユーザーとの会話中に検索を行う場合は、conversation リソース名と latest_message リソース名を指定します。enable_conversation_augmented_query オプションを有効にして、エージェントとユーザー間の会話コンテキストでクエリ回答エクスペリエンスを強化する場合は、これらの 2 つのフィールドが必要です。

シミュレータ

Agent Assist シミュレータでデータストアエージェントをテストします。

上の例では、データストアエージェントは、ユーザーのクエリ What is the refund processing time? に次の情報を返します。

生成 AI 生成回答: 返品された商品が販売者の返品センターに届いてから、処理が完了するまでに最長で 7 営業日ほどかかることがあります。注文ページに表示されている返品追跡番号で、払い戻しのステータスを確認してください。
関連するナレッジドキュメントのタイトル: 返品と払い戻し。

エージェント向けの Q＆A を事前に提案する

プロアクティブ生成ナレッジアシストでは、進行中の会話に沿って、検索語句の候補と回答を事前に提示します。

ステップ 1: 会話プロファイルを作成する

Agent Assist コンソールまたは API を使用して会話プロファイルを作成します。会話プロファイルは、Agent Assist コンソールを使用して作成することをおすすめします。

コンソールから作成する

生成ナレッジアシストの候補タイプを有効にして、前の手順で作成したデータストアエージェントにリンクします。これにより、データストアエージェントは、人間のエージェントからの手動検索クエリに対して、クエリと回答の候補を事前に提供したり、回答したりできるようになります。
省略可: [会話の候補クエリをすべて表示] チェックボックスをオンにすると、ナレッジドキュメントから回答が見つからない場合でも、データストアエージェントがこれらのクエリをすべて表示します。これは、進行中の会話から取得できるクエリをテストすることを目的としています。
省略可: [事前回答を非同期で読み込む] チェックボックスをオンにすると、クエリの候補のみを取得できます。候補として表示されたクエリは、SearchKnowledge API に手動で送信できます。また、Agent Assist コンソールシミュレーターと UI モジュールで自動的に送信することもできます。

API から作成

次の手順では、HumanAgentAssistantConfig オブジェクトを使用して ConversationProfile を作成します。これらの操作は Agent Assist コンソールを使用して行うこともできます。

会話プロファイルを作成するには、ConversationProfile リソースの create メソッドを呼び出します。

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

PROJECT_ID: プロジェクト ID
LOCATION_ID: ロケーションの ID
AGENT_ID: 前の手順で取得したデータストアエージェント ID

JSON の例を次に示します。

  {
    "displayName": "my-conversation-profile-display-name",
    "humanAgentAssistantConfig": {
      "humanAgentSuggestionConfig": {
        "featureConfigs": [
          {
            "suggestionFeature": {
              "type": "KNOWLEDGE_ASSIST"
            },
            "queryConfig": {
              "dialogflowQuerySource": {
                "agent": "projects/PROJECT_ID/locations/LOCATION_ID/agents/AGENT_ID"
              }
            },
            "enableQuerySuggestionWhenNoAnswer": false,
          }
        ]
      }
    }
  }

ステップ 2: ランタイムに会話を処理する

プロアクティブ生成ナレッジアシストでは、会話を実行時に処理し、現在の会話のコンテキストと回答に基づいて検索語句をプロアクティブに提案します。

会話を作成する

まず、会話を作成する必要があります。

REST

会話を作成するには、Conversation リソースの create メソッドを呼び出します。

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

PROJECT_ID: 実際の Cloud プロジェクトの ID
LOCATION_ID: ロケーション ID
CONVERSATION_PROFILE_ID: 会話プロファイルの作成時に受け取った ID

HTTP メソッドと URL:

POST https://dialogflow.googleapis.com/v2/projects/PROJECT_ID/locations/LOCATION_ID/conversations

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

{
  "conversationProfile": "projects/PROJECT_ID/locations/LOCATION_ID/conversationProfiles/CONVERSATION_PROFILE_ID",
}

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

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 "x-goog-user-project: PROJECT_ID" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://dialogflow.googleapis.com/v2/projects/PROJECT_ID/locations/LOCATION_ID/conversations"

PowerShell（Windows）

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

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

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred"; "x-goog-user-project" = "PROJECT_ID" }

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

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

{
  "name": "projects/PROJECT_ID/locations/LOCATION_ID/conversations/CONVERSATION_ID",
  "lifecycleState": "IN_PROGRESS",
  "conversationProfile": "projects/PROJECT_ID/locations/LOCATION_ID/conversationProfiles/CONVERSATION_PROFILE_ID",
  "startTime": "2018-11-05T21:05:45.622Z"
}

conversations の後のパスセグメントには、新しい会話 ID が含まれます。

Python

詳細については、Vertex AI Agent Builder Python API のリファレンスドキュメントをご覧ください。

Vertex AI Agent Builder に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。

def create_conversation(project_id, conversation_profile_id):
    """Creates a conversation with given values

    Args:
        project_id:  The GCP project linked with the conversation.
        conversation_profile_id: The conversation profile id used to create
        conversation."""

    client = dialogflow.ConversationsClient()
    conversation_profile_client = dialogflow.ConversationProfilesClient()
    project_path = client.common_project_path(project_id)
    conversation_profile_path = conversation_profile_client.conversation_profile_path(
        project_id, conversation_profile_id
    )
    conversation = {"conversation_profile": conversation_profile_path}
    response = client.create_conversation(
        parent=project_path, conversation=conversation
    )

    print("Life Cycle State: {}".format(response.lifecycle_state))
    print("Conversation Profile Name: {}".format(response.conversation_profile))
    print("Name: {}".format(response.name))
    return response

ユーザー参加者を作成する

ユーザーとエージェントの参加者を会話に追加して、候補を表示します。まず、ユーザー参加者を会話に追加します。

REST

ユーザー参加者を作成するには、Participant リソースの create メソッドを呼び出します。

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

PROJECT_ID: 実際の Cloud プロジェクトの ID
LOCATION_ID: ロケーション ID
CONVERSATION_ID: 会話 ID

HTTP メソッドと URL:

POST https://dialogflow.googleapis.com/v2/projects/PROJECT_ID/locations/LOCATION_ID/conversations/CONVERSATION_ID/participants

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

{
  "role": "END_USER",
}

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

curl（Linux、macOS、Cloud Shell）

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

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "x-goog-user-project: PROJECT_ID" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://dialogflow.googleapis.com/v2/projects/PROJECT_ID/locations/LOCATION_ID/conversations/CONVERSATION_ID/participants"

PowerShell（Windows）

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

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred"; "x-goog-user-project" = "PROJECT_ID" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://dialogflow.googleapis.com/v2/projects/PROJECT_ID/locations/LOCATION_ID/conversations/CONVERSATION_ID/participants" | Select-Object -Expand Content

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

{
  "name": "projects/PROJECT_ID/locations/LOCATION_ID/conversations/CONVERSATION_ID/participants/PARTICIPANT_ID",
  "role": "END_USER"
}

participants の後のパスセグメントには、新しいユーザー参加者 ID が含まれます。

Python

詳細については、Vertex AI Agent Builder Python API のリファレンスドキュメントをご覧ください。

def create_participant(project_id: str, conversation_id: str, role: str):
    from google.cloud import dialogflow_v2beta1 as dialogflow

    """Creates a participant in a given conversation.

    Args:
        project_id: The GCP project linked with the conversation profile.
        conversation_id: Id of the conversation.
        participant: participant to be created."""

    client = dialogflow.ParticipantsClient()
    conversation_path = dialogflow.ConversationsClient.conversation_path(
        project_id, conversation_id
    )
    if role in ROLES:
        response = client.create_participant(
            parent=conversation_path, participant={"role": role}, timeout=600
        )
        print("Participant Created.")
        print(f"Role: {response.role}")
        print(f"Name: {response.name}")

        return response

エージェント参加者を作成する

エージェント参加者を会話に追加します。

REST

エージェント参加者を作成するには、Participant リソースの create メソッドを呼び出します。

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

PROJECT_ID: 実際の Cloud プロジェクトの ID
LOCATION_ID: ロケーション ID
CONVERSATION_ID: 会話 ID

HTTP メソッドと URL:

POST https://dialogflow.googleapis.com/v2/projects/PROJECT_ID/locations/LOCATION_ID/conversations/CONVERSATION_ID/participants

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

{
  "role": "HUMAN_AGENT",
}

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

curl（Linux、macOS、Cloud Shell）

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

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "x-goog-user-project: PROJECT_ID" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://dialogflow.googleapis.com/v2/projects/PROJECT_ID/locations/LOCATION_ID/conversations/CONVERSATION_ID/participants"

PowerShell（Windows）

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

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred"; "x-goog-user-project" = "PROJECT_ID" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://dialogflow.googleapis.com/v2/projects/PROJECT_ID/locations/LOCATION_ID/conversations/CONVERSATION_ID/participants" | Select-Object -Expand Content

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

{
  "name": "projects/PROJECT_ID/locations/LOCATION_ID/conversations/CONVERSATION_ID/participants/PARTICIPANT_ID",
  "role": "HUMAN_AGENT"
}

participants の後のパスセグメントには、新しい人間のエージェントの参加者 ID が含まれます。

Python

詳細については、Vertex AI Agent Builder Python API のリファレンスドキュメントをご覧ください。

def create_participant(project_id: str, conversation_id: str, role: str):
    from google.cloud import dialogflow_v2beta1 as dialogflow

    """Creates a participant in a given conversation.

    Args:
        project_id: The GCP project linked with the conversation profile.
        conversation_id: Id of the conversation.
        participant: participant to be created."""

    client = dialogflow.ParticipantsClient()
    conversation_path = dialogflow.ConversationsClient.conversation_path(
        project_id, conversation_id
    )
    if role in ROLES:
        response = client.create_participant(
            parent=conversation_path, participant={"role": role}, timeout=600
        )
        print("Participant Created.")
        print(f"Role: {response.role}")
        print(f"Name: {response.name}")

        return response

エージェントからのメッセージを追加して分析する

いずれかの参加者が会話でメッセージを入力するたびに、API にメッセージを送信して処理する必要があります。データストアエージェントは、人間のエージェントとユーザーメッセージの分析に基づいて提案を行います。以下の例では、人間のエージェントが「ご用件はなんでしょうか？」という質問をして会話を開始します。

レスポンスでは候補がまだ返されていません。

REST

会話に人間のエージェントのメッセージを追加して分析するには、Participant リソースの analyzeContent メソッドを呼び出します。

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

PROJECT_ID: プロジェクト ID
CONVERSATION_ID: 会話 ID
PARTICIPANT_ID: 人間のエージェントの参加者 ID

HTTP メソッドと URL:

POST https://dialogflow.googleapis.com/v2/projects/PROJECT_ID/conversations/CONVERSATION_ID/participants/PARTICIPANT_ID:analyzeContent

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

{
  "textInput": {
    "text": "How may I help you?",
    "languageCode": "en-US"
  }
}

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

curl（Linux、macOS、Cloud Shell）

リクエスト本文を 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://dialogflow.googleapis.com/v2/projects/PROJECT_ID/conversations/CONVERSATION_ID/participants/PARTICIPANT_ID:analyzeContent"

PowerShell（Windows）

リクエスト本文を 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://dialogflow.googleapis.com/v2/projects/PROJECT_ID/conversations/CONVERSATION_ID/participants/PARTICIPANT_ID:analyzeContent" | Select-Object -Expand Content

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

{
  "message": {
    "name": "projects/PROJECT_ID/conversations/CONVERSATION_ID/messages/MESSAGE_ID",
    "content": "How may I help you?",
    "languageCode": "en-US",
    "participant": "PARTICIPANT_ID",
    "participantRole": "HUMAN_AGENT",
    "createTime": "2020-02-13T00:01:30.683Z"
  }
}

Python

詳細については、Vertex AI Agent Builder Python API のリファレンスドキュメントをご覧ください。

def analyze_content_text(
    project_id: str, conversation_id: str, participant_id: str, text: str
):
    from google.cloud import dialogflow_v2beta1 as dialogflow

    """Analyze text message content from a participant.

    Args:
        project_id: The GCP project linked with the conversation profile.
        conversation_id: Id of the conversation.
        participant_id: Id of the participant.
        text: the text message that participant typed."""

    client = dialogflow.ParticipantsClient()
    participant_path = client.participant_path(
        project_id, conversation_id, participant_id
    )
    text_input = {"text": text, "language_code": "en-US"}
    response = client.analyze_content(
        participant=participant_path, text_input=text_input
    )
    print("AnalyzeContent Response:")
    print(f"Reply Text: {response.reply_text}")

    for suggestion_result in response.human_agent_suggestion_results:
        if suggestion_result.error is not None:
            print(f"Error: {suggestion_result.error.message}")
        if suggestion_result.suggest_articles_response:
            for answer in suggestion_result.suggest_articles_response.article_answers:
                print(f"Article Suggestion Answer: {answer.title}")
                print(f"Answer Record: {answer.answer_record}")
        if suggestion_result.suggest_faq_answers_response:
            for answer in suggestion_result.suggest_faq_answers_response.faq_answers:
                print(f"Faq Answer: {answer.answer}")
                print(f"Answer Record: {answer.answer_record}")
        if suggestion_result.suggest_smart_replies_response:
            for (
                answer
            ) in suggestion_result.suggest_smart_replies_response.smart_reply_answers:
                print(f"Smart Reply: {answer.reply}")
                print(f"Answer Record: {answer.answer_record}")

    for suggestion_result in response.end_user_suggestion_results:
        if suggestion_result.error:
            print(f"Error: {suggestion_result.error.message}")
        if suggestion_result.suggest_articles_response:
            for answer in suggestion_result.suggest_articles_response.article_answers:
                print(f"Article Suggestion Answer: {answer.title}")
                print(f"Answer Record: {answer.answer_record}")
        if suggestion_result.suggest_faq_answers_response:
            for answer in suggestion_result.suggest_faq_answers_response.faq_answers:
                print(f"Faq Answer: {answer.answer}")
                print(f"Answer Record: {answer.answer_record}")
        if suggestion_result.suggest_smart_replies_response:
            for (
                answer
            ) in suggestion_result.suggest_smart_replies_response.smart_reply_answers:
                print(f"Smart Reply: {answer.reply}")
                print(f"Answer Record: {answer.answer_record}")

    return response

ユーザーからのメッセージを追加して提案を取得する

エージェントに対して、お客様は「返品払い戻しはいつ受けられますか？」と尋ねます。今回は、API レスポンスに、推奨されるクエリと、ナレッジドキュメントに基づく生成 AI の回答が含まれています。

REST

会話のユーザーメッセージを追加して分析するには、Participant リソースの analyzeContent メソッドを呼び出します。

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

PROJECT_ID: プロジェクト ID
CONVERSATION_ID: 会話 ID
PARTICIPANT_ID: エンドユーザーの参加者 ID

HTTP メソッドと URL:

POST https://dialogflow.googleapis.com/v2/projects/PROJECT_ID/conversations/CONVERSATION_ID/participants/PARTICIPANT_ID:analyzeContent

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

{
  "textInput": {
    "text": "When can I get my return refund?",
    "languageCode": "en-US"
  }
}

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

curl（Linux、macOS、Cloud Shell）

リクエスト本文を 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://dialogflow.googleapis.com/v2/projects/PROJECT_ID/conversations/CONVERSATION_ID/participants/PARTICIPANT_ID:analyzeContent"

PowerShell（Windows）

リクエスト本文を 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://dialogflow.googleapis.com/v2/projects/PROJECT_ID/conversations/CONVERSATION_ID/participants/PARTICIPANT_ID:analyzeContent" | Select-Object -Expand Content

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

{
  "message": {
    "name": "projects/PROJECT_ID/conversations/CONVERSATION_ID/messages/MESSAGE_ID",
    "content": "When can I get my return refund?",
    "languageCode": "en-US",
    "participant": "PARTICIPANT_ID",
    "participantRole": "END_USER",
    "createTime": "2020-02-13T00:07:35.925Z"
  },
  "humanAgentSuggestionResults": [
    {
      "suggestKnowledgeAssistResponse": {
        "knowledgeAssistAnswer": {
          "suggestedQuery": {
            "queryText": "Refund processing time"
          },
          "suggestedQueryAnswer": {
            "answerText": "After your return is processed, you receive your refund in 7 days. The refund amount should be for the full value of the items returned, but doesn't include shipping & service fees.",
            "generativeSource": {
              "snippets": [
                {
                  "title": "Returns & refunds - Help",
                  "uri": "https://example.com/",
                  "text": "When the package with your return arrives at the seller's return center, it may take up to 7 additional business days to process. Check the status of your refund with the return tracking number found on your orders page."
                }
              ]
            },
          },
          "answerRecord": "projects/PROJECT_ID/answerRecords/ANSWER_RECORD_ID"
        },
      }
    }
  ]
}

Python

詳細については、Vertex AI Agent Builder Python API のリファレンスドキュメントをご覧ください。

def analyze_content_text(
    project_id: str, conversation_id: str, participant_id: str, text: str
):
    from google.cloud import dialogflow_v2beta1 as dialogflow

    """Analyze text message content from a participant.

    Args:
        project_id: The GCP project linked with the conversation profile.
        conversation_id: Id of the conversation.
        participant_id: Id of the participant.
        text: the text message that participant typed."""

    client = dialogflow.ParticipantsClient()
    participant_path = client.participant_path(
        project_id, conversation_id, participant_id
    )
    text_input = {"text": text, "language_code": "en-US"}
    response = client.analyze_content(
        participant=participant_path, text_input=text_input
    )
    print("AnalyzeContent Response:")
    print(f"Reply Text: {response.reply_text}")

    for suggestion_result in response.human_agent_suggestion_results:
        if suggestion_result.error is not None:
            print(f"Error: {suggestion_result.error.message}")
        if suggestion_result.suggest_articles_response:
            for answer in suggestion_result.suggest_articles_response.article_answers:
                print(f"Article Suggestion Answer: {answer.title}")
                print(f"Answer Record: {answer.answer_record}")
        if suggestion_result.suggest_faq_answers_response:
            for answer in suggestion_result.suggest_faq_answers_response.faq_answers:
                print(f"Faq Answer: {answer.answer}")
                print(f"Answer Record: {answer.answer_record}")
        if suggestion_result.suggest_smart_replies_response:
            for (
                answer
            ) in suggestion_result.suggest_smart_replies_response.smart_reply_answers:
                print(f"Smart Reply: {answer.reply}")
                print(f"Answer Record: {answer.answer_record}")

    for suggestion_result in response.end_user_suggestion_results:
        if suggestion_result.error:
            print(f"Error: {suggestion_result.error.message}")
        if suggestion_result.suggest_articles_response:
            for answer in suggestion_result.suggest_articles_response.article_answers:
                print(f"Article Suggestion Answer: {answer.title}")
                print(f"Answer Record: {answer.answer_record}")
        if suggestion_result.suggest_faq_answers_response:
            for answer in suggestion_result.suggest_faq_answers_response.faq_answers:
                print(f"Faq Answer: {answer.answer}")
                print(f"Answer Record: {answer.answer_record}")
        if suggestion_result.suggest_smart_replies_response:
            for (
                answer
            ) in suggestion_result.suggest_smart_replies_response.smart_reply_answers:
                print(f"Smart Reply: {answer.reply}")
                print(f"Answer Record: {answer.answer_record}")

    return response

会話を完了する

会話が終わったら、API を使用して会話を完了します。

REST

会話を完了するには、conversations リソースの complete メソッドを呼び出します。

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

PROJECT_ID: GCP プロジェクト ID
CONVERSATION_ID: 会話の作成時に受け取った ID

HTTP メソッドと URL:

POST https://dialogflow.googleapis.com/v2/projects/PROJECT_ID/conversations/CONVERSATION_ID:complete

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

curl（Linux、macOS、Cloud Shell）

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

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "x-goog-user-project: PROJECT_ID" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d "" \
     "https://dialogflow.googleapis.com/v2/projects/PROJECT_ID/conversations/CONVERSATION_ID:complete"

PowerShell（Windows）

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

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred"; "x-goog-user-project" = "PROJECT_ID" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -Uri "https://dialogflow.googleapis.com/v2/projects/PROJECT_ID/conversations/CONVERSATION_ID:complete" | Select-Object -Expand Content

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

{
  "name": "projects/PROJECT_ID/conversations/CONVERSATION_ID",
  "lifecycleState": "COMPLETED",
  "conversationProfile": "projects/PROJECT_ID/conversationProfiles/CONVERSATION_PROFILE_ID",
  "startTime": "2018-11-05T21:05:45.622Z",
  "endTime": "2018-11-06T03:50:26.930Z"
}

Python

詳細については、Vertex AI Agent Builder Python API のリファレンスドキュメントをご覧ください。

def complete_conversation(project_id, conversation_id):
    """Completes the specified conversation. Finished conversations are purged from the database after 30 days.

    Args:
        project_id: The GCP project linked with the conversation.
        conversation_id: Id of the conversation."""

    client = dialogflow.ConversationsClient()
    conversation_path = client.conversation_path(project_id, conversation_id)
    conversation = client.complete_conversation(name=conversation_path)
    print("Completed Conversation.")
    print("Life Cycle State: {}".format(conversation.lifecycle_state))
    print("Conversation Profile Name: {}".format(conversation.conversation_profile))
    print("Name: {}".format(conversation.name))
    return conversation

シミュレータ

データストアエージェントは Agent Assist シミュレータでテストできます。

上記の例では、データストアエージェントから次のような候補が提示されます。

推奨されるクエリ: Refund processing time（払い戻しの処理時間）。
Gen AI 生成回答: 返品処理が完了すると、7 日以内に払い戻しが行われます。払い戻し額は、返品された商品の全額を対象としますが、送料と手数料は含まれません。
関連するナレッジドキュメントのタイトル: 返品と払い戻し - ヘルプ。

ステップ 3: Pub/Sub 候補の通知

候補の通知を受け取るには、会話プロファイルの作成時に notificationConfig フィールドを設定します。このオプションでは、Pub/Sub を使用し、会話が進行して新しい候補が利用可能になったときに、候補の通知をアプリケーションに送信します。

AnalyzeContent API を介して統合する場合は、ConversationProfile で disable_high_latency_features_sync_delivery 構成を有効にして、プロアクティブな生成知識アシストの候補を待たずに AnalyzeContent API が応答し、Pub/Sub を介して候補を配信するようにできます。

この構成は、Agent Assist コンソールから有効にすることもできます。

会話型分析情報からデータにアクセスする

また、プロアクティブ生成ナレッジアシスタントによって生成された質問と回答は、会話型分析情報に自動的に入力されます。このデータにアクセスするには、Dialogflow ランタイムの統合を有効にするの手順に沿って操作します。

フィードバックを送信

フィードバックを送信する手順については、Agent Assist にフィードバックを送信するをご覧ください。

エージェントの質問に回答する

エージェントからの質問への回答に関するフィードバックを送信する JSON リクエストの例を次に示します。

{
  "name": "projects/PROJECT_ID/locations/LOCATION_ID/answerRecords/ANSWER_RECORD_ID",
  "answerFeedback": {
    "displayed": true
    "clicked": true
    "correctnessLevel": "FULLY_CORRECT"
    "agentAssistantDetailFeedback": {
      "knowledgeSearchFeedback": {
        "answerCopied": true
        "clickedUris": [
          "url_1",
          "url_2",
          "url_3",
        ]
      }
    }
  }
}

Q&A をプロアクティブに提案する

以下は、プロアクティブな候補に関するフィードバックを送信する JSON リクエストの例です。

{
  "name": "projects/PROJECT_ID/locations/LOCATION_ID/answerRecords/ANSWER_RECORD_ID",
  "answerFeedback": {
    "displayed": true
    "clicked": true
    "correctnessLevel": "FULLY_CORRECT"
    "agentAssistantDetailFeedback": {
      "knowledgeAssistFeedback": {
        "answerCopied": true
        "clickedUris": [
          "url_1",
          "url_2",
          "url_3",
        ]
      }
    }
  }
}

メタデータ

ナレッジドキュメントにmetadataを構成すると、生成ナレッジアシストとプロアクティブ生成ナレッジアシストの両方で、レスポンスとともにドキュメントのメタデータが返されます。

たとえば、メタデータを使用して、ナレッジドキュメントが内部限定公開の記事か外部公開の記事かをマークできます。エージェントアシスタントシミュレーターとUI モジュールの両方で、生成知識アシスタントとプロアクティブ生成知識アシスタントの両方が、特定のキーのドキュメントメタデータ値を自動的に表示します。

gka_source_label: 値が候補カードに直接表示されます。
gka_source_tooltip: 値が struct タイプの場合、ソースリンクにカーソルを合わせると、値がツールチップに表示されます。

ナレッジドキュメントに次のメタデータがある場合、候補カードにはソースが External Doc として表示され、ツールチップには doc_visibility: public doc が追加されます。

メタデータ: None { "title": "Public Sample Doc", "gka_source_label": "External Doc", "gka_source_tooltip": { "doc_visibility": "public doc" } }

言語サポート

サポートされている言語の全リストをご覧ください。

生成ナレッジ アシスト

データストア エージェントを作成する

人間のエージェントからの質問に回答する

ステップ 1: 会話プロファイルを作成する

コンソールから作成する

API から作成

ステップ 2: データストア エージェントを使用する

シミュレータ

エージェント向けの Q＆A を事前に提案する

ステップ 1: 会話プロファイルを作成する

コンソールから作成する

API から作成

ステップ 2: ランタイムに会話を処理する

会話を作成する

REST

curl（Linux、macOS、Cloud Shell）

PowerShell（Windows）

Python

ユーザー参加者を作成する

REST

curl（Linux、macOS、Cloud Shell）

PowerShell（Windows）

Python

エージェント参加者を作成する

REST

curl（Linux、macOS、Cloud Shell）

PowerShell（Windows）

Python

エージェントからのメッセージを追加して分析する

REST

curl（Linux、macOS、Cloud Shell）

PowerShell（Windows）

Python

ユーザーからのメッセージを追加して提案を取得する

REST

curl（Linux、macOS、Cloud Shell）

PowerShell（Windows）

Python

会話を完了する

REST

curl（Linux、macOS、Cloud Shell）

PowerShell（Windows）

Python

シミュレータ

ステップ 3: Pub/Sub 候補の通知

会話型分析情報からデータにアクセスする

フィードバックを送信

エージェントの質問に回答する

Q&A をプロアクティブに提案する

メタデータ

言語サポート

生成ナレッジアシスト

データストアエージェントを作成する

ステップ 2: データストアエージェントを使用する