会話の概要を取得

会話の軽量なサマリーを取得します。タイトル、生成された文字起こしのサマリー、通話が成功したかどうか、および会話が短い場合に限りプレーンなチャットメッセージが含まれます。レスポンスを小さく保つため、ツール呼び出し、ツール結果、コンテキスト更新は省略されます。要点だけが必要な場合(例:エージェントが多数の会話を読む場合)は、完全な会話エンドポイントの代わりにこちらを使用してください。ツール呼び出しとコンテキスト更新を含む完全な文字起こしが必要な場合は、GET /v1/convai/conversations/{conversation_id}を使用してください。

パスパラメータ

conversation_idstring必須

操作対象の会話のID。

ヘッダー

xi-api-keystringオプション

クエリパラメータ

max_messagesintegerオプション1-200デフォルト値 40

インラインに含めるチャットメッセージターンの最大数。会話がこの数を超える場合、メッセージは省略され、messages_omittedが設定されます。

レスポンス

成功レスポンス。

conversation_idstring
agent_idstring
statusenum
許可された値:
message_countinteger

会話内の通常のチャットメッセージのターン数です。

notestring

完全な文字起こしを取得する方法をエージェントに指示するガイダンスです。

call_summary_titlestring or nullオプション

会話用に生成された短いタイトルです。

transcript_summarystring or nullオプション

生成された通話の自然言語サマリー。

call_successfulenum or nullオプション
許可された値:
messageslist of objects or nullオプション

プレーンチャットメッセージ(ロールとテキストのみ)。message_countがリクエストされたmax_messagesを超えない場合にのみ含まれます。それ以外の場合はnullとなり、messages_omittedはtrueです。

messages_omittedbooleanオプションデフォルト値 false

会話が長すぎるためにチャットメッセージが省略された場合はtrueです。メッセージについては完全な文字起こしを取得してください。

エラー

422
Unprocessable Entity Error