API の検索とフィルタリング

このページは Apigee と Apigee ハイブリッドに適用されます。

このトピックでは、Vertex AI を搭載したスマート検索とフィルタベースの検索オプションを使用して、API Hub で特定のリソースを検索する方法について説明します。

スマート検索を使用すると、API Hub に登録されている API リソースを簡単に検索して表示できます。スマート検索では、インスタンスで使用可能なすべての API リソースをフリーテキスト検索クエリによって検索できます。すべてのエンティティ タイプ（API、API オペレーション、仕様など）を検索するか、検索対象のエンティティ タイプを指定できます。

Vertex AI 検索エンジンにより、スマート検索は単語の「マッチング」を超えた検索を実現します。詳細な API リソース エントリ内のあらゆる場所から、入力されたフリーテキスト検索クエリと意味的に類似する語句を見つけ出し、その語句が含まれる結果を返します。

フリーテキスト検索では、次の詳細を含む検索結果のリストが複数のページに分かれて返されます。

  • リソース名: API、API オペレーション、仕様ファイルの名前。
  • リソースの説明: リソースの簡単な説明。
  • リソースのオーナー: リソースのオーナーの名前とメールアドレス。
  • リソースの詳細リンク: リソースの詳細情報ページへのリンク。

特定の語句を含む API を検索するには:

  1. Google Cloud コンソールで、API Hub の [検出] ページに移動します。

    API Hub の [検出] に移動

  2. 検索ボックスに検索クエリを入力します。

    たとえば、「Order management APIs」や「Spec file for wireless carrier settings」と入力します。

    検索クエリ プロンプトでシステム属性を使用して、検索を絞り込むことができます。API Hub で API を登録する際にユーザー属性を作成した場合は、その属性を検索クエリのプロンプトに組み込むこともできます。

  3. 検索結果リストには、入力した検索クエリと意味的に類似する語句を含む API リソースのリストが表示されます。
  4. API リソース名をクリックすると、リソースの詳細ページが表示されます。
  5. 現在のクエリを消去するには、[Clear results] をクリックします。

API Hub API を使用して API Hub リソースを検索することもできます。searchResources メソッドを使用すると、フリーテキスト クエリとフィルタを使用して API Hub リソースをクエリできます。

次の API 呼び出しを使用して、API Hub リソース全体を検索できます。 

curl -X POST https://apihub.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION:searchResources \
  -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" \
  -d '{
    "query":"QUERY",
    "filter":"resource_type = RESOURCE_TYPE"
   }'

ここで

  • PROJECT_ID は、API Hub インスタンスのホスト プロジェクトの ID です。
  • LOCATION は、API Hub インスタンスがホストされている場所です。
  • QUERY は、検索で使用するフリーテキスト クエリです。クエリには、表示名、説明、その他のメタデータなど、API Hub リソースの詳細に関連するキーワードを含めることができます。
  • RESOURCE_TYPE は、検索に指定するオプションのフィルタです。次のいずれかの API Hub リソースタイプをフィルタとして指定できます。
    • Api
    • ApiOperation
    • Deployment
    • Definition
    • Spec
    • Version

例: 

curl -X POST https://apihub.googleapis.com/v1/projects/{project-id}/locations/{location}:searchResources \
  -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" \
  -d '{
    "query":"dog status in the store",
    "filter":"resource_type = SPEC"
    }'

この呼び出しでは、次のものを含む API Hub リソースのリストが複数のページに分かれて返されます。

  • リソースの表示名。
  • リソースの説明。
  • リソースに関するドキュメントへのリンク。
  • リソースのオーナー。

リソースに追加のシステム属性またはユーザー属性が構成されている場合は、その属性に関連付けられたメタデータも返されます。

API Hub API を使用したフリーテキスト検索の詳細については、Method:project.locations.searchResources の API リファレンス ドキュメントをご覧ください。

フィルタベースの検索オプション

システム属性を検索パラメータとして使用して、[API] ページに表示された API のリストを絞り込むことができます。API Hub で API を登録する際にユーザー属性を作成した場合は、その属性を検索クエリに組み込むこともできます。表示された API リソースのリストをカスタマイズする際は、次の機能を使用します。

フィルタ

フィルタベースのリスト検索を使用すると、リソースに関連付けられている事前定義済みのパラメータとシステム属性に基づいて、API のリストを効率化できます。フィルタ適用後のビューは、Match ALL または Match ANY のオプションによってカスタマイズできます。

フィルタ オプションを指定するには:

  1. Google Cloud コンソールで、API Hub の [API] ページに移動します。

    API Hub の [API] に移動

  2. [表をフィルタ] フィールドをクリックして、表をフィルタします。[フィルタ] ペインが開きます。
  3. 次のフィルタ オプションを指定または選択します。
    • API 名: API の表示名
    • ドキュメント: API ドキュメントのショートリンク。
  4. フィルタ オプションを選択したら、[値] リストからフィルタ値を選択します。また、選択したフィルタ属性の値を入力することもできます。
  5. フィルタを追加するには、[表をフィルタ] フィールドをクリックして、使用可能な演算子から演算子を選択し、別のフィルタ属性と値を選択します。

  6. 選択したフィルタ プロパティには、フィルタクエリが使用している条件ロジックが表示されます。演算子として OR を選択できます。演算子を選択しないと、デフォルトの AND が使用されます。

  7. 個別のフィルタをクリアするには、フィルタの [X] をクリックします。すべてのフィルタをクリアするには、[フィルタ] ペインで [すべてクリア] をクリックします。

並べ替え

表示された API のリストを並べ替えるには:

  1. Google Cloud コンソールで、API Hub の [API] ページに移動します。

    API Hub の [API] に移動

    デフォルトでは、[API] リストページが表示されます。

  2. [API] リストページで、[API 名] 列見出しを見つけます。
  3. 矢印は、現在の並べ替えの優先度を表します。 下矢印はアルファベットの降順を示し、 上矢印はアルファベットの昇順を示しています。
  4. [API 名] をクリックすると、API リストが名前で並べ替えられます。

ページネーション

API リソースが複数ある場合は、複数のページに分かれて表示されることがあります。

リストの表示をカスタマイズし、ページ間を移動するには:

  1. Google Cloud コンソールで、API Hub の [API] ページに移動します。

    API Hub の [API] に移動

    デフォルトでは、[API] リストページが表示されます。

  2. [API] リストで、下に示すページネーション ツールを見つけます。

  3. ページごとに表示する API の数を選択します。
  4. [> 進む] をクリックして次のページに移動します。
  5. [< 戻る] をクリックして前のページに移動します。

次のステップ