searchRequest リソースの種類

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

注意

Microsoft Search API の要求および応答で使用されたリソースの名前が変更されたか、削除された、または廃止されています。 廃止についての詳細は、 「詳細情報」でご確認ください。 検索 API クエリは、以前のいずれかのアプリで適宜更新します。

JSON BLOB でフォーマットされた検索要求。

JSON BLOB には、応答で予期されるリソースの種類、基になるソース、ページング パラメーター、並べ替えオプション、要求された集計とフィールド、および実際の検索クエリが含まれています。 さまざまなリソースでの検索要求の 例 を確認します。

注:

エンティティ型の特定の組み合わせの検索、検索結果の並べ替えまたは集計に関する 既知の制限 事項に注意してください。

プロパティ

プロパティ 型 説明
集計 aggregationOption コレクション 検索結果と共に返される集計 (絞り込み条件とも呼ばれます) を指定します。 省略可能。
aggregationFilters String collection 1 つまたは複数のフィルターが含まれ、フィールドの特定の値に集計およびフィルター処理された検索結果を取得します。 省略可能。
このフィルターは、同じフィールドで集計される以前の検索に基づいて構築します。 前の検索の応答から、フィールドの特定の値に結果をフィルター処理する searchBucket を特定し、 aggregationFilterToken プロパティで文字列を使用して、 "{field}:\"{aggregationFilterToken}\"" の形式で集計フィルター文字列を作成します。
同じフィールドに複数の値を指定する必要がある場合は、 aggregationFilterToken プロパティの文字列を使用し、 "{field}:or(\"{aggregationFilterToken1}\",\"{aggregationFilterToken2}\")" の形式で集計フィルター文字列を作成します。
たとえば、ドライブ項目をファイルの種類別に検索および集計すると、応答でdocxファイルの種類の searchBucket が返されます。 後続の検索クエリでこの searchBucket に対して返される aggregationFilterToken を便利に使用し、一致をフィルター処理して、docxファイルの種類の項目をドライブできます。 例 1 と 例 2 は、実際の要求と応答を示しています。
collapseProperties collapseProperty コレクション フィールドの順序付けされたコレクションを含み、結果を折りたたむまで制限します。 省略可能。
contentSources String collection 対象となる接続が格納されます。
次の形式を尊重します。 /external/connections/connectionid ここで、 connectionid はコネクタ管理で定義された ConnectionId です。
注: contentSource は entityType=externalItem の場合にのみ適用されます。 省略可能。
enableTopResults ブール型 これにより、メッセージのハイブリッド並べ替えがトリガーされます。最初の 3 つのメッセージが最も関連性が高くなります。 このプロパティは entityType=message にのみ適用されます。 省略可能。
entityTypes entityType コレクション 応答で想定される 1 つ以上の種類のリソース。 有効な値は、 list、 site、 listItem、 message、 event、 drive、 driveItem、 person、 externalItem、 acronym、 bookmark、 chatMessage です。 同じ検索要求でサポートされる 2 つ以上のエンティティ型の組み合わせの詳細については、「 既知の制限事項」を参照してください。 必須です。
フィールド String collection entityTypes で指定されている各リソース オブジェクトに対して返されるフィールドが含まれ、それ以外の場合に返されるフィールドをカスタマイズできます。これには、SharePoint や OneDrive のカスタム管理プロパティなどの追加フィールドや、Microsoft 365 Copilot コネクタが取り込むコンテンツの externalItem のカスタム フィールドなど、既定で返されるフィールドをカスタマイズできます。
fields プロパティには、プロパティに適用される セマンティック ラベル を使用できます。 たとえば、プロパティのラベルが title である場合、次の構文を使用して取得できます: label_title。
省略可能。
from Int32 検索結果のオフセットを指定します。 オフセット 0 は、最初の結果を返します。 省略可能。
query SearchQuery クエリ用語を格納します。 必須です。
queryAlterationOptions searchAlterationOptions スペル修正に関連する 2 つのオプション フラグを含む JSON BLOB 形式のクエリ変更オプションを提供します。 省略可能。
region string アプリケーションのアクセス許可を使用する検索に必要です。 検索の地理的な場所を表します。 詳細については、「 リージョン値の取得」を参照してください。
resultTemplateOptions resultTemplateOption コレクション コネクタ検索結果をレンダリングするための検索結果テンプレート オプションを提供します。
sharePointOneDriveOptions sharePointOneDriveOptions アプリケーションのアクセス許可を使用して検索を実行するときに検索するコンテンツの種類を示します。 省略可能。
size Int32 取得するページのサイズ。 最大値は 500 です。 省略可能。
sortProperties sortProperty コレクション フィールドの順序付けされたコレクションと、結果を並べ替える方向が含まれます。 コレクションには最大 5 つの並べ替えプロパティを含めることができます。 省略可能。
trimDuplicates ブール型 重複する SharePoint ファイルを検索結果からトリミングするかどうかを示します。 既定値は false です。 省略可能。
stored_fields (非推奨) String collection 現在は fields プロパティに置き換えられています。

JSON 表記

次の JSON 表現は、リソースの種類を示しています。

{
  "aggregationFilters": ["String"],
  "aggregations": [{"@odata.type": "microsoft.graph.aggregationOption"}],
  "contentSources": ["String"],
  "enableTopResults": true,
  "entityTypes": ["String"],
  "fields": ["String"],
  "from": 1024,
  "query": {"@odata.type": "microsoft.graph.searchQuery"},
  "queryAlterationOptions": {"@odata.type": "microsoft.graph.searchAlterationOptions"},
  "region": "63128164-cbbf-4db4-896c-a7038417019c",
  "resultTemplateOptions": [{"@odata.type": "microsoft.graph.resultTemplateOption"}],
  "sharePointOneDriveOptions": {"@odata.type": "microsoft.graph.sharePointOneDriveOptions"},
  "size": 1024,
  "sortProperties": [{"@odata.type": "microsoft.graph.sortProperty"}],
  "collapseProperties": [{"@odata.type": "microsoft.graph.collapseProperty"}],
  "trimDuplicates": false
}

関連コンテンツ

  • Last updated on