IBM watsonx.ai API を使用すると、watsonx.ai の基盤モデルをプログラムで操作できます。
API リファレンス ドキュメントを参照してください。
また、REST APIを使用して以下のタスクを実行することもできます:
- foundation model情報の取得
- 推論基盤モデル
- チャットAPIでアプリケーションにジェネレーティブチャットを追加する
- エージェント主導型チャットワークフローの構築
- 文書からテキストを抽出する
- foundation modelの迅速なチューニング
- テキストをベクトル化する
- 文書パッセージの再ランク付け
- 将来の価値を予測する
前提条件
開発者アクセスページにアクセスすると、以下の情報に素早くアクセスできます:
- APIエンドポイントのベース URLと
- プロジェクトまたはスペース ID
watsonx.ai から、作業を行いたいプロジェクトまたはスペースのホームページを開き、 ナビゲーションメニュー を開き、次に 「Developer access(開発者アクセス)」 をクリックします。
また、REST APIリクエストを送信するには、以下の情報が必要です:
watsonx.ai APIを使用するには、ベアラートークンが必要です。
詳細については、プログラム・アクセスのための認証情報を参照してください。
使用したいfoundation modelの「
{model_id}
指定する必要があります。利用可能な基盤モデルを一覧表示するメソッドを使用して、foundation modelの ID を取得できます。
watsonx.ai に含まれる基盤モデルのモデル ID のリストについては、API 用の基盤モデル ID を参照してください。
各リクエストで要求されるバージョンパラメータには、コードを作成しテストした日付を指定してください。 例えば、
version=2024-10-21
などです。
タスクによっては、データ接続として利用可能なデータを参照する必要があります。 ファイルを追加し、APIからファイルを参照する方法の詳細については、APIからファイルを参照するを参照してください。
APIで推論リクエストのフォーマットについてサポートが必要な場合は、同じリクエストを Prompt Lab から送信することができます。 Prompt Lab のコードパネルには、プロンプトで生成された cURL リクエストが表示されます。このパネルで、使用されている構文を確認できます。
親トピック 生成的AIソリューションのコーディング