REST Resource: projects.locations.apps.conversations

リソース: Conversation

会話は、エンドユーザーと CES アプリの間のやり取りを表します。

JSON 表現 
{
  "name": string,
  "startTime": string,
  "endTime": string,
  "turns": [
    {
      object (Conversation.Turn)
    }
  ],
  "turnCount": integer,
  "channelType": enum (Conversation.ChannelType),
  "source": enum (Conversation.Source),
  "inputTypes": [
    enum (Conversation.InputType)
  ],
  "entryAgent": string,
  "deployment": string,
  "appVersion": string,
  "languageCode": string,
  "messages": [
    {
      object (Message)
    }
  ]
}
フィールド
name

string

ID。会話の一意の ID。形式: projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}
startTime

string (Timestamp format)

出力専用。会話が作成されたときのタイムスタンプ。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
endTime

string (Timestamp format)

出力専用。会話が完了したときのタイムスタンプ。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
turns[]

object (Conversation.Turn)

必須。会話のターン。
turnCount

integer

出力専用。会話のターンの数。
channelType
(deprecated)

enum (Conversation.ChannelType)

非推奨。代わりに inputTypes を使用してください。
source

enum (Conversation.Source)

出力専用。会話のソースを示します。
inputTypes[]

enum (Conversation.InputType)

出力専用。会話の入力タイプ。
entryAgent

string

出力専用。会話を最初に処理するエージェント。指定しない場合、会話はルート エージェントによって処理されます。形式: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
deployment

string

出力専用。会話の処理に使用されるアプリのデプロイ。形式: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
appVersion

string

出力専用。会話の処理に使用されるアプリのバージョン。形式: projects/{project}/locations/{location}/apps/{app}/versions/{version}
languageCode

string

出力専用。会話の言語コード。
messages[]
(deprecated)

object (Message)

非推奨です。代わりにターンを使用してください。

Conversation.Turn

会話の 1 つのターンに関するすべての情報。

JSON 表現 
{
  "messages": [
    {
      object (Message)
    }
  ],
  "rootSpan": {
    object (Span)
  },
  "userIntendedText": string
}
フィールド
messages[]

object (Message)

省略可。会話のターンのメッセージのリスト。ユーザー入力、エージェントのレスポンス、処理中の中間イベントなど。
rootSpan

object (Span)

省略可。アクション処理のルート スパン。
userIntendedText

string

省略可。シミュレートされた発信者（Polysynth）からの意図された正解テキスト。単語誤り率の指標が有効になっている場合にのみ入力されます。

Conversation.ChannelType

会話のチャネル タイプ。

列挙型
CHANNEL_TYPE_UNSPECIFIED チャネル タイプが指定されていません。
TEXT 会話には、エンドユーザーとエージェント間のテキスト メッセージのみが含まれます。
AUDIO 会話には、エンドユーザーとエージェント間の音声メッセージが含まれます。
MULTIMODAL 会話には、エンドユーザーとエージェント間のマルチモーダル メッセージ（画像など）が含まれます。

Conversation.Source

会話のソース。

列挙型
SOURCE_UNSPECIFIED ソースが指定されていません。
LIVE 会話はライブ エンドユーザーからのものです。
SIMULATOR 会話はシミュレータからのものです。
EVAL 会話は評価からのものです。
AGENT_TOOL 会話はエージェント ツールからのものです。エージェント ツールは、テストとデバッグを目的として保持される別のセッションでエージェントを実行します。

Conversation.InputType

入力メッセージのタイプ。

列挙型
INPUT_TYPE_UNSPECIFIED 入力タイプが指定されていません。
INPUT_TYPE_TEXT テキスト入力。
INPUT_TYPE_EVENT イベント入力。
INPUT_TYPE_AUDIO 音声入力。
INPUT_TYPE_IMAGE 画像入力。
INPUT_TYPE_BLOB blob 入力。
INPUT_TYPE_TOOL_RESPONSE クライアント関数ツールのレスポンス入力。
INPUT_TYPE_VARIABLES 変数の入力。

メソッド

batchDelete

 指定した会話を一括削除します。

delete

 指定した会話を削除します。

generateEvaluation

 会話からゴールデン評価を作成します。

get

 指定した会話の詳細を取得します。

list

 指定したアプリの会話を一覧表示します。