IBM Cloud Docs
API メソッドのサマリー

API メソッドのサマリー

次の表は watsonx Assistant利用できるメソッドをまとめたものです。

ランタイム・メソッド

メソッド 説明 バージョン 参照資料
セッションの作成 新規セッションを作成してください。 セッションは、ユーザー入力をスキルに送信し、応答を受信するために使用されます。 会話の状態も維持します。 v2 cURL ノード Java python
セッションの削除 タイムアウトになる前に明示的にセッションを削除します。 v2 cURL ノード Java python
アシスタントへのユーザー入力の送信 (ステートフル) ユーザー入力をアシスタントに送信し、応答を受信します。会話の状態(コンテキストデータを含む)は、セッション中に watsonx Assistant によって保存されます。 v2 cURL ノード Java python
アシスタントへのユーザー入力の送信 (ステートレス) ユーザー入力をアシスタントに送信し、応答を受信します。アプリケーションによって管理される会話状態 (コンテキスト・データを含む) も伴います。 v2 cURL ノード Java python

オーサリング・メソッド

メソッド 説明 バージョン 参照資料
ワークスペースのリスト化 watsonx Assistantに関連付けられているワークスペースをリストアップします。 v1 cURL ノード Java python
ワークスペースの作成 コンポーネント・オブジェクトに基づいてワークスペースを作成します。 新しいワークスペースの内容を定義するワークスペースコンポーネントを提供する必要があります。 v1 cURL ノード Java python
ワークスペースに関する情報の取得 ワークスペースに関する情報を取得します。オプションで、すべてのワークスペースのコンテンツを含めます。 v1 cURL ノード Java python
ワークスペースの更新 新規または変更されたデータで既存のワークスペースを更新します。 更新されたワークスペースの内容を定義するコンポーネントオブジェクトを提供する必要があります。 v1 cURL ノード Java python
ワークスペースの削除 サービス・インスタンスからワークスペースを削除します。 v1 cURL ノード Java python
インテントのリスト ワークスペースのインテントをリストします。 v1 cURL ノード Java python
インテントの作成 新規インテントを作成します。 v1 cURL ノード Java python
インテントの取得 インテントに関する情報を取得します。オプションで、すべてのインテント・コンテンツを含めます。 v1 cURL ノード Java python
インテントの更新 新規または変更されたデータで既存のインテントを更新します。 更新された意図の内容を定義するコンポーネントオブジェクトを提供する必要があります。 v1 cURL ノード Java python
インテントの削除 ワークスペースからインテントを削除します。 v1 cURL ノード Java python
ユーザー入力の例のリスト インテントに対するユーザー入力の例をリストします。オプションで、コンテキスト・エンティティーの言及を含めます。 v1 cURL ノード Java python
ユーザー入力例の作成 インテントに新しいユーザー入力例を追加します。 v1 cURL ノード Java python
ユーザー入力例の取得 ユーザー入力の例に関する情報を取得します。 v1 cURL ノード Java python
ユーザー入力例の更新 ユーザー入力例に関するテキストを更新します。 v1 cURL ノード Java python
ユーザー入力例の削除 インテントからユーザー入力例を削除します。 v1 cURL ノード Java python
反例のリスト ワークスペースの反例をリストします。 反例とは、無関係な入力としてマークされた例です。 v1 cURL ノード Java python
反例の作成 新規の反例をワークスペースに追加します。 反例とは、無関係な入力としてマークされた例です。 v1 cURL ノード Java python
反例の取得 反例に関する情報を取得します。 反例とは、無関係な入力としてマークされた例です。 v1 cURL ノード Java python
反例の更新 反例のテキストを更新します。 反例とは、無関係な入力としてマークされた例です。 v1 cURL ノード Java python
反例の削除 ワークスペースから反例を削除します。 反例とは、無関係な入力としてマークされた例です。 v1 cURL ノード Java python
エンティティーのリスト ワークスペースのエンティティーをリストします。 v1 cURL ノード Java python
エンティティーの作成 新規エンティティーを作成するか、システム・エンティティーを有効にします。 v1 cURL ノード Java python
エンティティーの取得 エンティティーに関する情報を取得します。オプションで、すべてのエンティティー・コンテンツを含めます。 v1 cURL ノード Java python
エンティティーの更新 新規または変更されたデータで既存のエンティティーを更新します。 更新されたエンティティの内容を定義するコンポーネントオブジェクトを提供する必要があります。 v1 cURL ノード Java python
エンティティーの削除 ワークスペースからエンティティーを削除するか、システム・エンティティーを無効にします。 v1 cURL ノード Java python
エンティティーに関する言及のリスト コンテキスト・エンティティーに関する言及をリストします。 エンティティーの言及とは、インテントのユーザー入力例のコンテキストにおけるコンテキスト・エンティティーの出現のことです。 v1 cURL ノード Java python
エンティティー値のリスト エンティティーの値をリストします。 v1 cURL ノード Java python
エンティティー値の追加 エンティティーの新規値を作成します。 v1 cURL ノード Java python
エンティティー値の取得 エンティティー値に関する情報を取得します。 v1 cURL ノード Java python
エンティティー値の更新 新規または変更されたデータで既存のエンティティー値を更新します。 更新されたエンティティ値の内容を定義するコンポーネントオブジェクトを提供する必要があります。 v1 cURL ノード Java python
エンティティー値の削除 エンティティーから値を削除します。 v1 cURL ノード Java python
エンティティー値の同義語のリスト エンティティー値の同義語をリストします。 v1 cURL ノード Java python
エンティティー値の同義語の追加 新規の同義語をエンティティー値に追加します。 v1 cURL ノード Java python
エンティティー値の同義語の取得 エンティティー値の同義語に関する情報を取得します。 v1 cURL ノード Java python
エンティティー値の同義語の更新 新規テキストで既存のエンティティー値の同義語を更新します。 v1 cURL ノード Java python
エンティティー値の同義語の削除 エンティティー値から同義語を削除します。 v1 cURL ノード Java python
ダイアログ・ノードのリスト ワークスペースのダイアログ・ノードをリストします。 v1 cURL ノード Java python
ダイアログ・ノードの作成 新規ダイアログ・ノードを作成します。 v1 cURL ノード Java python
ダイアログ・ノードの取得 ダイアログ・ノードに関する情報を取得します。 v1 cURL ノード Java python
ダイアログ・ノードの更新 新規または変更されたデータで既存のダイアログ・ノードを更新します。 v1 cURL ノード Java python
ダイアログ・ノードの削除 ワークスペースからダイアログ・ノードを削除します。 v1 cURL ノード Java python
ワークスペースのログ・イベントのリスト 特定のワークスペースのログのイベントをリストします。 v1 cURL ノード Java python
すべてのワークスペースのログ・イベントのリスト サービス・インスタンスのすべてのワークスペースのログのイベントをリストします。 v1 cURL ノード Java python
ラベル付きデータの削除 指定した顧客IDに関連付けられているすべてのデータを削除します。 顧客 ID に関連付けられたデータがない場合は、このメソッドを実行しても何の効果もありません。 v1 cURL ノード Java python