このドキュメントでは、チャットの文字起こしのメタデータを構造化するために使用される JSON スキーマについて説明します。このスキーマは、チャットの会話を正確に表現して処理するために必要です。
チャットの文字起こしメタデータ スキーマ
このスキーマでは、チャットの文字起こしのデータ構造について説明します。コア コンポーネントについては、以降のセクションで説明します。
文字起こしのコア情報
次のプロパティは、文字起こし自体の基本的な情報を提供します。
comm_type(文字列)。この文字起こしが属するコミュニケーションのタイプ。 ブレンド SMS 機能を使用する通話の場合は、チャットまたは通話になります。comm_id(整数)。コミュニケーションの識別子。たとえば、この文字起こしに関連するチャットや通話などです。transcript_version(文字列)。文字起こし形式のバージョン。文字起こしを解析する際の下位互換性が必要です。assigned_at(文字列、日付 / 時刻)。チャットが割り当てられたときのタイムスタンプ。timezone(文字列)。チャットが行われたタイムゾーン。
メッセージの定義
definitions セクションには、文字起こし内のさまざまなメッセージ タイプの構造を定義する再利用可能なスキーマ コンポーネントが含まれています。これにより、さまざまなコンテンツ形式を柔軟に処理できます。
text(オブジェクト): テキスト メッセージを表します。type(文字列): 「text」にする必要があります。content(文字列): メッセージの実際のテキスト コンテンツ。lang(文字列): テキスト コンテンツの言語。
text_template(オブジェクト): テンプレート化されたテキスト メッセージを表します。type(文字列):text_templateにする必要があります。content(文字列): テキスト テンプレートのコンテンツ。プレースホルダが含まれる場合があります。
markdown(オブジェクト): Markdown 形式を使用したメッセージを表します。type(文字列):Markdownにする必要があります。content(文字列): Markdown テンプレートのコンテンツ。
markdown_template(オブジェクト): テンプレート化された Markdown メッセージを表します。type(文字列):markdown_templateにする必要があります。content(文字列): Markdown テンプレートのコンテンツ。プレースホルダが含まれる場合があります。
photo(オブジェクト): 写真を含むメッセージを表します。type(文字列):photoにする必要があります。media_id(整数): 写真のメディア ファイルの ID。
video(オブジェクト): 動画を含むメッセージを表します。title(文字列): 動画のタイトル。video(オブジェクト): 動画の詳細。url(文字列): 動画の URL。text(文字列): 動画 URL の代替テキスト。
media_id(整数): 動画 URL が直接指定されていない場合に取得するメディア ID。
image(オブジェクト): 画像を含むメッセージを表します。title(文字列): 画像のタイトル。image(オブジェクト): 画像の詳細。url(文字列): 画像の URL。text(文字列): 画像 URL の代替テキスト。
document(オブジェクト): ドキュメントを含むメッセージを表します。title(文字列): ドキュメントのタイトル。document(オブジェクト): ドキュメントの詳細。url(文字列): ドキュメントの URL。text(文字列): ドキュメント URL の代替テキスト。
inline_button(オブジェクト): インライン ボタンのセットを表します。title(文字列): インライン ボタンのセットのタイトル。buttons(配列): ボタン オブジェクトの配列。title(文字列): ボタンのタイトル。action(文字列): ボタンで示されるアクションの名前。link(文字列): クイック返信リンク アクションの URL リンク。
sticky_button(オブジェクト): 固定ボタンのセットを表します。title(文字列): 固定ボタンのセットのタイトル。buttons(配列): ボタン オブジェクトの配列。title(文字列): ボタンのタイトル。action(文字列): ボタンで示されるアクションの名前。link(文字列): クイック返信リンク アクションの URL リンク。
content_card(オブジェクト): コンテンツ カードを表します。cards(配列): コンテンツ カード オブジェクトの配列。title(文字列): コンテンツ カードのタイトル。body(文字列): コンテンツ カードの本文。
server_message(オブジェクト): サーバーから取得したメッセージを表します。message_id(整数): 保存されているサーバー メッセージの ID。content(文字列): サーバーから取得したメッセージのコンテンツ。
action(オブジェクト): チャット中に行われたアクションを表します。次のいずれかになります。action_escalation(オブジェクト): エスカレーション アクションを表します。action(文字列): 「escalation」にする必要があります。escalation_reason(文字列): エスカレーションの理由。menu_id(整数): コミュニケーションをエスカレーションする ID。language(文字列): エスカレーション先のキューの ISO 689 言語コード。
action_deflection(オブジェクト): 転換アクションを表します。action(文字列):deflectionにする必要があります。deflection_type(文字列): 転換のタイプ。sip_parameters(オブジェクトまたは null): 転換の一部として転送する SIP パラメータ(存在する場合)。
action_end(オブジェクト): 終了アクションを表します。action(文字列):endにする必要があります。
noti(オブジェクト): 通知メッセージを表します。さまざまな通知タイプがあります。noti_transfer_started(オブジェクト): 転送開始の通知。type(文字列):notiにする必要があります。event(文字列): 「transferStarted」にする必要があります。target(文字列): 転送先の宛先(メニュー、エージェントなど)。agent(オブジェクト): 転送を開始したエージェント。id(整数): エージェントの ID。email(文字列): エージェントのメール。name(文字列): エージェントの名前。
noti_verification_requested(オブジェクト): 確認リクエストの通知。type(文字列):notiにする必要があります。event(文字列):verificationRequestedにする必要があります。agent(オブジェクト): 確認をリクエストしているエージェント。id(整数): 確認をリクエストしているエージェントの ID。email(文字列): 確認をリクエストしているエージェントのメール。name(文字列): 確認をリクエストしているエージェントの名前。
noti_end_user_verified(オブジェクト): エンドユーザーが確認されたときの通知。type(文字列):notiにする必要があります。event(文字列):endUserVerifiedにする必要があります。
その他の
noti_\*タイプでは、写真リクエスト、動画リクエスト、共同ブラウジング イベント、タスク バーチャル エージェント イベント、エージェントの参加、転送またはエスカレーションのステータス変更など、さまざまなイベントの通知を定義します。noti_custom(オブジェクト): カスタム通知を表します。type(文字列):notiにする必要があります。event(文字列):customにする必要があります。detail(オブジェクト): カスタム イベントの詳細。key(文字列): カスタム イベントの詳細を表すキー。data(オブジェクト): カスタム定義のイベント ペイロード。
文字起こしのエントリ
entries(配列): オブジェクトの配列。各オブジェクトは、チャットで送信された個々のメッセージを表します。timestamp(文字列): メッセージ送信時のタイムスタンプ。type(文字列): メッセージのタイプ。前に説明した定義のいずれかを参照します(text、photo、notiなど)。body(オブジェクト): メッセージのコンテンツ。メッセージのタイプで定義された構造に準拠しています。oneOfを使用して、さまざまな本文タイプに対応しています。role(文字列): メッセージを送信した参加者のロール。使用できる 値は、end_user、agent、manager、virtual_agent、external_agent、task_virtual_agent、systemです。user_data(オブジェクト): メッセージを送信したユーザーのデータ。エンドユーザーまたはシステム メッセージの場合は除きます。name(文字列): ユーザーの名前。id(整数): ユーザーの一意の ID。
avatar_url(文字列): ユーザーのアバターのストレージ URL。