IBM Cloud Docs
watsonx Assistant API の概要

watsonx Assistant API の概要

watsonx Assistant REST API および対応する SDK を使用して、サービスと対話するアプリケーションを開発することができます。

クライアント・アプリケーション

実行時にアシスタントと通信するバーチャルアシスタントやその他のクライアントアプリケーションを構築するには、 v2 APIを使用します。 実動で使用するためにデプロイできる顧客対面クライアント、アシスタントと別のサービスとの間の通信を仲介するアプリケーション、またはテスト・アプリケーションを開発できます。

v2 ランタイム API を使用してアシスタントと通信することにより、アプリケーションは以下の機能を利用できます。

  • 自動の状態管理。 v2 ランタイムAPIは、ユーザーとの各セッションを管理し、完全な会話のためにアシスタントが必要とするすべてのコンテキストデータを保存し、維持します。

  • アシスタントを簡単にデプロイできます。 カスタム・クライアントのサポートに加えて、Slack や Facebook Messenger などの一般的なメッセージング・チャネルにアシスタントを簡単にデプロイできます。

  • バージョン管理。 コンテンツのスナップショットを保存し、アシスタントをその特定のバージョンにリンクさせることができます。 その後、実動アシスタントに影響を与えることなく、開発バージョンの更新を続けることができます。

  • 検索機能。 v2 ランタイム API を使用して、検索統合から応答を受け取ることができます。 アシスタントが回答できない照会が送信されると、検索統合は、構成されたデータ・ソースから最良の回答を見つけることができます。

詳しくは、 watsonx Assistant v2 API リファレンスを参照してください。

watsonx Assistant v1 APIは、ダイアログで使用されるワークスペースにユーザー入力を直接送信する /message メソッドをサポートしています。 v1のランタイムAPIは、主に互換性のためにサポートされている。 v1 の /message メソッドを使用する場合は、独自の状態管理を実装する必要があります。また、バージョン管理などのアシスタントの機能は利用できません。

オーサリング・アプリケーション

v1 APIは、古典的な Watson Assistant ユーザーインターフェイスを使用してグラフィカルにスキルを構築する代わりに、アプリケーションがダイアログスキルを作成または変更できるようにするメソッドを提供します。 オーサリング・アプリケーションは、API を使用して、ダイアログ・スキルを構成するスキル、インテント、エンティティー、ダイアログ・ノードなどの成果物を作成および変更します。 詳細については、 v1 APIリファレンスを参照してください。

v1のオーサリング・メソッドは、スキルではなくワークスペースを作成し、変更する。 ワークスペースは、ダイアログ・スキル内のダイアログおよびトレーニング・データ (インテントやエンティティーなど) のコンテナーです。 APIを使用して新しいワークスペースを作成すると、クラシックな Watson Assistant ユーザー・インターフェースの新しいダイアログ・スキルとして表示されます。

使用可能な API メソッドのリストについては、API メソッドのサマリーを参照してください。