検索 API で使用できる各種機能の詳細については、リファレンスドキュメントを参照してください。
クエリ演算子
検索 API は、AND、OR、NOT、""など、いくつかの検索演算子をサポートします。これらの演算子を使用すると、より複雑な組み合わせの検索語句に一致する項目のみが返されるように検索結果を絞り込むことができます。
論理演算子の使用の詳細を確認する
検索インデックス作成
Box は、Box に格納されているファイルまたはフォルダの検索インデックスを保持します。ファイルまたはフォルダが変更されるたびに、これらの単語がインデックスに追加されます。検索が実行されると、API は、検索インデックスで、クエリに一致するファイルやフォルダを探します。Box 内でコンテンツが追加、更新、または削除されると、それに応じて検索インデックスが更新されます。Boxの検索インデックスの詳細を確認する
10 分経過してもインデックスが更新されない場合もあります。このような場合は、Box サポートに問い合わせて問題を解決することをお勧めします。
メタデータクエリとの比較
一見、検索クエリ API はメタデータクエリ APIとよく似ていますが、動作には重要な違いがいくつかあります。大まかに言うと、メタデータクエリは正確さとスループットの向上のために最適化されているのに対し、通常の検索は、人間のユーザーとの関連度のために最適化されています。| メタデータクエリ API | 検索 API | |
|---|---|---|
| インデックスの作成対象 | この API では、検索対象のメタデータテンプレートの値に基づいてファイル/フォルダのみが返されます。 | この API では、項目名、説明、コンテンツ (最初の 10,000 バイトまで) の値のほか、関連付けられたメタデータテンプレートインスタンスに基づいてファイル、フォルダ、ウェブリンクが返されます。 |
| インデックス作成時間 | この API では、ファイルまたはフォルダのメタデータが追加、削除、更新されるとすぐに正確な結果が返されます。 | この API は、検索インデックスの作成が遅延すると、その影響を受けます。この遅延は通常 10 分ですが、場合によっては長くなることがあります。つまり、メタデータが更新されてから 10 分を経過しても項目が返されない場合があります。 |
| 一致 | この API では、SQL の規則に基づいて完全一致が使用されます。結果は、指定した並べ替え順を基に返されます。 | この API では、あいまい一致が使用されるため、文字列のトークン化、特殊文字の削除、およびその他の検索コンセプトに基づいて異なる結果が返される場合があります。結果の順序は、項目の関連度または更新日に基づいています。 |
| 条件付きロジック | この API は、比較演算子を使用するマルチパートブール式をサポートします。 | この API では、メタデータによるクエリのサポートが限定的です。サポートされるのは、一度に 1 つのメタデータテンプレートに対するクエリのみで、単純なクエリ操作のみが可能です。 |
| レスポンスタイプ | この API では、一致したファイル/フォルダと、クエリによって一致した関連するメタデータの両方が返されます。 | この API で返されるのは、一致した項目のみです。各項目のメタデータを返すには、後続の API コールが必要です。 |
| スループット (Throughput) | この API には現在、ユーザーごとのレート制限のほか、企業あたりのリクエスト数が 10 件/秒という制限があります。 | この API では、1 ユーザーあたりの検索数は 6 件/秒、企業あたりの検索数は最大 60 件/分および 12 件/秒がサポートされています。 |
| 規模 | この API では、指定したメタデータテンプレートを使用して返される項目数に制限はありません。一致する結果が 2,000 件以下になるクエリのみを送信することをお勧めします。 | この API には、指定したメタデータテンプレートを使用して返される項目数に制限はありません。ただし、検索に一致する項目数が増えるにつれ、レスポンス時間が大幅に増大します。この API では、1 つのクエリに対する結果は 1,000 万件までという制限があります。一致する結果が 50,000 件以下になるクエリのみを送信することをお勧めします。 |
| スコープ | この API は常に、ユーザーがアクセスできるコンテンツに制限されています。 | この API は、ユーザーがアクセスできるコンテンツ (user_content) または社内のすべてのコンテンツ (enterprise_content) のいずれかに制限される場合があります。 |