Microsoft Graph コネクタを使用してインポートしたカスタムタイプを検索するには、Microsoft 検索 API を使用します。Use the Microsoft Search API to search custom types imported using Microsoft Graph connectors

Microsoft 検索 API を使用して、コンテンツ取り込まれたを検索し、 Microsoft Graph コネクタによってインデックスを作成します。Use the Microsoft Search API to search accross content ingested and indexed by Microsoft Graph connectors. コンテンツは、Microsoft によって提供される 組み込みのコネクタ を介して、または microsoft Graph コネクタのインジェスト APIを使用して実装されたカスタムコネクタを介してインポートされます。The content is imported either via built-in connectors provided by Microsoft, or via custom connectors implemented using the Microsoft Graph connectors ingestion API.

重要

Microsoft Graph のコネクタは現在パブリック プレビューの状態です。Microsoft Graph connectors are currently in public preview status. コネクタ機能にアクセスするには、テナントの対象指定リリース オプションを有効にする必要があります。To gain access to connectors functionality, you must turn on the Targeted release option in your tenant. 詳細については、「 コネクタのプレビュープログラム」を参照してください。See more details on the connectors preview program.

注意事項

検索要求の一部のプロパティで検索 API スキーマが変更され、応答が変更または削除されました。The search API schema has changed with some properties in a search request and response renamed or removed. 廃止の詳細については、「」を参照 してくださいSee more details about the deprecation. このトピックの例では、今後使用するスキーマを示します。Examples in this topic show the schema to use going forward.

コンテンツをインポートしてインデックスを作成したら、検索 API を使用してコンテンツを照会できます。Once the content has been imported and indexed, you can use the search API to query the content.

カスタム型を検索するには、 query メソッドの要求本文で次のプロパティを指定します。To search for custom types, specify the following properties in the request body of the query method:

  • Contentsourcesプロパティは、コネクタのセットアップ時に割り当てられた接続 ID を含みます。The contentSources property to include the connection ID that is assigned during the connector setup. 複数の接続 Id を使用して、複数の接続にわたる検索を行うことができます。You can pass multiple connection IDs to search across multiple connections. 結果は1つのリストで返され、複数の接続でランク付けされます。Results are returned in a single list, ranked accross the multiple connections.
  • Entitytypesプロパティをとして externalItemThe entityTypes property as externalItem.

  • 取得する外部アイテムのフィールドを含める fields プロパティ。The fields property to include the fields in the external item to retrieve. 要求にフィールドが含まれていない場合、応答には、 contentsourcesプロパティで指定された接続に対して指定されたデータスキーマで取得可能としてマークされたすべてのフィールドが含まれていることに注意してください。Note that if you do not include any fields in the request, the response will contain all the fields marked as retrievable in the data schema specified for the specified connections in the contentSources property.

Example

この例では、 AdventureWorks データベースのコンテンツが Azure SQL 組み込みコネクタを使用して取り込まれたされています。In this example, the content of the AdventureWorks database has been ingested using the Azure SQL built-in connector.

要求Request

POST https://graph.microsoft.com/beta/search/query
Content-Type: application/json

{
  "requests": [
    {
      "entityTypes": [
        "externalItem"
      ],
      "contentSources": [
          "/external/connections/azuresqlconnector",
          "/external/connections/azuresqlconnector2"
      ],
      "query": {
        "queryString": "yang"
      },
      "from": 0,
      "size": 25,
      "fields": [
        "BusinessEntityID",
        "firstName",
        "lastName"
      ]
    }
  ]
}

応答Response

HTTP/1.1 200 OK
Content-type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.searchResponse)",
  "value": [
    {
      "searchTerms": ["ya"],
      "hitsContainers": [
        {
          "total": 2,
          "moreResultsAvailable": false,
          "hits": [
            {
              "hitId": "AAMkADc0NDNlNTE0",
              "rank": 1,
              "summary": "<ddd/>",
              "contentSource": "/external/connections/azuresqlconnector",
              "resource": {
                "@odata.type": "#microsoft.graph.externalItem",
                "properties": {
                  "businessEntityID": 20704,
                  "firstName": "Amy",
                  "lastName": "Yang"
                }
              }
            },
           {
              "hitId": "AQMkADg3M2I3YWMyLTEwZ",
              "rank": 2,
              "summary": "<ddd/>",
              "contentSource": "/external/connections/azuresqlconnector2",
              "resource": {
                "@odata.type": "#microsoft.graph.externalItem",
                "properties": {
                  "businessEntityID": 20704,
                  "shortdescription": "Contoso maintenance guidelines",
                  "firstName": "Amy",
                  "lastName": "Yang"
                }
              }
            },
          ]
        }
      ]
    }
  ]
}

次の手順Next steps