Voiceflow APIの種別

VoiceflowのAPI開発の基本となります。随時、進化して変わっていく可能性は有ると思います。

Voiceflow の5種類のAPI

1. Dialog manager API
2. Knowledge base API
3. Transcripts API
4. Analytics API
5. Project API

1. Dialog manager API(DM API)

Dialog Manager API (DM API)は、対話エンドポイントへのHTTPコールを使用して、任意のアプリケーションがVoiceflowダイアグラムと対話できるようにします。

2. Knowledge base API

ナレッジベースAPIは、Voiceflowナレッジベース内のドキュメント、テーブル、タグを管理するためのツール群を提供します。これらのAPIにより、ユーザはデータのアップロード、検索、クエリ、および管理を効率的に行うことができ、ナレッジベースの整理、検索、および応答性を維持することができます。

1. Query API
2. Document API
3. Tags API

Authentication

Knowledge Base APIへのリクエストは全てDialog Manager API Keyを使用して認証されなければなりません。APIキーはVoiceflowプロジェクト設定のインテグレーションタブから取得できます。

3. Transcripts API

ユーザーが話した音声をテキスト化（文字起こし）したデータ(トランスクリプト)のAPI

LANGUAGE

4. Analytics API

(会話)Queryアシスタントの使用状況データ取得。アシスタントがどのように使用されているかなど分析し、アシスタントのパフォーマンスと有効性を評価し、改善すべき領域を特定し、その開発と展開についてデータ駆動型の意思決定を行うために役立ちます。

1. 会話の開始数
2. 送信されたメッセージ数
3. ユニークユーザー数

など。

LANGUAGE

5. Project API

Voiceflowプロジェクトファイル ( .vfファイル ) の取得

.vfファイル	ダイアグラム内のブロックやステップの詳細を含む、プロジェクトの全情報
.vfrファイル	programsプロパティにプロジェクトの簡潔なバージョンが含まれています。プログラム解析やサードパーティ製ツールとの統合には、このファイルを使用することをお勧めします。 .vfrファイルのprogramsプロパティを確実に使用するには、プロジェクトの更新後にキャンバスから 「Publish 」または 「Run 」ボタンを選択し、ファイルに反映させることをお勧めします。

LANGUAGE