IBM Cloud Docs
組み込み UI コンポーネントのデプロイ

組み込み UI コンポーネントのデプロイ

ドキュメントの取得およびカスタム・プロジェクトでは、一連のユーザー・インターフェース・コンポーネントを使用できます。

開発者と協力して、 IBM が提供する事前作成 UI コンポーネントを使用してアプリケーションをデプロイします。

独自のアプリの作成について詳しくは、 API を使用したカスタム・アプリケーションの作成 を参照してください。

いくつかの組み込み UI コンポーネントが使用可能です。

検索結果

クエリに最も関連性の高い文章や表をランク付けした結果のセット。

Search results list
Search results list

無料で試す

ファセット

ユーザーが特定のカテゴリーおよびドメインで検索結果をフィルタリングするのに役立つファセットを使用して、結果を絞り込みます。

Facets
Facets

無料で試す

リッチ文書のプレビュー

文書のプレビューに結果を表示します。 このビューは、元の文書のテキスト内の結果パッセージを強調表示します。 また、文書内で検出されたエンリッチメントについての言及も表示されます。 リッチプレビューは、PDF、Microsoft PowerPoint,、Microsoft Wordファイルなど、SDUモデルが適用されているソースドキュメントで使用できます。

Rich document preview
Rich document view

無料で試す

プロジェクトのデプロイ

プロジェクトを展開するには、以下の手順に従ってください

  1. API を使用するには、プロジェクトのプロジェクト ID を知っている必要があります。 「統合とデプロイ」 > 「API 情報」 ページに移動します。

  2. 「 > UI コンポーネントの統合とデプロイ」 ページで、開発者が開始するために使用できるリソースへのリンクを見つけます。

GitHub サンプル・アプリの概要

GitHub, にあるリソースから、UI コンポーネントを組み込んだサンプル アプリを起動するスクリプトを実行できます。 実際、サンプル・アプリケーションは、製品自体がこれらの UI コンポーネントを使用するため、製品の 「改善とカスタマイズ (Improve and customize)」 ページによく似ています。

このスクリプトを機能させるには、いくつかの前提条件ソフトウェアが必要です。 スクリプトを開始すると、必要なソフトウェアがシステムにインストールされているかどうかが検査されます。 そうでない場合は、インストールする必要があるソフトウェアを知らせます。 まだインストールされていない場合は、以下のパッケージをインストールしてください

このスクリプトは、プロジェクト用に構成したデータと検索の設定を使用してサンプル・アプリケーションに適用するために、サービス・インスタンスとプロジェクトに関する情報を必要とします。 後で情報を要求されたときにスクリプトと共有できるように、以下の情報を収集する必要があります。

サービス資格情報

サンプル・アプリケーション・スクリプトは、以下の情報を使用して、API 要求を送信したりサービス・インスタンスで認証したりできるエンドポイントを構成します。

  • URL
  • API キー

この情報を取得するには、使用しているデプロイメントのタイプに該当するステップを実行します。

  • IBM CloudIBM Cloud リソース・リストから、 「AI/Machine Learning セクションを展開し、前に作成したサービス・インスタンスを見つけます。 インスタンスをクリックすると、その概要ページが開きます。 「認証情報」セクションから、 URL とAPIキーの値をコピーし、後でアクセスできるように、ローカルのテキストファイルなど、どこかに保存します。

  • IBM Cloud Pak for DataIBM Software Hub ウェブクライアントのメインメニューで 、「サービス」 を展開し 、「インスタンス」 をクリックします。 インスタンスを見つけてクリックし、サマリー・ページを開きます。 ページの 「アクセス情報」 セクションまでスクロールし、 URL ベアラー・トークンをコピーします。 後でアクセスできる場所 (ローカル・テキスト・ファイルなど) に値を保管します。 (ベアラー・トークンは、インストールされたデプロイメントの API 鍵として機能します。)

プロジェクト ID

このチュートリアルで作成したプロジェクトの固有 ID です。

「統合とデプロイ」 ページの 「API 情報」 タブからプロジェクト ID をコピーできます。

サンプル・アプリケーションを開始するスクリプトを実行するには、以下のステップを実行します。

  1. 以下のいずれかを実行します。

    • リポジトリーをダウンロードした場合は、ファイルをアーカイブからシステム上の作業ディレクトリーに解凍します。 コマンド端末ウィンドウを開き、リポジトリー・ファイルをダウンロードしたディレクトリーに移動します。

    • リポジトリーを複製した場合は、リポジトリーの複製先のディレクトリーから端末ウィンドウを開きます。

  2. スクリプトを起動するには、次のコマンドを入力します

    ./runExampleApp.sh

    アプリケーションを実行するために必要なリソースをセットアップするための時間をスクリプトに与えます。

    必要な前提条件ソフトウェア・パッケージが欠落している場合は、スクリプトを正常に使用するためにインストールする必要があるパッケージをスクリプトが通知します。

  3. authType の指定を求めるプロンプトが出されたら、使用する認証のタイプを入力します。 タイプは、サービス・インスタンスのデプロイ方法によって異なります。

    • IBM Cloud Enter iam

    • IBM Cloud Pak for DataIBM Software Hub CP4D を入力してください。

      iam 値は、 Identity and Access Managementを使用していることを示します。これは、 IBM Cloud が管理対象サービスを認証するために使用するサービスです。 IBM Cloud Pak for Data 上にデプロイされているインストール済みインスタンスでは、代わりに CP4D が指定されます。

    次の 3 つのプロンプトには、前にコピーして保存した情報を入力します。

    • URL
    • apikey
    • project_id

スクリプトが完了すると、サンプル・アプリを今すぐ開始するかどうかを尋ねられます。 はいの場合は、 y と入力してください。 新しい Web ブラウザー・ウィンドウまたはタブが表示され、サンプル・アプリケーションがページにレンダリングされます。 サンプルアプリの URL は http://localhost:3000/ です。これは、アプリがローカルで実行されており、異なるコンピュータを使用しているユーザーはアクセスできないことを意味します。

Shows the sample app user interface
Sample app user interface

サンプル・アプリは、検索プロジェクトのプレビューを提供します。 これを使用して、検索プロジェクトをテストし、必要な調整を行います。

サンプル・アプリケーションのテストが完了したら、初期スクリプトを実行した端末ウィンドウに戻って Ctrl + C を押すことで、サンプル・アプリケーションを停止できます。

他のプロジェクト・タイプのデプロイ

コンテンツ・マイニング・プロジェクトのデータを分析するには、 「改善とカスタマイズ (Improve and customize)」 ページで 「アプリケーションの起動 (Launch application)」 をクリックします。 詳しくは、「 データの分析」を参照してください。

契約プロジェクトのドキュメント保存期間から契約を分析するには、照会を送信します。 契約情報の理解について詳しくは、 契約について を参照してください。

会話型検索プロジェクトをデプロイするには、このプロジェクトを watsonx Assistantでビルドされたアシスタントに接続します。 実行する一般的なステップには、以下のものがあります。

  1. アシスタントを作成します。

    テスト目的で watsonx Assistant 試用版プランを使用できます。

  2. 検索スキルをアシスタントに追加してから、このプロジェクトに接続します。

  3. アシスタントをデプロイします。

    watsonx Assistant 検索スキルの作成について詳しくは、デプロイメントの該当する資料を参照してください。